Get member details | ClickHouse Docs

GET/v1/organizations/{organizationId}/members/{userId}

Returns a single organization member details.

Authorizations

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

Path parameters

organizationIdstringrequired
ID of the organization the member is part of.

format: uuid
userIdstringrequired
ID of the requested user.

format: uuid

Response

JSON

200

Successful response

JSON

statusoptionalnumber
HTTP status code.

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

format: uuid
resultoptionalobject
6 properties
- userIdoptionalstring
  Unique user ID. If a user is a member in multiple organizations this ID will stay the same.
- nameoptionalstring
  Name of the member as set a personal user profile.
- emailoptionalstring
  Email of the member as set in personal user profile.
  
  format: email
- roledeprecatedadminordeveloper
  DEPRECATED. Use assignedRoles instead. Role of the member in the organization. For organizations that have migrated to custom roles, this field is frozen at the pre-migration value and does not reflect current role assignments.
- joinedAtoptionalstring
  Timestamp the member joined the organization. ISO-8601.
  
  format: date-time
- assignedRolesoptionalarray ofobject
  Custom roles and System roles assigned to this member
  
  3 properties
  roleIdoptionalstring
  Unique identifier of the role
  
  format: uuid
  roleNameoptionalstring
  Human-readable name of the role
  
  roleTypeoptionalsystemorcustom
  Type of role: system (predefined) or custom (organization-defined)

Get member details

curl --request GET \
  --url https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/members/497f6eca-6276-4993-bfeb-53cbbbba6f08 \
  --header 'Authorization: Basic <token>'

const url = 'https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/members/497f6eca-6276-4993-bfeb-53cbbbba6f08';
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));

import requests

url = "https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/members/497f6eca-6276-4993-bfeb-53cbbbba6f08"

headers = {"Authorization": "Basic <token>"}

response = requests.get(url, headers=headers)

print(response.text)

Response example

{
  "status": 200,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "result": {
    "userId": "string",
    "name": "string",
    "email": "user@example.com",
    "role": "admin",
    "joinedAt": "2019-08-24T14:15:22Z",
    "assignedRoles": [
      {
        "roleId": "7382d58e-652a-4905-b7c9-bcca1e0e5391",
        "roleName": "string",
        "roleType": "system"
      }
    ]
  }
}

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

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