List Users

Lists users in your organization with pagination in most cases. A subset of users can be returned that match a supported filter expression or search criteria.

External Documentation

To learn more, visit the Okta documentation.

Basic Parameters

Parameter	Description
Query	Finds a user that matches firstName, lastName, and email properties.
Return All Pages	Automatically fetch all resources, page by page.
Search	Searches for users with a supported filtering expression for most properties based on the SCIM protocol specification. Refer to https://developer.okta.com/docs/reference/core-okta-api/#filter for more information. For example: status eq "ACTIVE", lastUpdated gt "yyyy-MM-dd'T'HH:mm:ss.SSSZ".

Advanced Parameters

Parameter	Description
Filter	Filters users with a supported expression for a subset of properties. Refer to https://developer.okta.com/docs/reference/core-okta-api/#filter for more information. Okta recommends using the search parameter instead.
Limit	Specifies the number of results returned (maximum 200 per page).
Sort By	Only relevant along with the 'Search' parameter. Can be any single property, for example sortBy=profile.lastName.
Sort Order	Only relevant along with both the 'Search' and the 'Sort By' parameter.

Example Output

[
    {
        "id": "00ub0oNGTSWTBKOLGLNR",
        "status": "ACTIVE",
        "created": "2013-06-24T16:39:18.000Z",
        "activated": "2013-06-24T16:39:19.000Z",
        "statusChanged": "2013-06-24T16:39:19.000Z",
        "lastLogin": "2013-06-24T17:39:19.000Z",
        "lastUpdated": "2013-07-02T21:36:25.344Z",
        "passwordChanged": "2013-07-02T21:36:25.344Z",
        "profile": {
            "firstName": "Isaac",
            "lastName": "Brock",
            "email": "isaac.brock@example.com",
            "login": "isaac.brock@example.com",
            "mobilePhone": "555-415-1337"
        },
        "credentials": {
            "password": {},
            "recovery_question": {
                "question": "Who's a major player in the cowboy scene?"
            },
            "provider": {
                "type": "OKTA",
                "name": "OKTA"
            }
        },
        "_links": {
            "self": {
                "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR"
            }
        }
    }
]

Workflow Library Example

Get Alerts for Login Attempts of Disabled Users in Okta

Preview this Workflow on desktop