Create Group V2 Using POST

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

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"
}
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Operation doesn't return any data structure

201

Created

Returns GroupDTO of type(s) application/json 
"GroupDTO Object"
string
displayName
Optional

Display Name

string
domain
Optional

Domain

object
groupMetadata
Optional

groupMetadata

string
groupType
Optional

Group Type

boolean
isDisabled
Optional

isDisabled

string
providerIdentifier
Optional

Provider ID

array of object
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 
"GenericErrorResponseDTO Object"
string
errorCode
Optional

errorCode

string
errorLabel
Optional

errorLabel

string
message
Optional

message

array of string
recommendations
Optional

recommendations


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/lcm/authzn/api/v2/groups
On This Page
Authentication Group Controller Operations
POST
Create Group V2 Using POST
GET
Get Groups By Display Name V2 Using GET
GET
Get Group By Display Name And Domain V2 Using GET
GET
Get Group By Provider Identifier V2 Using GET
PUT
Update Group By Id V2 Using PUT
DELETE
Delete Group By Id V2 Using DELETE
PATCH
Update Group By Id V2 Using PATCH