List or filter users

GET /Users
Adra personal access token

Returns a list of users, optionally filtered by query parameters

Query parameters

  • filter string

    Filter string (e.g. userName eq "user@example.com")

  • startIndex integer(int32)

    The 1-based index of the first result

    Minimum value is 1. Default value is 1.

  • count integer(int32)

    Maximum number of results to return

    Minimum value is 1.

Responses

  • 200 application/scim+json

    OK

    Hide response attributes Show response attributes object
    • schemas array[string]
    • totalResults integer(int32)
    • itemsPerPage integer(int32)
    • startIndex integer(int32) | null
    • Resources array[object] | null
      Hide Resources attributes Show Resources attributes object
      • enterpriseExtension object | null

        Additional properties are NOT allowed.

        Hide enterpriseExtension attribute Show enterpriseExtension attribute object | null
        • employeeNumber string | null
      • active boolean
      • electronicMailAddresses array[object]
        Hide electronicMailAddresses attributes Show electronicMailAddresses attributes object
        • value string | null
        • itemType string | null
        • primary boolean
      • locale string | null
      • meta object | null

        Additional properties are NOT allowed.

        Hide meta attribute Show meta attribute object | null
        • resourceType string | null
      • name object

        Additional properties are NOT allowed.

        Hide name attributes Show name attributes object
        • familyName string
        • givenName string
      • preferredLanguage string | null
      • timeZone string | null
      • title string | null
      • userName string
      • externalId string | null
      • schemas array[string] | null
  • 400 application/scim+json

    Bad Request

    Hide response attributes Show response attributes object
    • type string | null
    • title string | null
    • status integer(int32) | null
    • detail string | null
    • instance string | null
  • 401 application/scim+json

    Unauthorized

    Hide response attributes Show response attributes object
    • type string | null
    • title string | null
    • status integer(int32) | null
    • detail string | null
    • instance string | null
  • 403 application/scim+json

    Forbidden

    Hide response attributes Show response attributes object
    • type string | null
    • title string | null
    • status integer(int32) | null
    • detail string | null
    • instance string | null
  • 500 application/scim+json

    Internal Server Error

    Hide response attributes Show response attributes object
    • type string | null
    • title string | null
    • status integer(int32) | null
    • detail string | null
    • instance string | null
  • 501 application/scim+json

    Not Implemented

    Hide response attributes Show response attributes object
    • type string | null
    • title string | null
    • status integer(int32) | null
    • detail string | null
    • instance string | null
GET /Users 
curl \
 --request GET 'https://setup.adra.com/api/organizations/{organizationSid}/scim/Users' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "Resources": [
    {
      "id": "9876fedc-ba09-8765-4321-0fedcba98765",
      "meta": {
        "resourceType": "User"
      },
      "name": {
        "givenName": "John",
        "familyName": "Smith"
      },
      "active": true,
      "emails": [
        {
          "type": "work",
          "value": "jsmith@example.com",
          "primary": true
        }
      ],
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
      ],
      "userName": "jsmith@example.com"
    },
    {
      "id": "abcdef12-3456-7890-abcd-ef1234567890",
      "meta": {
        "resourceType": "User"
      },
      "name": {
        "givenName": "Jane",
        "familyName": "Doe"
      },
      "active": true,
      "emails": [
        {
          "type": "work",
          "value": "jdoe@example.com",
          "primary": true
        }
      ],
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
      ],
      "userName": "jdoe@example.com"
    }
  ],
  "startIndex": 1,
  "itemsPerPage": 10,
  "totalResults": 2
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (401) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (403) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (500) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (501) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}