List users

GET 
/Users

List users

Request

Query Parameters

filter string

Does not support complex filters, for now.

Responses

200

successful operation

application/json

Schema

Schema

Resources object[]

user list

itemsPerPage int64
schemas string[]

Possible values: [urn:ietf:params:scim:api:messages:2.0:ListResponse]

startIndex int64
totalResults int64

Example (from schema)

{
  "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-05-13T11:13:26.444Z",
        "lastModified": "2024-05-13T11:13:26.444Z",
        "location": "string",
        "resourceType": "User"
      }
    }
  ],
  "itemsPerPage": 0,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "startIndex": 0,
  "totalResults": 0
}

application/scim+json

Schema

Schema

Resources object[]

user list

itemsPerPage int64
schemas string[]

Possible values: [urn:ietf:params:scim:api:messages:2.0:ListResponse]

startIndex int64
totalResults int64

Example (from schema)

{
  "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-05-13T11:13:26.446Z",
        "lastModified": "2024-05-13T11:13:26.446Z",
        "location": "string",
        "resourceType": "User"
      }
    }
  ],
  "itemsPerPage": 0,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "startIndex": 0,
  "totalResults": 0
}

400

bad request

application/json

Schema

Schema

detail string

detail error message

schemas string[]

Possible values: [urn:ietf:params:scim:api:messages:2.0:Error]

scimType string

Possible values: [uniqueness, tooMany, mutability, sensitive, invalidSyntax, invalidFilter, invalidPath, invalidValue, invalidVers, noTarget]

bad request type when status code is 400

status string

same as HTTP status code, e.g. 400, 401, etc.

Example (from schema)

{
  "detail": "string",
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "scimType": "uniqueness",
  "status": "string"
}

application/scim+json

Schema

Schema

detail string

detail error message

schemas string[]

Possible values: [urn:ietf:params:scim:api:messages:2.0:Error]

scimType string

Possible values: [uniqueness, tooMany, mutability, sensitive, invalidSyntax, invalidFilter, invalidPath, invalidValue, invalidVers, noTarget]

bad request type when status code is 400

status string

same as HTTP status code, e.g. 400, 401, etc.

Example (from schema)

{
  "detail": "string",
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "scimType": "uniqueness",
  "status": "string"
}

401

authorization failure

application/json

Schema

Schema

detail string

detail error message

schemas string[]

Possible values: [urn:ietf:params:scim:api:messages:2.0:Error]

scimType string

Possible values: [uniqueness, tooMany, mutability, sensitive, invalidSyntax, invalidFilter, invalidPath, invalidValue, invalidVers, noTarget]

bad request type when status code is 400

status string

same as HTTP status code, e.g. 400, 401, etc.

Example (from schema)

{
  "detail": "string",
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "scimType": "uniqueness",
  "status": "string"
}

application/scim+json

Schema

Schema

detail string

detail error message

schemas string[]

Possible values: [urn:ietf:params:scim:api:messages:2.0:Error]

scimType string

Possible values: [uniqueness, tooMany, mutability, sensitive, invalidSyntax, invalidFilter, invalidPath, invalidValue, invalidVers, noTarget]

bad request type when status code is 400

status string

same as HTTP status code, e.g. 400, 401, etc.

Example (from schema)

{
  "detail": "string",
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "scimType": "uniqueness",
  "status": "string"
}

403

permissions denied

application/json

Schema

Schema

detail string

detail error message

schemas string[]

Possible values: [urn:ietf:params:scim:api:messages:2.0:Error]

scimType string

Possible values: [uniqueness, tooMany, mutability, sensitive, invalidSyntax, invalidFilter, invalidPath, invalidValue, invalidVers, noTarget]

bad request type when status code is 400

status string

same as HTTP status code, e.g. 400, 401, etc.

Example (from schema)

{
  "detail": "string",
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "scimType": "uniqueness",
  "status": "string"
}

application/scim+json

Schema

Schema

detail string

detail error message

schemas string[]

Possible values: [urn:ietf:params:scim:api:messages:2.0:Error]

scimType string

Possible values: [uniqueness, tooMany, mutability, sensitive, invalidSyntax, invalidFilter, invalidPath, invalidValue, invalidVers, noTarget]

bad request type when status code is 400

status string

same as HTTP status code, e.g. 400, 401, etc.

Example (from schema)

{
  "detail": "string",
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "scimType": "uniqueness",
  "status": "string"
}

429

too many requests

application/json

Schema

Schema

detail string

detail error message

schemas string[]

Possible values: [urn:ietf:params:scim:api:messages:2.0:Error]

scimType string

Possible values: [uniqueness, tooMany, mutability, sensitive, invalidSyntax, invalidFilter, invalidPath, invalidValue, invalidVers, noTarget]

bad request type when status code is 400

status string

same as HTTP status code, e.g. 400, 401, etc.

Example (from schema)

{
  "detail": "string",
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "scimType": "uniqueness",
  "status": "string"
}

application/scim+json

Schema

Schema

detail string

detail error message

schemas string[]

Possible values: [urn:ietf:params:scim:api:messages:2.0:Error]

scimType string

Possible values: [uniqueness, tooMany, mutability, sensitive, invalidSyntax, invalidFilter, invalidPath, invalidValue, invalidVers, noTarget]

bad request type when status code is 400

status string

same as HTTP status code, e.g. 400, 401, etc.

Example (from schema)

{
  "detail": "string",
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "scimType": "uniqueness",
  "status": "string"
}

500

internal server error

application/json

Schema

Schema

detail string

detail error message

schemas string[]

Possible values: [urn:ietf:params:scim:api:messages:2.0:Error]

scimType string

Possible values: [uniqueness, tooMany, mutability, sensitive, invalidSyntax, invalidFilter, invalidPath, invalidValue, invalidVers, noTarget]

bad request type when status code is 400

status string

same as HTTP status code, e.g. 400, 401, etc.

Example (from schema)

{
  "detail": "string",
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "scimType": "uniqueness",
  "status": "string"
}

application/scim+json

Schema

Schema

detail string

detail error message

schemas string[]

Possible values: [urn:ietf:params:scim:api:messages:2.0:Error]

scimType string

Possible values: [uniqueness, tooMany, mutability, sensitive, invalidSyntax, invalidFilter, invalidPath, invalidValue, invalidVers, noTarget]

bad request type when status code is 400

status string

same as HTTP status code, e.g. 400, 401, etc.

Example (from schema)

{
  "detail": "string",
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "scimType": "uniqueness",
  "status": "string"
}

Loading...