List users
GET/Users
List users
Request
Query Parameters
Does not support complex filters, for now.
Responses
- 200
- 400
- 401
- 403
- 429
- 500
successful operation
- application/json
- application/scim+json
- Schema
- Example (from schema)
Schema
user list
Possible values: [urn:ietf:params:scim:api:messages:2.0:ListResponse
]
{
"Resources": [
{
"active": false,
"addresses": [
{
"country": "string",
"locality": "string",
"postalCode": "string",
"region": "string",
"streetAddress": "string",
"type": "work"
}
],
"emails": [
{
"type": "work",
"value": "string"
}
],
"externalId": "string",
"id": "string",
"name": {
"familyName": "string",
"givenName": "string"
},
"phoneNumbers": [
{
"type": "work",
"value": "string"
}
],
"photos": [
{
"type": "photo",
"value": "string"
}
],
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"department": "string"
},
"userName": "string",
"urn:ietf:params:scim:schemas:extension:elfsquad:2.0:User": {
"currencyIso": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"languageIso": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"crmAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"crmContactId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"meta": {
"created": "2024-06-06T15:30:34.507Z",
"lastModified": "2024-06-06T15:30:34.507Z",
"location": "string",
"resourceType": "User"
}
}
],
"itemsPerPage": 0,
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"startIndex": 0,
"totalResults": 0
}
- Schema
- Example (from schema)
Schema
user list
Possible values: [urn:ietf:params:scim:api:messages:2.0:ListResponse
]
{
"Resources": [
{
"active": false,
"addresses": [
{
"country": "string",
"locality": "string",
"postalCode": "string",
"region": "string",
"streetAddress": "string",
"type": "work"
}
],
"emails": [
{
"type": "work",
"value": "string"
}
],
"externalId": "string",
"id": "string",
"name": {
"familyName": "string",
"givenName": "string"
},
"phoneNumbers": [
{
"type": "work",
"value": "string"
}
],
"photos": [
{
"type": "photo",
"value": "string"
}
],
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"department": "string"
},
"userName": "string",
"urn:ietf:params:scim:schemas:extension:elfsquad:2.0:User": {
"currencyIso": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"languageIso": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"crmAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"crmContactId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"meta": {
"created": "2024-06-06T15:30:34.509Z",
"lastModified": "2024-06-06T15:30:34.509Z",
"location": "string",
"resourceType": "User"
}
}
],
"itemsPerPage": 0,
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"startIndex": 0,
"totalResults": 0
}
bad request
- application/json
- application/scim+json
- Schema
- Example (from schema)
Schema
detail error message
Possible values: [urn:ietf:params:scim:api:messages:2.0:Error
]
Possible values: [uniqueness
, tooMany
, mutability
, sensitive
, invalidSyntax
, invalidFilter
, invalidPath
, invalidValue
, invalidVers
, noTarget
]
bad request type when status code is 400
same as HTTP status code, e.g. 400, 401, etc.
{
"detail": "string",
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:Error"
],
"scimType": "uniqueness",
"status": "string"
}
- Schema
- Example (from schema)
Schema
detail error message
Possible values: [urn:ietf:params:scim:api:messages:2.0:Error
]
Possible values: [uniqueness
, tooMany
, mutability
, sensitive
, invalidSyntax
, invalidFilter
, invalidPath
, invalidValue
, invalidVers
, noTarget
]
bad request type when status code is 400
same as HTTP status code, e.g. 400, 401, etc.
{
"detail": "string",
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:Error"
],
"scimType": "uniqueness",
"status": "string"
}
authorization failure
- application/json
- application/scim+json
- Schema
- Example (from schema)
Schema
detail error message
Possible values: [urn:ietf:params:scim:api:messages:2.0:Error
]
Possible values: [uniqueness
, tooMany
, mutability
, sensitive
, invalidSyntax
, invalidFilter
, invalidPath
, invalidValue
, invalidVers
, noTarget
]
bad request type when status code is 400
same as HTTP status code, e.g. 400, 401, etc.
{
"detail": "string",
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:Error"
],
"scimType": "uniqueness",
"status": "string"
}
- Schema
- Example (from schema)
Schema
detail error message
Possible values: [urn:ietf:params:scim:api:messages:2.0:Error
]
Possible values: [uniqueness
, tooMany
, mutability
, sensitive
, invalidSyntax
, invalidFilter
, invalidPath
, invalidValue
, invalidVers
, noTarget
]
bad request type when status code is 400
same as HTTP status code, e.g. 400, 401, etc.
{
"detail": "string",
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:Error"
],
"scimType": "uniqueness",
"status": "string"
}
permissions denied
- application/json
- application/scim+json
- Schema
- Example (from schema)
Schema
detail error message
Possible values: [urn:ietf:params:scim:api:messages:2.0:Error
]
Possible values: [uniqueness
, tooMany
, mutability
, sensitive
, invalidSyntax
, invalidFilter
, invalidPath
, invalidValue
, invalidVers
, noTarget
]
bad request type when status code is 400
same as HTTP status code, e.g. 400, 401, etc.
{
"detail": "string",
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:Error"
],
"scimType": "uniqueness",
"status": "string"
}
- Schema
- Example (from schema)
Schema
detail error message
Possible values: [urn:ietf:params:scim:api:messages:2.0:Error
]
Possible values: [uniqueness
, tooMany
, mutability
, sensitive
, invalidSyntax
, invalidFilter
, invalidPath
, invalidValue
, invalidVers
, noTarget
]
bad request type when status code is 400
same as HTTP status code, e.g. 400, 401, etc.
{
"detail": "string",
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:Error"
],
"scimType": "uniqueness",
"status": "string"
}
too many requests
- application/json
- application/scim+json
- Schema
- Example (from schema)
Schema
detail error message
Possible values: [urn:ietf:params:scim:api:messages:2.0:Error
]
Possible values: [uniqueness
, tooMany
, mutability
, sensitive
, invalidSyntax
, invalidFilter
, invalidPath
, invalidValue
, invalidVers
, noTarget
]
bad request type when status code is 400
same as HTTP status code, e.g. 400, 401, etc.
{
"detail": "string",
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:Error"
],
"scimType": "uniqueness",
"status": "string"
}
- Schema
- Example (from schema)
Schema
detail error message
Possible values: [urn:ietf:params:scim:api:messages:2.0:Error
]
Possible values: [uniqueness
, tooMany
, mutability
, sensitive
, invalidSyntax
, invalidFilter
, invalidPath
, invalidValue
, invalidVers
, noTarget
]
bad request type when status code is 400
same as HTTP status code, e.g. 400, 401, etc.
{
"detail": "string",
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:Error"
],
"scimType": "uniqueness",
"status": "string"
}
internal server error
- application/json
- application/scim+json
- Schema
- Example (from schema)
Schema
detail error message
Possible values: [urn:ietf:params:scim:api:messages:2.0:Error
]
Possible values: [uniqueness
, tooMany
, mutability
, sensitive
, invalidSyntax
, invalidFilter
, invalidPath
, invalidValue
, invalidVers
, noTarget
]
bad request type when status code is 400
same as HTTP status code, e.g. 400, 401, etc.
{
"detail": "string",
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:Error"
],
"scimType": "uniqueness",
"status": "string"
}
- Schema
- Example (from schema)
Schema
detail error message
Possible values: [urn:ietf:params:scim:api:messages:2.0:Error
]
Possible values: [uniqueness
, tooMany
, mutability
, sensitive
, invalidSyntax
, invalidFilter
, invalidPath
, invalidValue
, invalidVers
, noTarget
]
bad request type when status code is 400
same as HTTP status code, e.g. 400, 401, etc.
{
"detail": "string",
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:Error"
],
"scimType": "uniqueness",
"status": "string"
}