Update User

Modify basic details of the specified user.

Request

URI

PUT

https://{api_host}/cloudapi/1.0.0/users/{userUrn}

COPY

Path Parameters

string

userUrn

Required

userUrn

string

userUrn

Required

userUrn

Request Body

VcdUser of type(s) application/json

Optional

{
    "username": "string",
    "fullName": "string",
    "description": "string",
    "id": "string",
    "roleEntityRefs": [
        {
            "name": "string",
            "id": "string"
        }
    ],
    "orgEntityRef": {
        "name": "string",
        "id": "string"
    },
    "password": "string",
    "deployedVmQuota": 0,
    "storedVmQuota": 0,
    "email": "string",
    "nameInSource": "string",
    "enabled": false,
    "isGroupRole": false,
    "providerType": "string",
    "locked": false,
    "stranded": false,
    "phone": "string"
}

string

username

Required

User name of the user.

string

fullName

Optional

Full name (display name) of the user.

string

description

Optional

Description of the user.

string

Optional

Unique id for the user.

array of EntityReference

roleEntityRefs

Optional

The role(s) of the user. If "isGroupRole" is true, then this field is a read-only representation of the roles inherited from the user's groups.

EntityReference

orgEntityRef

Optional

orgEntityRef

string

password

Optional

Password for the user. Must be null for external users.

integer As int32 As int32

deployedVmQuota

Optional

The deployed VM quota for this user. Defaults to 0 which means unlimited. This property is deprecated in 35.0. Use user quotas API.

integer As int32 As int32

storedVmQuota

Optional

The stored VM quota for this user. Defaults to 0 which means unlimited. This property is deprecated in 35.0. Use user quotas API.

string As email As 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

isGroupRole

Optional

Determines if this user's role is inherited from a group. 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.

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Returns VcdUser of type(s) application/json;version=38.1

{
    "username": "string",
    "fullName": "string",
    "description": "string",
    "id": "string",
    "roleEntityRefs": [
        {
            "name": "string",
            "id": "string"
        }
    ],
    "orgEntityRef": {
        "name": "string",
        "id": "string"
    },
    "password": "string",
    "deployedVmQuota": 0,
    "storedVmQuota": 0,
    "email": "string",
    "nameInSource": "string",
    "enabled": false,
    "isGroupRole": false,
    "providerType": "string",
    "locked": false,
    "stranded": false,
    "phone": "string"
}

string

username

Required

User name of the user.

string

fullName

Optional

Full name (display name) of the user.

string

description

Optional

Description of the user.