Okta integration

If you’re new to integrations in Rewst, read through our introductory integration documentation here.

Set up the Okta integration

Set up steps in Okta

  1. Log in to the Okta Admin Console. You'll need to have administrator privileges to be able to create API tokens.

  2. Navigate to Security > API in the left side menu.

  3. Click Tokens.

  4. Click Create Token.

  5. Enter a descriptive name for your token in the Create token dialog. This will help you to identify the token later.

  6. Click Create Token.

  7. The token value will be displayed in a new dialog. You will need this value to authenticate your API calls in Rewst. Make sure to copy the token value and store it in a secure location. You will not be able to view the token value again after you close the dialog box.

Set up steps in Rewst

  1. Navigate to Configuration > Integrations in the left side menu of your Rewst platform.

  2. Search for Okta in the integrations page.

  3. Click on the integration tile to launch the configuration setup page.

  4. Under Parameters:

    1. Enter the copied key value into the API Key field.

    2. Enter your hostname.

  5. Click Save Configuration.

  6. Rewst will do a quick validation of your input. Once completed, you'll see a new section beneath the configuration form for organization mapping. Complete your mapping as desired.

Actions and endpoints

For more on how actions work in Rewst, check out our introductory actions documentation here.

Category
Action
Description

Application

List Applications

Enumerates apps added to your organization with pagination. A subset of apps can be returned that match a supported filter expression or query.

Application

Create Application

Adds a new application to your Okta organization.

Application

Get Application

Fetches an application from your Okta organization by id.

Application

Update Application

Updates an application in your organization.

Application

Delete Application

Removes an inactive application.

Application

Get Default Provisioning Connection For Application

Get default Provisioning Connection for application

Application

Sets Default Provisioning Connection For Application

Set default Provisioning Connection for application

Application

Activate Default Provisioning Connection For Application

Activates the default Provisioning Connection for an application.

Application

Deactivate Default Provisioning Connection For Application

Deactivates the default Provisioning Connection for an application.

Application

List Certificate Signing Requests For Application

Enumerates Certificate Signing Requests for an application

Application

Generate Certificate Signing Request For Application

Generates a new key pair and returns the Certificate Signing Request for it.

Application

Get CSR For Application

Description coming soon...

Application

Revoke CSR From Application

Description coming soon...

Application

Publish CSR Credential

Description coming soon...

Application

List Key Credentials For Application

Enumerates key credentials for an application

Application

Generate Application Key

Generates a new X.509 certificate for an application key credential

Application

Get Key Credential For Application

Gets a specific application key credential by kid

Application

Clone Application Key Credential

Clones a X.509 certificate for an application key credential from a source application to target application.

Application

List Client Secrets

Enumerates the client's collection of secrets

Application

Create New Client Secret

Adds a new secret to the client's collection of secrets.

Application

Get Client Secret

Gets a specific client secret by secretId

Application

Delete Client Secret For Application

Removes a secret from the client's collection of secrets.

Application

Activate A Client Secret

Activates a specific client secret by secretId

Application

Deactivate A Client Secret

Deactivates a specific client secret by secretId

Application

List Features for Application

Description coming soon...

Application

Get Application Feature

Description coming soon...

Application

Updates A Feature Object For An Application

Description coming soon...

Application

List Scope Consent Grants

Lists all scope consent grants for the application

Application

Grant Consent To Scope

Grants consent for the application to request an OAuth 2.0 Okta scope

Application

Get Scope Consent Grant

Fetches a single scope consent grant for the application

Application

Revoke Scope Consent Grant

Revokes permission for the application to request the given scope

Application

List Groups Assigned To Application

Enumerates group assignments for an application.

Application

Get Assigned Group For Application

Fetches an application group assignment

Application

Assign Group To Application

Assigns a group to an application

Application

Remove Group From Application

Removes a group assignment from an application.

Application

Activate Application

Activates an inactive application.

Application

Deactivate Application

