Scim
User
List SCIM Users
Retrieves a list of users, supports filtering and pagination. Used by SCIM clients like Okta.
get/scim/Users
Query parameters
filterstring
Filter expression to retrieve matching users
startIndexinteger
The 1-based index of the first result
countinteger
Desired maximum number of query results per page
Response
User list retrieved successfully
Example response
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"totalResults": 3,
"startIndex": 1,
"itemsPerPage": 3,
"Resources": [
{
"id": "d0dd58e43ded4293a61a8760fcba0458",
"externalId": "00ustvXq1A8UAuobW0f5",
"meta": {
"created": "04-17-2020 00:00:00",
"lastModified": "04-17-2020 00:00:00",
"version": "v1.0"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:scim:schemas:extension:okta:1.0"
],
"userName": "steph.c@example.com",
"displayName": " Steph Curry",
"preferredLanguage": "en",
"locale": "en-US",
"timezone": "America/Los_Angeles",
"active": true,
"emails": [
{
"value": "steph.c@example.com",
"type": "work",
"primary": true
}
],
"phoneNumbers": [
{
"value": "123-444-5555",
"type": "mobile"
}
],
"groups": [],
"name": {
"familyName": "Curry",
"givenName": "Steph"
},
"urn:okta:onprem_app:1.0:user:custom": {
"roleUUID": "84e67f54-5157-442b-a2b3-8b9c728b2fef"
}
}
]
}