User

Object that identifies the user functions.

Overview

avatarData string
avatarType enum (BASE64 | COMPUTEDURL | URL)
disabled boolean
email string required   filterable   orderable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated   filterable   orderable  
externalID string filterable   orderable   locally unique  
firstName string required   filterable   orderable  
lastName string required   filterable   orderable  
lastUpdatedBy string autogenerated  
LDAPUserDN string orderable  
managementMode enum (CMS | DEFAULT)
mobileNumber string filterable   orderable  
password string required  
userName string required   filterable   orderable  

API Resource

/users/id
delete get put

Parents

/enterprises/id/users
get post
/groups/id/users
get put
/users
get post

Children

/users/id/metadatas
get post
/users/id/globalmetadatas
get post put
/users/id/vms
get
/users/id/containers
get
/users/id/groups
get
/users/id/avatars
get post
/users/id/eventlogs
get

Members

This object has no members.

Attributes documentation

avatarData string
Discussion

URL to the avatar data associated with the enterprise. If the avatarType is URL then value of avatarData should an URL of the image. If the avatarType BASE64 then avatarData should be BASE64 encoded value of the image

Charateristics

Format: free
SDK attribute: avatarData

avatarType enum
Discussion

Avatar type.

Charateristics

Allowed values: BASE64, COMPUTEDURL, URL
SDK attribute: avatarType

disabled boolean
Discussion

Status of the user account; true=disabled, false=not disabled; default value = false

Charateristics

Format: free
SDK attribute: disabled

email string required   filterable   orderable  
Discussion

Email address of the user

Charateristics

Format: free
SDK attribute: email

entityScope enum autogenerated   filterable   orderable  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
Format: free
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

firstName string required   filterable   orderable  
Discussion

First name of the user

Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: firstName

lastName string required   filterable   orderable  
Discussion

Last name of the user

Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: lastName

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

LDAPUserDN string orderable  
Discussion

The LDAP distinguished name (DN) for the user.

Charateristics

Format: free
SDK attribute: LDAPUserDN

managementMode enum
Discussion

Management mode of the user object - allows for override of external authorization and syncup

Charateristics

Allowed values: CMS, DEFAULT
Format: free
SDK attribute: managementMode

mobileNumber string filterable   orderable  
Discussion

Mobile Number of the user

Charateristics

Format: free
SDK attribute: mobileNumber

password string required  
Discussion

User password stored as a hash (SHA-1 encrpted)

Charateristics

Format: free
SDK attribute: password

userName string required   filterable   orderable  
Discussion

Unique Username of the user. Valid characters are alphabets, numbers and hyphen( - ).

Charateristics

Format: free
Min length: 1
Max length: 32
SDK attribute: userName