Update User Status

Update User Status

Operation ID: updateUserStatus
Update status of the user in the platform tenant

Request
URI
PATCH
https://{api_host}/api/v1/tenants/{tenantId}/users/{userId}
COPY
Path Parameters
string
tenantId
Required

The ID of the tenant which the user to update belongs to

string
userId
Required

The ID of the user to update

Request Body

User status to update in the platform tenant. Only property 'active' takes effect

OsisUser of type(s) application/json
Required 
{
    "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
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,
string
cd_user_id
Required

The ID of the VCD user.

string
cd_tenant_id
Required

The ID of the VCD tenant.

Authentication
This operation uses the following authentication methods.
Responses
200

The user status is updated

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
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,
string
cd_user_id
Required

The ID of the VCD user.

string
cd_tenant_id
Required

The ID of the VCD tenant.


400

Bad Request

Returns OsisError of type(s) application/json 
{
    "code": "E_BAD_REQUEST",
    "message": "invalid value for the property xyz."
}
string
code
Required

code

string
message
Optional

message


On This Page
User Operations
POST
Create User
DELETE
Delete User
GET
Get User With Canonical Id
GET
Get User With Id
GET
List Users
GET
Query Users
PATCH
Update User Status