Deactivates an active application.

Application

Update Application Policy

Assign an application to a specific policy. This unassigns the application from its currently assigned policy.

Application

Previewsaml App Metadata

Previews SAML metadata based on a specific key credential for an application

Application

Listoauth Tokensforapplication

Lists all tokens for the application

Application

Revokeoauth Tokensforapplication

Revokes all tokens for the specified application

Application

Getoauth Tokenforapplication

Gets a token for the specified application

Application

Revokeoauth Tokenforapplication

Revokes the specified token for the specified application

Application

List Users Assigned To Application

Enumerates all assigned application users for an application.

Application

Assign User To Application For Sso Provisioning

Assigns an user to an application with credentials and an app-specific profile. Profile mappings defined for the application are first applied before applying any profile properties specified in the request.

Application

Get Assigned User For Application

Fetches a specific user assignment for application by id.

Application

Update Application Profile For Assigned User

Updates a user's profile for an application

Application

Remove User From Application

Removes an assignment for a user from an application.

Authenticator

List Authenticators

List Authenticators

Authenticator

Create An Authenticator

Create Authenticator

Authenticator

Get Authenticator

Description coming soon...

Authenticator

Update Authenticator

Updates an authenticator

Authenticator

Activate Authenticator

Description coming soon...

Authenticator

Deactivate Authenticator

Description coming soon...

Authorizationserver

List Authorization Servers

Description coming soon...

Authorizationserver

Create Authorization Server

Description coming soon...

Authorizationserver

Get Authorization Server

Description coming soon...

Authorizationserver

Update Authorization Server

Description coming soon...

Authorizationserver

Delete Authorization Server

Description coming soon...

Authorizationserver

List oAuth Claims

Description coming soon...

Authorizationserver

Create oAuth Claim

Description coming soon...

Authorizationserver

Get oAuth Claim

Description coming soon...

Authorizationserver

Updateoauth Claim

Description coming soon...

Authorizationserver

Deleteoauth Claim

Description coming soon...

Authorizationserver

Listoauth Clientsforauthorizationserver

Description coming soon...

Authorizationserver

List Refresh Tokens For Authorization Server And Client

Description coming soon...

Authorizationserver

Revoke Refresh Tokens For Authorization Server And Client

Description coming soon...

Authorizationserver

Get Refresh Token For Authorization Server And Client

Description coming soon...

Authorizationserver

Revoke Refresh Token For Authorization Server And Client

Description coming soon...

Authorizationserver

List Authorization Server Keys

Description coming soon...

Authorizationserver

Rotate Authorization Server Keys

Description coming soon...

Authorizationserver

Activate Authorization Server

Description coming soon...

Authorizationserver

Deactivate Authorization Server

Description coming soon...

Authorizationserver

List Authorization Server Policies

Description coming soon...

Authorizationserver

Create Authorization Server Policy

Description coming soon...

Authorizationserver

Get Authorization Server Policy

Description coming soon...

Authorizationserver

Update Authorization Server Policy

Description coming soon...

Authorizationserver

Delete Authorization Server Policy

Description coming soon...

Authorizationserver

Activate Authorization Server Policy

Description coming soon...

Authorizationserver

Deactivate Authorization Server Policy

Description coming soon...

Authorizationserver

List Authorization Server Policy Rules

Enumerates all policy rules for the specified Custom Authorization Server and Policy.

Authorizationserver

Create Authorization Server Policy Rule

Creates a policy rule for the specified Custom Authorization Server and Policy.

Authorizationserver

Get Authorization Server Policy Rule

Returns a Policy Rule by ID that is defined in the specified Custom Authorization Server and Policy.

Authorizationserver

Update Authorization Server Policy Rule

Updates the configuration of the Policy Rule defined in the specified Custom Authorization Server and Policy.

Authorizationserver

Delete Authorization Server Policy Rule

Deletes a Policy Rule defined in the specified Custom Authorization Server and Policy.

