Users (Okta API)
The [Okta User API](/docs/api/rest/users.html) provides operations to manage users in your organization.
Identity & security#openapi#security
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The Okta User API provides operations to manage users in your organization.
Endpoints 19
Create User
- POSTCreate User in Group
/api/v1/users?activate=falseCreate User in Group
Credential Operations
- PUTSet Recovery Credential
/api/v1/users/:userIdSet Recovery Credential - POSTChange Password
/api/v1/users/:userId/credentials/change_passwordChange Password - POSTChange Recovery Question
/api/v1/users/:userId/credentials/change_recovery_questionChange Recovery Question - POSTForgot Password (One Time Code)
/api/v1/users/:userId/credentials/forgot_password?sendEmail=falseForgot Password (One Time Code)
Lifecycle Operations
- POSTActivate User
/api/v1/users/:userId/lifecycle/activate?sendEmail=falseActivate User - POSTDeactivate User
/api/v1/users/:userId/lifecycle/deactivateDeactivate User - POSTSet Temp Password
/api/v1/users/:userId/lifecycle/expire_password?tempPassword=trueSet Temp Password - POSTReset Password
/api/v1/users/:userId/lifecycle/reset_password?sendEmail=falseReset Password - POSTSuspend User
/api/v1/users/:userId/lifecycle/suspendSuspend User - POSTUnlock User
/api/v1/users/:userId/lifecycle/unlockUnlock User - POSTUnsuspend User
/api/v1/users/:userId/lifecycle/unsuspendUnsuspend User
- GETFind User
/api/v1/users?q=userFind User - GETGet Current User
/api/v1/users/meGet Current User - GETGet User
/api/v1/users/:userIdGet User - GETGet Assigned App Links
/api/v1/users/:userId/appLinksGet Assigned App Links - GETGet Groups for User
/api/v1/users/:userId/groupsGet Groups for User - POSTReset Factors
/api/v1/users/:userId/lifecycle/reset_factorsReset Factors - DELETEClear User Sessions
/api/v1/users/:userId/sessionsClear User Sessions
API details
- Base URL
http://okta.local- Authentication
- None declared in the description
- Operations
- 19 operations on 17 pathsPOST 12GET 5PUT 1DELETE 1
- Main resources
- Lifecycle Operations 7Credential Operations 4Create User 1
- Description format
- OpenAPI 3.0.3, API version
1.0.0 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Users (Okta API) in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Users (Okta API) collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “Create User in Group” (POST /api/v1/users?activate=false), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Users (Okta API)?
The [Okta User API](/docs/api/rest/users.html) provides operations to manage users in your organization. It is listed under Identity & security and has 19 endpoints.
Who publishes the Users (Okta API)?
It is listed from Okta's public API description (an OpenAPI document), not published by Okta on Swastik Codes. Anyone who controls okta.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Users (Okta API)?
Requests go to http://okta.local. Endpoint paths are added to this base URL.
How do I authenticate with the Users (Okta API)?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the Users (Okta API) have?
19 operations on 17 paths (12 POST, 5 GET, 1 PUT, 1 DELETE). The largest groups are Lifecycle Operations, Credential Operations, Create User.
Is forking the Users (Okta API) free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.