Attributes
Attribute | Type | Required | Modifiable | Since | Deprecated | Description |
---|---|---|---|---|---|---|
href | anyURI | No | always | 0.9 | The URI of the entity. | |
type | string | No | always | 0.9 | The MIME type of the entity. | |
id | string | No | none | 0.9 | The entity identifier, expressed in URN format. The value of this attribute uniquely identifies the entity, persists for the life of the entity, and is never reused. | |
operationKey | string | No | create | 5.1 | Optional unique identifier to support idempotent semantics for create and delete operations. | |
name | string | Yes | always | 0.9 | The name of the entity. |
Elements
Element | Type | Required | Modifiable | Since | Deprecated | Description |
---|---|---|---|---|---|---|
AlertEmail | string | No | always | 0.9 | 6.0 | This field is unused and is deprecated. (True if this user should get alert email.) |
AlertEmailPrefix | string | No | always | 0.9 | 6.0 | This field is unused and is deprecated. (String to prepend to alert message Subject line.) |
DeployedVmQuota | int | No | always | 1.0 | Quota of vApps that this user can deploy concurrently. A value of 0 specifies an unlimited quota. | |
Description | string | No | always | 0.9 | Optional description. | |
EmailAddress | string | No | always | 0.9 | Email address of the user. | |
FullName | string | No | always | 0.9 | Full name of the user. | |
GroupReferences | GroupsListType | No | none | 0.9 | Container for references to groups of which this user is a member. | |
IM | string | No | always | 0.9 | User's instant messaging address. | |
IsAlertEnabled | boolean | No | always | 0.9 | 6.0 | This field is unused and is deprecated. (True if alerts are enabled for the user.) |
IsDefaultCached | boolean | No | always | 0.9 | 6.0 | This field is unused and is deprecated. (True if this user is cached by default.) |
IsEnabled | boolean | No | always | 0.9 | True if the user is enabled and can log in. | |
IsExternal | boolean | No | always | 0.9 | On creation, specifies whether this user should be imported from the organization's LDAP service or created locally. Ignored if ProviderType is SAML or OAUTH. On retrieval, indicates whether the user is local or imported. | |
IsGroupRole | boolean | No | always | 0.9 | True if this user has a group role. | |
IsLocked | boolean | No | always | 0.9 | True if the user account has been locked due to too many invalid login attempts. A locked user account can be re-enabled by updating the user with this flag set to false. Only the system can set the value to true. | |
Link | LinkType | No | none | 0.9 | A reference to an entity or operation associated with this object. | |
NameInSource | string | No | none | 0.9 | User name as retrieved from, and in the encoding used by, the specified identity provider. | |
Password | string | No | always | 0.9 | The user's password. This value is never returned by GET. It is inspected on create and modify. On modify, the absence of this element indicates that the password should not be changed. | |
ProviderType | string | No | always | 5.1 |
Identity provider type for this this user. One of: INTEGRATED (The user is created locally or imported from LDAP.) SAML (The user is imported from a SAML identity provider.) OAUTH (The user is imported from an OAUTH identity provider.) If missing or empty the default value is INTEGRATED. |
|
Role | ReferenceType | No | always | 0.9 | A reference to the user's role. When you are creating a User, the request body must contain exactly one Role element. If the Role element is empty when retrieved,the user inherits a role from the group. | |
StoredVmQuota | int | No | always | 1.0 | Quota of vApps that this user can store. A value of 0 specifies an unlimited quota. | |
Tasks | TasksInProgressType | No | none | 0.9 | A list of queued, running, or recently completed tasks associated with this entity. | |
Telephone | string | No | always | 0.9 | Telephone number of the user. | |
VCloudExtension | VCloudExtensionType | No | always | 0.9 | An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services. |
Operations
CRUD | Operation | Description | Since | Deprecated |
---|---|---|---|---|
create | POST /admin/org/{id}/users | Create or import a user. | 0.9 | |
read | GET /admin/user/{id} | Retrieve a user. | 0.9 | |
update | PUT /admin/user/{id} | Update a user. | 0.9 | |
delete | DELETE /admin/user/{id} | Delete a user. | 0.9 | |
action | POST /admin/user/{id}/action/takeOwnership | Transfer ownership of this user's vApps, media, and catalogs to the caller. | 5.6 | |
action | POST /admin/user/{id}/action/unlock | Unlock a user. | 1.5 | Since Version 5.1 |
action | POST /admin/user/{id}/entityRights | Queries user privileges on a set of entities | 5.1 |