Create User

Create User

Operation ID: createUser
Create a storage user in the storage tenant. 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.

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

The ID of the storage tenant to which the creating user belongs

Request Body

Storage user to create in the storage tenant. canonical_user_id is ignored.

OsisUser of type(s) application/json
Required 
{
    "user_id": "rachelw",
    "canonical_user_id": "68fb0f20-4a0c-4036-a584-cc3ee421093f",
    "tenant_id": "bb8287a9-874e-46d2-abbd-58278e1ac046",
    "active": false,
    "username": "string",
    "email": "[email protected]",
    "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

Authentication
This operation uses the following authentication methods.
Responses
201

A storage user is created

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": "[email protected]",
    "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


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