1.0

get /v1/groups/{group_id}

Description

show a specific group

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260223

Parameters

Type	Name	Description	Schema	Default
path	group_id required	Group ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
query	instance_id required	Instance ID Example : `ssoins-12345`	string	None

Responses

HTTP Code	Description	Schema
200	OK	GroupShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/groups/{group_id}?instance_id={instance_id}

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.0"

Example HTTP response

Response 200

{
    "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"
            }
        ]
    }
}