[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api
Update VIdm User Group Role
DescriptionUpdate role for user-group mapped through VMware Identity Manager. Only admin users can perform this action.
Request
URLURL
https://vrni.example.com/api/ni/settings/user-groups/vidm
Path Parameters
Path Parameters
string
id
Required
The Entity ID of object requestion information on
Request Body
Request Body
{
"domain": "vidmlabs.com",
"group_name": "testgroup",
"role": "ADMIN"
}
string
domain
Optional
Provide domain name to which user-group belongs to.
string
group_name
Optional
Specify group name (domain should not be part of group name).
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse 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: LDAP , LOCAL , VIDM
string
id
Optional
Unique identifier assigned to user-group.
Errors
ApiError
400
Bad Request
ApiError
401
Unauthorized
ApiError
403
Forbidden
ApiError
404
Not Found
ApiError
409
Already Exists
500
Internal Error
Code Samples
cURL Command
curl -X PUT -H "Content-Type: application/json" -d '{"domain":"vidmlabs.com","group_name":"testgroup","role":"ADMIN"}' https://vrni.example.com/api/ni/settings/user-groups/vidm
[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api
On This Page
Settings Operations
post
post
post
post
post
post
post
delete
delete
delete
delete
delete
delete
delete
delete
delete
delete
post
post
get
get
get
get
get
get
get
get
get
get
get
post
put
