API docs by Redocly

Mgr-Tenants API (v1)

Tenant Manager API

tenants

createTenant

Create a new tenant

Request Body schema: application/json
required
id
string <uuid>

A UUID identifying this attribute

name
required
string[a-z][a-z0-9_]{0,29}[a-z0-9]

Tenant name

description
string

Tenant description

type
string (Tenant Type Schema)
Default: "default"
Enum: "default" "virtual"

Tenant type

secure
boolean

The flag shows whether the particular tenant is secure or not

Array of objects (Tenant Attribute Schema)

List of tenant attributes

Array
id
string <uuid>

A UUID identifying this attribute

key
required
string

Key for this attribute

value
required
string

Value for this attribute

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

createdDate
required
string <date-time>

Date and time when the record was created

createdBy
string <uuid>

ID of the user who created the record (when available)

modifiedDate
string <date-time>

Date and time when the record was last updated

modifiedBy
string <uuid>

ID of the user who last updated the record (when available)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "type": "default",
  • "secure": true,
  • "attributes": [
    ],
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "type": "default",
  • "secure": true,
  • "attributes": [
    ],
  • "metadata": {
    }
}

getTenantsByQuery

Get tenants by query

query Parameters
query
string

A CQL query string with search conditions.

offset
integer >= 0
Default: 0

Skip over a number of elements by specifying an offset value for the query.

limit
integer [ 0 .. 500 ]
Default: 10

Limit the number of elements returned in the response.

Responses

Response samples

Content type
application/json
{
  • "tenants": [
    ],
  • "totalRecords": 0
}

getTenantById

Get tenant by id

path Parameters
id
required
string <uuid>

Entity id

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "type": "default",
  • "secure": true,
  • "attributes": [
    ],
  • "metadata": {
    }
}

updateTenantById

Update a tenant

path Parameters
id
required
string <uuid>

Entity id

Request Body schema: application/json
id
string <uuid>

A UUID identifying this attribute

name
required
string[a-z][a-z0-9_]{0,29}[a-z0-9]

Tenant name

description
string

Tenant description

type
string (Tenant Type Schema)
Default: "default"
Enum: "default" "virtual"

Tenant type

secure
boolean

The flag shows whether the particular tenant is secure or not

Array of objects (Tenant Attribute Schema)

List of tenant attributes

Array
id
string <uuid>

A UUID identifying this attribute

key
required
string

Key for this attribute

value
required
string

Value for this attribute

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

createdDate
required
string <date-time>

Date and time when the record was created

createdBy
string <uuid>

ID of the user who created the record (when available)

modifiedDate
string <date-time>

Date and time when the record was last updated

modifiedBy
string <uuid>

ID of the user who last updated the record (when available)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "type": "default",
  • "secure": true,
  • "attributes": [
    ],
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "type": "default",
  • "secure": true,
  • "attributes": [
    ],
  • "metadata": {
    }
}

deleteTenantById

Remove a tenant by id

path Parameters
id
required
string <uuid>

Entity id

query Parameters
purgeKafkaTopics
boolean
Default: false

If set to true, the tenant's Kafka topics will be purged.

Responses

Response samples

Content type
application/json
{ }

tenant-attributes

getTenantAttributes

Retrieve list of available tenant attributes by tenant id

path Parameters
tenantId
required
string <uuid>

Tenant id

query Parameters
query
string

A CQL query string with search conditions.

offset
integer >= 0
Default: 0

Skip over a number of elements by specifying an offset value for the query.

limit
integer [ 0 .. 500 ]
Default: 10

Limit the number of elements returned in the response.

Responses

Response samples

Content type
application/json
{
  • "tenantAttributes": [
    ],
  • "totalRecords": 0
}

createTenantAttributes

Create or replace tenant-attributes associated with the specified tenant. Idempotent operation

path Parameters
tenantId
required
string <uuid>

Tenant id

Request Body schema: application/json
required
required
Array of objects (Tenant Attribute Schema)

List of tenant attributes

Array
id
string <uuid>

A UUID identifying this attribute

key
required
string

Key for this attribute

value
required
string

Value for this attribute

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

totalRecords
integer

Responses

Request samples

Content type
application/json
{
  • "tenantAttributes": [
    ],
  • "totalRecords": 0
}

Response samples

Content type
application/json
{
  • "tenantAttributes": [
    ],
  • "totalRecords": 0
}

getTenantAttribute

Retrieve tenant attribute by id

path Parameters
tenantId
required
string <uuid>

Tenant id

id
required
string <uuid>

Entity id

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "key": "string",
  • "value": "string",
  • "metadata": {
    }
}

updateTenantAttribute

Update tenant attribute

path Parameters
tenantId
required
string <uuid>

Tenant id

id
required
string <uuid>

Entity id

Request Body schema: application/json
required
id
string <uuid>

A UUID identifying this attribute

key
required
string

Key for this attribute

value
required
string

Value for this attribute

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

createdDate
required
string <date-time>

Date and time when the record was created

createdBy
string <uuid>

ID of the user who created the record (when available)

modifiedDate
string <date-time>

Date and time when the record was last updated

modifiedBy
string <uuid>

ID of the user who last updated the record (when available)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "key": "string",
  • "value": "string",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "key": "string",
  • "value": "string",
  • "metadata": {
    }
}

deleteTenantAttribute

Delete tenant attribute

path Parameters
tenantId
required
string <uuid>

Tenant id

id
required
string <uuid>

Entity id

Responses

Response samples

Content type
application/json
{ }