SCIM-Demo API Documentation
Fetch All User Resource
GET {{url}}/Users
Fetches information on all Qodex team members. You can fetch information for a particular user with filters. Note: By default, this endpoint will return a list of hundred users. To overwrite the default setting, update the 'startIndex=1&count=100' value in the request.
Body
PARAM
| Key | Datatype | Required | Description |
startIndex
|
number | ||
count
|
number | ||
filter
|
string |
HEADERS
| Key | Datatype | Required | Description |
Authorization
|
string |
RESPONSES
status OK
| {
"schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
"totalResults": 1000,
"startIndex": 1,
"itemsPerPage": 1,
"Resources": [{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"id": "405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99",
"userName": "{{userEmail}}",
"name": {
"givenName": "Test",
"familyName": "User"
},
"externalId": "23123123",
"active": true,
"meta": {
"resourceType": "User",
"created": "2021-02-22T04:24:13.000Z",
"lastModified": "2021-02-22T04:24:13.000Z"
}
}]
} |
Curl
curl -X GET 'url/Users?startIndex=1&count=100&filter=userName eq userEmail' -H 'Authorization: apiKey'
ENDPOINTS