[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"version":"v37.0"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]

vmware-cloud-director

Introduced2 Changed1

VcdUser

User Spec object.

Properties

string

username Required

User name of the user.

array of EntityReference

roleEntityRefs Changed Required

The role(s) of the user. If isGroupRole is true, this user inherits their role(s) from group membership(s)

string

nameInSource Optional

Name of the user in its source.

boolean

enabled Optional

Enabled state of the user. Defaults to true.

string

fullName Optional

Full name (display name) of the user.

string

id Optional

Unique id for the user.

boolean

isGroupRole Optional

Determines if this user’s role is inherited from a group. Defaults to false.

boolean

locked Introduced 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.

Added in 37.2

string as email

email Optional

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

EntityReference

orgEntityRef Optional

Organization that the user belongs to.

string

password Optional

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

string

providerType Optional

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

string

description Optional

Description of the user.

integer 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.

Added in 35.0 | Deprecated in 35.0 | Removed in 37.0

boolean

stranded Introduced Optional

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

Added in 37.2

integer 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.

Added in 35.0 | Deprecated in 35.0 | Removed in 37.0

JSON Example

Show optional properties

{
	"roleEntityRefs": [
		{}
	],
	"username": "string"
}

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

Vendor Extensions

This class contains the following vendor extensions defined in the spec:

x-vcloud-property-annotations:
    orgEntityRef:
        x-vcloud-constraints:
            - args:
                - arg: org
              constraint: Urn
            - constraint: ReadOnly

vmware-cloud-director

Availability

Added in 35.0

Property Of

InlineVcdUsers1

Parameter To

Create User
Update User

Returned By

Create User
Get User
Update User

What's changed in latest?

Added Properties
stranded
locked

CHANGED (1)

Changed Properties
roleEntityRefs

VcdUser

Properties

JSON Example

Vendor Extensions

Availability

Property Of

Parameter To

Returned By

What's changed in latest?

Was this page helpful?