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

Get User Groups

Description

Retrieve the list of existing user-groups. Only admin users can retrieve this information. This action is currently restricted to user-groups mapped through VMware Identity Manager.

Request

Request

URL

URL


get
https://vrni.example.com/api/ni/settings/user-groups
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-group


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns PagedUserGroupListResponse of type(s) application/json
{
	"cursor": "MTA=",
	"results": [
		{
			"domain": "vidmlabs.com",
			"group_name": "vrniAdmins",
			"group_type": "VIDM",
			"id": "testgroup@vidmlabs.com",
			"role": "ADMIN"
		}
	],
	"total_count": 1000
}
string
cursor Optional

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/user-groups?type=string


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

Was this page helpful?