Resolve the caller identity

GET/v1/whoami

Disclaimer: This beta endpoint is evolving; the API contract may change.

Returns the identity of the authenticated caller. For a user (JWT or clickhousectl token) the result carries the user fields; for an organization API key it carries the key fields instead. Use actorType to tell the two apart.

Authorizations

Authorizationstringheaderrequired
Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

Response

JSON

200

Successful response

JSON

statusoptionalnumber
HTTP status code.

Example: 200
requestIdoptionalstring
Unique id assigned to every request. UUIDv4

format: uuid
resultoptionalWhoamiUserorWhoamiApiKey
2 variants
One of the following:
WhoamiUser
View WhoamiUser schema →
5 properties
actorTypestringrequired
Discriminator identifying the caller as a user (JWT or clickhousectl token).

userIdstringrequired
Unique ID of the user.

format: uuid
emailstringrequired
Email address of the user.

format: email
namestringrequired
Full name of the user.

organizationsarray ofobjectrequired
Organizations the user belongs to.

2 properties
organizationIdstringrequired
ID of the organization the user belongs to.

format: uuid
organizationNamestringrequired
Name of the organization.

WhoamiApiKey
View WhoamiApiKey schema →
4 properties
actorTypestringrequired
Discriminator identifying the caller as an organization API key.

keyIdstringrequired
Unique ID of the API key.

namestringrequired
Name of the API key.

organizationIdstringrequired
ID of the organization that owns the API key.

format: uuid

Resolve the caller identity

curl --request GET \
  --url https://api.clickhouse.cloud/v1/whoami \
  --header 'Authorization: Basic <token>'

const url = 'https://api.clickhouse.cloud/v1/whoami';
const options = {method: 'GET', headers: {Authorization: 'Basic <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response example

{
  "status": 200,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "result": {
    "actorType": "user",
    "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
    "email": "user@example.com",
    "name": "string",
    "organizations": [
      {
        "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
        "organizationName": "string"
      }
    ]
  }
}

{
  "status": 400,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}

{
  "status": 500,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}