Use this endpoint to search for users and associated workspaces. Note that the limit is 100 users per call.

Method and endpoint

GET

/Users

Parameters

Filter parameterDetails
filter

A filter expression to restrict the result set in the form of <field> <operator> <value>

Example: givenName Eq “John”

Note that expressions may be separated with and, or or ( ) (note that not is not supported).

FieldDetails
idSupported
externalIdSupported
userNameSupported
name.familyNameSupported
name.givenNameSupported
activeSupported
name.formattedNot Supported
displayNameNot Supported
entitlements.displayNot Supported
entitlements.primaryNot Supported
entitlements.typeNot Supported
entitlements.valueNot Supported
Pagination parameterDetails
startIndexThe pagination index to start with for the response

Default: 1
countThe pagination count per response

Default: 50

Curl example

GET /Users?filter=name.givenName Eq "John"&startIndex=1&count=100
   Host: https://api.anaplan.com/scim/1/0/v2
   Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
   Accept: application/json

Response

    {
       "totalResults": 1,
       "startIndex": 1,
       "itemsPerPage": 1,
       "Resources": [
           {
               "schemas": [
                   "urn:ietf:params:scim:schemas:core:2.0:User"
               ],
               "meta": {
                   "resourceType": "User",
                   "created": "2018-04-24T23:43:48.000+00:00",
                   "lastModified": "2019-01-15T22:04:19.000+00:00",
                   "location": "https://localhost:8090/1/0/v2/Users/8a80db9362f64cad0162fa0ab3fe0001"
               },
               "id": "8a80db9362f64cad0162fa0ab3fe0001",
               "externalId": "",
               "active": "True",
               "userName": "sfqasuper@anaplan.com",
               "name": {
                   "familyName": "Super",
                   "givenName": "SFQA",
                   "formatted": "SFQA Super"
               },
               "displayName": "SFQA Super",
               "active": true,
               "entitlements": [
                   {
                       "display": "Finance Workspace",
                       "value": "6edb50156273d29050001",
                       "type": "WORKSPACE"
                   },
                   {
                       "display": "Sales Workspace",
                       "value": "6edb50156273d29050002",
                       "type": "WORKSPACE"
                   },
                   {
                       "value": "6edb50156273d29050001,6edb50156273d29050002",
                       "type": "WORKSPACE_IDS"
                   }
               ]
           }
       ]
   }