Authorizationserver

Activate Authorization Server Policy Rule

Description coming soon...

Authorizationserver

Deactivate Authorization Server Policy Rule

Description coming soon...

Authorizationserver

Listoauth Scopes

Description coming soon...

Authorizationserver

Createoauth Scope

Description coming soon...

Authorizationserver

Getoauth Scope

Description coming soon...

Authorizationserver

Updateoauth Scope

Description coming soon...

Authorizationserver

Deleteoauth Scope

Description coming soon...

Brand

List Brands

List all the brands in your org.

Brand

Get Brand

Fetches a brand by brandId

Brand

Update Brand

Updates a brand by brandId

Brand

List Email Templates

List email templates in your organization with pagination.

Brand

Get Email Template

Fetch an email template by templateName

Brand

List Email Template Customization

List all email customizations for an email template

Brand

Create Email Template Customization

Create an email customization

Brand

Delete Email Template Customization

Delete all customizations for an email template. Also known as “Reset to Default”.

Brand

Get Email Template Customization

Fetch an email customization by id.

Brand

Update Email Customization

Update an email customization

Brand

Delete Email Customization

Delete an email customization

Brand

Get Preview Content Of Email Customization

Get a preview of an email template customization.

Brand

Get Default Content Of Email Template

Fetch the default content for an email template.

Brand

Get Preview Of Email Template Default Content

Fetch a preview of an email template's default content by populating velocity references with the current user's environment.

Brand

Get Preview Of Email Template Default Content

Send a test email to the current users primary and secondary email addresses. The email content is selected based on the following priority: An email customization specifically for the users locale. The default language of email customizations. The email templates default content.

Brand

Get Brand Themes

List all the themes in your brand

Brand

Get A Theme For A Brand

Fetches a theme for a brand

Brand

Update A Theme For A Brand

Updates a theme for a brand

Brand

Updates The Background Image For Your Theme

Description coming soon...

Brand

Deletes A Theme Background Image

Description coming soon...

Brand

Updates The Favicon For Your Theme

Description coming soon...

Brand

Deletes A Theme Favicon The Org Then Uses The Okta Default Favicon

Description coming soon...

Brand

Update A Themes Logo

Updates the logo for your Theme

Brand

Deletes A Theme Logo The Org Then Uses The Okta Default Logo

Description coming soon...

Domain

List Domains

List all verified custom Domains for the org.

Domain

Create Domain

Creates your domain.

Domain

Get Domain

Fetches a Domain by id.

Domain

Delete Domain

Deletes a Domain by id.

Domain

Create Certificate

Creates the Certificate for the Domain.

Domain

Verify Domain

Verifies the Domain by id.

Eventhook

List Event Hooks

Description coming soon...

Eventhook

Create Event Hook

Description coming soon...

Eventhook

Get Event Hook

Description coming soon...

Eventhook

Update Event Hook

Description coming soon...

Eventhook

Delete Event Hook

Description coming soon...

Eventhook

Activate Event Hook

Description coming soon...

Eventhook

Deactivate Event Hook

Description coming soon...

Eventhook

Verify Event Hook

Description coming soon...

Feature

List Features

Description coming soon...

Feature

Get Feature

Description coming soon...

Feature

List Feature Dependencies

Description coming soon...

Feature

List Feature Dependents

Description coming soon...

Feature

Update Feature Lifecycle

Description coming soon...

Generic Request

Okta Generic Request

Generic action for making authenticated requests against the Okta API

Group

List Groups

Enumerates groups in your organization with pagination. A subset of groups can be returned that match a supported filter expression or query.

Group

Create Group

Adds a new group with OKTA_GROUP type to your organization.

Group

List Group Rules

Lists all group rules for your organization.

Group

Create Group Rule

Creates a group rule to dynamically add users to the specified group if they match the condition

Group

Get Group Rule

Fetches a specific group rule by id from your organization

Group

Update Group Rule

