Get Groups By Display Name V2 Using GET

This API is used to get groups by display name.

Request

URI

GET

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

COPY

Path Parameters

string

displayName

Required

displayName

Authentication

This operation uses the following authentication methods.

Authorization

Responses

200

Returns Array of 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"
    }
]

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