Me

Object that identifies the user functions

Overview

avatarData string filterable   orderable  
avatarType enum (BASE64 | COMPUTEDURL | URL) filterable   orderable  
disabled boolean filterable   orderable  
elasticSearchAddress string filterable   orderable  
email string required   filterable   orderable  
enterpriseID string filterable   orderable  
enterpriseName string filterable   orderable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated   filterable   orderable  
externalID string filterable   orderable   locally unique  
firstName string required   filterable   orderable  
flowCollectionEnabled boolean orderable  
lastName string required   filterable   orderable  
lastUpdatedBy string autogenerated  
mobileNumber string filterable   orderable  
password string required   filterable   orderable  
role string filterable   orderable  
statisticsEnabled boolean
userName string required   filterable   orderable  

API Resource

/me/id

Parents

This object has no parents.

Children

/l2domains
get
/eamconfigs
get
/ratelimiters
get post
/gateways
get post
/gatewaytemplates
get post
/patmappers
get post
/patnatpools
get post
/tcas
get
/vcenters
get post
/vcenterhypervisors
get
/redirectiontargets
get
/redundancygroups
get post
/performancemonitors
get post
/certificates
post
/me/id/metadatas
get post
/metadatatags
get post
/networklayout
get
/keyservermembers
get post
/zfbautoassignments
get post
/zfbrequests
get post
/bgpneighbors
get
/bgpprofiles
get
/egressaclentrytemplates
get
/egressacltemplates
get
/egressdomainfloatingipacltemplates
get post
/egressfloatingipacltemplates
get post
/egressqospolicies
get post
/sharednetworkresources
get post
/licenses
get post
/licensestatus
get
/mirrordestinations
get post
/sites
get post
/floatingips
get
/globalmetadatas
get post
/vms
get post
/vminterfaces
get
/cms
get post
/underlays
get post
/infrastructureaccessprofiles
delete get post
/infrastructuregatewayprofiles
get post
/infrastructurevscprofiles
get post
/ingressaclentrytemplates
get
/ingressacltemplates
get
/ingressadvfwdentrytemplates
get
/ingressqospolicies
get post
/enterprises
get post
/enterpriseprofiles
get post
/jobs
get post
/policygroups
get
/domains
get
/zones
get
/containers
get post
/containerinterfaces
get
/hostinterfaces
get
/routingpolicies
get
/uplinkroutedistinguishers
get
/applicationservices
get post
/vrsconfigs
get
/users
get post
/nsgateways
get
/nsgatewaytemplates
get post
/nsggroups
get post
/nsgredundancygroups
get
/vsps
get
/staticroutes
get
/statisticscollector
get
/subnets
get
/ducgroups
get post
/multicastchannelmaps
get post
/autodiscoveredgateways
get
/externalappservices
get post
/externalservices
get post
/systemconfigs
get

Members

This object has no members.

Attributes documentation

avatarData string filterable   orderable  
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 filterable   orderable  
Discussion

Avatar type.

Charateristics

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

disabled boolean filterable   orderable  
Discussion

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

Charateristics

Format: free
SDK attribute: disabled

elasticSearchAddress string filterable   orderable  
Discussion

elastic search address

Charateristics

Format: free
SDK attribute: elasticSearchAddress

email string required   filterable   orderable  
Discussion

Email address of the user

Charateristics

Format: free
SDK attribute: email

enterpriseID string filterable   orderable  
Discussion

Identifier of the enterprise.

Charateristics

Format: free
SDK attribute: enterpriseID

enterpriseName string filterable   orderable  
Discussion

Name of the enterprise.

Charateristics

Format: free
SDK attribute: enterpriseName

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
SDK attribute: firstName

flowCollectionEnabled boolean orderable  
Discussion

Enables flow statistics collection. It is needed for the VSS feature, and requires a valid VSS license. This option requires "statisticsEnabled".

Charateristics

Format: free
SDK attribute: flowCollectionEnabled

lastName string required   filterable   orderable  
Discussion

Last name of the user

Charateristics

Format: free
SDK attribute: lastName

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

mobileNumber string filterable   orderable  
Discussion

Mobile Number of the user

Charateristics

Format: free
SDK attribute: mobileNumber

password string required   filterable   orderable  
Discussion

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

Charateristics

Format: free
SDK attribute: password

role string filterable   orderable  
Discussion

Role of the user.

Charateristics

Format: free
SDK attribute: role

statisticsEnabled boolean
Discussion

This flag is used to indicate if statistics is enabled in the system. CSProot is expected to activate this through the enable statistics script.

Charateristics

Format: free
SDK attribute: statisticsEnabled

userName string required   filterable   orderable  
Discussion

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

Charateristics

Format: free
SDK attribute: userName