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

Get User Group

Description

Get details of a user-group. Only admin users can perform this action. This action is currently restricted to user-group mapped through VMware Identity Manager.

Request

Request

URL

URL


get
https://vrni.example.com/api/ni/settings/user-groups/{id}
Copy

Path Parameters

Path Parameters

string
id Required

The Entity ID of object requestion information on


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns UserGroupResponse of type(s) application/json
{
    "domain": "vidmlabs.com",
    "group_name": "testgroup",
    "group_type": "VIDM",
    "id": "testgroup@vidmlabs.com",
    "role": "ADMIN"
}
string
domain Optional

Domain name to which user-group belongs to.


string
group_name Optional

Group-name of the user-group.


group_type Optional

The type of user-group.

Possible values are: LDAPLOCALVIDM


string
id Optional

Unique identifier assigned to user-group.


role Optional

Role assigned the user/group.

Possible values are: MEMBERADMINAUDITOR

Errors

Errors

401

Unauthorized


404

Not Found


500

Internal Error

Code Samples

Code Samples

cURL Command

curl https://vrni.example.com/api/ni/settings/user-groups/{id}


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

Was this page helpful?