Updates a group rule. Only INACTIVE rules can be updated.

Group

Delete A Group Rule

Removes a specific group rule by id from your organization

Group

Activate A Group Rule

Activates a specific group rule by id from your organization

Group

Deactivate A Group Rule

Deactivates a specific group rule by id from your organization

Group

Get Group

Fetches a group from your organization.

Group

Update Group

Updates the profile for a group with OKTA_GROUP type from your organization.

Group

Remove Group

Removes a group with OKTA_GROUP type from your organization.

Group

List Assigned Applications

Enumerates all applications that are assigned to a group.

Group

List Group Assigned Roles

Description coming soon...

Group

Assign Role To Group

Assigns a Role to a Group

Group

Get Role

Description coming soon...

Group

Remove Role From Group

Unassigns a Role from a Group

Group

List Application Targets For Application Administrator Role For Group

Lists all App targets for an APP_ADMIN Role assigned to a Group. 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.

Group

Create Application Target To Admin Role Given To Group

Description coming soon...

Group

Remove Application Target From Application Administrator Role Given To Group

Description coming soon...

Group

Create App Instance Target To App Administrator Role Given To A Group

Description coming soon...

Group

Remove App Instance Target To App Administrator Role Given To A Group

Description coming soon...

Group

List Group Targets For Group Role

Description coming soon...

Group

Add Group Target To Group Administrator Role For Group

Group

Remove Group Target From Group Administrator Role Given To Group

Group

List Group Members

Enumerates all users that are a member of a group.

Group

Add User To Group

Adds a user to a group with 'OKTA_GROUP' type.

Group

Remove User From Group

Removes a user from a group with 'OKTA_GROUP' type.

Groupschema

Get Default Group Schema

Description coming soon...

Groupschema

Update Default Group Schema

Description coming soon...

Identityprovider

List Identity Providers

Enumerates IdPs in your organization with pagination. A subset of IdPs can be returned that match a supported filter expression or query.

Identityprovider

Create Identity Provider

Adds a new IdP to your organization.

Identityprovider

List Keys

Enumerates IdP key credentials.

Identityprovider

Create X 509 Certificate Public Key

Adds a new X.509 certificate credential to the IdP key store.

Identityprovider

Get Key

Gets a specific IdP Key Credential by kid

Identityprovider

Delete Key

Deletes a specific IdP Key Credential by kid if it is not currently being used by an Active or Inactive IdP.

Identityprovider

Get Identity Provider

Fetches an IdP by id.

Identityprovider

Update Identity Provider

Updates the configuration for an IdP.

Identityprovider

Delete Identity Provider

Removes an IdP from your organization.

Identityprovider

List Certificate Signing Requests For IDP

Enumerates Certificate Signing Requests for an IdP

Identityprovider

Generate Certificate Signing Request For IDP

Generates a new key pair and returns a Certificate Signing Request for it.

Identityprovider

Get CSR For Identity Provider

Gets a specific Certificate Signing Request model by id

Identityprovider

Revoke CSR For Identity Provider

Revoke a Certificate Signing Request and delete the key pair from the IdP

Identityprovider

Update CSR

Update the Certificate Signing Request with a signed X.509 certificate and add it into the signing key credentials for the IdP.

Identityprovider

List Signing Key Credentials For IDP

Enumerates signing key credentials for an IdP

Identityprovider

Generate New IDP Signing Key Credential

Generates a new X.509 certificate for an IdP signing key credential to be used for signing assertions sent to the IdP

Identityprovider

Get Signing Key Credential For IDP

Gets a specific IdP Key Credential by kid

Identityprovider

Clone Signing Key Credential For IDP

Clones a X.509 certificate for an IdP signing key credential from a source IdP to target IdP

Identityprovider

Activate Identity Provider

Activates an inactive IdP.

Identityprovider

Deactivate Identity Provider

Deactivates an active IdP.

Identityprovider

Find Users

