Create User
Operation ID: createUser
Create a user in the platform. The platform decides whether to adopt the cd_user_id in request body as canonical ID. This means the platform could generate new user_id by itself for the new user. The user_id in request body is ignored.
The ID of the tenant which the created user belongs to
User to create in the platform tenant. canonical_user_id is ignored.
{
"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": "rachelw@acme.com",
"username": "username"
}The ID of platform user. The property is absent in user creation request, and is mandatory in the user creation response.
The canonical ID of platform user. The property is absent in user creation request, and is mandatory in the user creation response.
The arn of platform user.
The ID of the platform tenant which the platform user belongs to.
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.
The platform username mapped with VCD user.
The user email of the VCD user.
user role
The ID of the VCD user.
The ID of the VCD tenant.
A user is created
{
"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": "rachelw@acme.com",
"username": "username"
}The ID of platform user. The property is absent in user creation request, and is mandatory in the user creation response.
The canonical ID of platform user. The property is absent in user creation request, and is mandatory in the user creation response.
The arn of platform user.
The ID of the platform tenant which the platform user belongs to.
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.
The platform username mapped with VCD user.
The user email of the VCD user.
user role
The ID of the VCD user.
The ID of the VCD tenant.
Bad Request
{
"code": "E_BAD_REQUEST",
"message": "invalid value for the property xyz."
}code
message