Users

The user of the cluster. Access is managed by certificates. The certificates are retrieved by the access endpoint. This tag groups all operations for users.

Retrieve all Users

get

https://kafka.de-txl.ionos.comhttps://kafka.de-fra.ionos.comhttps://kafka.fr-par.ionos.comhttps://kafka.es-vit.ionos.comhttps://kafka.gb-lhr.ionos.comhttps://kafka.gb-bhx.ionos.comhttps://kafka.us-las.ionos.comhttps://kafka.us-mci.ionos.comhttps://kafka.us-ewr.ionos.com

/clusters/{clusterId}/users

This endpoint enables retrieving all Users using pagination and optional filters.

Authorizations

tokenAuth

AuthorizationstringRequired

The token can be generated using the Authentication API.

Path parameters

clusterIdstring · uuidRequired

The ID (UUID) of the Cluster.

Example: e69b22a5-8fee-56b1-b6fb-4a07e4205ead

Responses

200

Returned all requested Users successfully.

application/json

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Not Allowed

The user issuing the request does not have the needed permissions.

application/json

429

Too Many Requests

The user has sent too many requests in a given amount of time.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

503

Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

Unexpected Internal Server Error

An unexpected internal error occurred. We apologize for the inconvenience!

application/json

get

/clusters/{clusterId}/users

HTTPcURLJavaScriptPython

GET /clusters/{clusterId}/users HTTP/1.1
Host: kafka.de-txl.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "434e0c83-031d-5f5a-be82-63ee54dda025",
  "type": "collection",
  "href": "/clusters/{clusterId}/users",
  "items": [
    {
      "id": "d11db12c-2625-5664-afd4-a3599731b5af",
      "type": "user",
      "href": "/clusters/{clusterId}/users/d11db12c-2625-5664-afd4-a3599731b5af",
      "metadata": {
        "createdDate": "2020-12-10T13:37:50+01:00",
        "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "lastModifiedDate": "2020-12-11T13:37:50+01:00",
        "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
        "state": "AVAILABLE",
        "message": "In progress."
      },
      "properties": {
        "name": "my-kafka-cluster-user"
      }
    }
  ]
}

Retrieve Apache Kafka User with Credentials

get

https://kafka.de-txl.ionos.comhttps://kafka.de-fra.ionos.comhttps://kafka.fr-par.ionos.comhttps://kafka.es-vit.ionos.comhttps://kafka.gb-lhr.ionos.comhttps://kafka.gb-bhx.ionos.comhttps://kafka.us-las.ionos.comhttps://kafka.us-mci.ionos.comhttps://kafka.us-ewr.ionos.com

/clusters/{clusterId}/users/{userId}/access

Returns the user by ID containing its access certificates in the metadata.

Authorizations

tokenAuth

AuthorizationstringRequired

The token can be generated using the Authentication API.

Path parameters

clusterIdstring · uuidRequired

The ID (UUID) of the cluster.

Example: e69b22a5-8fee-56b1-b6fb-4a07e4205ead

userIdstring · uuidRequired

The ID (UUID) of the user.

Example: d11db12c-2625-5664-afd4-a3599731b5af

Responses

200

Get user access information was successful.

application/json

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Not Allowed

The user issuing the request does not have the needed permissions.

application/json

404

Not Found

The resource that was requested could not be found.

application/json

429

Too Many Requests

The user has sent too many requests in a given amount of time.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

503

Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

Unexpected Internal Server Error

An unexpected internal error occurred. We apologize for the inconvenience!

application/json

get

/clusters/{clusterId}/users/{userId}/access

HTTPcURLJavaScriptPython

GET /clusters/{clusterId}/users/{userId}/access HTTP/1.1
Host: kafka.de-txl.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "d11db12c-2625-5664-afd4-a3599731b5af",
  "type": "user",
  "href": "/clusters/{clusterId}/users/d11db12c-2625-5664-afd4-a3599731b5af",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2020-12-11T13:37:50+01:00",
    "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
    "state": "AVAILABLE",
    "message": "In progress.",
    "certificateAuthority": "-----BEGIN CERTIFICATE ...",
    "privateKey": "-----BEGIN PRIVATE KEY ...",
    "certificate": "-----BEGIN CERTIFICATE ..."
  },
  "properties": {
    "name": "my-kafka-cluster-user"
  }
}