Find all the users linked to an identity provider

Identityprovider

Get Identity Provider Application User

Fetches a linked IdP user by ID

Identityprovider

Link A User To A Social IDP Without A Transaction

Links an Okta user to an existing Social Identity Provider. This does not support the SAML2 Identity Provider Type

Identityprovider

Unlink User From IDP

Removes the link between the Okta user and the IdP user.

Identityprovider

Social Authentication Token Operation

Fetches the tokens minted by the Social Authentication Provider when the user authenticates with Okta via Social Auth.

Inlinehook

List Inline Hooks

Description coming soon...

Inlinehook

Create Inline Hook

Description coming soon...

Inlinehook

Get Inline Hook

Gets an inline hook by ID

Inlinehook

Update Inline Hook

Updates an inline hook by ID

Inlinehook

Delete Inline Hook

Deletes the Inline Hook matching the provided id. Once deleted, the Inline Hook is unrecoverable. As a safety precaution, only Inline Hooks with a status of INACTIVE are eligible for deletion.

Inlinehook

Execute Inline Hook

Executes the Inline Hook matching the provided inlineHookId using the request body as the input. This will send the provided data through the Channel and return a response if it matches the correct data contract. This execution endpoint should only be used for testing purposes.

Inlinehook

Activate Inline Hook

Activates the Inline Hook matching the provided id

Inlinehook

Deactivate Inline Hook

Deactivates the Inline Hook matching the provided id

Linkedobject

List Linked Object Definitions

Description coming soon...

Linkedobject

Create Linked Object Definition

Description coming soon...

Linkedobject

Get Linked Object Definition

Description coming soon...

Linkedobject

Delete Linked Object Definition

Description coming soon...

Log

Get Org System Log

The Okta System Log API provides read access to your organization’s system log. This API provides more functionality than the Events API

Networkzone

List Network Zones

Enumerates network zones added to your organization with pagination. A subset of zones can be returned that match a supported filter expression or query.

Networkzone

Create Network Zone

Adds a new network zone to your Okta organization.

Networkzone

Get Network Zone

Fetches a network zone from your Okta organization by id.

Networkzone

Update Network Zone

Updates a network zone in your organization.

Networkzone

Delete Network Zone

Removes network zone.

Networkzone

Activate Network Zone

Description coming soon...

Networkzone

Deactivate Network Zone

Deactivates a network zone.

Org

Get Org Settings

Get settings of your organization.

Org

Update Org Setting

Update settings of your organization.

Org

Partial Update Org Setting

Partial update settings of your organization.

Org

Get Org Contact Types

Gets Contact Types of your organization.

Org

Get Org Contact User

Retrieves the URL of the User associated with the specified Contact Type.

Org

Update Org Contact User

Updates the User associated with the specified Contact Type.

Org

Get Org Preferences

Gets preferences of your organization.

Org

Get Okta Support Settings

Gets Okta Support Settings of your organization.

Org

Extend Okta Support

Extends the length of time that Okta Support can access your org by 24 hours. This means that 24 hours are added to the remaining access time.

Org

Grant Okta Support

Enables you to temporarily allow Okta Support to access your org as an administrator for eight hours.

Org

Extend Okta Support

Revokes Okta Support access to your organization.

Policy

List Policies

Gets all policies with the specified type.

Policy

Create Policy

Creates a policy.

Policy

Get Policy

Gets a policy.

Policy

Update Policy

Updates a policy.

Policy

Delete Policy

Removes a policy.

Policy

Activate Policy

Activates a policy.

Policy

Deactivate Policy

Deactivates a policy.

Policy

List Policy Rules

Enumerates all policy rules.

Policy

Create Policy Rule

Creates a policy rule.

Policy

Get Policy Rule

Gets a policy rule.

Policy

Update Policy Rule

Updates a policy rule.

Policy

Delete Policy Rule

Removes a policy rule.

Policy

Activate Policy Rule

Activates a policy rule.

