List or filter users

GET /Users

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

    The 1-based index of the first result

    Minimum value is 1. Default value is 1.

  • count integer

    Maximum number of results to return

    Minimum value is 0.

Responses

  • 200 application/scim+json

    List of users

GET /Users 
curl \
 -X GET https://setup.adra.com/api/organizations/{organizationSid}/scim/Users
Response examples (200) 
{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "Resources": [
    {
      "id": "197c9146-b39a-48e2-b81a-cad422018941",
      "meta": {
        "resourceType": "User"
      },
      "name": {
        "givenName": "Roger",
        "familyName": "Eagles"
      },
      "title": "Administrator",
      "active": true,
      "emails": [
        {
          "type": "work",
          "value": "employee@tenant.com",
          "primary": true
        }
      ],
      "locale": "en-GB",
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
      ],
      "timezone": "Europe/London",
      "userName": "employee2@tenant.onmicrosoft.com",
      "externalId": "cad422018941",
      "preferredLanguage": "en-GB",
      "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
        "employeeNumber": "0603"
      }
    }
  ],
  "startIndex": 1,
  "itemsPerPage": 41,
  "totalResults": 41
}
{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "Resources": [
    {
      "id": "197c9146-b39a-48e2-b81a-cad422018941",
      "meta": {
        "resourceType": "User"
      },
      "name": {
        "givenName": "Roger",
        "familyName": "Eagles"
      },
      "title": "Administrator",
      "active": true,
      "emails": [
        {
          "type": "work",
          "value": "employee2@tenant.onmicrosoft.com",
          "primary": true
        }
      ],
      "locale": "en-GB",
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
      ],
      "timezone": "Europe/London",
      "userName": "employee2@tenant.onmicrosoft.com",
      "externalId": "cad422018941",
      "preferredLanguage": "en-GB",
      "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
        "employeeNumber": "0603"
      }
    }
  ],
  "startIndex": 1,
  "itemsPerPage": 1,
  "totalResults": 1
}