Get Group By Display Name And Domain V2 Using GET

Get Group By Display Name And Domain V2 Using GET

This API is used to get a group by display name and domain.

Request
URI
GET
https://{api_host}/lcm/authzn/api/v2/groups/name/{displayName}/domain/{domain}
COPY
Path Parameters
string
displayName
Required

displayName

string
domain
Required

domain


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns GroupExDTO 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-2b537b02cac2",
    "roleMappings": [
        {
            "authorities": "string",
            "isInternal": false,
            "roleDescription": "string",
            "roleName": "string",
            "vmid": "string"
        }
    ],
    "vmid": "cf8d99a2-3748-486f-b555-6ac64bc9f84c"
}
string
displayName
Optional

Display Name

string
domain
Optional

Domain

groupMetadata
Optional

groupMetadata

string
groupType
Optional

Group Type

boolean
isDisabled
Optional

isDisabled

string
providerIdentifier
Optional

Provider ID

array of RoleExDTO
roleMappings
Optional

roleMappings

string
vmid
Optional

Group ID


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