Policy

Deactivate Policy Rule

Deactivates a policy rule.

Profilemapping

List Profile Mappings

Enumerates Profile Mappings in your organization with pagination.

Profilemapping

Get Profile Mapping

Fetches a single Profile Mapping referenced by its ID.

Profilemapping

Update Profile Mapping

Updates an existing Profile Mapping by adding, updating, or removing one or many Property Mappings.

Subscription

List All Subscriptions Of A Custom Role

When roleType List all subscriptions of a Role. Else when roleId List subscriptions of a Custom Role

Subscription

Get Subscriptions Of A Custom Role By Specific Notification Type

When roleType Get subscriptions of a Role with a specific notification type. Else when roleId Get subscription of a Custom Role with a specific notification type.

Subscription

Subscribe A Custom Role To A Specific Notification Type

When roleType Subscribes a Role to a specific notification type. When you change the subscription status of a Role, it overrides the subscription of any individual user of that Role. Else when roleId Subscribes a Custom Role to a specific notification type. When you change the subscription status of a Custom Role, it overrides the subscription of any individual user of that Custom Role.

Subscription

Unsubscribe A Custom Role From A Specific Notification Type

When roleType Unsubscribes a Role from a specific notification type. When you change the subscription status of a Role, it overrides the subscription of any individual user of that Role. Else when roleId Unsubscribes a Custom Role from a specific notification type. When you change the subscription status of a Custom Role, it overrides the subscription of any individual user of that Custom Role.

Subscription

Subscribe To A Specific Notification Type

Subscribes a User to a specific notification type. Only the current User can subscribe to a specific notification type. An AccessDeniedException message is sent if requests are made from other users.

Subscription

Unsubscribe From A Specific Notification Type

Unsubscribes a User from a specific notification type. Only the current User can unsubscribe from a specific notification type. An AccessDeniedException message is sent if requests are made from other users.

Template

List SMS Templates

Enumerates custom SMS templates in your organization. A subset of templates can be returned that match a template type.

Template

Create SMS Template

Adds a new custom SMS template to your organization.

Template

Get SMS Template

Fetches a specific template by id

Template

Update SMS Template

Updates the SMS template.

Template

Partial SMS Template Update

Updates only some of the SMS template properties:

Template

Remove SMS Template

Removes an SMS template.

Threatinsight

Get Current ThreatInsight Configuration

Description coming soon...

Threatinsight

Update ThreatInsight Configuration

Description coming soon...

Trustedorigin

List Trusted Origins

Description coming soon...

Trustedorigin

Create Trusted Origin

Description coming soon...

Trustedorigin

Get Trusted Origin

Description coming soon...

Trustedorigin

Update Trusted Origin

Description coming soon...

Trustedorigin

Delete Trusted Origin

Description coming soon...

Trustedorigin

Activate Origin

Description coming soon...

Trustedorigin

Deactivate Trusted Origin

Description coming soon...

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.

User

Create User

Creates a new user in your Okta organization with or without credentials.

User

Set Linked Object For User

Description coming soon...

User

Get User

Fetches a user from your Okta organization.

User

Update User

Update a user's profile and/or credentials using strict-update semantics.

User

Partial Update User

Update a user's profile or credentials with partial update semantics.

User

Delete User

Deletes a user permanently. This operation can only be performed on users that have a DEPROVISIONED status. This action cannot be recovered!

User

Get Assigned App Links

Fetches appLinks for all direct or indirect (via group membership) assigned applications.

User

List User Clients

Lists all client resources for which the specified user has grants or tokens.

User

List Grants For User And Client

Lists all grants for a specified user and client

User

Revoke Grants For User And Client

Revokes all grants for the specified user and client

User

List Refresh Tokens For User And Client

Lists all refresh tokens issued for the specified User and Client.

User

Revoke Tokens For User And Client

Revokes all refresh tokens issued for the specified User and Client.

User

Get Refresh Token For User And Client

