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

Get Users

Description

Get users from IAM with an optional filter by IAM user principal name

Request

Request

URL

URL


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

Query Parameters

Query Parameters

string
domain Optional

domain


string
first_name Optional

first_name


string
last_name Optional

last_name


string
next_link Optional

next_link


string
org_id Optional

org_id


integer
top Optional

top


array of string
user_ids Optional

user_ids

Parameter Serialization Style: form Explode:true

string
user_name Optional

user_name


Authentication

Authentication

This operation uses the following authentication methods.

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?