[{"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

Create User

Description

Create a new user.

Request

URL

post

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

Copy

Request Body

VcdUser of type(s) application/json Required

Show optional properties

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

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

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.

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

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.

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Response

Response Body

201 Created

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

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

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.

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

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.

No error details were provided in the OpenAPI specification.

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"deployedVmQuota":0,"description":"string","email":"string","enabled":false,"fullName":"string","id":"string","isGroupRole":false,"nameInSource":"string","orgEntityRef":{"id":"string","name":"string"},"password":"string","providerType":"string","roleEntityRefs":[{"id":"string","name":"string"}],"storedVmQuota":0,"username":"string"}' https://{api_host}/cloudapi/1.0.0/users

vmware-cloud-director

Availability

Added in 35.0

User Operations

post

Change Password Introduced

post

Create User

delete

Delete User

get

Get User

get

Query User Groups

get

Query Users

put

Update User

Create User

Request

URL

Request Body

Authentication

ApiKeyAuth

Response

Response Body

201 Created

No error details were provided in the OpenAPI specification.

Code Samples

cURL Command

Availability

On This Page

User Operations

Was this page helpful?