Get User

Get User

Get a specified user by id.

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/users/{userUrn}
COPY
Path Parameters
string
userUrn
Required

userUrn

string
userUrn
Required

userUrn

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns VcdUser of type(s) application/json;version=37.1 
{
    "username": "string",
    "fullName": "string",
    "description": "string",
    "id": "string",
    "roleEntityRefs": [
        {
            "name": "string",
            "id": "string"
        }
    ],
    "orgEntityRef": {
        "name": "string",
        "id": "string"
    },
    "password": "string",
    "deployedVmQuota": 0,
    "storedVmQuota": 0,
    "email": "string",
    "nameInSource": "string",
    "enabled": false,
    "isGroupRole": false,
    "providerType": "string"
}
string
username
Required

User name of the user.

string
fullName
Optional

Full name (display name) of the user.

string
description
Optional

Description of the user.

string
id
Optional

Unique id for 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)

EntityReference
orgEntityRef
Optional

orgEntityRef

string
password
Optional

Password for the user. Must be null for external users.

integer As int32 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.

integer As int32 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.

string As email As email
email
Optional

A user's email address. Based on org email preferences, notifications can be sent to the user via email.

string
nameInSource
Optional

Name of the user in its source.

boolean
enabled
Optional

Enabled state of the user. Defaults to true.

boolean
isGroupRole
Optional

Determines if this user's role is inherited from a group. Defaults to false.

string
providerType
Optional

Provider type of the user. It must be one of: LOCAL, LDAP, SAML, OAUTH.


Availability
Added in 35.0
On This Page
User Operations
POST
Change Password
POST
Create User
DELETE
Delete User
GET
Get User
GET
Query User Groups
GET
Query Users
POST
Take Ownership
PUT
Update User