VMware Cloud Director API - User

UserType

Element:

User

Type:

UserType

Namespace:

http://www.vmware.com/vcloud/v1.5

Description:

Represents a local or imported user.

Since:

0.9

Schema:

user.xsd

Media type(s):

application/vnd.vmware.admin.user+xml
application/vnd.vmware.admin.user+json

Extends:

EntityType

XML Representation:

<User xmlns="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
        name="xs:string">
    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string" model="xs:string"/>
    <Description> xs:string </Description>
    <Tasks>
        <Task href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
                name="xs:string" status="xs:string" operation="xs:string" operationName="xs:string"
                serviceNamespace="xs:string" startTime="xs:dateTime" endTime="xs:dateTime" expiryTime="xs:dateTime"
                cancelRequested="xs:boolean">
            <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string" model="xs:string"/>
            <Description> xs:string </Description>
            <Tasks> TasksInProgressType </Tasks>
            <Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
                    vendorSpecificErrorCode="xs:string">
                <TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"/>
            </Error>
            <User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Progress> xs:int </Progress>
            <Params> ... </Params>
            <Details> xs:string </Details>
            <VcTaskList>
                <VcTask name="xs:string" moref="xs:string" status="xs:string" description="xs:string"
                        errorMessage="xs:string" objectName="xs:string" objectType="xs:string" objectMoref="xs:string"
                        virtualCenterID="xs:string" startTime="xs:dateTime" endTime="xs:dateTime"/>
            </VcTaskList>
            <Result>
                <ResultContent> ... </ResultContent>
                <ResultReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            </Result>
        </Task>
    </Tasks>
    <FullName> xs:string </FullName>
    <EmailAddress> xs:string </EmailAddress>
    <Telephone> xs:string </Telephone>
    <IsEnabled> xs:boolean </IsEnabled>
    <IsLocked> xs:boolean </IsLocked>
    <IM> xs:string </IM>
    <NameInSource> xs:string </NameInSource>
    <IsExternal> xs:boolean </IsExternal>
    <ProviderType> xs:string </ProviderType>
    <IsGroupRole> xs:boolean </IsGroupRole>
    <StoredVmQuota> xs:int </StoredVmQuota>
    <DeployedVmQuota> xs:int </DeployedVmQuota>
    <Role href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <Password> xs:string </Password>
    <GroupReferences>
        <GroupReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </GroupReferences>
</User>

Attributes

Attribute	Type	Required	Modifiable	Since	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
DeployedVmQuota	int	No	always	1.0	35.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.
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 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	35.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	38.0
read	GET /admin/user/{id}	Retrieve a user.	0.9	38.0
update	PUT /admin/user/{id}	Update a user.	0.9	38.0
delete	DELETE /admin/user/{id}	Delete a user.	0.9	38.0
action	POST /admin/user/{id}/action/takeOwnership	Transfer ownership of this user's vApps, media, and catalogs to the caller.	5.6	38.0
action	POST /admin/user/{id}/action/unlock	Unlock a user.	1.5	5.1
action	POST /admin/user/{id}/entityRights	Queries user privileges on a set of entities	5.1