Help Center/ IAM Identity Center/ API Reference/ API/ Group Management/ Querying a Group ID
Updated on 2024-04-10 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying a Group ID

Function

This API is used to query the group ID in exact match based on either the display name or the external identity source ID. They cannot be both specified.

URI

POST /v1/identity-stores/{identity_store_id}/groups/retrieve-group-id

Table 1 Path parameters

Parameter

Mandatory

Type

Description

identity_store_id

Yes

String

Globally unique ID of the identity source

Minimum length: 12

Maximum length: 12

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
Table 3 Parameters in the request body

Parameter

Mandatory

Type

Description

alternate_identifier

Yes

Object

Alternative identifier
Table 4 alternate_identifier

Parameter

Mandatory

Type

Description

external_id

No

Object

ID issued by an external identity provider

unique_attribute

No

Object

Unique attribute of a specific principal
Table 5 alternate_identifier.external_id

Parameter

Mandatory

Type

Description

id

Yes

String

ID issued by an external identity provider

Minimum length: 1

Maximum length: 256

issuer

Yes

String

Issuer of the external ID

Minimum length: 1

Maximum length: 100
Table 6 alternate_identifier.unique_attribute

Parameter

Mandatory

Type

Description

attribute_path

Yes

String

Attribute path

Minimum length: 1

Maximum length: 255

attribute_value

Yes

String

Attribute value

Minimum length: 1

Maximum length: 255

Response Parameters

Status code: 200

Table 7 Parameters in the response body

Parameter

Type

Description

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 the identity source

Minimum length: 1

Maximum length: 36

Status code: 400

Table 8 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

request_id

String

Request ID

encoded_authorization_message

String

Authentication information

Status code: 403

Table 9 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

request_id

String

Request ID

encoded_authorization_message

String

Authentication information

Example Request

Querying the group ID in exact match based on either the display name or the external identity source ID

POST https://{hostname}/v1/identity-stores/{identity_store_id}/groups/retrieve-group-id

{
  "alternate_identifier" : {
    "external_id" : null,
    "unique_attribute" : {
      "attribute_path" : "display_name",
      "attribute_value": "Group name g1"
    }
  }
}

Example Response

Status code: 200

Successful

{
  "group_id" : "0efaa0db-6aa4-7aaa-6aa5-c222aaaaf31a",
  "identity_store_id" : "d-a00aaaa33f"
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Group Management