Help & Support
Follow

User Provisioning API: Search for a User

Search for a user

GET /Users

Returns a list of paginated users.

Supported querystring parameters

  • startIndex - the page number to begin with starting at 0
  • count - the number of results to return per page (max of 200)
  • filter - filter the results returned (see below for detailed information)

Filtering results

The filter can be optionally used to limit the users returned. The filter parameter MUST contain at least one valid Boolean expression. Each expression MUST contain an attribute name followed by an attribute operator and optional value. Multiple expressions MAY be combined using the two logical operators AND/OR. Furthermore expressions can be grouped together using "()".

Example filter urls:

# username equals demo@user.com
https://myaccount.leankit.com/io/scim/v1/users?filter=username eq "demo@user.com"

# familyname contains the word user
https://myaccount.leankit.com/io/scim/v1/users?filter=name.familyname co "user"

# users who have accessed the system since 2017-02-22 and are administrators
https://myaccount.leankit.com/io/scim/v1/users?filter=urn:scim:schemas:extension:leankit:user:1.0.lastaccess gt "2017-02-22T00:00:00Z" AND urn:scim:schemas:extension:leankit:user:1.0.administrator eq "true"

Additional information can be found in the SCIM 1.1 Filtering documentation.

Note:

  • timezone is not a valid filter field
  • not all fields support all operators

Returns

  • 200 OK with the paginated user results

Example response body:

{
    "schemas": [
        "urn:scim:schemas:core:1.0",
        "urn:scim:schemas:extension:leankit:user:1.0"
    ],
    "totalResults": 2,
    "itemsPerPage": 50,
    "startIndex": 1,
    "Resources": [
        {
            "id": "12345678",
            "externalId": "ABC234",
            "userName": "demo@user.com",
            "name": {
                "familyName": "User",
                "givenName": "Demo",
                "formatted": "Demo User"
            },
            "timezone": "America/Chicago",
            "active": true,
            "meta": {
                "created": "2017-08-22T20:49:43Z",
                "location": "https://myaccount.leankit.com/io/scim/v1/users/12345678"
            },
            "urn:scim:schemas:extension:leankit:user:1.0": {
                "licenseType": "full",
                "lastAccess": "2017-08-23T20:49:43Z",
                "administrator": false,
                "boardCreator": false,
                "dateFormat": "mm/dd/yyyy"
            }
        },
        {
            "id": "45678901",
            "externalId": "ZYX234",
            "userName": "demotwo@user.com",
            "name": {
                "familyName": "User",
                "givenName": "Demo Two",
                "formatted": "Demo Two User"
            },
            "timezone": "America/Los_Angeles",
            "active": true,
            "meta": {
                "created": "2017-09-22T20:49:43Z",
                "location": "https://myaccount.leankit.com/io/scim/v1/users/45678901"
            },
            "urn:scim:schemas:extension:leankit:user:1.0": {
                "licenseType": "full",
                "lastAccess": "2017-09-23T20:49:43Z",
                "administrator": true,
                "boardCreator": false,
                "dateFormat": "dd/mm/yyyy"
            }
        }
    ]
}
Have more questions? Submit a request