Get All Users
get
/rest/v16/scim/users
This endpoint returns a list of all users.
Request
Query Parameters
-
count: integer
Specifies number of records to be retrieved. If no count is selected default is 50
-
filter: string
Specifies to search on particular record(s).
-
sortBy: string
Specifies to sort the record according to the field(s) mentioned.
-
sortOrder: string
Specifies to sort the records in ascending or descending order. Acceptable value is ascending or descending, it is case insensitive. if Sortby specified and sortorder not specified then default is ascending. The sortOrder cannot be specified without sortBy
-
startIndex: integer
Specifies the starting point from which records to be retrieved. Starts from 1
Response
Supported Media Types
- application/json
Default Response
The response for getting all users.
Root Schema : scim-user-collection
Type:
Show Source
object-
itemsPerPage:
integer
Specifies the size of returned results in a response page.
-
Resources:
array List of users
Title:
List of usersList of users -
schemas:
array Schemas
Title:
SchemasSchemas used in the response. -
startIndex:
integer
The starting position of the response rows.
-
totalResults:
integer
Specifies the size of returned results by the list or query operation.
Nested Schema : user-response
Type:
Show Source
object-
active:
boolean
Title:
User statusStatus of the User -
emails:
array Email
Title:
EmailEmail of the User -
enterpriseUser:
object enterpriseUser
-
extensionUser:
object extensionUser
-
id:
string
Title:
Unique resource Id of the UserUnique resource Id of the User -
meta:
object metaData
-
name:
object Name
Title:
NameFull name of the user -
phoneNumbers:
array Phone Numbers
Title:
Phone NumbersPhone numbers of the User -
preferredLanguage:
string
Title:
Preferred LanguagePreferred language of the User -
schemas:
array Schemas
Title:
SchemasSchemas used in the response -
timezone:
string
Title:
timezoneTime zone of the user -
title:
string
Title:
Job title of the UserJob title of the User -
userName:
string
Title:
UsernameLogin Name of the user
Nested Schema : enterpriseUser
Type:
Show Source
object-
organization:
string
Title:
Organizationcompany name of the user
Nested Schema : extensionUser
Type:
Show Source
object-
addresses:
array addresses
-
approvalDelegate:
string
Title:
Approval DelegateApproval Delegate -
currency:
string
Title:
Currency CodePreferred Currency Code of the user -
dateFormat:
integer
Title:
Date Format IdDate Format Id -
enabledForSso:
string
Title:
Enabled For SSOEnabled For SSO -
externalSsoId:
string
Title:
externalSsoIdExternal SSO Id -
fax:
string
Title:
Fax NumberFax of the user -
isAccessAdminPermEnabled:
boolean
Title:
Access Admin Permission EnabledAccess Admin Permission Enabled -
isNotifyEmail:
boolean
Title:
Is Notification Preference EmailIs Notification Preference Email -
isNotifyFax:
boolean
Title:
Is Notification Preference FaxIs Notification preference Fax -
isProxyPermEnabled:
boolean
Title:
Proxy permission enabledProxy permission enabled -
isSuperUserPermEnabled:
boolean
Title:
Is Superuser Permission EnabledIs Superuser Permission Enabled -
isWebServicesOnly:
boolean
Title:
Web Services OnlyWeb Services Only -
numberFormat:
integer
Title:
Number Format IdNumber Format Id -
partnerLogin:
string
Title:
Partner LoginPartner Login of the user -
SeparateShipAddr:
boolean
Title:
Separate ship addressSeparate ship address -
sfdcOrgId:
string
Title:
Sfdc Organization IDSfdc Organization ID -
units:
integer
Title:
UnitsUnits -
userType:
string
Title:
Type of the userType of the user
Nested Schema : metaData
Type:
Show Source
object-
created:
string
Title:
Created dateCreated date of the user -
lastModified:
string
Title:
LastModifiedLastModified date of the user -
location:
string
Title:
locationLocation of the resource -
resourceType:
string
Title:
ResourceTypeType of the resource -
version:
string
Title:
versionVersion of the resource
Nested Schema : Name
Type:
objectTitle:
NameFull name of the user
Show Source
-
familyName:
string
Title:
FamilyNameLast Name of the user -
givenName(required):
string
Title:
GivenNameFirst name of the user
Nested Schema : Phone Numbers
Type:
arrayTitle:
Phone NumbersPhone numbers of the User
Show Source
Nested Schema : email
Type:
Show Source
object-
primary:
boolean
Title:
primaryWhether email is primary or not -
type:
string
Title:
typeType of the email -
value(required):
string
Title:
valuevalue of the email
Nested Schema : address
Type:
Show Source
object-
address1:
string
Title:
Shipping/Billing Address 1Shipping/Billing Address 1 -
address2:
string
Title:
Shipping/Billing Address 2Shipping/Billing Address 2 -
companyName:
string
Title:
Shipping/Billing CompanyShipping/Billing Company -
companyName2:
string
Title:
Shipping/Billing Company2Shipping/Billing Company2 -
country:
string
Title:
Shipping/Billing CountryShipping/Billing Country -
email:
string
Title:
Shipping/Billing EmailShipping/Billing Email -
fax:
string
Title:
Shipping/Billing FaxShipping/Billing Fax -
locality:
string
Title:
Shipping/Billing LocalityShipping/Billing Locality -
name:
object Shipping/Billing Full name
Title:
Shipping/Billing Full nameShipping/Billing Full name -
phone:
string
Title:
Shipping/Billing PhoneShipping/Billing Phone -
postalCode:
string
Title:
Shipping/Billing Postal CodeShipping/Billing Postal Code -
region:
string
Title:
Shipping/Billing RegionShipping/Billing Region -
type:
string
Title:
Address TypeAllowed Values:[ "BILL_TO", "SHIP_TO" ]Address Type
Nested Schema : Shipping/Billing Full name
Type:
objectTitle:
Shipping/Billing Full nameShipping/Billing Full name
Show Source
-
familyName:
string
Title:
Shipping/Billing FamilyNameShipping/Billing FamilyName -
givenName:
string
Title:
Shipping/Billing GivenNameShipping/Billing GivenName
Nested Schema : phoneNumber
Type:
Show Source
object-
primary:
boolean
Title:
primaryWhether phone number is primary or not -
type:
string
Title:
typeType of the phone number -
value:
string
Title:
valuevalue of the phone number