List all Users
GET {{baseUrl}}/api/v1/users
Lists all users that do not have a status of 'DEPROVISIONED' (by default), up to the maximum (200 for most orgs), with pagination. A subset of users can be returned that match a supported filter expression or search criteria.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
q | string | Finds a user that matches firstName, lastName, and email properties | |
after | string | The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the Link response header. See Pagination for more information. | |
limit | number | Specifies the number of results returned. Defaults to 10 if q is provided. | |
filter | string | Filters users with a supported expression for a subset of properties | |
search | string | Searches for users with a supported filtering expression for most properties. Okta recommends using this parameter for search for best performance. | |
sortBy | string | ||
sortOrder | string |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"id":"00u118oQYT4TBGuay0g4","status":"ACTIVE","created":"2022-04-04T15:56:05.000Z","activated":null,"statusChanged":null,"lastLogin":"2022-05-04T19:50:52.000Z","lastUpdated":"2022-05-05T18:15:44.000Z","passwordChanged":"2022-04-04T16:00:22.000Z","type":{"id":"oty1162QAr8hJjTaq0g4"},"profile":{"firstName":"Alice","lastName":"Smith","mobilePhone":null,"secondEmail":null,"login":"alice.smith@example.com","email":"alice.smith@example.com"},"credentials":{"password":{},"provider":{"type":"OKTA","name":"OKTA"}},"_links":{"self":{"href":"http://your-subdomain.okta.com/api/v1/users/00u118oQYT4TBGuay0g4"}}}]