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

Get Groups By Display Name V2

Description

This API is used to get groups by display name.

Request

Request

URL

URL


get
https://localhost:8080/lcm/authzn/api/v2/groups/name/{displayName}
Copy

Path Parameters

Path Parameters

string
displayName Required

displayName


Authentication

Authentication

This operation uses the following authentication methods.

Authorization

Scopes: global

Response

Response

Response Body

Response Body

200 OK

Returns array of 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

Errors

Errors

401

Unauthorized


403

Forbidden


GenericErrorResponseDTO
404

Not Found


GenericErrorResponseDTO
500

Internal Server Error

Code Samples

Code Samples

cURL Command

curl https://localhost:8080/lcm/authzn/api/v2/groups/name/{displayName}


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

Was this page helpful?