user

user
user

Represents a local user of VMware Cloud Foundation Operations system.

JSON Example
{
    "distinguishedName": "string",
    "emailAddress": "string",
    "enabled": false,
    "externalId": "string",
    "firstName": "string",
    "groupIds": [
        "string"
    ],
    "id": "string",
    "lastLoginTime": 0,
    "lastName": "string",
    "links": [
        {
            "description": "string",
            "href": "string",
            "name": "string",
            "rel": "string"
        }
    ],
    "password": "string",
    "role-permissions": [
        {
            "allowAllObjects": false,
            "links": [
                {
                    "description": "string",
                    "href": "string",
                    "name": "string",
                    "rel": "string"
                }
            ],
            "roleName": "string",
            "scopeId": "string",
            "traversal-spec-instances": [
                {
                    "adapterKind": "string",
                    "includedAdapterKinds": [
                        "string"
                    ],
                    "name": "string",
                    "resourceKind": "string",
                    "resourceSelection": [
                        {
                            "resourceId": [
                                "string"
                            ],
                            "type": "string"
                        }
                    ],
                    "selectAllResources": false
                }
            ]
        }
    ],
    "roleNames": [
        "string"
    ],
    "username": "string"
}
string
distinguishedName
Optional

distinguished name of the current user.

string
emailAddress
Optional

The email address of the current user

boolean
enabled
Optional

Is the current user's account enabled?

string
externalId
Optional

External ID of vIDB user. This field is only used in vIDB user import flow. It will not be populated for any other scenarios. Please note, this field may be removed in future.

string
firstName
Optional

First name of the current user.

array of string
groupIds
Optional

The list of group ids to which the current user belongs to.

string As uuid As uuid
id
Optional

Identifier of the user in the system.

integer As int64 As int64
lastLoginTime
Optional

Last login time

string
lastName
Optional

The last name of the current user.

array of link
links
Optional

links

string
password
Required

Password of the user object. When creating a new local user, this field has to be specified.

array of role-permission
role-permissions
Optional

List of role permissions assigned to this user. May be null. Replaces and takes precedence over roleNames

array of string
roleNames
Optional

(Deprecated) List of role names assigned to the user. May be null.

string As ^[^\s,<&"'?+%=>;/#]+$
username
Required

Username of the current user.

Property Of
Parameter To
Returned By