{ "opencollection": "1.0.0", "info": { "name": "Okta Application User API", "version": "2.16.0" }, "items": [ { "info": { "name": "User", "type": "folder" }, "items": [ { "info": { "name": "Okta List Users", "type": "http" }, "http": { "method": "GET", "url": "https://your-subdomain.okta.com/api/v1/users", "params": [ { "name": "q", "value": "", "type": "query", "description": "Finds a user that matches firstName, lastName, and email properties" }, { "name": "after", "value": "", "type": "query", "description": "Specifies the pagination cursor for the next page of users" }, { "name": "limit", "value": "", "type": "query", "description": "Specifies the number of results returned" }, { "name": "filter", "value": "", "type": "query", "description": "Filters users with a supported expression for a subset of properties" }, { "name": "search", "value": "", "type": "query", "description": "Searches for users with a supported filtering expression for most properties" }, { "name": "sortBy", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "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." }, { "info": { "name": "Okta Create User", "type": "http" }, "http": { "method": "POST", "url": "https://your-subdomain.okta.com/api/v1/users", "params": [ { "name": "activate", "value": "", "type": "query", "description": "Executes activation lifecycle operation when creating the user" }, { "name": "provider", "value": "", "type": "query", "description": "Indicates whether to create a user with a specified authentication provider" }, { "name": "nextLogin", "value": "", "type": "query", "description": "With activate=true, set nextLogin to \"changePassword\" to have the password be EXPIRED, so user must change it the next time they log in." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Creates a new user in your Okta organization with or without credentials." }, { "info": { "name": "setLinkedObjectForUser", "type": "http" }, "http": { "method": "PUT", "url": "https://your-subdomain.okta.com/api/v1/users/:associatedUserId/linkedObjects/:primaryRelationshipName/:primaryUserId", "params": [ { "name": "associatedUserId", "value": "", "type": "path" }, { "name": "primaryRelationshipName", "value": "", "type": "path" }, { "name": "primaryUserId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } } }, { "info": { "name": "Okta Get User", "type": "http" }, "http": { "method": "GET", "url": "https://your-subdomain.okta.com/api/v1/users/:userId", "params": [ { "name": "userId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Fetches a user from your Okta organization." }, { "info": { "name": "partialUpdateUser", "type": "http" }, "http": { "method": "POST", "url": "https://your-subdomain.okta.com/api/v1/users/:userId", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "strict", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update a user's profile or credentials with partial update semantics." }, { "info": { "name": "Okta Update User", "type": "http" }, "http": { "method": "PUT", "url": "https://your-subdomain.okta.com/api/v1/users/:userId", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "strict", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update a user's profile and/or credentials using strict-update semantics." }, { "info": { "name": "Okta Delete User", "type": "http" }, "http": { "method": "DELETE", "url": "https://your-subdomain.okta.com/api/v1/users/:userId", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "sendEmail", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Deletes a user permanently. This operation can only be performed on users that have a `DEPROVISIONED` status. **This action cannot be recovered!**" }, { "info": { "name": "Okta Get Assigned App Links", "type": "http" }, "http": { "method": "GET", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/appLinks", "params": [ { "name": "userId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Fetches appLinks for all direct or indirect (via group membership) assigned applications." }, { "info": { "name": "listUserClients", "type": "http" }, "http": { "method": "GET", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/clients", "params": [ { "name": "userId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Lists all client resources for which the specified user has grants or tokens." }, { "info": { "name": "listGrantsForUserAndClient", "type": "http" }, "http": { "method": "GET", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/clients/:clientId/grants", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "clientId", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query" }, { "name": "after", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Lists all grants for a specified user and client" }, { "info": { "name": "revokeGrantsForUserAndClient", "type": "http" }, "http": { "method": "DELETE", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/clients/:clientId/grants", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "clientId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Revokes all grants for the specified user and client" }, { "info": { "name": "listRefreshTokensForUserAndClient", "type": "http" }, "http": { "method": "GET", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/clients/:clientId/tokens", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "clientId", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query" }, { "name": "after", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Lists all refresh tokens issued for the specified User and Client." }, { "info": { "name": "revokeTokensForUserAndClient", "type": "http" }, "http": { "method": "DELETE", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/clients/:clientId/tokens", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "clientId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Revokes all refresh tokens issued for the specified User and Client." }, { "info": { "name": "getRefreshTokenForUserAndClient", "type": "http" }, "http": { "method": "GET", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/clients/:clientId/tokens/:tokenId", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "clientId", "value": "", "type": "path" }, { "name": "tokenId", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "after", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets a refresh token issued for the specified User and Client." }, { "info": { "name": "revokeTokenForUserAndClient", "type": "http" }, "http": { "method": "DELETE", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/clients/:clientId/tokens/:tokenId", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "clientId", "value": "", "type": "path" }, { "name": "tokenId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Revokes the specified refresh token." }, { "info": { "name": "Okta Change Password", "type": "http" }, "http": { "method": "POST", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/credentials/change_password", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "strict", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Changes a user's password by validating the user's current password. This operation can only be performed on users in `STAGED`, `ACTIVE`, `PASSWORD_EXPIRED`, or `RECOVERY` status that have a valid password credential" }, { "info": { "name": "Okta Change Recovery Question", "type": "http" }, "http": { "method": "POST", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/credentials/change_recovery_question", "params": [ { "name": "userId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Changes a user's recovery question & answer credential by validating the user's current password. This operation can only be performed on users in **STAGED**, **ACTIVE** or **RECOVERY** `status` that have a valid password credential" }, { "info": { "name": "Okta Forgot Password", "type": "http" }, "http": { "method": "POST", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/credentials/forgot_password", "params": [ { "name": "userId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Okta Forgot Password" }, { "info": { "name": "listUserGrants", "type": "http" }, "http": { "method": "GET", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/grants", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "scopeId", "value": "", "type": "query" }, { "name": "expand", "value": "", "type": "query" }, { "name": "after", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Lists all grants for the specified user" }, { "info": { "name": "revokeUserGrants", "type": "http" }, "http": { "method": "DELETE", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/grants", "params": [ { "name": "userId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Revokes all grants for a specified user" }, { "info": { "name": "getUserGrant", "type": "http" }, "http": { "method": "GET", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/grants/:grantId", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "grantId", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets a grant for the specified user" }, { "info": { "name": "revokeUserGrant", "type": "http" }, "http": { "method": "DELETE", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/grants/:grantId", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "grantId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Revokes one grant for a specified user" }, { "info": { "name": "Okta Get Member Groups", "type": "http" }, "http": { "method": "GET", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/groups", "params": [ { "name": "userId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Fetches the groups of which the user is a member." }, { "info": { "name": "Okta Listing IdPs associated with a user", "type": "http" }, "http": { "method": "GET", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/idps", "params": [ { "name": "userId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Lists the IdPs associated with the user." }, { "info": { "name": "Okta Activate User", "type": "http" }, "http": { "method": "POST", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/lifecycle/activate", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "sendEmail", "value": "", "type": "query", "description": "Sends an activation email to the user if true" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Activates a user. This operation can only be performed on users with a `STAGED` status. Activation of a user is an asynchronous operation. The user will have the `transitioningToStatus` property with a value of `ACTIVE` during activation to indicate that the user hasn't completed the asynchronous operation. The user will have a status of `ACTIVE` when the activation process is complete." }, { "info": { "name": "Okta Deactivate User", "type": "http" }, "http": { "method": "POST", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/lifecycle/deactivate", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "sendEmail", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Deactivates a user. This operation can only be performed on users that do not have a `DEPROVISIONED` status. While the asynchronous operation (triggered by HTTP header `Prefer: respond-async`) is proceeding the user's `transitioningToStatus` property is `DEPROVISIONED`. The user's status is `DEPROVISIONED` when the deactivation process is complete." }, { "info": { "name": "Okta Expire Password", "type": "http" }, "http": { "method": "POST", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/lifecycle/expire_password?tempPassword=false", "params": [ { "name": "userId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This operation transitions the user to the status of `PASSWORD_EXPIRED` so that the user is required to change their password at their next login." }, { "info": { "name": "Okta Expire Password", "type": "http" }, "http": { "method": "POST", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/lifecycle/expire_password?tempPassword=true", "params": [ { "name": "userId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This operation transitions the user to the status of `PASSWORD_EXPIRED` and the user's password is reset to a temporary password that is returned." }, { "info": { "name": "Okta Reactivate User", "type": "http" }, "http": { "method": "POST", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/lifecycle/reactivate", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "sendEmail", "value": "", "type": "query", "description": "Sends an activation email to the user if true" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Reactivates a user. This operation can only be performed on users with a `PROVISIONED` status. This operation restarts the activation workflow if for some reason the user activation was not completed when using the activationToken from [Activate User](#activate-user)." }, { "info": { "name": "Okta Reset Factors", "type": "http" }, "http": { "method": "POST", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/lifecycle/reset_factors", "params": [ { "name": "userId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This operation resets all factors for the specified user. All MFA factor enrollments returned to the unenrolled state. The user's status remains ACTIVE. This link is present only if the user is currently enrolled in one or more MFA factors." }, { "info": { "name": "Okta Reset Password", "type": "http" }, "http": { "method": "POST", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/lifecycle/reset_password", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "sendEmail", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Generates a one-time token (OTT) that can be used to reset a user's password. The OTT link can be automatically emailed to the user or returned to the API caller and distributed using a custom flow." }, { "info": { "name": "Okta Suspend User", "type": "http" }, "http": { "method": "POST", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/lifecycle/suspend", "params": [ { "name": "userId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Suspends a user. This operation can only be performed on users with an `ACTIVE` status. The user will have a status of `SUSPENDED` when the process is complete." }, { "info": { "name": "Okta Unlock User", "type": "http" }, "http": { "method": "POST", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/lifecycle/unlock", "params": [ { "name": "userId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Unlocks a user with a `LOCKED_OUT` status and returns them to `ACTIVE` status. Users will be able to login with their current password." }, { "info": { "name": "Okta Unsuspend User", "type": "http" }, "http": { "method": "POST", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/lifecycle/unsuspend", "params": [ { "name": "userId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Unsuspends a user and returns them to the `ACTIVE` state. This operation can only be performed on users that have a `SUSPENDED` status." }, { "info": { "name": "getLinkedObjectsForUser", "type": "http" }, "http": { "method": "GET", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/linkedObjects/:relationshipName", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "relationshipName", "value": "", "type": "path" }, { "name": "after", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get linked objects for a user, relationshipName can be a primary or associated relationship name" }, { "info": { "name": "removeLinkedObjectForUser", "type": "http" }, "http": { "method": "DELETE", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/linkedObjects/:relationshipName", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "relationshipName", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete linked objects for a user, relationshipName can be ONLY a primary relationship name" }, { "info": { "name": "listAssignedRolesForUser", "type": "http" }, "http": { "method": "GET", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/roles", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Lists all roles assigned to a user." }, { "info": { "name": "assignRoleToUser", "type": "http" }, "http": { "method": "POST", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/roles", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "disableNotifications", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Assigns a role to a user." }, { "info": { "name": "getUserRole", "type": "http" }, "http": { "method": "GET", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/roles/:roleId", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "roleId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets role that is assigne to user." }, { "info": { "name": "removeRoleFromUser", "type": "http" }, "http": { "method": "DELETE", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/roles/:roleId", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "roleId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Unassigns a role from a user." }, { "info": { "name": "listApplicationTargetsForApplicationAdministratorRoleForUser", "type": "http" }, "http": { "method": "GET", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/roles/:roleId/targets/catalog/apps", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "roleId", "value": "", "type": "path" }, { "name": "after", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Lists all App targets for an `APP_ADMIN` Role assigned to a User. This methods return list may include full Applications or Instances. The response for an instance will have an `ID` value, while Application will not have an ID." }, { "info": { "name": "addAllAppsAsTargetToRole", "type": "http" }, "http": { "method": "PUT", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/roles/:roleId/targets/catalog/apps", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "roleId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Success" }, { "info": { "name": "addApplicationTargetToAdminRoleForUser", "type": "http" }, "http": { "method": "PUT", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/roles/:roleId/targets/catalog/apps/:appName", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "roleId", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Success" }, { "info": { "name": "removeApplicationTargetFromApplicationAdministratorRoleForUser", "type": "http" }, "http": { "method": "DELETE", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/roles/:roleId/targets/catalog/apps/:appName", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "roleId", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Success" }, { "info": { "name": "Okta Add App Instance Target to App Administrator Role given to a User", "type": "http" }, "http": { "method": "PUT", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/roles/:roleId/targets/catalog/apps/:appName/:applicationId", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "roleId", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" }, { "name": "applicationId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Add App Instance Target to App Administrator Role given to a User" }, { "info": { "name": "Okta Remove App Instance Target to App Administrator Role given to a User", "type": "http" }, "http": { "method": "DELETE", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/roles/:roleId/targets/catalog/apps/:appName/:applicationId", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "roleId", "value": "", "type": "path" }, { "name": "appName", "value": "", "type": "path" }, { "name": "applicationId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Remove App Instance Target to App Administrator Role given to a User" }, { "info": { "name": "listGroupTargetsForRole", "type": "http" }, "http": { "method": "GET", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/roles/:roleId/targets/groups", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "roleId", "value": "", "type": "path" }, { "name": "after", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Success" }, { "info": { "name": "addGroupTargetToRole", "type": "http" }, "http": { "method": "PUT", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/roles/:roleId/targets/groups/:groupId", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "roleId", "value": "", "type": "path" }, { "name": "groupId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Success" }, { "info": { "name": "removeGroupTargetFromRole", "type": "http" }, "http": { "method": "DELETE", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/roles/:roleId/targets/groups/:groupId", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "roleId", "value": "", "type": "path" }, { "name": "groupId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Success" }, { "info": { "name": "clearUserSessions", "type": "http" }, "http": { "method": "DELETE", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/sessions", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "oauthTokens", "value": "", "type": "query", "description": "Revoke issued OpenID Connect and OAuth refresh and access tokens" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Removes all active identity provider sessions. This forces the user to authenticate on the next operation. Optionally revokes OpenID Connect and OAuth refresh and access tokens issued to the user." }, { "info": { "name": "Okta List subscriptions of a User", "type": "http" }, "http": { "method": "GET", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/subscriptions", "params": [ { "name": "userId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "List subscriptions of a User. Only lists subscriptions for current user. An AccessDeniedException message is sent if requests are made from other users." }, { "info": { "name": "Okta Get the subscription of a User with a specific notification type", "type": "http" }, "http": { "method": "GET", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/subscriptions/:notificationType", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "notificationType", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get the subscriptions of a User with a specific notification type. Only gets subscriptions for current user. An AccessDeniedException message is sent if requests are made from other users." } ] } ], "bundled": true }