OKokta
User

List Users

Lists users that do not have a status of 'DEPROVISIONED' (by default), up to the maximum (200 for most orgs), with pagination in most cases. A subset of users can be returned that match a supported filter expression or search criteria.

get/api/v1/users

Request

  • Base URL
    https://your-subdomain.okta.com
  • Auth
    API key in header Authorization

Query parameters

qstring

Finds a user that matches firstName, lastName, and email properties

afterstring

Specifies the pagination cursor for the next page of users

limitinteger

Specifies the number of results returned

filterstring

Filters users with a supported expression for a subset of properties

searchstring

Searches for users with a supported filtering expression for most properties

sortBystring
sortOrderstring

Response

Success

_embeddedobject
_linksobject
activatedstring date-time
createdstring date-time
idstring
lastLoginstring date-time
lastUpdatedstring date-time
passwordChangedstring date-time
status'ACTIVE' | 'DEPROVISIONED' | 'LOCKED_OUT' | 'PASSWORD_EXPIRED' | 'PROVISIONED' | 'RECOVERY' | 'STAGED' | 'SUSPENDED'
statusChangedstring date-time
transitioningToStatus'ACTIVE' | 'DEPROVISIONED' | 'LOCKED_OUT' | 'PASSWORD_EXPIRED' | 'PROVISIONED' | 'RECOVERY' | 'STAGED' | 'SUSPENDED'

Changes

No recorded changes to this operation across all 1 revision of this API.