Get User With Canonical Id

Operation ID: getUserWithCanonicalID
Get the user with the user canonical ID

Request

URI

GET

https://{api_host}/api/v1/users/{canonicalUserId}

COPY

Path Parameters

string

canonicalUserId

Required

The canonical ID of the user to get

Authentication

This operation uses the following authentication methods.

basicAuth

bearerAuth

Responses

200

The user is returned

Returns OsisUser of type(s) application/json

{
    "tenant_id": "bb8287a9-874e-46d2-abbd-58278e1ac046",
    "role": "PROVIDER_ADMIN",
    "canonical_user_id": "68fb0f20-4a0c-4036-a584-cc3ee421093f",
    "user_id": "rachelw",
    "cd_tenant_id": "40b97e3c-c3b1-4251-b7de-e9637324683f",
    "active": true,
    "user_arn": "arn:aws:iam::account:user/user-name-with-path",
    "cd_user_id": "rachelw",
    "email": "[email protected]",
    "username": "username"
}

string

user_id

Optional

The ID of platform user. The property is absent in user creation request, and is mandatory in the user creation response.

string

canonical_user_id

Optional

The canonical ID of platform user. The property is absent in user creation request, and is mandatory in the user creation response.

string

user_arn

Optional

The arn of platform user.

string

tenant_id

Required

The ID of the platform tenant which the platform user belongs to.

boolean

active

Optional

The status of platform user. For the platforms not supporting activate/deactivate user, either returning active=true or not returning active indicates the platform user is in active status.

string

username

Optional

The platform username mapped with VCD user.

string As email As email

Optional

The user email of the VCD user.

string

role

Optional

user role

Possible values are : PROVIDER_ADMIN, TENANT_ADMIN, TENANT_USER, ANONYMOUS, UNKNOWN,