Gets a refresh token issued for the specified User and Client.

User

Revoke Token For User And Client

Revokes the specified refresh token.

User

Change Password

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

User

Change Recovery Question

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

User

Forgot Password

Description coming soon...

User

List User Grants

Lists all grants for the specified user

User

Revoke User Grants

Revokes all grants for a specified user

User

Get User Grant

Gets a grant for the specified user

User

Revoke User Grant

Revokes one grant for a specified user

User

Get Member Groups

Fetches the groups of which the user is a member.

User

Listing IDPs for User

Lists the IdPs associated with the user.

User

Activate User

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.

User

Deactivate User

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.

User

Expire Password

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.

User

Reactivate User

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.

User

Reset Factors

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.

User

Reset Password

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.

User

Suspend User

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.

User

Unlock User

Unlocks a user with a LOCKED_OUT status and returns them to ACTIVE status. Users will be able to login with their current password.

User

Unsuspend User

Unsuspends a user and returns them to the ACTIVE state. This operation can only be performed on users that have a SUSPENDED status.

User

Get Linked Objects For User

Get linked objects for a user, relationshipName can be a primary or associated relationship name

User

Remove Linked Object For User

Delete linked objects for a user, relationshipName can be ONLY a primary relationship name

User

List Assigned Roles For User

Lists all roles assigned to a user.

User

Assign Role To User

Assigns a role to a user.

User

Get User Role

Gets role that is assigne to user.

User

Remove Role From User

Unassigns a role from a user.

User

List Application Targets For Application Administrator Role For User

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.

User

Add All Apps As Target To Role

Description coming soon...

User

Add Application Target To Admin Role For User

Description coming soon...

User

Remove Application Target From Application Administrator Role For User

Description coming soon...

User

Add App Instance Target To App Administrator Role Given To A User

Description coming soon...

User

Remove App Instance Target To App Administrator Role Given To A User

Description coming soon...

User

List Group Targets For Role

Description coming soon...

User

Add Group Target To Role

Description coming soon...

User

Remove Group Target From Role

Description coming soon...

User

Clear User Sessions

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.

User

List Subscriptions Of A User

List subscriptions of a User. Only lists subscriptions for current user. An AccessDeniedException message is sent if requests are made from other users.

User

Get The Subscription Of A User With A Specific Notification Type

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.

Userfactor

List Factors

Enumerates all the enrolled factors for the specified user

Userfactor

Enroll Factor

Enrolls a user with a supported factor.

Userfactor

List Supported Factors

Enumerates all the supported factors that can be enrolled for the specified user

Userfactor

List Supported Security Questions

Enumerate security questions for a user's question factor

Userfactor

Get Factor

Fetches a factor for the specified user

Userfactor

Delete Factor

Unenrolls an existing factor for the specified user, allowing the user to enroll a new factor.

Userfactor

Activate Factor

The sms and token:software:totp factor types require activation to complete the enrollment process.

Userfactor

Get Factor Transaction Status

Polls factors verification transaction for status.

Userfactor

Verify MFA Factor

Verifies an OTP for a token or token:hardware factor

Userschema

Get Application Default User Schema

Description coming soon...

Userschema

Update Application User Profile

Description coming soon...

Userschema

Get Schema For User

Description coming soon...

Userschema

Update User Profile

Partial updates on the User Profile properties of the user schema.

Usertype

List User Types

Fetches all User Types in your org

Usertype

Create User Type

Creates a new User Type. A default User Type is automatically created along with your org, and you may add another 9 User Types for a maximum of 10.

Usertype

Get User Type

Fetches a User Type by ID. The special identifier default may be used to fetch the default User Type.

Usertype

Replace User Type

Replace an existing User Type

Usertype

Update User Type

Updates an existing User Type

Usertype

Delete User Type

Deletes a User Type permanently. This operation is not permitted for the default type, nor for any User Type that has existing users

Last updated

Was this helpful?