Search for Users / Get users by [property]
Only a very limited set of filtering methods have been implemented. See the list below
Endpoint | Method |
|
---|---|---|
| GET | Search for a user with a specific email |
| GET | Search for a user with a specific externalId |
| GET | List ALL users (9999). No pagination |
| Get | Lists a paged set of users controlled by pagination-parameters |
Responses:
200 OK | |
---|---|
Statuscode | 200 |
Response-body: A list of users matching query Sample-response: {
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"totalResults": 3,
"itemsPerPage": 3,
"startIndex": 1,
"Resources": [
{
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {},
"active": true,
"meta": {
"resourceType": "User"
},
"name": {
"familyName": "NewLastname",
"givenName": "NewFirstname"
},
"userName": "newUsername@domain.com",
"externalId": "externalId-changed",
"id": "a3792aca-8f99-4d4b-a1f2-2b31e871b634",
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
]
},
{
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {},
"active": true,
"meta": {
"resourceType": "User"
},
"name": {
"familyName": "Doe",
"givenName": "John"
},
"userName": "username@domain.com",
"externalId": "16861ac5-deaa-4d66-a4cc-bc788965cc37",
"id": "6dec03a9-dedd-4940-8763-6201761d022e",
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
]
},
{
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {},
"active": false,
"meta": {
"resourceType": "User"
},
"name": {},
"userName": "2username@domain.com",
"externalId": "86861ac5-deaa-4d66-a4cc-bc788965cc37",
"id": "667a9059-7af5-4deb-a3d2-e22e2a53c6e7",
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
]
}
]
}
|