Create Group V2 Using POST

This API is used to add a group and assign roles to it. You can fetch different roles by triggering get all external roles.

Request

URI

POST

https://{api_host}/lcm/authzn/api/v2/groups

COPY

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.

Authorization

Responses

200

Operation doesn't return any data structure

201

Created

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

401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

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