Creating a Group_Group Management_API_API Reference

Function

This API is used to create an IAM Identity Center group in the specified identity source. It can be called only from the organization's management account or from a delegated administrator account of a cloud service.

URI

POST /v1/identity-stores/{identity_store_id}/groups

**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

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
description	No	String	Group description. Minimum length: 0 Maximum length: 1024
display_name	Yes	String	Display name of a group. Minimum length: 1 Maximum length: 1024

Response Parameters

Status code: 201

**Table 4** 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 an identity source. Minimum length: 1 Maximum length: 36

Status code: 400

**Table 5** Parameters in the response body
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Request ID.

Status code: 403

**Table 6** 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	Encrypted error message.

Status code: 409

**Table 7** Parameters in the response body
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Request ID.

Example Request

Creating an IAM Identity Center group in the specified identity source

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

{
  "description" : "Example group",
  "display_name" : "Group name g1"
}

Example Response

Status code: 201

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.

Creating a Group