Get User With Canonical ID
Operation ID: getUserWithCanonicalID
Get the storage user by user canonical ID
Request
URI
GET
https://{api_host}/osis/api/v1/users/{canonicalUserId}
COPY
Path Parameters
string
canonicalUserId
Required
The canonical ID of the storage user to get
Responses
200
The storage user is returned
Returns OsisUser of type(s) application/json
{
"user_id": "rachelw",
"canonical_user_id": "68fb0f20-4a0c-4036-a584-cc3ee421093f",
"tenant_id": "bb8287a9-874e-46d2-abbd-58278e1ac046",
"active": false,
"username": "string",
"email": "rachelw@acme.com",
"role": "string",
"cd_user_id": "rachelw",
"cd_tenant_id": "40b97e3c-c3b1-4251-b7de-e9637324683f"
}string
user_id
Required
user id
string
canonical_user_id
Required
canonical user id
string
tenant_id
Required
ID of the storage tenant which the user belongs to
boolean
active
Required
user status
string
username
Optional
username mapped with Cloud Director username
string As email As email
email
Optional
user email
string
role
Optional
user role
Possible values are : PROVIDER_ADMIN, TENANT_ADMIN, TENANT_USER, ANONYMOUS, UNKNOWN,
string
cd_user_id
Required
Cloud Director user id
string
cd_tenant_id
Required
id of Cloud Director tenant which the user belongs to
404
The tenant doesn't exist
Operation doesn't return any data structure