VcdUser

VcdUser
VcdUser

User Spec object.

JSON Example
{
    "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"
    }
}
string
username
Required

User name of the user.

string
givenName
Optional

Given name of the user (e.g. first name in most Western languages).

string
familyName
Optional

Family name of the user (e.g. last name in most Western languages).

string
fullName
Optional
Constraints: default:

Full name (display name) of the user.

string
description
Optional
Constraints: default:

Description of the user.

string
id
Optional

Unique id for the user. The id can be specified on creation but not changed afterwards.

array of EntityReference
roleEntityRefs
Optional

The directly assigned role(s) of the user.

array of EntityReference
effectiveRoleEntityRefs
Optional
Constraints: maxItems: 128

A read-only list of all of a user's roles, both directly assigned and inherited from the user's groups.

EntityReference
orgEntityRef
Optional

Entity reference used to describe VCD entities

string
password
Optional

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

string As email As email
email
Optional

A user's email address. Based on org email preferences, notifications can be sent to the user via email.

string
nameInSource
Optional

Name of the user in its source.

boolean
enabled
Optional

Enabled state of the user. Defaults to true.

boolean
inheritGroupRoles
Optional

Determines if this user can inherit roles from groups. Defaults to false.

string
providerType
Optional

Provider type of the user. It must be one of: LOCAL, LDAP, SAML, OAUTH.

boolean
locked
Optional

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.

boolean
stranded
Optional

True if the user account has been stranded, meaning it is unable to be accessed due to its original identity source being removed.

string
phone
Optional

Phone number of the user.

string
domain
Optional

IDP domain the user is in

EntityReference
managerEntityRef
Optional

Entity reference used to describe VCD entities

Parameter To
Returned By