permissions

Select Tenant

Select current tenant.

This endpoint selects a tenant with the specified UUID. Tenants are used to organize users and resources in multi-tenant environments, providing isolation and access control between different groups or organizations.

Sending a null/None value as tenant_id selects his default single user tenant

Request Parameters

tenant_id (Union[UUID, None]): UUID of the tenant to select, If null/None is provided use the default single user tenant

Response

Returns a success message along with selected tenant id.

POST

api

permissions

tenants

select

Select Tenant

curl --request POST \
  --url https://api.cognee.ai/api/v1/permissions/tenants/select \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

tenantId

string<uuid> | null

Response

Successful Response

Get Tenant Roles

⌘I

Select Tenant

curl --request POST \
  --url https://api.cognee.ai/api/v1/permissions/tenants/select \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}