Create User
Create a new user.
Show optional properties
{
"username": "string"
}{
"username": "string",
"givenName": "string",
"familyName": "string",
"fullName": "string",
"description": "string",
"id": "string",
"roleEntityRefs": [
{
"name": "string",
"id": "string"
}
],
"effectiveRoleEntityRefs": [
{
"name": "string",
"id": "string"
}
],
"orgEntityRef": {
"name": "string",
"id": "string"
},
"password": "string",
"email": "string",
"nameInSource": "string",
"enabled": false,
"inheritGroupRoles": false,
"providerType": "string",
"locked": false,
"stranded": false,
"phone": "string",
"domain": "string",
"managerEntityRef": {
"name": "string",
"id": "string"
}
}Created
"VcdUser Object"User name of the user.
Given name of the user (e.g. first name in most Western languages).
Family name of the user (e.g. last name in most Western languages).
Full name (display name) of the user.
Description of the user.
Unique id for the user. The id can be specified on creation but not changed afterwards.
The directly assigned role(s) of the user.
A read-only list of all of a user's roles, both directly assigned and inherited from the user's groups.
Entity reference used to describe VCD entities
Password for the user. Must be null for external users. Local user passwords must be at least 15 characters long and contain 1 of each of the following: lowercase letter, uppercase letter, digit, special character
A user's email address. Based on org email preferences, notifications can be sent to the user via email.
Name of the user in its source.
Enabled state of the user. Defaults to true.
Determines if this user can inherit roles from groups. Defaults to false.
Provider type of the user. It must be one of: LOCAL, LDAP, SAML, OAUTH.
True if the user account has been locked due to too many invalid login attempts. An administrator can unlock a locked user account by setting this flag to false. A user may not be explicitly locked. Instead, disable the user, if user's access must be revoked temporarily.
True if the user account has been stranded, meaning it is unable to be accessed due to its original identity source being removed.
Phone number of the user.
IDP domain the user is in
Entity reference used to describe VCD entities
This operation contains the following vendor extensions defined in the spec:
[object Object],[object Object]
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"username:"string"}' https://{api_host}/cloudapi/1.0.0/users