Users API

Explore the Okta Public API Collections (opens new window) workspace to get started with the Users API.

User operations

The Users API provides operations to manage users in your org. These operations are available at the new Okta API reference portal (opens new window) as part of the Users API (opens new window).

Create User

See Create a User (opens new window) in the new Okta API reference portal (opens new window).

Get User

See Retrieve a User (opens new window).

Get current User

See Retrieve a User (opens new window) in the new Okta API reference portal (opens new window).

Get User with ID

See Retrieve a User (opens new window) in the new Okta API reference portal (opens new window).

Hint: If you don't know the user id, list the users to find the correct ID.

Get User with login

See Retrieve a User (opens new window) in the new Okta API reference portal (opens new window).

Get User with Login Shortname

See Retrieve a User (opens new window) in the new Okta API reference portal (opens new window).

List Users

Searching arrays

For more information, see the search (opens new window) parameter description.

List Users with a filter

See List all Users (opens new window) in the new Okta API reference portal (opens new window).

Find Users

See List all Users (opens new window) in the new Okta API reference portal (opens new window), specifically with the q (opens new window) parameter and the search (opens new window) parameter.

List all Users

See List all Users (opens new window) in the new Okta API reference portal (opens new window).

Update User

See Update a User (opens new window) in the new Okta API reference portal (opens new window).

Update current User's Profile

See Update a User (opens new window) in the new Okta API reference portal (opens new window).

Update Profile with ID

See Update a User (opens new window) in the new Okta API reference portal (opens new window).

Related resources

Get Assigned App Links

See List all Assigned Application Links (opens new window) in the new Okta API reference portal (opens new window).

Get Group Memberships

See List all Groups (opens new window) in the new Okta API reference portal (opens new window).

Lifecycle operations

Lifecycle operations are non-idempotent operations that initiate a state transition for a user's status. These operations are available at the new Okta API reference portal (opens new window) as part of the User Lifecycle API (opens new window).

Activate User

See Activate a User (opens new window) in the new Okta API reference portal (opens new window).

Reactivate User

See Reactivate a User (opens new window) in the new Okta API reference portal (opens new window).

Deactivate User

See Deactivate a User (opens new window) in the new Okta API reference portal (opens new window).

Suspend User

See Suspend a User (opens new window) in the new Okta API reference portal (opens new window).

Unsuspend User

See Unsuspend a User (opens new window) in the new Okta API reference portal (opens new window).

Delete User

See Delete a User (opens new window) in the new Okta API reference portal as part of the Users API (opens new window).

Unlock User

See Unlock a User (opens new window) in the new Okta API reference portal (opens new window).

Reset password

See Reset password (opens new window) in the new Okta API reference portal as part of the User Credentials API (opens new window).

Expire password

See Expire Password (opens new window) in the new Okta API reference portal as part of the User Credentials API (opens new window).

Reset Factors

See Reset Factors (opens new window) in the new Okta API reference portal (opens new window).

Clear current User sessions

See End a current User session (opens new window) in the new Okta API reference portal as part of the User Sessions API (opens new window).

User sessions

The User Sessions API provides operations to manage user sessions in your org. These operations are available at the new Okta API reference portal (opens new window) as part of the User Sessions API (opens new window).

Clear User sessions

See Revoke all User sessions (opens new window) in the new Okta API reference portal (opens new window).

Credential operations

The User Credentials API provides operations to manage user credentials in your org. These operations are available at the new Okta API reference portal (opens new window) as part of the User Credentials API (opens new window).

Forgot password

See Start forgot password flow (opens new window) in the new Okta API reference portal (opens new window).

Change password

See Update Password (opens new window) in the new Okta API reference portal (opens new window).

Change recovery question

See Update Recovery Question (opens new window) in the new Okta API reference portal (opens new window).

User-consent Grant operations

The User Grants API provides operations to manage user consent grants in your org. These operations are available at the new Okta API reference portal (opens new window) as part of the User Grants API (opens new window).

List Grants

See List all User Grants (opens new window) in the new Okta API reference portal (opens new window).

Get a Grant

See Retrieve a Grant (opens new window) in the new Okta API reference portal (opens new window).

List Grants for a User-Client combination

See List all Grants for a Client (opens new window) in the new Okta API reference portal (opens new window).

Revoke all Grants for a User

See Revoke all User Grants (opens new window) in the new Okta API reference portal (opens new window).

Revoke a Grant for a User

See Revoke a User Grant (opens new window) in the new Okta API reference portal (opens new window).

Revoke Grants for User and Client

See Revoke all Grants for a Client (opens new window) in the new Okta API reference portal (opens new window).

User OAuth 2.0 Token management operations

The User OAuth 2.0 Token Management API provides operations to manage tokens issued by an authorization server for a particular user and client in your org. These operations are available at the new Okta API reference portal (opens new window) as part of the User OAuth 2.0 Token Management API (opens new window).

List Refresh Tokens

See List all Refresh Tokens for a Client (opens new window) in the new Okta API reference portal (opens new window).

Get Refresh Token

See Retrieve a Refresh Token for a Client (opens new window) in the new Okta API reference portal (opens new window).

Revoke All Refresh Tokens

See Revoke all Refresh Tokens for a Client (opens new window) in the new Okta API reference portal (opens new window).

Revoke Refresh Token

See Revoke a Token for a Client (opens new window) in the new Okta API reference portal (opens new window).

User Client resource operations

The User Resources API provides operations related to user resources. These operations are available at the new Okta API reference portal (opens new window) as part of the User Resources API (opens new window).

List Client resources for a User

See List all Clients (opens new window) in the new Okta API reference portal (opens new window).

User object

See User - response payload (opens new window) in the new Okta API reference portal (opens new window).

Profile object

Credentials object

See credentials (opens new window) in the new Okta API reference portal (opens new window)..

Password object

See password (opens new window) in the new Okta API reference portal (opens new window).

Hashed Password object

See hash (opens new window) in the new Okta API reference portal (opens new window).

Password Hook object

See hook (opens new window) in the new Okta API reference portal (opens new window).

Recovery Question object

See recovery_question (opens new window) in the new Okta API reference portal (opens new window).

Provider object

See recovery_question (opens new window) in the new Okta API reference portal (opens new window).

Links object

See the Links object section in the Users API (opens new window) in the new Okta API reference portal (opens new window).

User Block object

See User block - response payload (opens new window) in the new Okta API reference portal (opens new window).

Client Grant object

See User Grant - response payload (opens new window) in the new Okta API reference portal (opens new window).