[{"label":"Latest (1.3.0)","version":"latest"}]
vrealize-suite-lifecycle-manager

Update Group By ID V2

Description

This API is used to update group role(s) by vmid.

Request

Request

URL

URL


patch
https://localhost:8080/lcm/authzn/api/v2/groups/{vmid}
Copy

Path Parameters

Path Parameters

string
vmid Required

vmid


Request Body

Request Body

GroupRequestDTO of type(s) application/json Required

groupRequestDTO

{
    "displayName": "ALL USERS",
    "domain": "example.com",
    "groupType": "ALL_USERS",
    "providerIdentifier": "c1c9f52d-afd1-4561-afbf-2b537b02cad2"
}
string
displayName Optional

Display Name


string
domain Optional

Domain


groupMetadata Optional

string
groupType Optional

Group Type


boolean
isDisabled Optional

array of string
mappedRoles Optional

string
providerIdentifier Optional

Provider ID

Authentication

Authentication

This operation uses the following authentication methods.

Authorization

Scopes: global

Response

Response

Response Body

Response Body

200 OK

Returns GroupDTO of type(s) application/json
{
    "displayName": "ALL USERS",
    "domain": "<domain>",
    "groupType": "ALL_USERS",
    "providerIdentifier": "c1c9f52d-afd1-4561-afbf-2b5334-y57ds",
    "vmid": "cf8d99a2-3748-486f-b555-6ac64bc9f84c"
}
string
displayName Optional

Display Name


string
domain Optional

Domain


groupMetadata Optional

string
groupType Optional

Group Type


boolean
isDisabled Optional

string
providerIdentifier Optional

Provider ID


array of RoleDTO
roleMappings Optional

string
vmid Optional

Group ID


204 No Content

No Content

Errors

Errors

400

Bad Request


401

Unauthorized


403

Forbidden


404

Not Found


500

Internal Server Error

Code Samples

Code Samples

cURL Command

curl -X PATCH -H "Content-Type: application/json" -d '{"displayName":"ALL USERS","domain":"example.com","groupType":"ALL_USERS","providerIdentifier":"c1c9f52d-afd1-4561-afbf-2b537b02cad2"}' https://localhost:8080/lcm/authzn/api/v2/groups/{vmid}


[{"label":"Latest (1.3.0)","version":"latest"}]
vrealize-suite-lifecycle-manager
Feedback

Was this page helpful?