[{"label":"Latest (1.3.0)","version":"latest"}]
vrealize-suite-lifecycle-manager

Get Users By Principal Name V2

Description

This API is used to get a user by principal name.

Request

Request

URL

URL


get
https://localhost:8080/lcm/authzn/api/v2/users/upn/{upn}
Copy

Path Parameters

Path Parameters

string
upn Required

upn


Authentication

Authentication

This operation uses the following authentication methods.

Authorization

Scopes: global

Response

Response

Response Body

Response Body

200 OK

Returns UserDTO of type(s) application/json
{
    "displayName": "lcm user1",
    "domain": "example.com",
    "providerIdentifier": "3d6701ea-0c5b-43e7-871c-468947e86616",
    "userType": "VIDM_AD_USER",
    "username": "lcmuser1",
    "vmid": "3eef09c1-ae69-4f20-ba97-07f607227b13"
}
string
displayName Optional

Display Name


string
domain Optional

Domain


boolean
isDisabled Optional

string
password Optional

string
providerIdentifier Optional

Provider ID


array of RoleDTO
roleMappings Optional

userMetadata Optional

string
userPrincipalName Optional

User Principal Name


string
userType Optional

User Type


string
username Optional

Username


string
vmid Optional

User ID

Errors

Errors

401

Unauthorized


403

Forbidden


GenericErrorResponseDTO
404

Not Found


GenericErrorResponseDTO
500

Internal Server Error

Code Samples

Code Samples

cURL Command

curl https://localhost:8080/lcm/authzn/api/v2/users/upn/{upn}


Feedback

Was this page helpful?