[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen

Get Users

Description

Get users from IAM with an optional filter by IAM user_name or list of user ids(exclusive)

Request

Request

URL

URL


get
https://cloud.vmwarehorizon.com/auth/v1/admin/users
Copy

Query Parameters

Query Parameters

string
domain Optional

string
first_name Optional

string
last_name Optional

string
next_link Optional

string
org_id Optional

integer
top Optional

array of string
user_ids Optional

string
user_name Optional

Response

Response

Response Body

Response Body

200 OK

Returns UsersResponse of type */*
{
	"nextLink": "string",
	"users": [
		{
			"active": true,
			"avatar": "url",
			"azureAdDomain": "string",
			"department": "Finance",
			"displayName": "John Smith",
			"distinguishedName": "CN=JSMITH,DC=vmware,DC=com",
			"domain": "horizonv2.local",
			"familyName": "Smith",
			"givenName": "John",
			"id": "1223234",
			"ipaddr": "0.0.0.0",
			"onPremisesUserPrincipalName": "john.smith@horizonv2.local",
			"orgIds": [
				"string"
			],
			"tid": "1223234",
			"userDomain": "string",
			"userGroups": [
				"string"
			],
			"userName": "john.smith",
			"userPrincipalName": "john.smith@horizonv2.onmicrosof.com",
			"userSid": "S-1-5-21-2502306595"
		}
	]
}
string
nextLink Optional

Link to the next page of users when pagination is used


array of UserInfo
users Optional

List of users

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl https://cloud.vmwarehorizon.com/auth/v1/admin/users


Feedback

Was this page helpful?