[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api

Get Users

Description

List the existing users. Only admin users can retrieve this information. This action is currently restricted to users mapped through VMware Identity Manager

Request

Request

URL

URL


get
https://vrni.example.com/api/ni/settings/users
Copy

Query Parameters

Query Parameters

string
cursor Optional

Cursor from previous response


number
size Optional

Page size of results


string
type Required

Type of user


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns PagedUserListResponse of type(s) application/json
{
	"cursor": "MTA=",
	"results": [
		{
			"display_name": "alley martin",
			"domain": "vidmlabs.com",
			"id": "alleymartin123@vidmlabs.com",
			"role": "ADMIN",
			"user_type": "VIDM",
			"username": "alleyMartin123"
		}
	],
	"total_count": 101
}
string
cursor Optional

array of UserResponse
results Optional

integer
total_count Optional
Errors

Errors

400

Bad Request


401

Unauthorized


403

Forbidden


404

Not Found


500

Internal Error

Code Samples

Code Samples

cURL Command

curl https://vrni.example.com/api/ni/settings/users?type=string


[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api
Settings Operations
Feedback

Was this page helpful?