Listing Groups_SCIM Group Management_API_API Reference

Function

This API is used to list groups. A maximum of 50 results can be returned for each request.

URI

GET /{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.

Response Parameters

Status code: 200

**Table 3** Parameters in the response body
Parameter	Type	Description
totalResults	Integer	Total results.
itemsPerPage	Integer	Number of elements on each page.
startIndex	String	Start index.
schemas	Array of strings	Summary.
Resources	Array of objects	List of group information.

**Table 4** Resources
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 5** Resources.meta
Parameter	Type	Description
resourceType	String	Resource type.
created	String	Resource creation time.
lastModified	String	Last resource update time.

**Table 6** Resources.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 7** 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 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: 404

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

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

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

Example Request

Listing groups

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

Example Response

Status code: 200

Successful

{
  "totalResults" : 1,
  "itemsPerPage" : 10,
  "startIndex" : "649040aaaaaaaaaaaa3e3050",
  "schemas" : [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ],
  "Resources" : [ {
    "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.

Listing Groups