Description: This API fetches details of all users.
You can use the API without any filter query parameter to return the list of the first 20 users. You can add the query parameter, startIndex=x&count=y, to fetch y number of users from the xth number of user. For example, startIndex=1&count=100 fetches the first 100 users and startIndex=96&count=5 gets the five users from the first 100 users.
If you wish to get the details of all users, you can do it through two API calls. The response for the first API call with the parameter, startIndex=1&count=0, provides totalResults with the total number of users. You can send a second API call with the parameter, startIndex=1&count="value of totalResults" to get the details of all users in the system.
Usage: GET /api/v1/scim/v2/Users
Query parameters (optional): ?startIndex=x&count=y
Produces: application/scim+json; charset=UTF-8
Header parameter: Authorization: Bearer
Sample response:
200 - OK - user exists
{
"totalResults": 1,
"itemsPerPage": 1,
"startIndex": 1,
"Resources": [
{
"id": "bjensenexamplecom",
"userName": "bjensenexamplecom",
"active": true,
"emails": [
{
"primary": true,
"value": "bjensen@wso2.com"
}
],
"groups": [
{
"value": "readers"
}
],
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"meta": {
"resourceType": "User"
}
}
],
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
]
}
200 - OK - user does not exist
{
"totalResults": 0,
"itemsPerPage": 0,
"startIndex": 1,
"Resources": [],
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
]
}To Fetch Details of all Users
The first API call to get the total number of users in the system.
GET /api/v1/scim/v2/Users?startIndex=1&count=0
Sample response
200 - OK
{
"totalResults": 2370,
"itemsPerPage": 0,
"startIndex": 1,
"Resources": [],
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
]
}The second API call to get the total number of users in the system.
GET /api/v1/scim/v2/Users?startIndex=1&count=2370