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

Update VIdm User Group Role

Description

Update role for user-group mapped through VMware Identity Manager. Only admin users can perform this action.

Request

Request

URL

URL


put
https://vrni.example.com/api/ni/settings/user-groups/vidm
Copy

Path Parameters

Path Parameters

string
id Required

The Entity ID of object requestion information on


Request Body

Request Body

VidmUserGroupRequest of type(s) application/json Required

User-group details

{
    "VidmUserGroupRequest": {
        "domain": "vidmlabs.com",
        "group_name": "testgroup",
        "role": "ADMIN"
    },
    "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).


role Optional

Role assigned the user/group.

Possible values are: MEMBERADMINAUDITOR

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns UserGroupResponse of type(s) application/json
{
    "UserGroupResponse": {
        "domain": "vidmlabs.com",
        "group_name": "testgroup",
        "group_type": "VIDM",
        "id": "testgroup@vidmlabs.com",
        "role": "ADMIN"
    },
    "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

ApiError
400

Bad Request


ApiError
401

Unauthorized


ApiError
403

Forbidden


ApiError
404

Not Found


ApiError
409

Already Exists


500

Internal Error

Code Samples

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"VidmUserGroupRequest":{"domain":"vidmlabs.com","group_name":"testgroup","role":"ADMIN"},"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
Settings Operations
Feedback

Was this page helpful?