Connectors
Identity & Access Management
Okta
Identity management: users, groups, applications, and lifecycle operations
Okta API referenceAPI checked August 16, 2026
- Signs in with
- Connection fields
- Runs on
- Cloud or On-Prem Worker
- Operations
- 734
- Ready-made triggers
- 0
Connect Okta
- In Neblex open Connect › Connections and click New Connection.
- Search for Okta and give the connection a clear name.
- Fill in the fields. Secret values are encrypted and never shown again.
- Click Test, then Create Connection.
| Field | What to enter |
|---|---|
| Okta domainOptional | Full Okta, Okta Preview, or custom domain without a scheme or path.Example: example.okta.com |
| Legacy okta.com subdomainOptional | Backward-compatible fallback used only when Okta domain is empty.Example: example |
| Scoped OAuth 2.0 access tokenOptionalSecret | Recommended for least privilege. |
| SSWS API tokenOptionalSecret | Legacy administrator API token for operations that allow apiToken. |
Use it in a flow
- Open a flow, open the node library and search for Okta.
- Drag it onto the canvas and choose an Operation and your connection.
- Map the operation's fields from earlier steps, or click Map with Matt.
- Use Test this step to see what it returns, then save.
To start a flow from Okta without a ready-made trigger: a Poll for changes trigger can check one of its list operations on a schedule and pass on only what is new; if Okta can send webhooks, a Webhook trigger receives them at its own URL.
Operations
734 operations in 121 groups. Each one is a step you can add to a flow.
AgentPool14
Activate an agent pool updateactivateAgentPoolsUpdate | POST | Activates a scheduled agent pool update |
Create an agent pool updatecreateAgentPoolsUpdate | POST | Creates an agent pool update |
Deactivate an agent pool updatedeactivateAgentPoolsUpdate | POST | Deactivates scheduled agent pool update |
Delete an agent pool updatedeleteAgentPoolsUpdate | DELETE | Deletes agent pool update |
List all agent pool updateslistAgentPoolsUpdates | GET | Lists all agent pool updates |
List all agent poolslistAgentPools | GET | Lists all agent pools with pagination support |
Pause an agent pool updatepauseAgentPoolsUpdate | POST | Pauses a running or queued agent pool update |
Resume an agent pool updateresumeAgentPoolsUpdate | POST | Resumes a running or queued agent pool update |
Retrieve an agent pool update by IDgetAgentPoolsUpdateInstance | GET | Retrieves an agent pool update by its updateId |
Retrieve an agent pool update's settingsgetAgentPoolsUpdateSettings | GET | Retrieves the current state of the agent pool update instance settings |
Retry an agent pool updateretryAgentPoolsUpdate | POST | Retries an agent pool update if the update is unsuccessful or communication with Okta was interrupted during an agent auto-update |
Stop an agent pool updatestopAgentPoolsUpdate | POST | Stops an agent pool update |
Update an agent pool update by IDupdateAgentPoolsUpdate | POST | Updates an agent pool update instance and returns the latest agent pool update |
Update an agent pool update settingsupdateAgentPoolsUpdateSettings | POST | Updates an agent pool update instance settings |
ApiServiceIntegration9
Activate an API service integration instance secretactivateApiServiceIntegrationInstanceSecret | POST | Activates an API Service Integration instance Secret by secretId |
Create an API service integration instancecreateApiServiceIntegrationInstance | POST | Creates and authorizes an API Service Integration instance |
Create an API service integration instance secretcreateApiServiceIntegrationInstanceSecret | POST | Creates an API Service Integration instance Secret object with a new active client secret. |
Deactivate an API service integration instance secretdeactivateApiServiceIntegrationInstanceSecret | POST | Deactivates an API Service Integration instance Secret by secretId |
Delete an API service integration instancedeleteApiServiceIntegrationInstance | DELETE | Deletes an API Service Integration instance by id. |
Delete an API service integration instance secretdeleteApiServiceIntegrationInstanceSecret | DELETE | Deletes an API Service Integration instance Secret by secretId. |
List all API service integration instance secretslistApiServiceIntegrationInstanceSecrets | GET | Lists all client secrets for an API Service Integration instance by apiServiceId |
List all API service integration instanceslistApiServiceIntegrationInstances | GET | Lists all API Service Integration instances with a pagination option |
Retrieve an API service integration instancegetApiServiceIntegrationInstance | GET | Retrieves an API Service Integration instance by id |
ApiToken5
List all API token metadatalistApiTokens | GET | Lists all the metadata of the active API tokens |
Retrieve an API token's metadatagetApiToken | GET | Retrieves the metadata for an active API token by apiTokenId |
Revoke an API tokenrevokeApiToken | DELETE | Revokes an API token by apiTokenId |
Revoke the current API tokenrevokeCurrentApiToken | DELETE | Revokes the API token provided in the Authorization header |
Upsert an API token network conditionupsertApiToken | PUT | Upserts an API Token Network Condition by apiTokenId |
Application7
Activate an applicationactivateApplication | POST | Activates an inactive application |
Create an applicationcreateApplication | POST | Creates an app instance in your Okta org. |
Deactivate an applicationdeactivateApplication | POST | Deactivates an active application |
Delete an applicationdeleteApplication | DELETE | Deletes an inactive application |
List all applicationslistApplications | GET | Lists all apps in the org with pagination. |
Replace an applicationreplaceApplication | PUT | Replaces properties for an application Notes: All required properties must be specified in the request body You can't modify system-assigned properties, such as id, name, status, created,... |
Retrieve an applicationgetApplication | GET | Retrieves an application from your Okta organization by id |
ApplicationConnection6
Activate the default provisioning connectionactivateDefaultProvisioningConnectionForApplication | POST | Activates the default provisioning connection for an app |
Deactivate the default provisioning connectiondeactivateDefaultProvisioningConnectionForApplication | POST | Deactivates the default provisioning connection for an app |
Retrieve a JSON Web Key Set (JWKS) for the default provisioninggetUserProvisioningConnectionJWKS | GET | Retrieves a JWKS for the default provisioning connection. |
Retrieve the default provisioning connectiongetDefaultProvisioningConnectionForApplication | GET | Retrieves the default provisioning connection for an app |
Update the default provisioning connectionupdateDefaultProvisioningConnectionForApplication | POST | Updates the default provisioning connection for an app |
Verify the provisioning connectionverifyProvisioningConnectionForApplication | POST | Verifies the OAuth 2.0-based connection as part of the OAuth 2.0 consent flow. |
ApplicationCrossAppAccessConnection5
Create a Cross App Access connectioncreateCrossAppAccessConnection | POST | Creates a Cross App Access connection |
Delete a Cross App Access connectiondeleteCrossAppAccessConnection | DELETE | Deletes a Cross App Access connection with the specified ID |
Retrieve a Cross App Access connectiongetCrossAppAccessConnection | GET | Retrieves the Cross App Access connection with the specified ID |
Retrieve all Cross App Access connectionsgetAllCrossAppAccessConnections | GET | Retrieves inbound and outbound Cross App Access connections associated with an app |
Update a Cross App Access connectionupdateCrossAppAccessConnection | PATCH | Updates the Cross App Access connection with the specified ID |
ApplicationFeature3
List all featureslistFeaturesForApplication | GET | Lists all features for an app Note: This request returns an error if provisioning isn't enabled for the app. |
Retrieve a featuregetFeatureForApplication | GET | Retrieves a Feature object for an app |
Update a featureupdateFeatureForApplication | PUT | Updates a Feature object for an app Note: This endpoint supports partial updates. |
ApplicationGrant4
Grant consent to scopegrantConsentToScope | POST | Grants consent for the app to request an OAuth 2.0 Okta scope |
List all app grantslistScopeConsentGrants | GET | Lists all scope consent Grants for the app |
Retrieve an app grantgetScopeConsentGrant | GET | Retrieves a single scope consent Grant object for the app |
Revoke an app grantrevokeScopeConsentGrant | DELETE | Revokes permission for the app to grant the given scope |
ApplicationGroup5
Assign an application groupassignGroupToApplication | PUT | Assigns a Group to an app, which in turn assigns the app to each User that belongs to the group. |
List all application groupslistApplicationGroupAssignments | GET | Lists all app group assignments |
Retrieve an application groupgetApplicationGroupAssignment | GET | Retrieves an app group assignment |
Unassign an application groupunassignApplicationFromGroup | DELETE | Unassigns a Group from an app |
Update an application groupupdateGroupAssignmentToApplication | PATCH | Updates a group assignment to an app |
ApplicationInterclientTrustMapping4
Create an allowed app mapping for a target appcreateInterclientTrustMapping | POST | Creates a mapping between the target app and an allowed app for interclient SSO using the interclient token |
Delete an interclient trust mappingdeleteInterclientTrustMapping | DELETE | Deletes the mapping between the target app and an allowed app |
List all allowed apps for a target applistInterclientAllowedApplications | GET | Lists all apps allowed by this app to request interclient SSO using the interclient token |
List all target apps for an allowed applistInterclientTargetApplications | GET | Lists all the target apps that allow this app to request interclient SSO using an interclient token |
ApplicationLogo1
Upload an application logouploadApplicationLogo | POST | Uploads a logo for the app instance. |
ApplicationPolicy1
Assign an app sign-in policyassignApplicationPolicy | PUT | Assigns an app to an app sign-in policy, identified by policyId. |
ApplicationSSO1
Preview the application SAML metadatapreviewSAMLmetadataForApplication | GET | Previews the SSO SAML metadata for an application |
ApplicationSSOCredentialKey9
Clone a key credentialcloneApplicationKey | POST | Clones an X.509 certificate for an application key credential from a source app to a target app. |
Generate a certificate signing requestgenerateCsrForApplication | POST | Generates a new key pair and returns the certificate signing request (CSR) for it. |
Generate a key credentialgenerateApplicationKey | POST | Generates a new X.509 certificate for an app key credential Note: To update an app with the newly generated key credential, use the Replace an Application request with the new... |
List all certificate signing requestslistCsrsForApplication | GET | Lists all certificate signing requests for an app |
List all key credentialslistApplicationKeys | GET | Lists all key credentials for an app |
Publish a certificate signing requestpublishCsrFromApplication | POST | Publishes a certificate signing request (CSR) for the app with a signed X.509 certificate and adds it into the application key credentials. |
Retrieve a certificate signing requestgetCsrForApplication | GET | Retrieves a certificate signing request (CSR) for the app by csrId. |
Retrieve a key credentialgetApplicationKey | GET | Retrieves a specific application key credential by kid |
Revoke a certificate signing requestrevokeCsrFromApplication | DELETE | Revokes a certificate signing request and deletes the key pair from the app |
ApplicationSSOFederatedClaim5
Create a federated claimcreateFederatedClaim | POST | Creates a claim that will be included in tokens produced by federation protocols (for example: OIDC id tokens or SAML Assertions) |
Delete a federated claimdeleteFederatedClaim | DELETE | Deletes a federated claim by claimId |
List all configured federated claimslistFederatedClaims | GET | Lists all federated claims for your app |
Replace a federated claimreplaceFederatedClaim | PUT | Replaces a claim that will be included in tokens produced by federation protocols (for example: OIDC id tokens or SAML Assertions) |
Retrieve a federated claimgetFederatedClaim | GET | Retrieves a federated claim by claimId |
ApplicationSSOPublicKey12
Activate an OAuth 2.0 client JSON Web KeyactivateOAuth2ClientJsonWebKey | POST | Activates an OAuth 2.0 client JSON Web Key by keyId Note: You can have only one active encryption key at any given time for an app. |
Activate an OAuth 2.0 client secretactivateOAuth2ClientSecret | POST | Activates an OAuth 2.0 client secret by secretId |
Add a JSON Web KeyaddJwk | POST | Adds a new JSON Web Key to the clients JSON Web Keys. |
Create an OAuth 2.0 client secretcreateOAuth2ClientSecret | POST | Creates an OAuth 2.0 client secret object with a new active client secret. |
Deactivate an OAuth 2.0 client JSON Web KeydeactivateOAuth2ClientJsonWebKey | POST | Deactivates an OAuth 2.0 client JSON Web Key by keyId Note: You can only deactivate signing keys. |
Deactivate an OAuth 2.0 client secretdeactivateOAuth2ClientSecret | POST | Deactivates an OAuth 2.0 client secret by secretId. |
Delete an OAuth 2.0 client JSON Web Keydeletejwk | DELETE | Deletes an OAuth 2.0 Client JSON Web Key by keyId. |
Delete an OAuth 2.0 client secretdeleteOAuth2ClientSecret | DELETE | Deletes an OAuth 2.0 client secret by secretId. |
List all OAuth 2.0 client secretslistOAuth2ClientSecrets | GET | Lists all client secrets for an OAuth 2.0 client app |
List all the OAuth 2.0 client JSON Web KeyslistJwk | GET | Lists all JSON Web Keys for an OAuth 2.0 client app |
Retrieve an OAuth 2.0 client JSON Web KeygetJwk | GET | Retrieves an OAuth 2.0 client JSON Web Key by keyId |
Retrieve an OAuth 2.0 client secretgetOAuth2ClientSecret | GET | Retrieves an OAuth 2.0 client secrets by secretId |
ApplicationToken4
List all application refresh tokenslistOAuth2TokensForApplication | GET | Lists all refresh tokens for an app |
Retrieve an application tokengetOAuth2TokenForApplication | GET | Retrieves a refresh token for the specified app |
Revoke all application tokensrevokeOAuth2TokensForApplication | DELETE | Revokes all OAuth 2.0 refresh tokens for the specified app. |
Revoke an application tokenrevokeOAuth2TokenForApplication | DELETE | Revokes the specified token for the specified app |
ApplicationUser5
Assign an application userassignUserToApplication | POST | Assigns a user to an app for: |
List all application userslistApplicationUsers | GET | Lists all assigned users for an app |
Retrieve an application usergetApplicationUser | GET | Retrieves a specific user assignment for a specific app |
Unassign an application userunassignUserFromApplication | DELETE | Unassigns a user from an app |
Update an application userupdateApplicationUser | POST | Updates the profile or credentials of a user assigned to an app |
AssociatedDomainCustomization7
Replace the customized well-known URI of the specific pathreplaceBrandWellKnownURI | PUT | Replaces the content of a customized well-known URI that you specify. |
Retrieve all the well-known URIsgetAllWellKnownURIs | GET | Retrieves the content from each of the well-known URIs for a specified brand |
Retrieve the customized apple-app-site-association URI contentgetAppleAppSiteAssociationWellKnownURI | GET | Retrieves the content of the apple-app-site-assocation well-known URI |
Retrieve the customized assetlinks.json URI contentgetAssetLinksWellKnownURI | GET | Retrieves the content of the assetlinks.json well-known URI |
Retrieve the customized content of the specified well-known URIgetBrandWellKnownURI | GET | Retrieves the customized content of a well-known URI for a specific brand and well-known URI path |
Retrieve the customized webauthn URI contentgetWebAuthnWellKnownURI | GET | Retrieves the content of the webauthn well-known URI |
Retrieve the well-known URI of a specific brandgetRootBrandWellKnownURI | GET | Retrieves the well-known URI of a specific brand and well-known URI path |
AttackProtection4
Replace the authenticator settingsreplaceAuthenticatorSettings | PUT | Replaces the Authenticator Settings for an org |
Replace the user lockout settingsreplaceUserLockoutSettings | PUT | Replaces the User Lockout Settings for an org |
Retrieve the authenticator settingsgetAuthenticatorSettings | GET | Retrieves the Authenticator Settings for an org |
Retrieve the user lockout settingsgetUserLockoutSettings | GET | Retrieves the User Lockout Settings for an org |
Authenticator19
Activate an authenticatoractivateAuthenticator | POST | Activates an authenticator by authenticatorId |
Activate an authenticator methodactivateAuthenticatorMethod | POST | Activates a method for an authenticator identified by authenticatorId and methodType |
Create a custom AAGUIDcreateCustomAAGUID | POST | Creates a custom AAGUID for the Passkey (FIDO2 WebAuthn) authenticator |
Create an authenticatorcreateAuthenticator | POST | Creates an authenticator |
Deactivate an authenticatordeactivateAuthenticator | POST | Deactivates an authenticator by authenticatorId |
Deactivate an authenticator methoddeactivateAuthenticatorMethod | POST | Deactivates a method for an authenticator identified by authenticatorId and methodType |
Delete a custom AAGUIDdeleteCustomAAGUID | DELETE | Deletes a custom AAGUID |
List all authenticatorslistAuthenticators | GET | Lists all authenticators |
List all custom AAGUIDslistAllCustomAAGUIDs | GET | Lists all custom Authenticator Attestation Global Unique Identifiers (AAGUIDs) in the org |
List all methods of an authenticatorlistAuthenticatorMethods | GET | Lists all methods of an authenticator identified by authenticatorId |
Replace a custom AAGUIDreplaceCustomAAGUID | PUT | Replaces a custom AAGUID for the specified Passkey (FIDO2 WebAuthn) authenticator |
Replace an authenticatorreplaceAuthenticator | PUT | Replaces the properties for an authenticator identified by authenticatorId |
Replace an authenticator methodreplaceAuthenticatorMethod | PUT | Replaces a method of methodType for an authenticator identified by authenticatorId |
Retrieve a custom AAGUIDgetCustomAAGUID | GET | Retrieves a custom AAGUID |
Retrieve an authenticatorgetAuthenticator | GET | Retrieves an authenticator from your Okta organization by authenticatorId |
Retrieve an authenticator methodgetAuthenticatorMethod | GET | Retrieves a method identified by methodType of an authenticator identified by authenticatorId |
Retrieve the well-known app authenticator configurationgetWellKnownAppAuthenticatorConfiguration | GET | Retrieves the well-known app authenticator configuration. |
Update a custom AAGUIDupdateCustomAAGUID | PATCH | Updates the properties of a custom AAGUID by the authenticatorId and aaguid ID |
Verify a Relying Party ID domainverifyRpIdDomain | POST | Verifies the Relying Party identifier (RP ID) domain for the specified Passkey (FIDO2 WebAuthn) authenticator and the specific webauthn authenticator method |
AuthorizationServer7
Activate an authorization serveractivateAuthorizationServer | POST | Activates an authorization server |
Create an authorization servercreateAuthorizationServer | POST | Creates an authorization server |
Deactivate an authorization serverdeactivateAuthorizationServer | POST | Deactivates an authorization server |
Delete an authorization serverdeleteAuthorizationServer | DELETE | Deletes an authorization server |
List all authorization serverslistAuthorizationServers | GET | Lists all custom authorization servers in the org |
Replace an authorization serverreplaceAuthorizationServer | PUT | Replaces an authorization server |
Retrieve an authorization servergetAuthorizationServer | GET | Retrieves an authorization server |
AuthorizationServerAssoc3
Create an associated authorization servercreateAssociatedServers | POST | Creates trusted relationships between the given authorization server and other authorization servers |
Delete an associated authorization serverdeleteAssociatedServer | DELETE | Deletes an associated Authorization Server |
List all associated authorization serverslistAssociatedServersByTrustedType | GET | Lists all associated Authorization Servers by trusted type for the given authServerId |
AuthorizationServerClaim5
Create a custom token claimcreateOAuth2Claim | POST | Creates a custom token Claim for a custom authorization server |
Delete a custom token claimdeleteOAuth2Claim | DELETE | Deletes a custom token Claim specified by the claimId |
List all custom token claimslistOAuth2Claims | GET | Lists all custom token Claims defined for a specified custom authorization server |
Replace a custom token claimreplaceOAuth2Claim | PUT | Replaces a custom token Claim specified by the claimId |
Retrieve a custom token claimgetOAuth2Claim | GET | Retrieves a custom token Claim by the specified claimId |
AuthorizationServerClient5
List all client resources for an authorization serverlistOAuth2ClientsForAuthorizationServer | GET | Lists all client resources for which the specified authorization server has tokens. |
List all refresh tokens for a clientlistRefreshTokensForAuthorizationServerAndClient | GET | Lists all refresh tokens issued by an authorization server for a specific Client |
Retrieve a refresh token for a clientgetRefreshTokenForAuthorizationServerAndClient | GET | Retrieves a refresh token for a Client |
Revoke a refresh token for a clientrevokeRefreshTokenForAuthorizationServerAndClient | DELETE | Revokes a refresh token for a Client |
Revoke all refresh tokens for a clientrevokeRefreshTokensForAuthorizationServerAndClient | DELETE | Revokes all refresh tokens for a Client |
AuthorizationServerKey3
List all credential keyslistAuthorizationServerKeys | GET | Lists all of the current, future, and expired Keys used by the Custom Authorization Server |
Retrieve an authorization server keygetAuthorizationServerKey | GET | Retrieves an Authorization Server Key specified by the keyId |
Rotate all credential keysrotateAuthorizationServerKeys | POST | Rotates the current Keys for a Custom Authorization Server. |
AuthorizationServerPolicy7
Activate a policyactivateAuthorizationServerPolicy | POST | Activates an authorization server policy |
Create a policycreateAuthorizationServerPolicy | POST | Creates a policy |
Deactivate a policydeactivateAuthorizationServerPolicy | POST | Deactivates an authorization server policy |
Delete a policydeleteAuthorizationServerPolicy | DELETE | Deletes a policy |
List all policieslistAuthorizationServerPolicies | GET | Lists all policies |
Replace a policyreplaceAuthorizationServerPolicy | PUT | Replaces a policy |
Retrieve a policygetAuthorizationServerPolicy | GET | Retrieves a policy |
AuthorizationServerRule7
Activate a policy ruleactivateAuthorizationServerPolicyRule | POST | Activates an authorization server policy rule |
Create a policy rulecreateAuthorizationServerPolicyRule | POST | Creates a policy rule for the specified Custom Authorization Server and Policy |
Deactivate a policy ruledeactivateAuthorizationServerPolicyRule | POST | Deactivates an authorization server policy rule |
Delete a policy ruledeleteAuthorizationServerPolicyRule | DELETE | Deletes a Policy Rule defined in the specified Custom Authorization Server and Policy |
List all policy ruleslistAuthorizationServerPolicyRules | GET | Lists all policy rules for the specified Custom Authorization Server and Policy |
Replace a policy rulereplaceAuthorizationServerPolicyRule | PUT | Replaces the configuration of the Policy Rule defined in the specified Custom Authorization Server and Policy |
Retrieve a policy rulegetAuthorizationServerPolicyRule | GET | Retrieves a policy rule by ruleId |
AuthorizationServerScope5
Create a custom token scopecreateOAuth2Scope | POST | Creates a custom token scope |
Delete a custom token scopedeleteOAuth2Scope | DELETE | Deletes a custom token scope |
List all custom token scopeslistOAuth2Scopes | GET | Lists all custom token scopes |
Replace a custom token scopereplaceOAuth2Scope | PUT | Replaces a custom token scope |
Retrieve a custom token scopegetOAuth2Scope | GET | Retrieves a custom token scope |
Behavior7
Activate a behavior detection ruleactivateBehaviorDetectionRule | POST | Activates a behavior detection rule |
Create a behavior detection rulecreateBehaviorDetectionRule | POST | Creates a new behavior detection rule |
Deactivate a behavior detection ruledeactivateBehaviorDetectionRule | POST | Deactivates a behavior detection rule |
Delete a behavior detection ruledeleteBehaviorDetectionRule | DELETE | Deletes a Behavior Detection Rule by behaviorId |
List all behavior detection ruleslistBehaviorDetectionRules | GET | Lists all behavior detection rules with pagination support |
Replace a behavior detection rulereplaceBehaviorDetectionRule | PUT | Replaces a Behavior Detection Rule by behaviorId |
Retrieve a behavior detection rulegetBehaviorDetectionRule | GET | Retrieves a Behavior Detection Rule by behaviorId |
BotProtection2
Retrieve the bot protection configurationgetBotProtectionConfiguration | GET | Retrieves the bot protection configuration for your org |
Update the bot protection configurationupdateBotProtectionConfiguration | POST | Updates the bot protection configuration for your org |
Brand6
Create a brandcreateBrand | POST | Creates a new brand in your org |
Delete a branddeleteBrand | DELETE | Deletes a brand by brandId |
List all brandslistBrands | GET | Lists all the brands in your org |
List all domains associated with a brandlistBrandDomains | GET | Lists all domains associated with a brand by brandId |
Replace a brandreplaceBrand | PUT | Replaces a brand by brandId |
Retrieve a brandgetBrand | GET | Retrieves a brand by brandId |
CAPTCHA9
Create a CAPTCHA instancecreateCaptchaInstance | POST | Creates a new CAPTCHA instance. |
Delete a CAPTCHA instancedeleteCaptchaInstance | DELETE | Deletes a specified CAPTCHA instance Note: If your CAPTCHA instance is still associated with your org, the request fails. |
Delete the org-wide CAPTCHA settingsdeleteOrgCaptchaSettings | DELETE | Deletes the CAPTCHA settings object for your organization |
List all CAPTCHA instanceslistCaptchaInstances | GET | Lists all CAPTCHA instances with pagination support. |
Replace a CAPTCHA instancereplaceCaptchaInstance | PUT | Replaces the properties for a specified CAPTCHA instance |
Replace the org-wide CAPTCHA settingsreplacesOrgCaptchaSettings | PUT | Replaces the CAPTCHA settings object for your organization Note : You can disable CAPTCHA for your organization by setting captchaId and enabledPages to null. |
Retrieve a CAPTCHA instancegetCaptchaInstance | GET | Retrieves the properties of a specified CAPTCHA instance |
Retrieve the org-wide CAPTCHA settingsgetOrgCaptchaSettings | GET | Retrieves the CAPTCHA settings object for your organization Note : If the current organization hasn't configured CAPTCHA Settings, the request returns an empty object. |
Update a CAPTCHA instanceupdateCaptchaInstance | POST | Partially updates the properties of a specified CAPTCHA instance |
CustomDomain7
Create a custom domaincreateCustomDomain | POST | Creates your custom domain |
Delete a custom domaindeleteCustomDomain | DELETE | Deletes a custom domain by domainId |
List all custom domainslistCustomDomains | GET | Lists all verified custom domains for the org |
Replace a custom domain's brandreplaceCustomDomain | PUT | Replaces a custom domain's brand |
Retrieve a custom domaingetCustomDomain | GET | Retrieves a custom domain by domainId |
Upsert the custom domain's certificateupsertCertificate | PUT | Upserts (creates or renews) the MANUAL certificate for the custom domain |
Verify a custom domainverifyDomain | POST | Verifies the custom domain and validity of DNS records by domainId. |
CustomPage19
Delete the customized error pagedeleteCustomizedErrorPage | DELETE | Deletes the customized error page. |
Delete the customized sign-in pagedeleteCustomizedSignInPage | DELETE | Deletes the customized sign-in page. |
Delete the preview error pagedeletePreviewErrorPage | DELETE | Deletes the preview error page. |
Delete the preview sign-in pagedeletePreviewSignInPage | DELETE | Deletes the preview sign-in page. |
List all Sign-In Widget versionslistAllSignInWidgetVersions | GET | Lists all sign-in widget versions supported by the current org |
Replace the customized error pagereplaceCustomizedErrorPage | PUT | Replaces the customized error page. |
Replace the customized sign-in pagereplaceCustomizedSignInPage | PUT | Replaces the customized sign-in page. |
Replace the preview error pagereplacePreviewErrorPage | PUT | Replaces the preview error page. |
Replace the preview sign-in pagereplacePreviewSignInPage | PUT | Replaces the preview sign-in page. |
Replace the sign-out page settingsreplaceSignOutPageSettings | PUT | Replaces the sign-out page settings |
Retrieve the customized error pagegetCustomizedErrorPage | GET | Retrieves the customized error page. |
Retrieve the customized sign-in pagegetCustomizedSignInPage | GET | Retrieves the customized sign-in page. |
Retrieve the default error pagegetDefaultErrorPage | GET | Retrieves the default error page. |
Retrieve the default sign-in pagegetDefaultSignInPage | GET | Retrieves the default sign-in page. |
Retrieve the error page sub-resourcesgetErrorPage | GET | Retrieves the error page sub-resources. |
Retrieve the preview error page previewgetPreviewErrorPage | GET | Retrieves the preview error page. |
Retrieve the preview sign-in page previewgetPreviewSignInPage | GET | Retrieves the preview sign-in page. |
Retrieve the sign-in page sub-resourcesgetSignInPage | GET | Retrieves the sign-in page sub-resources. |
Retrieve the sign-out page settingsgetSignOutPageSettings | GET | Retrieves the sign-out page settings |
CustomTelephonyProvider9
Activate a custom telephony provideractivateCustomTelephonyCredential | POST | Activates a custom telephony provider by its ID. |
Create a custom telephony providercreateCustomTelephonyProviderCredentials | POST | Creates a custom telephony provider with the provided credentials |
Deactivate a custom telephony providerdeactivateCustomTelephonyCredential | POST | Deactivates a custom telephony provider by its ID. |
Delete a custom telephony providerdeleteCustomTelephonyProviderCredential | DELETE | Deletes a custom telephony provider by its ID. |
List all custom telephony providerslistAllCustomTelephonyProviderCredentials | GET | Lists all custom telephony providers that are configured in your org |
Retrieve a custom telephony providergetCustomTelephonyProviderCredential | GET | Retrieves the details of a custom telephony provider by its ID |
Send a test message from a custom telephony providersendTestCustomTelephonyProviderCredential | POST | Sends a test message (SMS or call) using the specified custom telephony provider to verify that the provider is configured correctly. |
Set a custom telephony provider as a primary telephony providersetAsPrimaryCustomTelephonyCredential | POST | Sets a custom telephony provider as the primary telephony provider for the org. |
Update a custom telephony provider credentialupdateCustomTelephonyProviderCredential | PATCH | Updates the credentials of an existing custom telephony provider |
CustomTemplate14
Create an email customizationcreateEmailCustomization | POST | Creates a new Email Customization |
Delete all email customizationsdeleteAllCustomizations | DELETE | Deletes all customizations for an email template |
Delete an email customizationdeleteEmailCustomization | DELETE | Deletes an Email Customization by its unique identifier |
List all email customizationslistEmailCustomizations | GET | Lists all customizations of an email template |
List all email templateslistEmailTemplates | GET | Lists all supported email templates |
Replace an email customizationreplaceEmailCustomization | PUT | Replaces an email customization using property values |
Replace the email template settingsreplaceEmailSettings | PUT | Replaces an email template's settings |
Retrieve a preview of an email customizationgetCustomizationPreview | GET | Retrieves a Preview of an Email Customization. |
Retrieve a preview of the email template default contentgetEmailDefaultPreview | GET | Retrieves a preview of an Email Template's default content. |
Retrieve an email customizationgetEmailCustomization | GET | Retrieves an email customization by its unique identifier |
Retrieve an email templategetEmailTemplate | GET | Retrieves the details of an email template by name |
Retrieve an email template default contentgetEmailDefaultContent | GET | Retrieves an email template's default content |
Retrieve the email template settingsgetEmailSettings | GET | Retrieves an email template's settings |
Send a test emailsendTestEmail | POST | Sends a test email to the current user's primary and secondary email addresses. |
Device10
Activate a deviceactivateDevice | POST | Activates a device by setting its status to ACTIVE by deviceId. |
Deactivate a devicedeactivateDevice | POST | Deactivates a device by setting its status to DEACTIVATED by deviceId. |
Delete a devicedeleteDevice | DELETE | Deletes (permanently) a device by deviceId if it has a status of DEACTIVATED. |
List all deviceslistDevices | GET | Lists all devices with pagination support. |
List all OS accounts for a devicelistDeviceOSAccounts | GET | Lists all OS accounts for a device by deviceId |
List all users for a devicelistDeviceUsers | GET | Lists all Users for a device by deviceId |
Retrieve a devicegetDevice | GET | Retrieves a device by deviceId |
Retrieve an OS accountgetDeviceOSAccount | GET | Retrieves an OS account by osAccountId for a device |
Suspend a DevicesuspendDevice | POST | Suspends a device by setting its status to SUSPENDED. |
Unsuspend a DeviceunsuspendDevice | POST | Unsuspends a device by returning its status to ACTIVE. |
DeviceAssurance5
Create a device assurance policycreateDeviceAssurancePolicy | POST | Creates a new device assurance policy |
Delete a device assurance policydeleteDeviceAssurancePolicy | DELETE | Deletes a device assurance policy by deviceAssuranceId. |
List all device assurance policieslistDeviceAssurancePolicies | GET | Lists all device assurance policies |
Replace a device assurance policyreplaceDeviceAssurancePolicy | PUT | Replaces a device assurance policy by deviceAssuranceId |
Retrieve a device assurance policygetDeviceAssurancePolicy | GET | Retrieves a device assurance policy by deviceAssuranceId |
DeviceIntegration4
Activate a device integrationactivateDeviceIntegration | POST | Activates a device integration and populates the related configurations by deviceIntegrationId |
Deactivate a device integrationdeactivateDeviceIntegration | POST | Deactivates a device integration by deviceIntegrationId |
List all device integrationslistDeviceIntegrations | GET | Lists all device integrations for your org. |
Retrieve a device integrationgetDeviceIntegration | GET | Retrieves a device integration by deviceIntegrationId |
DevicePostureCheck6
Create a device posture checkcreateDevicePostureCheck | POST | Creates a device posture check |
Delete a device posture checkdeleteDevicePostureCheck | DELETE | Deletes a device posture check by postureCheckId. |
List all default device posture checkslistDefaultDevicePostureChecks | GET | Lists all default device posture checks. |
List all device posture checkslistDevicePostureChecks | GET | Lists all device posture checks |
Replace a device posture checkreplaceDevicePostureCheck | PUT | Replaces a device posture check by postureCheckId |
Retrieve a device posture checkgetDevicePostureCheck | GET | Retrieves a device posture check by postureCheckId |
DirectoriesIntegration3
Retrieve the results of an AD group querygetGroupAttributeQueryResult | GET | Retrieves the results of the requested Active Directory (AD) group attributes using the resultId returned from the POST /api/v1/directories/{appInstanceId}/groups/{groupId}/query call. |
Submit a query for AD GroupsubmitGroupAttributeQuery | POST | Submits a query search on the on-premises agent to asynchronously fetch specific Active Directory (AD) attributes for a group. |
Update an external directory group membershipupdateGroupMembership | POST | Updates an Active Directory or LDAP group membership directly in the Active Directory or LDAP server. |
DisasterRecovery4
Retrieve the disaster recovery status for a domaingetDRStatusForDomain | GET | Retrieves the failover or failback status for the domain specified in the request path |
Retrieve the disaster recovery status for all domainsgetDRStatus | GET | Retrieves the failover or failback status for all the domains for your org |
Start the failback of your orgstartOrgFailback | POST | Starts the failback of your org |
Start the failover of your orgstartOrgFailover | POST | Starts the failover of your org |
EmailCustomization1
Remove bounced emailsbulkRemoveEmailAddressBounces | POST | Removes emails from an email service bounce list. |
EmailDomain6
Create an email domaincreateEmailDomain | POST | Creates an Email Domain in your org |
Delete an email domaindeleteEmailDomain | DELETE | Deletes an Email Domain by emailDomainId |
List all email domainslistEmailDomains | GET | Lists all the Email Domains in your org |
Replace an email domainreplaceEmailDomain | PUT | Replaces associated username and sender display name by emailDomainId |
Retrieve an email domaingetEmailDomain | GET | Retrieves an Email Domain by emailDomainId |
Verify an email domainverifyEmailDomain | POST | Verifies an Email Domain by emailDomainId |
EmailServer6
Create a custom SMTP servercreateEmailServer | POST | Creates a custom email SMTP server configuration for your org. |
Delete an SMTP server configurationdeleteEmailServer | DELETE | Deletes the specified custom SMTP server configuration |
List all enrolled SMTP serverslistEmailServers | GET | Lists all the enrolled custom SMTP server configurations |
Retrieve an SMTP server configurationgetEmailServer | GET | Retrieves the specified custom SMTP server configuration |
Test an SMTP server configurationtestEmailServer | POST | Tests the specified custom SMTP server configuration |
Update an SMTP server configurationupdateEmailServer | PATCH | Updates the specified custom SMTP server configuration |
EventHook8
Activate an event hookactivateEventHook | POST | Activates the event hook that matches the provided id |
Create an event hookcreateEventHook | POST | Creates a new event hook for your organization in ACTIVE status. |
Deactivate an event hookdeactivateEventHook | POST | Deactivates the event hook that matches the provided id |
Delete an event hookdeleteEventHook | DELETE | Deletes the event hook that matches the provided id. |
List all event hookslistEventHooks | GET | Lists all event hooks |
Replace an event hookreplaceEventHook | PUT | Replaces an event hook. |
Retrieve an event hookgetEventHook | GET | Retrieves an event hook |
Verify an event hookverifyEventHook | POST | Verifies that the event hook matches the provided eventHookId. |
Feature5
List all dependencieslistFeatureDependencies | GET | Lists all feature dependencies for a specified feature. |
List all dependentslistFeatureDependents | GET | Lists all feature dependents for the specified feature. |
List all featureslistFeatures | GET | Lists all self-service features for your org |
Retrieve a featuregetFeature | GET | Retrieves a feature by ID |
Update a feature lifecycleupdateFeatureLifecycle | POST | Updates a feature's lifecycle status. |
GovernanceBundle10
Create a governance bundlecreateGovernanceBundle | POST | Creates a governance bundle of entitlements for the Admin Console |
Delete a governance bundledeleteGovernanceBundle | DELETE | Deletes an Admin Console governance bundle |
List all entitlements for a governance bundlelistBundleEntitlements | GET | Lists all entitlements specific to a governance bundle |
List all governance bundleslistGovernanceBundles | GET | Lists all governance bundles for the Admin Console in your org |
List all values for a governance bundle entitlementlistBundleEntitlementValues | GET | Lists all entitlement values that are specific to a governance bundle entitlement |
Opt in the Admin Console to entitlement managementoptIn | POST | Opts in the Admin Console to entitlement management |
Opt out the Admin Console from entitlement managementoptOut | POST | Opts out the Admin Console from entitlement management |
Replace a governance bundlereplaceGovernanceBundle | PUT | Replaces the properties of a governance bundle for the Admin Console |
Retrieve a governance bundlegetGovernanceBundle | GET | Retrieves a governance bundle for the Admin Console |
Retrieve the Admin Console opt-in statusgetOptInStatus | GET | Retrieves the entitlement management opt-in status for the Admin Console |
Group9
Add a groupaddGroup | POST | Adds a new group with the OKTA GROUP type to your org. |
Assign a user to a groupassignUserToGroup | PUT | Assigns a user to a group with the OKTA GROUP type. |
Delete a groupdeleteGroup | DELETE | Deletes a group of the OKTA GROUP or APP GROUP type from your org. |
List all assigned appslistAssignedApplicationsForGroup | GET | Lists all apps that are assigned to a group. |
List all groupslistGroups | GET | Lists all groups with pagination support. |
List all member userslistGroupUsers | GET | Lists all users that are a member of a group. |
Replace a groupreplaceGroup | PUT | Replaces the profile for a group of OKTA GROUP type from your org. |
Retrieve a groupgetGroup | GET | Retrieves a specific group by id from your org |
Unassign a user from a groupunassignUserFromGroup | DELETE | Unassigns a user from a group with the OKTA GROUP type. |
GroupOwner3
Assign a group ownerassignGroupOwner | POST | Assigns a group owner |
Delete a group ownerdeleteGroupOwner | DELETE | Deletes a group owner from a specific group |
List all group ownerslistGroupOwners | GET | Lists all owners for a specific group |
GroupPushMapping5
Create a group push mappingcreateGroupPushMapping | POST | Creates or links a group push mapping. |
Delete a group push mappingdeleteGroupPushMapping | DELETE | Deletes a specific group push mapping. |
List all group push mappingslistGroupPushMappings | GET | Lists all group push mappings with pagination support |
Retrieve a group push mappinggetGroupPushMapping | GET | Retrieves a group push mapping by ID |
Update a group push mappingupdateGroupPushMapping | PATCH | Updates the status of a group push mapping |
GroupRule7
Activate a group ruleactivateGroupRule | POST | Activates a specific group rule by ID from your org |
Create a group rulecreateGroupRule | POST | Creates a group rule to dynamically add users to the specified group if they match the condition. |
Deactivate a group ruledeactivateGroupRule | POST | Deactivates a specific group rule by ID from your org |
Delete a group ruledeleteGroupRule | DELETE | Deletes a specific group rule by groupRuleId |
List all group ruleslistGroupRules | GET | Lists all group rules for your org |
Replace a group rulereplaceGroupRule | PUT | Replaces a group rule Notes: You can only update rules with a group whose status is set to INACTIVE. |
Retrieve a group rulegetGroupRule | GET | Retrieves a specific group rule by ID from your org |
HookKey6
Create a keycreateHookKey | POST | Creates a key for use with other parts of the application, such as inline hooks |
Delete a keydeleteHookKey | DELETE | Deletes a key by id. |
List all keyslistHookKeys | GET | Lists all keys |
Replace a keyreplaceHookKey | PUT | Replaces a key by id |
Retrieve a key by IDgetHookKey | GET | Retrieves the public portion of the Key object using the id parameter |
Retrieve a public keygetPublicKey | GET | Retrieves a public key by keyId |
IdentityProvider7
Activate an IdPactivateIdentityProvider | POST | Activates an inactive identity provider (IdP) |
Create an IdPcreateIdentityProvider | POST | Creates a new identity provider (IdP) integration. |
Deactivate an IdPdeactivateIdentityProvider | POST | Deactivates an active identity provider (IdP) |
Delete an IdPdeleteIdentityProvider | DELETE | Deletes an identity provider (IdP) integration by idpId All existing IdP users are unlinked with the highest order profile source taking precedence for each IdP user. |
List all IdPslistIdentityProviders | GET | Lists all identity provider (IdP) integrations with pagination. |
Replace an IdPreplaceIdentityProvider | PUT | Replaces an identity provider (IdP) integration by idpId |
Retrieve an IdPgetIdentityProvider | GET | Retrieves an identity provider (IdP) integration by idpId |
IdentityProviderKey5
Create an IdP key credentialcreateIdentityProviderKey | POST | Creates a new X.509 certificate credential in the identity provider (IdP) key store Note: RSA-based certificates are supported for all IdP types. |
Delete an IdP key credentialdeleteIdentityProviderKey | DELETE | Deletes a specific identity provider (IdP) key credential by kid if it isn't currently being used by an active or inactive IdP |
List all IdP key credentialslistIdentityProviderKeys | GET | Lists all identity provider (IdP) key credentials |
Replace an IdP key credentialreplaceIdentityProviderKey | PUT | Replaces an identity provider (IdP) key credential by kid |
Retrieve an IdP key credentialgetIdentityProviderKey | GET | Retrieves a specific identity provider (IdP) key credential by kid |
IdentityProviderSigningKey10
Clone a signing key credential for IdPcloneIdentityProviderKey | POST | Clones an X.509 certificate for an identity provider (IdP) signing key credential from a source IdP to target IdP Caution: Sharing certificates isn't a recommended security practice. |
Generate a certificate signing requestgenerateCsrForIdentityProvider | POST | Generates a new key pair and returns a certificate signing request (CSR) for it Note: The private key isn't listed in the signing key credentials for the identity provider (IdP) until... |
Generate a new signing key credential for IdPgenerateIdentityProviderSigningKey | POST | Generates a new X.509 certificate for an identity provider (IdP) signing key credential to be used for signing assertions sent to the IdP. |
List all certificate signing requestslistCsrsForIdentityProvider | GET | Lists all certificate signing requests (CSRs) for an identity provider (IdP) |
List all signing key credentials for IdPlistIdentityProviderSigningKeys | GET | Lists all signing key credentials for an identity provider (IdP) |
List the active signing key credential for IdPlistActiveIdentityProviderSigningKey | GET | Lists the active signing key credential for an identity provider (IdP) |
Publish a certificate signing requestpublishCsrForIdentityProvider | POST | Publishes the certificate signing request (CSR) with a signed X.509 certificate and adds it into the signing key credentials for the identity provider (IdP) Notes: Publishing a... |
Retrieve a certificate signing requestgetCsrForIdentityProvider | GET | Retrieves a specific certificate signing request (CSR) by id |
Retrieve a signing key credential for IdPgetIdentityProviderSigningKey | GET | Retrieves a specific identity provider (IdP) key credential by kid |
Revoke a certificate signing requestrevokeCsrForIdentityProvider | DELETE | Revokes a certificate signing request (CSR) and deletes the key pair from the identity provider (IdP) |
IdentityProviderUser6
Link a user to IdPlinkUserToIdentityProvider | POST | Links an Okta user to an existing SAML or social identity provider (IdP). |
List all IdPs for userlistUserIdentityProviders | GET | Lists the identity providers (IdPs) associated with the user |
List all tokens from OIDC IdPlistSocialAuthTokens | GET | Lists the tokens minted by the social authentication provider when the user authenticates with Okta via Social Auth. |
List all users for IdPlistIdentityProviderApplicationUsers | GET | Lists all the users linked to an identity provider (IdP) |
Retrieve a user for IdPgetIdentityProviderApplicationUser | GET | Retrieves a linked identity provider (IdP) user by ID |
Unlink a user from IdPunlinkUserFromIdentityProvider | DELETE | Unlinks the Okta user and the identity provider (IdP) user. |
IdentitySource23
Create an identity source groupcreateIdentitySourceGroups | POST | Creates a group in an identity source for the given identity source instance |
Create an identity source sessioncreateIdentitySourceSession | POST | Creates an identity source session for the given identity source instance |
Create an identity source usercreateIdentitySourceUser | POST | Creates a user in an identity source for the given identity source instance |
Create the memberships for the given identity source groupcreateIdentitySourceGroupsMemberships | POST | Creates the group memberships for the given identity source group |
Delete an identity source groupdeleteIdentitySourceGroup | DELETE | Deletes a group in an identity source for a given identity source ID and group ID |
Delete an identity source sessiondeleteIdentitySourceSession | DELETE | Deletes an identity source session for a given identity source ID and session Id |
Delete an identity source userdeleteIdentitySourceUser | DELETE | Deletes a user in an identity source for the given identity source instance and external ID |
Delete the memberships for the specified identity source groupdeleteIdentitySourceGroupMemberships | DELETE | Deletes group memberships for the specified identity source group using member external IDs |
List all identity source sessionslistIdentitySourceSessions | GET | Lists all identity source sessions for the given identity source instance |
Replace an existing identity source userreplaceExistingIdentitySourceUser | PUT | Replaces an existing user for the given identity source instance and external ID |
Retrieve an identity source groupgetIdentitySourceGroup | GET | Retrieves a group from an identity source for a given identity source ID and group ID or external ID |
Retrieve an identity source sessiongetIdentitySourceSession | GET | Retrieves an identity source session for a given identity source ID and session ID |
Retrieve an identity source usergetIdentitySourceUser | GET | Retrieves a user by external ID in an identity source for the given identity source instance |
Retrieve the memberships for the given identity source groupgetIdentitySourceGroupMemberships | GET | Retrieves the group memberships for the given identity source group in the given identity source instance |
Start the import from the identity sourcestartImportFromIdentitySource | POST | Starts the import from the identity source described by the uploaded bulk operations |
Update an identity source groupupdateIdentitySourceGroups | POST | Updates a group to an identity source for the given identity source instance and group ID |
Update an identity source userupdateIdentitySourceUsers | PATCH | Updates a user to an identity source for the given identity source instance and external ID |
Upload the data to be deleted in OktauploadIdentitySourceDataForDelete | POST | Uploads external IDs of entities that need to be deleted in Okta from the identity source for the given session |
Upload the data to be upserted in OktauploadIdentitySourceDataForUpsert | POST | Uploads entities that need to be inserted or updated in Okta from the identity source for the given session |
Upload the group external IDs to be deleted in OktauploadIdentitySourceGroupsDataForDelete | POST | Uploads external IDs of groups that need to be deleted in Okta from the identity source for the given session |
Upload the group memberships to be deleted in OktauploadIdentitySourceGroupMembershipsForDelete | POST | Uploads the group memberships that need to be deleted in Okta from the identity source for the given session |
Upload the group memberships to be upserted in OktauploadIdentitySourceGroupMembershipsForUpsert | POST | Uploads the group memberships that need to be inserted or updated in Okta from the identity source for the given session |
Upload the group profiles without memberships to be upserted inuploadIdentitySourceGroupsForUpsert | POST | Uploads the group profiles without memberships that need to be inserted or updated in Okta from the identity source for the given session |
InlineHook9
Activate an inline hookactivateInlineHook | POST | Activates the inline hook by inlineHookId |
Create an inline hookcreateInlineHook | POST | Creates an inline hook |
Deactivate an inline hookdeactivateInlineHook | POST | Deactivates the inline hook by inlineHookId |
Delete an inline hookdeleteInlineHook | DELETE | Deletes an inline hook by inlineHookId. |
Execute an inline hookexecuteInlineHook | POST | Executes the inline hook that matches the provided inlineHookId by using the request body as the input. |
List all inline hookslistInlineHooks | GET | Lists all inline hooks or all inline hooks of a specific type. |
Replace an inline hookreplaceInlineHook | PUT | Replaces an inline hook by inlineHookId. |
Retrieve an inline hookgetInlineHook | GET | Retrieves an inline hook by inlineHookId |
Update an inline hookupdateInlineHook | POST | Updates an inline hook by inlineHookId |
LinkedObject4
Create a linked object definitioncreateLinkedObjectDefinition | POST | Creates a Linked Object definition |
Delete a linked object definitiondeleteLinkedObjectDefinition | DELETE | Deletes the Linked Object definition specified by either the primary or associated name. |
List all linked object definitionslistLinkedObjectDefinitions | GET | Lists all Linked Object definitions |
Retrieve a linked object definitiongetLinkedObjectDefinition | GET | Retrieves a Linked Object definition |
LogStream7
Activate a log streamactivateLogStream | POST | Activates a log stream by logStreamId |
Create a log streamcreateLogStream | POST | Creates a new log stream object |
Deactivate a log streamdeactivateLogStream | POST | Deactivates a log stream by logStreamId |
Delete a log streamdeleteLogStream | DELETE | Deletes a log stream object from your org by ID |
List all log streamslistLogStreams | GET | Lists all log stream objects in your org. |
Replace a log streamreplaceLogStream | PUT | Replaces the log stream object properties for a given ID. |
Retrieve a log streamgetLogStream | GET | Retrieves a log stream object by ID |
NetworkZone7
Activate a network zoneactivateNetworkZone | POST | Activates a Network Zone by zoneId |
Create a network zonecreateNetworkZone | POST | Creates a Network Zone For an IP Network Zone, you must define either gateways or proxies. |
Deactivate a network zonedeactivateNetworkZone | POST | Deactivates a Network Zone by zoneId |
Delete a network zonedeleteNetworkZone | DELETE | Deletes a Network Zone by zoneId Notes: You can't delete a Network Zone that's used by a Policy or Rule. |
List all network zoneslistNetworkZones | GET | Lists all Network Zones with pagination. |
Replace a network zonereplaceNetworkZone | PUT | Replaces a Network Zone by zoneId. |
Retrieve a network zonegetNetworkZone | GET | Retrieves a Network Zone by zoneId |
OAuth2ResourceServerCredentialsKey6
Activate a Custom Authorization Server Public JSON Web KeyactivateOAuth2ResourceServerJsonWebKey | POST | Activates a custom authorization server public JSON web key by key id. |
Add a JSON Web KeyaddOAuth2ResourceServerJsonWebKey | POST | Adds a new JSON Web Key to the custom authorization servers JSON web keys. |
Deactivate a Custom Authorization Server Public JSON Web KeydeactivateOAuth2ResourceServerJsonWebKey | POST | Deactivates a custom authorization server public JSON web key by key id. |
Delete a Custom Authorization Server Public JSON Web KeydeleteOAuth2ResourceServerJsonWebKey | DELETE | Deletes a custom authorization server public JSON web key by key id. |
List all Custom Authorization Server Public JSON Web KeyslistOAuth2ResourceServerJsonWebKeys | GET | Lists all the public keys used by the custom authorization server |
Retrieve a Custom Authorization Server Public JSON Web KeygetOAuth2ResourceServerJsonWebKey | GET | Retrieves a custom authorization server public JSON web key by key id |
OktaApplicationSetting2
Replace the Okta application settingsreplaceFirstPartyAppSettings | PUT | Replaces the settings for an Okta app (also known as an Okta first-party app) |
Retrieve the Okta application settingsgetFirstPartyAppSettings | GET | Retrieves the settings for an Okta app (also known as an Okta first-party app) |
OktaManagedUserAccount5
Create an Okta managed user accountcreateOktaManagedUserAccount | POST | Creates a new Okta managed user account for managing a Universal Directory user as a service account. |
Delete an Okta managed user accountdeleteOktaManagedUserAccount | DELETE | Deletes an Okta managed user account specified by ID. |
List all Okta managed user accountslistOktaManagedUserAccounts | GET | Lists all Okta managed user accounts in your org. |
Retrieve an Okta managed user accountgetOktaManagedUserAccount | GET | Retrieves an Okta managed user account specified by ID |
Update an Okta managed user accountupdateOktaManagedUserAccount | PATCH | Updates an existing Okta managed user account specified by ID. |
OktaPersonalSetting3
List all blocked email domainslistPersonalAppsExportBlockList | GET | Lists all blocked email domains which are excluded from app migration |
Replace the blocked email domainsreplaceBlockedEmailDomains | PUT | Replaces the list of blocked email domains which are excluded from app migration |
Replace the Okta Personal admin settingsreplaceOktaPersonalAdminSettings | PUT | Replaces Okta Personal admin settings in a Workforce org |
OrgCreator1
Create an orgcreateChildOrg | POST | Creates an org (child org) that has the same features as the current requesting org (parent org). |
OrgSettingAdmin6
Assign the default public client app role settingassignClientPrivilegesSetting | PUT | Assigns the Super Admin role as the default role for new public client apps |
Retrieve the default public client app role settinggetClientPrivilegesSetting | GET | Retrieves the org setting to assign the Super Admin role to new public client apps |
Retrieve the Okta Admin Console assignment settinggetAutoAssignAdminAppSetting | GET | Retrieves the org setting to automatically assign the Okta Admin Console when an admin role is assigned |
Retrieve the org third-party admin settinggetThirdPartyAdminSetting | GET | Retrieves the third-party admin setting. |
Update the Okta Admin Console assignment settingupdateAutoAssignAdminAppSetting | POST | Updates the org setting to automatically assign the Okta Admin Console when an admin role is assigned |
Update the org third-party admin settingupdateThirdPartyAdminSetting | POST | Updates the third-party admin setting. |
OrgSettingCommunication3
Opt in to Okta user communication emailsoptInUsersToOktaCommunicationEmails | POST | Opts in all users of this org to Okta communication emails |
Opt out of Okta user communication emailsoptOutUsersFromOktaCommunicationEmails | POST | Opts out all users of this org from Okta communication emails |
Retrieve the Okta communication settingsgetOktaCommunicationSettings | GET | Retrieves Okta Communication Settings of your org |
OrgSettingContact3
List all org contact typeslistOrgContactTypes | GET | Lists all org contact types for your Okta org |
Replace the contact type userreplaceOrgContactUser | PUT | Replaces the user associated with the specified contact type |
Retrieve the contact type usergetOrgContactUser | GET | Retrieves the ID and the user resource associated with the specified contact type |
OrgSettingCustomization3
Retrieve the org preferencesgetOrgPreferences | GET | Retrieves preferences of your Okta org |
Set the hide dashboard footer preferencesetOrgHideOktaUIFooter | POST | Sets the preference to hide the Okta End-User Dashboard footer for all end users of your org |
Set the show dashboard footer preferencesetOrgShowOktaUIFooter | POST | Sets the preference to show the Okta UI footer for all end users of your org |
OrgSettingGeneral3
Replace the Org general settingsreplaceOrgSettings | PUT | Replaces the Org General Settings for your Okta org |
Retrieve the Org general settingsgetOrgSettings | GET | Retrieves the Org General Settings |
Update the Org general settingsupdateOrgSettings | POST | Updates partial Org General Settings |
OrgSettingMetadata1
Retrieve the Org metadatagetWellknownOrgMetadata | GET | Retrieves the org metadata, which includes the org ID, configured custom domains, and authentication pipeline |
OrgSettingSupport9
Extend Okta Support accessextendOktaSupport | POST | Extends the length of time that Okta Support can access your org by 24 hours. |
Grant Okta Aerial access to your orggrantAerialConsent | POST | Grants an Okta Aerial account consent to manage your org. |
Grant Okta Support accessgrantOktaSupport | POST | Grants Okta Support temporary access to your org as an administrator for eight hours |
List all Okta Support caseslistOktaSupportCases | GET | Lists all Okta Support cases that the requesting principal has permission to view |
Retrieve Okta Aerial consent for your orggetAerialConsent | GET | Retrieves the Okta Aerial consent grant details for your Org. |
Retrieve the Okta Support settingsgetOrgOktaSupportSettings | GET | Retrieves Okta Support Settings for your org |
Revoke Okta Aerial access to your orgrevokeAerialConsent | POST | Revokes access of an Okta Aerial account to your Org. |
Revoke Okta Support accessrevokeOktaSupport | POST | Revokes Okta Support access to your org |
Update an Okta Support caseupdateOktaSupportCase | PATCH | Updates access to the org for an Okta Support case: |
Policy21
Activate a policyactivatePolicy | POST | Activates a policy |
Activate a policy ruleactivatePolicyRule | POST | Activates a policy rule identified by policyId and ruleId |
Clone an existing policyclonePolicy | POST | Clones an existing policy |
Create a policycreatePolicy | POST | Creates a policy. |
Create a policy rulecreatePolicyRule | POST | Creates a policy rule |
Create a policy simulationcreatePolicySimulation | POST | Creates a policy or policy rule simulation. |
Deactivate a policydeactivatePolicy | POST | Deactivates a policy |
Deactivate a policy ruledeactivatePolicyRule | POST | Deactivates a policy rule identified by policyId and ruleId |
Delete a policydeletePolicy | DELETE | Deletes a policy |
Delete a policy resource mappingdeletePolicyResourceMapping | DELETE | Deletes the resource mapping for a policy identified by policyId and mappingId |
Delete a policy ruledeletePolicyRule | DELETE | Deletes a policy rule identified by policyId and ruleId |
List all apps mapped to a policylistPolicyApps | GET | Lists all applications mapped to a policy identified by policyId |
List all policieslistPolicies | GET | Lists all policies with the specified type |
List all policy ruleslistPolicyRules | GET | Lists all policy rules |
List all resources mapped to a policylistPolicyMappings | GET | Lists all resources mapped to a policy identified by policyId |
Map a resource to a policymapResourceToPolicy | POST | Maps a resource to a policy identified by policyId |
Replace a policyreplacePolicy | PUT | Replaces the properties of a policy identified by policyId |
Replace a policy rulereplacePolicyRule | PUT | Replaces the properties for a policy rule identified by policyId and ruleId |
Retrieve a policygetPolicy | GET | Retrieves a policy |
Retrieve a policy resource mappinggetPolicyMapping | GET | Retrieves a resource mapping for a policy identified by policyId and mappingId |
Retrieve a policy rulegetPolicyRule | GET | Retrieves a policy rule |
PrincipalRateLimit4
Create a principal rate limitcreatePrincipalRateLimitEntity | POST | Creates a new principal rate limit entity. |
List all principal rate limitslistPrincipalRateLimitEntities | GET | Lists all Principal Rate Limit entities considering the provided parameters |
Replace a principal rate limitreplacePrincipalRateLimitEntity | PUT | Replaces a principal rate limit entity by principalRateLimitId |
Retrieve a principal rate limitgetPrincipalRateLimitEntity | GET | Retrieves a principal rate limit entity by principalRateLimitId |
ProfileMapping3
List all profile mappingslistProfileMappings | GET | Lists all profile mappings in your org with pagination. |
Retrieve a profile mappinggetProfileMapping | GET | Retrieves a single profile mapping referenced by its ID |
Update a profile mappingupdateProfileMapping | POST | Updates an existing profile mapping by adding, updating, or removing one or many property mappings |
PushProvider5
Create a push providercreatePushProvider | POST | Creates a new push provider. |
Delete a push providerdeletePushProvider | DELETE | Deletes a push provider by pushProviderId. |
List all push providerslistPushProviders | GET | Lists all push providers |
Replace a push providerreplacePushProvider | PUT | Replaces a push provider by pushProviderId |
Retrieve a push providergetPushProvider | GET | Retrieves a push provider by pushProviderId |
RateLimitSetting6
Replace the per-client rate limit settingsreplaceRateLimitSettingsPerClient | PUT | Replaces the Per-Client Rate Limit Settings and returns the configured properties |
Replace the rate limit admin notification settingsreplaceRateLimitSettingsAdminNotifications | PUT | Replaces the Rate Limit Admin Notification Settings and returns the configured properties |
Replace the rate limit warning threshold percentagereplaceRateLimitSettingsWarningThreshold | PUT | Replaces the Rate Limit Warning Threshold Percentage and returns the configured property |
Retrieve the per-client rate limit settingsgetRateLimitSettingsPerClient | GET | Retrieves the currently configured Per-Client Rate Limit Settings |
Retrieve the rate limit admin notification settingsgetRateLimitSettingsAdminNotifications | GET | Retrieves the currently configured Rate Limit Admin Notification Settings |
Retrieve the rate limit warning threshold percentagegetRateLimitSettingsWarningThreshold | GET | Retrieves the currently configured threshold for warning notifications when the API's rate limit is exceeded |
Realm5
Create a realmcreateRealm | POST | Creates a new realm |
Delete a realmdeleteRealm | DELETE | Deletes a realm permanently. |
List all realmslistRealms | GET | Lists all realms. |
Replace the realm profilereplaceRealm | PUT | Replaces the realm profile |
Retrieve a realmgetRealm | GET | Retrieves a realm |
RealmAssignment9
Activate a realm assignmentactivateRealmAssignment | POST | Activates a realm assignment |
Create a realm assignmentcreateRealmAssignment | POST | Creates a new realm assignment |
Deactivate a realm assignmentdeactivateRealmAssignment | POST | Deactivates a realm assignment |
Delete a realm assignmentdeleteRealmAssignment | DELETE | Deletes a realm assignment |
Execute a realm assignmentexecuteRealmAssignment | POST | Executes a realm assignment |
List all realm assignment operationslistRealmAssignmentOperations | GET | Lists all realm assignment operations. |
List all realm assignmentslistRealmAssignments | GET | Lists all realm assignments |
Replace a realm assignmentreplaceRealmAssignment | PUT | Replaces a realm assignment |
Retrieve a realm assignmentgetRealmAssignment | GET | Retrieves a realm assignment |
RoleAssignmentAUser8
Assign a user roleassignRoleToUser | POST | Assigns a standard role to a user. |
List all user role assignmentslistAssignedRolesForUser | GET | Lists all roles assigned to a user (identified by userId) |
List all users with role assignmentslistUsersWithRoleAssignments | GET | Lists all users with role assignments |
Retrieve a user role assignmentgetUserAssignedRole | GET | Retrieves a role assigned to a user (identified by userId). |
Retrieve a user role governance sourcegetRoleAssignmentGovernanceGrant | GET | Retrieves a governance source (identified by grantId) for a role (identified by roleAssignmentId) that's assigned to a user (identified by userId) |
Retrieve all user role governance sourcesgetUserAssignedRoleGovernance | GET | Retrieves the governance sources of a role (identified by roleAssignmentId) that's assigned to a user (identified by userId) |
Retrieve the user role governance source resourcesgetRoleAssignmentGovernanceGrantResources | GET | Retrieves the resources of a governance source (identified by grantId) for a role (identified by roleAssignmentId) that's assigned to a user (identified by userId) |
Unassign a user roleunassignRoleFromUser | DELETE | Unassigns a role assignment (identified by roleAssignmentId) from a user (identified by userId) |
RoleAssignmentBGroup4
Assign a role to a groupassignRoleToGroup | POST | Assigns a standard role to a group. |
List all group role assignmentslistGroupAssignedRoles | GET | Lists all assigned roles of a group by groupId |
Retrieve a group role assignmentgetGroupAssignedRole | GET | Retrieves a role assigned to a group (identified by the groupId). |
Unassign a group roleunassignRoleFromGroup | DELETE | Unassigns a role assignment (identified by roleAssignmentId) from a group (identified by the groupId) |
RoleAssignmentClient4
Assign a client roleassignRoleToClient | POST | Assigns a standard role to a client app. |
List all client role assignmentslistRolesForClient | GET | Lists all roles assigned to a client app identified by clientId |
Retrieve a client roleretrieveClientRole | GET | Retrieves a role assignment (identified by roleAssignmentId) for a client app (identified by clientId) |
Unassign a client roledeleteRoleFromClient | DELETE | Unassigns a role assignment (identified by roleAssignmentId) from a client app (identified by clientId) |
RoleBTargetAdmin10
Assign all apps as target to admin roleassignAllAppsAsTargetToRoleForUser | PUT | Assigns all apps as target to an APP ADMIN role |
Assign an admin role app instance targetassignAppInstanceTargetToAppAdminRoleForUser | PUT | Assigns an app instance target to an APP ADMIN role assignment to an admin user. |
Assign an admin role app targetassignAppTargetToAdminRoleForUser | PUT | Assigns an OIN app target for an APP ADMIN role assignment to an admin user. |
Assign an admin role group targetassignGroupTargetToUserRole | PUT | Assigns a group target for a USER ADMIN, HELP DESK ADMIN, or GROUP MEMBERSHIP ADMIN role assignment to an admin user. |
List all admin role app targetslistApplicationTargetsForApplicationAdministratorRoleForUser | GET | Lists all app targets for an APP ADMIN role assigned to a user. |
List all admin role group targetslistGroupTargetsForRole | GET | Lists all group targets for a USER ADMIN, HELP DESK ADMIN, or GROUP MEMBERSHIP ADMIN role assignment to an admin user. |
Retrieve a role target by assignment typegetRoleTargetsByUserIdAndRoleId | GET | Retrieves all role targets for an APP ADMIN, USER ADMIN, HELP DESK ADMIN, or GROUP MEMBERSHIP ADMIN role assignment to an admin user by user or group assignment type. |
Unassign an admin role app instance targetunassignAppInstanceTargetFromAdminRoleForUser | DELETE | Unassigns an app instance target from an APP ADMIN role assignment to an admin user. |
Unassign an admin role app targetunassignAppTargetFromAppAdminRoleForUser | DELETE | Unassigns an OIN app target from an APP ADMIN role assignment to an admin user. |
Unassign an admin role group targetunassignGroupTargetFromUserAdminRole | DELETE | Unassigns a group target from a USER ADMIN, HELP DESK ADMIN, or GROUP MEMBERSHIP ADMIN role assignment to an admin user. |
RoleBTargetBGroup8
Assign a group role app instance targetassignAppInstanceTargetToAppAdminRoleForGroup | PUT | Assigns an app instance target to an APP ADMIN role assignment to a group. |
Assign a group role app targetassignAppTargetToAdminRoleForGroup | PUT | Assigns an OIN app target to an APP ADMIN role assignment to a group. |
Assign a group role group targetassignGroupTargetToGroupAdminRole | PUT | Assigns a group target to a USER ADMIN, HELP DESK ADMIN, or GROUP MEMBERSHIP ADMIN role assignment to a group. |
List all group role app targetslistApplicationTargetsForApplicationAdministratorRoleForGroup | GET | Lists all app targets for an APP ADMIN role assignment to a group. |
List all group role group targetslistGroupTargetsForGroupRole | GET | Lists all group targets for a USER ADMIN, HELP DESK ADMIN, or GROUP MEMBERSHIP ADMIN role assignment to a group. |
Unassign a group role app instance targetunassignAppInstanceTargetToAppAdminRoleForGroup | DELETE | Unassigns an app instance target from an APP ADMIN role assignment to a group |
Unassign a group role app targetunassignAppTargetToAdminRoleForGroup | DELETE | Unassigns an OIN app target from an APP ADMIN role assignment to a group |
Unassign a group role group targetunassignGroupTargetFromGroupAdminRole | DELETE | Unassigns a group target from a USER ADMIN, HELP DESK ADMIN, or GROUP MEMBERSHIP ADMIN role assignment to a group. |
RoleBTargetClient8
Assign a client role app instance targetassignAppTargetInstanceRoleForClient | PUT | Assigns an app instance target to an APP ADMIN role assignment to a client. |
Assign a client role app targetassignAppTargetRoleToClient | PUT | Assigns an OIN app target for an APP ADMIN role assignment to a client. |
Assign a client role group targetassignGroupTargetRoleForClient | PUT | Assigns a group target to a USER ADMIN, HELP DESK ADMIN, or GROUP MEMBERSHIP ADMIN role assignment to a client app. |
List all client role app targetslistAppTargetRoleToClient | GET | Lists all OIN app targets for an APP ADMIN role that's assigned to a client (by clientId). |
List all client role group targetslistGroupTargetRoleForClient | GET | Lists all group targets for a USER ADMIN, HELP DESK ADMIN, or GROUP MEMBERSHIP ADMIN role assignment to a client. |
Unassign a client role app instance targetremoveAppTargetInstanceRoleForClient | DELETE | Unassigns an app instance target from a role assignment to a client app |
Unassign a client role app targetremoveAppTargetRoleFromClient | DELETE | Unassigns an OIN app target for a role assignment to a client app |
Unassign a client role group targetremoveGroupTargetRoleFromClient | DELETE | Unassigns a Group target from a USER ADMIN, HELP DESK ADMIN, or GROUP MEMBERSHIP ADMIN role assignment to a client app. |
RoleCResourceSet5
Create a resource setcreateResourceSet | POST | Creates a new resource set. |
Delete a resource setdeleteResourceSet | DELETE | Deletes a resource set by resourceSetIdOrLabel |
List all resource setslistResourceSets | GET | Lists all resource sets with pagination support |
Replace a resource setreplaceResourceSet | PUT | Replaces the label and description of a resource set. |
Retrieve a resource setgetResourceSet | GET | Retrieves a resource set by resourceSetIdOrLabel |
RoleCResourceSetResource6
Add a resource set resource with conditionsaddResourceSetResource | POST | Adds a resource with conditions for a resource set |
Add more resources to a resource setaddResourceSetResources | PATCH | Adds more resources to a resource set |
Delete a resource set resourcedeleteResourceSetResource | DELETE | Deletes a resource (identified by resourceId) from a resource set |
List all resource set resourceslistResourceSetResources | GET | Lists all resources for the resource set |
Replace the resource set resource conditionsreplaceResourceSetResource | PUT | Replaces the conditions of a resource identified by resourceId in a resource set |
Retrieve a resource set resourcegetResourceSetResource | GET | Retrieves a resource identified by resourceId in a resource set |
RoleDResourceSetBinding4
Create a role resource set bindingcreateResourceSetBinding | POST | Creates a binding for the resource set, custom role, and members (users or groups) |
Delete a role resource set bindingdeleteBinding | DELETE | Deletes a binding of a role (identified by roleIdOrLabel) and a resource set (identified by resourceSetIdOrLabel) |
List all role resource set bindingslistBindings | GET | Lists all bindings for a resource set with pagination support. |
Retrieve a role resource set bindinggetBinding | GET | Retrieves the binding of a role (identified by roleIdOrLabel) for a resource set (identified by resourceSetIdOrLabel) |
RoleDResourceSetBindingMember4
Add more role resource set binding membersaddMembersToBinding | PATCH | Adds more members to a role resource set binding |
List all role resource set binding memberslistMembersOfBinding | GET | Lists all members of a role resource set binding with pagination support |
Retrieve a role resource set binding membergetMemberOfBinding | GET | Retrieves a member (identified by memberId) that belongs to a role resource set binding |
Unassign a role resource set binding memberunassignMemberFromBinding | DELETE | Unassigns a member (identified by memberId) from a role resource set binding |
RoleECustom5
Create a custom rolecreateRole | POST | Creates a custom role |
Delete a custom roledeleteRole | DELETE | Deletes a custom role by roleIdOrLabel |
List all custom roleslistRoles | GET | Lists all custom roles with pagination support |
Replace a custom rolereplaceRole | PUT | Replaces the label and description for a custom role by roleIdOrLabel |
Retrieve a rolegetRole | GET | Retrieves a role by roleIdOrLabel |
RoleECustomPermission5
Create a custom role permissioncreateRolePermission | POST | Creates a permission (specified by permissionType) for a custom role |
Delete a custom role permissiondeleteRolePermission | DELETE | Deletes a permission (identified by permissionType) from a custom role |
List all custom role permissionslistRolePermissions | GET | Lists all permissions for a custom role by roleIdOrLabel |
Replace a custom role permissionreplaceRolePermission | PUT | Replaces a permission (specified by permissionType) for a custom role |
Retrieve a custom role permissiongetRolePermission | GET | Retrieves a permission (identified by permissionType) for a custom role |
Schema8
List the log stream schemaslistLogStreamSchemas | GET | Lists the schema for all log stream types visible for this org |
Retrieve a user schemagetUserSchema | GET | Retrieves the schema for a user type |
Retrieve the default app user schema for an appgetApplicationUserSchema | GET | Retrieves the default schema for an app user. |
Retrieve the default group schemagetGroupSchema | GET | Retrieves the group schema |
Retrieve the log stream schema for the schema typegetLogStreamSchema | GET | Retrieves the schema for a log stream type. |
Update a user schemaupdateUserProfile | POST | Updates a user schema. |
Update the app user profile schema for an appupdateApplicationUserProfile | POST | Updates the app user schema. |
Update the group profile schemaupdateGroupSchema | POST | Updates the group profile schema. |
ServiceAccount5
Create an app service accountcreateAppServiceAccount | POST | Creates a new app service account for managing an app account |
Delete an app service accountdeleteAppServiceAccount | DELETE | Deletes an app service account specified by ID |
List all app service accountslistAppServiceAccounts | GET | Lists all app service accounts |
Retrieve an app service accountgetAppServiceAccount | GET | Retrieves an app service account specified by ID |
Update an existing app service accountupdateAppServiceAccount | PATCH | Updates an existing app service account specified by ID |
Session3
Refresh a sessionrefreshSession | POST | Refreshes an existing session using the id for that session. |
Retrieve a sessiongetSession | GET | Retrieves information about the session specified by the given session ID |
Revoke a sessionrevokeSession | DELETE | Revokes the specified session |
SSFReceiver7
Activate a security events provideractivateSecurityEventsProviderInstance | POST | Activates a security events provider instance by setting its status to ACTIVE. |
Create a security events providercreateSecurityEventsProviderInstance | POST | Creates a security events provider instance |
Deactivate a security events providerdeactivateSecurityEventsProviderInstance | POST | Deactivates a security events provider instance by setting its status to INACTIVE. |
Delete a security events providerdeleteSecurityEventsProviderInstance | DELETE | Deletes a security events provider instance specified by id |
List all security events providerslistSecurityEventsProviderInstances | GET | Lists all security events provider instances |
Replace a security events providerreplaceSecurityEventsProviderInstance | PUT | Replaces a security events provider instance specified by id |
Retrieve the security events providergetSecurityEventsProviderInstance | GET | Retrieves the security events provider instance specified by id |
SSFSecurityEventToken1
Publish a security event tokenpublishSecurityEventTokens | POST | Publishes a security event token (SET) sent by a security events provider. |
SSFTransmitter8
Create an SSF streamcreateSsfStream | POST | Creates an SSF stream for an event receiver to start receiving security events in the form of Security Event Tokens (SETs) from Okta. |
Delete an SSF streamdeleteSsfStream | DELETE | Deletes the specified SSF stream. |
Replace an SSF streamreplaceSsfStream | PUT | Replaces all properties for an existing SSF stream configuration. |
Retrieve the SSF stream configuration(s)getSsfStreams | GET | Retrieves either a list of all known SSF stream configurations or the individual configuration if specified by ID. |
Retrieve the SSF stream statusgetSsfStreamStatus | GET | Retrieves the status of an SSF stream. |
Retrieve the SSF transmitter metadatagetWellknownSsfMetadata | GET | Retrieves SSF transmitter configuration metadata. |
Update an SSF streamupdateSsfStream | PATCH | Updates properties for an existing SSF stream configuration. |
Verify an SSF streamverifySsfStream | POST | Verifies an SSF stream by publishing a verification event requested by a security events provider. |
Subscription8
List all subscriptions for a rolelistSubscriptionsRole | GET | Lists all subscriptions available to a specified Role |
List all subscriptions for a userlistSubscriptionsUser | GET | Lists all subscriptions available to a specified user. |
Retrieve a subscription for a rolegetSubscriptionsNotificationTypeRole | GET | Retrieves a subscription by notificationType for a specified Role |
Retrieve a subscription for a usergetSubscriptionsNotificationTypeUser | GET | Retrieves a subscription by notificationType for a specified user. |
Subscribe a role to a specific notification typesubscribeByNotificationTypeRole | POST | Subscribes a Role to a specified notification type. |
Subscribe a user to a specific notification typesubscribeByNotificationTypeUser | POST | Subscribes the current user to a specified notification type. |
Unsubscribe a role from a specific notification typeunsubscribeByNotificationTypeRole | POST | Unsubscribes a Role from a specified notification type. |
Unsubscribe a user from a specific notification typeunsubscribeByNotificationTypeUser | POST | Unsubscribes the current user from a specified notification type. |
SystemLog1
List all System Log eventslistLogEvents | GET | Lists all System Log events |
Template6
Create an SMS templatecreateSmsTemplate | POST | Creates a new custom SMS template |
Delete an SMS templatedeleteSmsTemplate | DELETE | Deletes an SMS template |
List all SMS templateslistSmsTemplates | GET | Lists all custom SMS templates. |
Replace an SMS templatereplaceSmsTemplate | PUT | Replaces the SMS Template Notes: You can't update the default SMS Template. |
Retrieve an SMS templategetSmsTemplate | GET | Retrieves a specific template by id |
Update an SMS templateupdateSmsTemplate | POST | Updates only some of the SMS Template properties: All properties within the custom SMS Template that have values are updated. |
Theme9
Delete the background imagedeleteBrandThemeBackgroundImage | DELETE | Deletes a theme background image |
Delete the favicondeleteBrandThemeFavicon | DELETE | Deletes a theme favicon. |
Delete the logodeleteBrandThemeLogo | DELETE | Deletes a Theme logo. |
List all themeslistBrandThemes | GET | Lists all the themes in your brand. |
Replace a themereplaceBrandTheme | PUT | Replaces a theme for a brand |
Retrieve a themegetBrandTheme | GET | Retrieves a theme for a brand |
Upload the background imageuploadBrandThemeBackgroundImage | POST | Uploads and replaces the background image for the theme. |
Upload the faviconuploadBrandThemeFavicon | POST | Uploads and replaces the favicon for the theme |
Upload the logouploadBrandThemeLogo | POST | Uploads and replaces the logo for the theme. |
ThreatInsight2
Retrieve the ThreatInsight configurationgetCurrentConfiguration | GET | Retrieves the ThreatInsight configuration for the org |
Update the ThreatInsight configurationupdateConfiguration | POST | Updates the ThreatInsight configuration for the org |
TrustedOrigin7
Activate a trusted originactivateTrustedOrigin | POST | Activates a trusted origin. |
Create a trusted origincreateTrustedOrigin | POST | Creates a trusted origin |
Deactivate a trusted origindeactivateTrustedOrigin | POST | Deactivates a trusted origin. |
Delete a trusted origindeleteTrustedOrigin | DELETE | Deletes a trusted origin |
List all trusted originslistTrustedOrigins | GET | Lists all trusted origins |
Replace a trusted originreplaceTrustedOrigin | PUT | Replaces a trusted origin |
Retrieve a trusted origingetTrustedOrigin | GET | Retrieves a trusted origin |
UISchema5
Create a UI schemacreateUISchema | POST | Creates an input for an enrollment form |
Delete a UI schemadeleteUISchemas | DELETE | Deletes a UI Schema by id |
List all UI schemaslistUISchemas | GET | Lists all UI Schemas in your org |
Replace a UI schemareplaceUISchemas | PUT | Replaces a UI Schema by id |
Retrieve a UI schemagetUISchema | GET | Retrieves a UI Schema by id |
User7
Create a usercreateUser | POST | Creates a new user in your Okta org with or without credentials. |
Delete a userdeleteUser | DELETE | Deletes a user permanently. |
List all user blockslistUserBlocks | GET | Lists information about how the user is blocked from accessing their account |
List all userslistUsers | GET | Lists users in your org, with pagination in most cases. |
Replace a userreplaceUser | PUT | Replaces a user's profile, credentials, or both using strict-update semantics. |
Retrieve a usergetUser | GET | Retrieves a user from your Okta org. |
Update a userupdateUser | POST | Updates a user's profile or credentials with partial update semantics. |
UserAuthenticatorEnrollment5
Create an auto-activated Phone authenticator enrollmentcreateAuthenticatorEnrollment | POST | Creates a Phone authenticator enrollment that's automatically activated |
Create an auto-activated TAC authenticator enrollmentcreateTacAuthenticatorEnrollment | POST | Creates an auto-activated Temporary access code (TAC) authenticator enrollment |
Delete an authenticator enrollmentdeleteAuthenticatorEnrollment | DELETE | Deletes an existing enrollment for the specified user. |
List all authenticator enrollmentslistAuthenticatorEnrollments | GET | Lists all authenticator enrollments of the specified user |
Retrieve an authenticator enrollmentgetAuthenticatorEnrollment | GET | Retrieves a user's authenticator enrollment by enrollmentId |
UserClassification2
Replace the user's classificationreplaceUserClassification | PUT | Replaces the user's classification |
Retrieve a user's classificationgetUserClassification | GET | Retrieves a user's classification |
UserCred7
Expire the passwordexpirePassword | POST | Expires the password. |
Expire the password with a temporary passwordexpirePasswordWithTempPassword | POST | Expires the password and resets the user's password to a temporary password. |
Reset a passwordresetPassword | POST | Resets a password. |
Reset password with recovery questionforgotPasswordSetNewPassword | POST | Resets the user's password to the specified password if the provided answer to the recovery question is correct. |
Start forgot password flowforgotPassword | POST | Starts the forgot password flow. |
Update passwordchangePassword | POST | Updates a user's password by validating the user's current password. |
Update recovery questionchangeRecoveryQuestion | POST | Updates a user's recovery question and answer credential by validating the user's current password. |
UserFactor13
Activate a factoractivateFactor | POST | Activates a factor. |
Enroll a factorenrollFactor | POST | Enrolls a supported factor for the specified user |
List all enrolled factorslistFactors | GET | Lists all enrolled factors for the specified user that are included in the highest priority authenticator enrollment policy that applies to the user. |
List all supported factorslistSupportedFactors | GET | Lists all the supported factors that can be enrolled for the specified user that are included in the highest priority authenticator enrollment policy that applies to the user. |
List all supported security questionslistSupportedSecurityQuestions | GET | Lists all available security questions for the specified user |
List all YubiKey OTP tokenslistYubikeyOtpTokens | GET | Lists all YubiKey OTP tokens |
Resend a factor enrollmentresendEnrollFactor | POST | Resends an sms, call, or email factor challenge as part of an enrollment flow. |
Retrieve a factorgetFactor | GET | Retrieves an existing factor for the specified user |
Retrieve a factor transaction statusgetFactorTransactionStatus | GET | Retrieves the status of a push factor verification transaction |
Retrieve a YubiKey OTP tokengetYubikeyOtpTokenById | GET | Retrieves the specified YubiKey OTP token by id |
Unenroll a factorunenrollFactor | DELETE | Unenrolls an existing factor for the specified user. |
Upload a YubiKey OTP seeduploadYubikeyOtpTokenSeed | POST | Uploads a seed for a user to enroll a YubiKey OTP |
Verify a factorverifyFactor | POST | Verifies an OTP for a factor. |
UserGrant6
List all grants for a clientlistGrantsForUserAndClient | GET | Lists all grants for a specified user and client |
List all user grantslistUserGrants | GET | Lists all grants for the specified user |
Retrieve a user grantgetUserGrant | GET | Retrieves a grant for the specified user |
Revoke a user grantrevokeUserGrant | DELETE | Revokes one grant for a specified user |
Revoke all grants for a clientrevokeGrantsForUserAndClient | DELETE | Revokes all grants for the specified user and client |
Revoke all user grantsrevokeUserGrants | DELETE | Revokes all grants for a specified user |
UserLifecycle7
Activate a useractivateUser | POST | Activates a user. |
Deactivate a userdeactivateUser | POST | Deactivates a user. |
Reactivate a userreactivateUser | POST | Reactivates a user. |
Reset the factorsresetFactors | POST | Resets all factors for the specified user. |
Suspend a usersuspendUser | POST | Suspends a user. |
Unlock a userunlockUser | POST | Unlocks a user with a LOCKED OUT status or unlocks a user with an ACTIVE status that's blocked from unknown devices. |
Unsuspend a userunsuspendUser | POST | Unsuspends a user and returns them to the ACTIVE state. |
UserLinkedObject3
Assign a linked object value for primaryassignLinkedObjectValueForPrimary | PUT | Assigns the first user as the associated and the second user as the primary for the specified relationship. |
Delete a linked object valuedeleteLinkedObjectForUser | DELETE | Deletes any existing relationship between the associated and primary user. |
List the primary or all of the associated linked object valueslistLinkedObjectsForUser | GET | Lists either the self link for the primary user or all associated users in the relationship specified by relationshipName. |
UserOAuth4
List all refresh tokens for a clientlistRefreshTokensForUserAndClient | GET | Lists all refresh tokens issued for the specified user and client |
Retrieve a refresh token for a clientgetRefreshTokenForUserAndClient | GET | Retrieves a refresh token issued for the specified user and client |
Revoke a token for a clientrevokeTokenForUserAndClient | DELETE | Revokes the specified refresh and access tokens |
Revoke all refresh tokens for a clientrevokeTokensForUserAndClient | DELETE | Revokes all refresh tokens issued for the specified user and client |
UserResource4
List all assigned app linkslistAppLinks | GET | Lists all app links for all direct or indirect (through group membership) assigned apps |
List all clientslistUserClients | GET | Lists all client resources for which the specified user has grants or tokens |
List all devices for an enrolled userlistUserDevices | GET | Lists all devices enrolled by a user |
List all groupslistUserGroups | GET | Lists all groups of which the user is a member Note: To list all groups in your org, use the List all groups endpoints in the Groups API. |
UserRisk2
Retrieve the user's riskgetUserRisk | GET | Retrieves the user risk object for a user ID |
Upsert the user's riskupsertUserRisk | PUT | Upserts (creates or updates) the user risk object for a user ID. |
UserSession1
Revoke all user sessionsrevokeUserSessions | DELETE | Revokes all active identity provider sessions of the user. |
UserType6
Create a user typecreateUserType | POST | Creates a new user type. |
Delete a user typedeleteUserType | DELETE | Deletes a user type permanently. |
List all user typeslistUserTypes | GET | Lists all user types in your org |
Replace a user typereplaceUserType | PUT | Replaces an existing user type. |
Retrieve a user typegetUserType | GET | Retrieves a user type by ID. |
Update a user typeupdateUserType | POST | Updates an existing user type. |
WebAuthnPreregistration7
Activate a preregistered WebAuthn factoractivatePreregistrationEnrollment | POST | Activates a preregistered WebAuthn factor. |
Assign the fulfillment error status to a WebAuthnassignFulfillmentErrorWebAuthnPreregistrationFactor | POST | Assigns the fulfillment error status to a WebAuthn preregistration factor for a user. |
Delete a WebAuthn preregistration factordeleteWebAuthnPreregistrationFactor | DELETE | Deletes a specific WebAuthn preregistration factor for a user |
Enroll a preregistered WebAuthn factorenrollPreregistrationEnrollment | POST | Enrolls a preregistered WebAuthn factor. |
Generate a fulfillment requestgenerateFulfillmentRequest | POST | Generates a fulfillment request by sending a WebAuthn preregistration event to start the flow. |
List all WebAuthn preregistration factorslistWebAuthnPreregistrationFactors | GET | Lists all WebAuthn preregistration factors for the specified user |
Send a PIN to usersendPin | POST | Sends the decoded PIN for the specified WebAuthn preregistration enrollment. |