1.2

1.2

post /v1/groups

Description

create a group

State ACTIVE (CURRENT)

VersionSupported Until
1.2-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

GroupCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedGroupShowResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = iam-identity-center 1.2"

Request body

{
    "description": "Group for administrators",
    "instance_id": "ssoins-12345",
    "name": "Admin_Group",
    "user_uuids": [
        "138c2fc8c29a449dbfa8681f8f1d78e2"
    ]
}

Example HTTP response

Response 201

{
    "group": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "creator_name": "John Doe",
        "description": "Group for administrators",
        "id": "138c2fc8c29a449dbfa8681f8f1d78e2",
        "instance_id": "ssoins-12345",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "modifier_name": "Smith",
        "name": "Admin_Group",
        "user_count": 1,
        "users": [
            {
                "id": "6fdd2a6d-6f4f-4157-8259-5d55e7dd1269",
                "name": "John Doe",
                "user_id": "johndoe"
            }
        ]
    }
}