GET
/
api
/
scim
/
v2
/
Users

Parameters

startIndex
integer

The 1-based index of the first query result. A value less than 1 SHALL be interpreted as 1. By default this value is 1

count
integer

Non-negative integer. Specifies the desired maximum number of query results per page, e.g., 10. When specified, the service provider MUST NOT return more results than specified, although it MAY return fewer results. If unspecified, the maximum will be 100

Response

schemas
array
required

The SCIM RFC schema for the User List resource - always urn:ietf:params:scim:api:messages:2.0:ListResponse

itemsPerPage
integer
required

Non-negative integer. Specifies the number of query results returned in a query response page, e.g., 10.

startIndex
integer
required

Non-negative integer. Specifies the total number of results matching the client query, e.g., 1000.

totalResults
integer
required

The 1-based index of the first result in the current set of query results, e.g., 1.

Resources
array
required
id
string
required

The user’s identifier

userName
string
required

The user’s email address

active
boolean
required

Whether or not the user is active or not in the Sendoso platform.

name
object
required
givenName
string
required

The user’s first name

familyName
string
required

The user’s last name

emails
array
required

The user’s personal balance

emails
array
required
value
string
required

The user’s email address

userType
string
required

The user’s role. Values can be sender, manager, admin.

division
string
required

The user’s team.