Creating a Group

Function

This API is used to synchronize a group to IAM Identity Center using the SCIM protocol.

URI

POST /{tenant_id}/scim/v2/Groups

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
tenant_id	Yes	String	Globally unique ID of a tenant

Request Parameters

**Table 2** Parameters in the request header
Parameter	Mandatory	Type	Description
Authorization	Yes	String	Bearer token

**Table 3** Parameters in the request body
Parameter	Mandatory	Type	Description
externalId	No	String	External ID
displayName	Yes	String	Display name of a group
members	No	Array of objects	List of member objects in a group
schemas	Yes	Array of strings	Summary

**Table 4** members
Parameter	Mandatory	Type	Description
value	Yes	String	Globally unique ID of a member
$ref	No	String	Reference information of a member
type	No	String	Member type. User: user

Response Parameters

Status code: 201

**Table 5** Parameters in the response body
Parameter	Type	Description
id	String	Globally unique ID of a group
externalId	String	External ID
meta	Object	Metadata
schemas	Array of strings	Summary
displayName	String	Display name of a group
members	Array of objects	Members in a group

**Table 6** meta
Parameter	Type	Description
resourceType	String	Resource type
created	String	Resource creation time
lastModified	String	Last resource update time

**Table 7** members
Parameter	Type	Description
value	String	Globally unique ID of a member
$ref	String	Reference information of a member
type	String	Member type. User: user

Status code: 400

**Table 8** Parameters in the response body
Parameter	Type	Description
schema	String	Summary
schemas	Array of strings	Summary list
detail	String	Exception details
status	Integer	Status code
timeStamp	String	Timestamp

Status code: 403

**Table 9** Parameters in the response body
Parameter	Type	Description
schema	String	Summary
schemas	Array of strings	Summary list
detail	String	Exception details
status	Integer	Status code
timeStamp	String	Timestamp

Status code: 404

**Table 10** Parameters in the response body
Parameter	Type	Description
schema	String	Summary
schemas	Array of strings	Summary list
detail	String	Exception details
status	Integer	Status code
timeStamp	String	Timestamp

Status code: 409

**Table 11** Parameters in the response body
Parameter	Type	Description
schema	String	Summary
schemas	Array of strings	Summary list
detail	String	Exception details
status	Integer	Status code
timeStamp	String	Timestamp

Status code: 500

**Table 12** Parameters in the response body
Parameter	Type	Description
schema	String	Summary
schemas	Array of strings	Summary list
detail	String	Exception details
status	Integer	Status code
timeStamp	String	Timestamp

Example Request

Creating a group

POST https://{hostname}/{tenant_id}/scim/v2/Groups

{
  "displayName" : "SCIM group name g1",
  "members" : [ {
    "value" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9",
    "$ref" : "../Users/ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9",
    "type" : "User"
  } ],
  "schemas" : [ "urn:ietf:params:scim:schemas:core:2.0:Group" ]
}

Example Response

Status code: 201

Successful

{
  "id" : "0efaa0db-6aa4-7aaa-6aa5-c222aaaaf31a",
  "meta" : {
    "resourceType" : "Group",
    "created" : "2023-04-08T14:53:43Z",
    "lastModified" : "2023-04-08T14:53:43Z"
  },
  "schemas" : [ "urn:ietf:params:scim:schemas:core:2.0:Group" ],
  "displayName" : "SCIM group name g1",
  "members" : [ {
    "value" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9",
    "$ref" : "../Users/ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9",
    "type" : "User"
  } ]
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: SCIM Group Management

Previous topic: SCIM Group Management

Next topic: Listing Groups