VcdUser

User Spec object.


Properties

string
username Required

Immutable user name of the user.


array of EntityReference
roleEntityRefs 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.


string as email
email Optional

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


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 is immutable and 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.

Deprecated in 35.0

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.

Deprecated in 35.0

JSON Example

{
	"roleEntityRefs": [
		{}
	],
	"username": "string"
}
Availability
Added in 35.0
Property Of

InlineVcdUsers
Parameter To

Create User
Update User
Returned By

Create User
Get User
Update User

Feedback

Was this page helpful?