External DocumentationTo 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 |
|---|---|
| After | The numerical cursor to use for pagination. Represents the index of the first item on the next page of results. |
| 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. |