Update Group By Id V2 Using PATCH

Update Group By Id V2 Using PATCH

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

Request
URI
PATCH
https://{api_host}/lcm/authzn/api/v2/groups/{vmid}
COPY
Path Parameters
string
vmid
Required

vmid

Request Body
GroupRequestDTO of type(s) application/json
Optional 
{
    "displayName": "ALL USERS",
    "domain": "example.com",
    "groupMetadata": {
        "additionalMeta": [
            "string"
        ],
        "distinguishedName": "string",
        "externalId": "string"
    },
    "groupType": "ALL_USERS",
    "isDisabled": false,
    "mappedRoles": [
        "string"
    ],
    "providerIdentifier": "c1c9f52d-afd1-4561-afbf-2b537b02cad2"
}
string
displayName
Optional

Display Name

string
domain
Optional

Domain

GroupMetadataDTO
groupMetadata
Optional

groupMetadata

string
groupType
Optional

Group Type

boolean
isDisabled
Optional

isDisabled

array of string
mappedRoles
Optional

mappedRoles

string
providerIdentifier
Optional

Provider ID

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns GroupDTO of type(s) application/json 
{
    "displayName": "ALL USERS",
    "domain": "<domain>",
    "groupMetadata": {
        "additionalMeta": [
            "string"
        ],
        "distinguishedName": "string",
        "externalId": "string"
    },
    "groupType": "ALL_USERS",
    "isDisabled": false,
    "providerIdentifier": "c1c9f52d-afd1-4561-afbf-2b5334-y57ds",
    "roleMappings": [
        {
            "roleDescription": "vRealize Lifecycle Manager Administrator",
            "roleName": "admin",
            "vmid": "782c2945-3b69-4e29-8b32-b3d0d37ff562"
        }
    ],
    "vmid": "cf8d99a2-3748-486f-b555-6ac64bc9f84c"
}
string
displayName
Optional

Display Name

string
domain
Optional

Domain

GroupMetadataDTO
groupMetadata
Optional

groupMetadata

string
groupType
Optional

Group Type

boolean
isDisabled
Optional

isDisabled

string
providerIdentifier
Optional

Provider ID

array of RoleDTO
roleMappings
Optional

roleMappings

string
vmid
Optional

Group ID


204

No Content

Operation doesn't return any data structure

400

Bad Request

Returns GenericErrorResponseDTO of type(s) application/json 
{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}
string
errorCode
Optional

errorCode

string
errorLabel
Optional

errorLabel

string
message
Optional

message

array of string
recommendations
Optional

recommendations


401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

404

Not Found

Returns GenericErrorResponseDTO of type(s) application/json 
{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}
string
errorCode
Optional

errorCode

string
errorLabel
Optional

errorLabel

string
message
Optional

message

array of string
recommendations
Optional

recommendations


500

Internal Server Error

Returns GenericErrorResponseDTO of type(s) application/json 
{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}
string
errorCode
Optional

errorCode

string
errorLabel
Optional

errorLabel

string
message
Optional

message

array of string
recommendations
Optional

recommendations


On This Page
Authentication Group Controller Operations
POST
Create Group V2 Using POST
DELETE
Delete Group By Id V2 Using DELETE
GET
Get Group By Display Name And Domain V2 Using GET
GET
Get Group By Provider Identifier V2 Using GET
GET
Get Groups By Display Name V2 Using GET
PATCH
Update Group By Id V2 Using PATCH
PUT
Update Group By Id V2 Using PUT