Updated on 2025-08-21 GMT+08:00

Querying Group Details

Function

This API is used to query details about an IAM Identity Center group based on the group ID. It can be called only from the organization's management account or from a delegated administrator account of a cloud service.

URI

GET /v1/identity-stores/{identity_store_id}/groups/{group_id}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

identity_store_id

Yes

String

Globally unique ID of an identity source.

Minimum length: 12

Maximum length: 12

group_id

Yes

String

Globally unique ID of an IAM Identity Center group in the identity source.

Minimum length: 1

Maximum length: 64

Request Parameters

Table 2 Parameters in the request header

Parameter

Mandatory

Type

Description

X-Security-Token

No

String

Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required.

Maximum length: 2048

Response Parameters

Status code: 200

Table 3 Parameters in the response body

Parameter

Type

Description

description

String

Group description.

Minimum length: 1

Maximum length: 1024

display_name

String

Display name of a group.

Minimum length: 1

Maximum length: 1024

external_id

String

Identifier assigned by an external identity source to a resource.

external_ids

Array of objects

List of resource IDs issued by an external identity provider.

Array length: 1-10

group_id

String

Globally unique ID of an IAM Identity Center group in the identity source.

Minimum length: 1

Maximum length: 47

identity_store_id

String

Globally unique ID of an identity source.

Minimum length: 1

Maximum length: 36

created_at

Long

Timestamp when a group is created.

created_by

String

Creator.

updated_at

Long

Timestamp when a group is updated.

updated_by

String

Updater.

Table 4 external_ids

Parameter

Type

Description

id

String

Resource ID issued by an external identity provider.

Minimum length: 1

Maximum length: 256

issuer

String

Issuer of an external ID.

Minimum length: 1

Maximum length: 100

Example Request

Querying details about an IAM Identity Center group based on the group ID

GET https://{hostname}/v1/identity-stores/{identity_store_id}/groups/{group_id}

Example Response

Status code: 200

{
  "description" : "Example group",
  "display_name" : "Group name g1",
  "external_ids" : null,
  "group_id" : "0efaa0db-6aa4-7aaa-6aa5-c222aaaaf31a",
  "identity_store_id" : "d-a00aaaa33f",
  "created_at" : 1677175760379,
  "created_by" : "5146d03d8aaaaaaaaaaaabbae60620a5",
  "updated_at" : 1677175760379,
  "updated_by" : "5146d03d8aaaaaaaaaaaabbae60620a5"
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.