Listing Users

Function

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

URI

GET /{tenant_id}/scim/v2/Users

**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	String	Number of elements on each page
startIndex	String	Start index
schemas	Array of strings	Summary
Resources	Array of objects	User information

**Table 4** Resources
Parameter	Type	Description
id	String	Globally unique ID of a user
externalId	String	External ID
meta	Object	Metadata
schemas	Array of strings	Summary
userName	String	Username, which uniquely identifies a user
name	Object	Name of a user
displayName	String	Display name of a user
active	Boolean	Whether a user is enabled
emails	Array of objects	Email addresses of a user
userType	String	User type
nickName	String	Nickname of a user Minimum length: 1 Maximum length: 1024
title	String	User title Minimum length: 1 Maximum length: 1024
preferredLanguage	String	User's preferred language Minimum length: 1 Maximum length: 1024
locale	String	Geographical area or location of a user Minimum length: 1 Maximum length: 1024
timezone	String	User time zone Minimum length: 1 Maximum length: 1024
addresses	Array of objects	Address list of a user Array length: 1-1
phoneNumbers	Array of objects	Phone number list of a user Array length: 1-1
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User	Object	Object that contains the user's work-related information

**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.name
Parameter	Type	Description
formatted	String	Formatted name to be displayed
familyName	String	Family name of a user
givenName	String	Given name of a user
middleName	String	Middle name of a user
honorificPrefix	String	Prefix of a user name
honorificSuffix	String	Suffix of a user name

**Table 7** Resources.emails
Parameter	Type	Description
value	String	Email address
type	String	Email address type
primary	Boolean	Whether the value is the user's primary email address

**Table 8** users.addresses
Parameter	Type	Description
formatted	String	Formatted address to be displayed Minimum length: 1 Maximum length: 1024
streetAddress	String	Street Minimum length: 1 Maximum length: 1024
locality	String	Locality Minimum length: 1 Maximum length: 1024
region	String	Region Minimum length: 1 Maximum length: 1024
postalCode	String	Postal code Minimum length: 1 Maximum length: 1024
country	String	Country or region Minimum length: 1 Maximum length: 1024
type	String	Address type Minimum length: 1 Maximum length: 1024
primary	Boolean	Whether the address is the user's primary address

**Table 9** users.phoneNumbers
Parameter	Type	Description
value	String	Phone number Minimum length: 1 Maximum length: 1024
type	String	Phone number type Minimum length: 1 Maximum length: 1024
primary	Boolean	Whether the value is the user's primary phone number

**Table 10** urn:ietf:params:scim:schemas:extension:enterprise:2.0:User
Parameter	Type	Description
costCenter	String	Cost center Minimum length: 1 Maximum length: 1024
department	String	Department Minimum length: 1 Maximum length: 1024
division	String	Division Minimum length: 1 Maximum length: 1024
employeeNumber	String	Employee ID Minimum length: 1 Maximum length: 1024
manager	Object	Manager
organization	String	Organization Minimum length: 1 Maximum length: 1024

**Table 11** manager
Parameter	Type	Description
value	String	Manager Minimum length: 1 Maximum length: 1024

Status code: 400

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

Status code: 403

**Table 13** 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 14** 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 15** 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 16** 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 users

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

Example Response

Status code: 200

Successful

{
  "totalResults" : 1,
  "itemsPerPage" : 10,
  "startIndex" : "649040aaaaaaaaaaaa3e3050",
  "schemas" : [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ],
  "Resources" : [ {
    "id" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9",
    "externalId" : "123456",
    "meta" : {
      "resourceType" : "User",
      "created" : "2023-04-08T14:53:43Z",
      "lastModified" : "2023-04-08T14:53:43Z"
    },
    "schemas" : [ "urn:ietf:params:scim:schemas:core:2.0:User" ],
    "userName" : "xxx",
    "name" : {
      "formatted" : "xxx",
      "familyName" : "xxx",
      "givenName" : "xxx",
      "middleName" : "xxx",
      "honorificPrefix" : "xxx",
      "honorificSuffix" : "xxx"
    },
    "displayName" : "xxx",
    "active" : true,
    "emails" : [ {
      "value" : "xxx",
      "type" : "work",
      "primary" : true
    } ],
    "userType" : "xxx"
  } ]
}