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

  1. In Neblex open Connect › Connections and click New Connection.
  2. Search for Okta and give the connection a clear name.
  3. Fill in the fields. Secret values are encrypted and never shown again.
  4. Click Test, then Create Connection.
FieldWhat to enter
Okta domainOptionalFull Okta, Okta Preview, or custom domain without a scheme or path.Example: example.okta.com
Legacy okta.com subdomainOptionalBackward-compatible fallback used only when Okta domain is empty.Example: example
Scoped OAuth 2.0 access tokenOptionalSecretRecommended for least privilege.
SSWS API tokenOptionalSecretLegacy administrator API token for operations that allow apiToken.

Use it in a flow

  1. Open a flow, open the node library and search for Okta.
  2. Drag it onto the canvas and choose an Operation and your connection.
  3. Map the operation's fields from earlier steps, or click Map with Matt.
  4. 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 updateactivateAgentPoolsUpdatePOSTActivates a scheduled agent pool update
Create an agent pool updatecreateAgentPoolsUpdatePOSTCreates an agent pool update
Deactivate an agent pool updatedeactivateAgentPoolsUpdatePOSTDeactivates scheduled agent pool update
Delete an agent pool updatedeleteAgentPoolsUpdateDELETEDeletes agent pool update
List all agent pool updateslistAgentPoolsUpdatesGETLists all agent pool updates
List all agent poolslistAgentPoolsGETLists all agent pools with pagination support
Pause an agent pool updatepauseAgentPoolsUpdatePOSTPauses a running or queued agent pool update
Resume an agent pool updateresumeAgentPoolsUpdatePOSTResumes a running or queued agent pool update
Retrieve an agent pool update by IDgetAgentPoolsUpdateInstanceGETRetrieves an agent pool update by its updateId
Retrieve an agent pool update's settingsgetAgentPoolsUpdateSettingsGETRetrieves the current state of the agent pool update instance settings
Retry an agent pool updateretryAgentPoolsUpdatePOSTRetries an agent pool update if the update is unsuccessful or communication with Okta was interrupted during an agent auto-update
Stop an agent pool updatestopAgentPoolsUpdatePOSTStops an agent pool update
Update an agent pool update by IDupdateAgentPoolsUpdatePOSTUpdates an agent pool update instance and returns the latest agent pool update
Update an agent pool update settingsupdateAgentPoolsUpdateSettingsPOSTUpdates an agent pool update instance settings
ApiServiceIntegration9
Activate an API service integration instance secretactivateApiServiceIntegrationInstanceSecretPOSTActivates an API Service Integration instance Secret by secretId
Create an API service integration instancecreateApiServiceIntegrationInstancePOSTCreates and authorizes an API Service Integration instance
Create an API service integration instance secretcreateApiServiceIntegrationInstanceSecretPOSTCreates an API Service Integration instance Secret object with a new active client secret.
Deactivate an API service integration instance secretdeactivateApiServiceIntegrationInstanceSecretPOSTDeactivates an API Service Integration instance Secret by secretId
Delete an API service integration instancedeleteApiServiceIntegrationInstanceDELETEDeletes an API Service Integration instance by id.
Delete an API service integration instance secretdeleteApiServiceIntegrationInstanceSecretDELETEDeletes an API Service Integration instance Secret by secretId.
List all API service integration instance secretslistApiServiceIntegrationInstanceSecretsGETLists all client secrets for an API Service Integration instance by apiServiceId
List all API service integration instanceslistApiServiceIntegrationInstancesGETLists all API Service Integration instances with a pagination option
Retrieve an API service integration instancegetApiServiceIntegrationInstanceGETRetrieves an API Service Integration instance by id
ApiToken5
List all API token metadatalistApiTokensGETLists all the metadata of the active API tokens
Retrieve an API token's metadatagetApiTokenGETRetrieves the metadata for an active API token by apiTokenId
Revoke an API tokenrevokeApiTokenDELETERevokes an API token by apiTokenId
Revoke the current API tokenrevokeCurrentApiTokenDELETERevokes the API token provided in the Authorization header
Upsert an API token network conditionupsertApiTokenPUTUpserts an API Token Network Condition by apiTokenId
Application7
Activate an applicationactivateApplicationPOSTActivates an inactive application
Create an applicationcreateApplicationPOSTCreates an app instance in your Okta org.
Deactivate an applicationdeactivateApplicationPOSTDeactivates an active application
Delete an applicationdeleteApplicationDELETEDeletes an inactive application
List all applicationslistApplicationsGETLists all apps in the org with pagination.
Replace an applicationreplaceApplicationPUTReplaces 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 applicationgetApplicationGETRetrieves an application from your Okta organization by id
ApplicationConnection6
Activate the default provisioning connectionactivateDefaultProvisioningConnectionForApplicationPOSTActivates the default provisioning connection for an app
Deactivate the default provisioning connectiondeactivateDefaultProvisioningConnectionForApplicationPOSTDeactivates the default provisioning connection for an app
Retrieve a JSON Web Key Set (JWKS) for the default provisioninggetUserProvisioningConnectionJWKSGETRetrieves a JWKS for the default provisioning connection.
Retrieve the default provisioning connectiongetDefaultProvisioningConnectionForApplicationGETRetrieves the default provisioning connection for an app
Update the default provisioning connectionupdateDefaultProvisioningConnectionForApplicationPOSTUpdates the default provisioning connection for an app
Verify the provisioning connectionverifyProvisioningConnectionForApplicationPOSTVerifies the OAuth 2.0-based connection as part of the OAuth 2.0 consent flow.
ApplicationCrossAppAccessConnection5
Create a Cross App Access connectioncreateCrossAppAccessConnectionPOSTCreates a Cross App Access connection
Delete a Cross App Access connectiondeleteCrossAppAccessConnectionDELETEDeletes a Cross App Access connection with the specified ID
Retrieve a Cross App Access connectiongetCrossAppAccessConnectionGETRetrieves the Cross App Access connection with the specified ID
Retrieve all Cross App Access connectionsgetAllCrossAppAccessConnectionsGETRetrieves inbound and outbound Cross App Access connections associated with an app
Update a Cross App Access connectionupdateCrossAppAccessConnectionPATCHUpdates the Cross App Access connection with the specified ID
ApplicationFeature3
List all featureslistFeaturesForApplicationGETLists all features for an app Note: This request returns an error if provisioning isn't enabled for the app.
Retrieve a featuregetFeatureForApplicationGETRetrieves a Feature object for an app
Update a featureupdateFeatureForApplicationPUTUpdates a Feature object for an app Note: This endpoint supports partial updates.
ApplicationGrant4
Grant consent to scopegrantConsentToScopePOSTGrants consent for the app to request an OAuth 2.0 Okta scope
List all app grantslistScopeConsentGrantsGETLists all scope consent Grants for the app
Retrieve an app grantgetScopeConsentGrantGETRetrieves a single scope consent Grant object for the app
Revoke an app grantrevokeScopeConsentGrantDELETERevokes permission for the app to grant the given scope
ApplicationGroup5
Assign an application groupassignGroupToApplicationPUTAssigns a Group to an app, which in turn assigns the app to each User that belongs to the group.
List all application groupslistApplicationGroupAssignmentsGETLists all app group assignments
Retrieve an application groupgetApplicationGroupAssignmentGETRetrieves an app group assignment
Unassign an application groupunassignApplicationFromGroupDELETEUnassigns a Group from an app
Update an application groupupdateGroupAssignmentToApplicationPATCHUpdates a group assignment to an app
ApplicationInterclientTrustMapping4
Create an allowed app mapping for a target appcreateInterclientTrustMappingPOSTCreates a mapping between the target app and an allowed app for interclient SSO using the interclient token
Delete an interclient trust mappingdeleteInterclientTrustMappingDELETEDeletes the mapping between the target app and an allowed app
List all allowed apps for a target applistInterclientAllowedApplicationsGETLists all apps allowed by this app to request interclient SSO using the interclient token
List all target apps for an allowed applistInterclientTargetApplicationsGETLists all the target apps that allow this app to request interclient SSO using an interclient token
ApplicationLogo1
Upload an application logouploadApplicationLogoPOSTUploads a logo for the app instance.
ApplicationPolicy1
Assign an app sign-in policyassignApplicationPolicyPUTAssigns an app to an app sign-in policy, identified by policyId.
ApplicationSSO1
Preview the application SAML metadatapreviewSAMLmetadataForApplicationGETPreviews the SSO SAML metadata for an application
ApplicationSSOCredentialKey9
Clone a key credentialcloneApplicationKeyPOSTClones an X.509 certificate for an application key credential from a source app to a target app.
Generate a certificate signing requestgenerateCsrForApplicationPOSTGenerates a new key pair and returns the certificate signing request (CSR) for it.
Generate a key credentialgenerateApplicationKeyPOSTGenerates 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 requestslistCsrsForApplicationGETLists all certificate signing requests for an app
List all key credentialslistApplicationKeysGETLists all key credentials for an app
Publish a certificate signing requestpublishCsrFromApplicationPOSTPublishes 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 requestgetCsrForApplicationGETRetrieves a certificate signing request (CSR) for the app by csrId.
Retrieve a key credentialgetApplicationKeyGETRetrieves a specific application key credential by kid
Revoke a certificate signing requestrevokeCsrFromApplicationDELETERevokes a certificate signing request and deletes the key pair from the app
ApplicationSSOFederatedClaim5
Create a federated claimcreateFederatedClaimPOSTCreates a claim that will be included in tokens produced by federation protocols (for example: OIDC id tokens or SAML Assertions)
Delete a federated claimdeleteFederatedClaimDELETEDeletes a federated claim by claimId
List all configured federated claimslistFederatedClaimsGETLists all federated claims for your app
Replace a federated claimreplaceFederatedClaimPUTReplaces a claim that will be included in tokens produced by federation protocols (for example: OIDC id tokens or SAML Assertions)
Retrieve a federated claimgetFederatedClaimGETRetrieves a federated claim by claimId
ApplicationSSOPublicKey12
Activate an OAuth 2.0 client JSON Web KeyactivateOAuth2ClientJsonWebKeyPOSTActivates 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 secretactivateOAuth2ClientSecretPOSTActivates an OAuth 2.0 client secret by secretId
Add a JSON Web KeyaddJwkPOSTAdds a new JSON Web Key to the clients JSON Web Keys.
Create an OAuth 2.0 client secretcreateOAuth2ClientSecretPOSTCreates an OAuth 2.0 client secret object with a new active client secret.
Deactivate an OAuth 2.0 client JSON Web KeydeactivateOAuth2ClientJsonWebKeyPOSTDeactivates an OAuth 2.0 client JSON Web Key by keyId Note: You can only deactivate signing keys.
Deactivate an OAuth 2.0 client secretdeactivateOAuth2ClientSecretPOSTDeactivates an OAuth 2.0 client secret by secretId.
Delete an OAuth 2.0 client JSON Web KeydeletejwkDELETEDeletes an OAuth 2.0 Client JSON Web Key by keyId.
Delete an OAuth 2.0 client secretdeleteOAuth2ClientSecretDELETEDeletes an OAuth 2.0 client secret by secretId.
List all OAuth 2.0 client secretslistOAuth2ClientSecretsGETLists all client secrets for an OAuth 2.0 client app
List all the OAuth 2.0 client JSON Web KeyslistJwkGETLists all JSON Web Keys for an OAuth 2.0 client app
Retrieve an OAuth 2.0 client JSON Web KeygetJwkGETRetrieves an OAuth 2.0 client JSON Web Key by keyId
Retrieve an OAuth 2.0 client secretgetOAuth2ClientSecretGETRetrieves an OAuth 2.0 client secrets by secretId
ApplicationToken4
List all application refresh tokenslistOAuth2TokensForApplicationGETLists all refresh tokens for an app
Retrieve an application tokengetOAuth2TokenForApplicationGETRetrieves a refresh token for the specified app
Revoke all application tokensrevokeOAuth2TokensForApplicationDELETERevokes all OAuth 2.0 refresh tokens for the specified app.
Revoke an application tokenrevokeOAuth2TokenForApplicationDELETERevokes the specified token for the specified app
ApplicationUser5
Assign an application userassignUserToApplicationPOSTAssigns a user to an app for:
List all application userslistApplicationUsersGETLists all assigned users for an app
Retrieve an application usergetApplicationUserGETRetrieves a specific user assignment for a specific app
Unassign an application userunassignUserFromApplicationDELETEUnassigns a user from an app
Update an application userupdateApplicationUserPOSTUpdates the profile or credentials of a user assigned to an app
AssociatedDomainCustomization7
Replace the customized well-known URI of the specific pathreplaceBrandWellKnownURIPUTReplaces the content of a customized well-known URI that you specify.
Retrieve all the well-known URIsgetAllWellKnownURIsGETRetrieves the content from each of the well-known URIs for a specified brand
Retrieve the customized apple-app-site-association URI contentgetAppleAppSiteAssociationWellKnownURIGETRetrieves the content of the apple-app-site-assocation well-known URI
Retrieve the customized assetlinks.json URI contentgetAssetLinksWellKnownURIGETRetrieves the content of the assetlinks.json well-known URI
Retrieve the customized content of the specified well-known URIgetBrandWellKnownURIGETRetrieves the customized content of a well-known URI for a specific brand and well-known URI path
Retrieve the customized webauthn URI contentgetWebAuthnWellKnownURIGETRetrieves the content of the webauthn well-known URI
Retrieve the well-known URI of a specific brandgetRootBrandWellKnownURIGETRetrieves the well-known URI of a specific brand and well-known URI path
AttackProtection4
Replace the authenticator settingsreplaceAuthenticatorSettingsPUTReplaces the Authenticator Settings for an org
Replace the user lockout settingsreplaceUserLockoutSettingsPUTReplaces the User Lockout Settings for an org
Retrieve the authenticator settingsgetAuthenticatorSettingsGETRetrieves the Authenticator Settings for an org
Retrieve the user lockout settingsgetUserLockoutSettingsGETRetrieves the User Lockout Settings for an org
Authenticator19
Activate an authenticatoractivateAuthenticatorPOSTActivates an authenticator by authenticatorId
Activate an authenticator methodactivateAuthenticatorMethodPOSTActivates a method for an authenticator identified by authenticatorId and methodType
Create a custom AAGUIDcreateCustomAAGUIDPOSTCreates a custom AAGUID for the Passkey (FIDO2 WebAuthn) authenticator
Create an authenticatorcreateAuthenticatorPOSTCreates an authenticator
Deactivate an authenticatordeactivateAuthenticatorPOSTDeactivates an authenticator by authenticatorId
Deactivate an authenticator methoddeactivateAuthenticatorMethodPOSTDeactivates a method for an authenticator identified by authenticatorId and methodType
Delete a custom AAGUIDdeleteCustomAAGUIDDELETEDeletes a custom AAGUID
List all authenticatorslistAuthenticatorsGETLists all authenticators
List all custom AAGUIDslistAllCustomAAGUIDsGETLists all custom Authenticator Attestation Global Unique Identifiers (AAGUIDs) in the org
List all methods of an authenticatorlistAuthenticatorMethodsGETLists all methods of an authenticator identified by authenticatorId
Replace a custom AAGUIDreplaceCustomAAGUIDPUTReplaces a custom AAGUID for the specified Passkey (FIDO2 WebAuthn) authenticator
Replace an authenticatorreplaceAuthenticatorPUTReplaces the properties for an authenticator identified by authenticatorId
Replace an authenticator methodreplaceAuthenticatorMethodPUTReplaces a method of methodType for an authenticator identified by authenticatorId
Retrieve a custom AAGUIDgetCustomAAGUIDGETRetrieves a custom AAGUID
Retrieve an authenticatorgetAuthenticatorGETRetrieves an authenticator from your Okta organization by authenticatorId
Retrieve an authenticator methodgetAuthenticatorMethodGETRetrieves a method identified by methodType of an authenticator identified by authenticatorId
Retrieve the well-known app authenticator configurationgetWellKnownAppAuthenticatorConfigurationGETRetrieves the well-known app authenticator configuration.
Update a custom AAGUIDupdateCustomAAGUIDPATCHUpdates the properties of a custom AAGUID by the authenticatorId and aaguid ID
Verify a Relying Party ID domainverifyRpIdDomainPOSTVerifies the Relying Party identifier (RP ID) domain for the specified Passkey (FIDO2 WebAuthn) authenticator and the specific webauthn authenticator method
AuthorizationServer7
Activate an authorization serveractivateAuthorizationServerPOSTActivates an authorization server
Create an authorization servercreateAuthorizationServerPOSTCreates an authorization server
Deactivate an authorization serverdeactivateAuthorizationServerPOSTDeactivates an authorization server
Delete an authorization serverdeleteAuthorizationServerDELETEDeletes an authorization server
List all authorization serverslistAuthorizationServersGETLists all custom authorization servers in the org
Replace an authorization serverreplaceAuthorizationServerPUTReplaces an authorization server
Retrieve an authorization servergetAuthorizationServerGETRetrieves an authorization server
AuthorizationServerAssoc3
Create an associated authorization servercreateAssociatedServersPOSTCreates trusted relationships between the given authorization server and other authorization servers
Delete an associated authorization serverdeleteAssociatedServerDELETEDeletes an associated Authorization Server
List all associated authorization serverslistAssociatedServersByTrustedTypeGETLists all associated Authorization Servers by trusted type for the given authServerId
AuthorizationServerClaim5
Create a custom token claimcreateOAuth2ClaimPOSTCreates a custom token Claim for a custom authorization server
Delete a custom token claimdeleteOAuth2ClaimDELETEDeletes a custom token Claim specified by the claimId
List all custom token claimslistOAuth2ClaimsGETLists all custom token Claims defined for a specified custom authorization server
Replace a custom token claimreplaceOAuth2ClaimPUTReplaces a custom token Claim specified by the claimId
Retrieve a custom token claimgetOAuth2ClaimGETRetrieves a custom token Claim by the specified claimId
AuthorizationServerClient5
List all client resources for an authorization serverlistOAuth2ClientsForAuthorizationServerGETLists all client resources for which the specified authorization server has tokens.
List all refresh tokens for a clientlistRefreshTokensForAuthorizationServerAndClientGETLists all refresh tokens issued by an authorization server for a specific Client
Retrieve a refresh token for a clientgetRefreshTokenForAuthorizationServerAndClientGETRetrieves a refresh token for a Client
Revoke a refresh token for a clientrevokeRefreshTokenForAuthorizationServerAndClientDELETERevokes a refresh token for a Client
Revoke all refresh tokens for a clientrevokeRefreshTokensForAuthorizationServerAndClientDELETERevokes all refresh tokens for a Client
AuthorizationServerKey3
List all credential keyslistAuthorizationServerKeysGETLists all of the current, future, and expired Keys used by the Custom Authorization Server
Retrieve an authorization server keygetAuthorizationServerKeyGETRetrieves an Authorization Server Key specified by the keyId
Rotate all credential keysrotateAuthorizationServerKeysPOSTRotates the current Keys for a Custom Authorization Server.
AuthorizationServerPolicy7
Activate a policyactivateAuthorizationServerPolicyPOSTActivates an authorization server policy
Create a policycreateAuthorizationServerPolicyPOSTCreates a policy
Deactivate a policydeactivateAuthorizationServerPolicyPOSTDeactivates an authorization server policy
Delete a policydeleteAuthorizationServerPolicyDELETEDeletes a policy
List all policieslistAuthorizationServerPoliciesGETLists all policies
Replace a policyreplaceAuthorizationServerPolicyPUTReplaces a policy
Retrieve a policygetAuthorizationServerPolicyGETRetrieves a policy
AuthorizationServerRule7
Activate a policy ruleactivateAuthorizationServerPolicyRulePOSTActivates an authorization server policy rule
Create a policy rulecreateAuthorizationServerPolicyRulePOSTCreates a policy rule for the specified Custom Authorization Server and Policy
Deactivate a policy ruledeactivateAuthorizationServerPolicyRulePOSTDeactivates an authorization server policy rule
Delete a policy ruledeleteAuthorizationServerPolicyRuleDELETEDeletes a Policy Rule defined in the specified Custom Authorization Server and Policy
List all policy ruleslistAuthorizationServerPolicyRulesGETLists all policy rules for the specified Custom Authorization Server and Policy
Replace a policy rulereplaceAuthorizationServerPolicyRulePUTReplaces the configuration of the Policy Rule defined in the specified Custom Authorization Server and Policy
Retrieve a policy rulegetAuthorizationServerPolicyRuleGETRetrieves a policy rule by ruleId
AuthorizationServerScope5
Create a custom token scopecreateOAuth2ScopePOSTCreates a custom token scope
Delete a custom token scopedeleteOAuth2ScopeDELETEDeletes a custom token scope
List all custom token scopeslistOAuth2ScopesGETLists all custom token scopes
Replace a custom token scopereplaceOAuth2ScopePUTReplaces a custom token scope
Retrieve a custom token scopegetOAuth2ScopeGETRetrieves a custom token scope
Behavior7
Activate a behavior detection ruleactivateBehaviorDetectionRulePOSTActivates a behavior detection rule
Create a behavior detection rulecreateBehaviorDetectionRulePOSTCreates a new behavior detection rule
Deactivate a behavior detection ruledeactivateBehaviorDetectionRulePOSTDeactivates a behavior detection rule
Delete a behavior detection ruledeleteBehaviorDetectionRuleDELETEDeletes a Behavior Detection Rule by behaviorId
List all behavior detection ruleslistBehaviorDetectionRulesGETLists all behavior detection rules with pagination support
Replace a behavior detection rulereplaceBehaviorDetectionRulePUTReplaces a Behavior Detection Rule by behaviorId
Retrieve a behavior detection rulegetBehaviorDetectionRuleGETRetrieves a Behavior Detection Rule by behaviorId
BotProtection2
Retrieve the bot protection configurationgetBotProtectionConfigurationGETRetrieves the bot protection configuration for your org
Update the bot protection configurationupdateBotProtectionConfigurationPOSTUpdates the bot protection configuration for your org
Brand6
Create a brandcreateBrandPOSTCreates a new brand in your org
Delete a branddeleteBrandDELETEDeletes a brand by brandId
List all brandslistBrandsGETLists all the brands in your org
List all domains associated with a brandlistBrandDomainsGETLists all domains associated with a brand by brandId
Replace a brandreplaceBrandPUTReplaces a brand by brandId
Retrieve a brandgetBrandGETRetrieves a brand by brandId
CAPTCHA9
Create a CAPTCHA instancecreateCaptchaInstancePOSTCreates a new CAPTCHA instance.
Delete a CAPTCHA instancedeleteCaptchaInstanceDELETEDeletes a specified CAPTCHA instance Note: If your CAPTCHA instance is still associated with your org, the request fails.
Delete the org-wide CAPTCHA settingsdeleteOrgCaptchaSettingsDELETEDeletes the CAPTCHA settings object for your organization
List all CAPTCHA instanceslistCaptchaInstancesGETLists all CAPTCHA instances with pagination support.
Replace a CAPTCHA instancereplaceCaptchaInstancePUTReplaces the properties for a specified CAPTCHA instance
Replace the org-wide CAPTCHA settingsreplacesOrgCaptchaSettingsPUTReplaces 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 instancegetCaptchaInstanceGETRetrieves the properties of a specified CAPTCHA instance
Retrieve the org-wide CAPTCHA settingsgetOrgCaptchaSettingsGETRetrieves 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 instanceupdateCaptchaInstancePOSTPartially updates the properties of a specified CAPTCHA instance
CustomDomain7
Create a custom domaincreateCustomDomainPOSTCreates your custom domain
Delete a custom domaindeleteCustomDomainDELETEDeletes a custom domain by domainId
List all custom domainslistCustomDomainsGETLists all verified custom domains for the org
Replace a custom domain's brandreplaceCustomDomainPUTReplaces a custom domain's brand
Retrieve a custom domaingetCustomDomainGETRetrieves a custom domain by domainId
Upsert the custom domain's certificateupsertCertificatePUTUpserts (creates or renews) the MANUAL certificate for the custom domain
Verify a custom domainverifyDomainPOSTVerifies the custom domain and validity of DNS records by domainId.
CustomPage19
Delete the customized error pagedeleteCustomizedErrorPageDELETEDeletes the customized error page.
Delete the customized sign-in pagedeleteCustomizedSignInPageDELETEDeletes the customized sign-in page.
Delete the preview error pagedeletePreviewErrorPageDELETEDeletes the preview error page.
Delete the preview sign-in pagedeletePreviewSignInPageDELETEDeletes the preview sign-in page.
List all Sign-In Widget versionslistAllSignInWidgetVersionsGETLists all sign-in widget versions supported by the current org
Replace the customized error pagereplaceCustomizedErrorPagePUTReplaces the customized error page.
Replace the customized sign-in pagereplaceCustomizedSignInPagePUTReplaces the customized sign-in page.
Replace the preview error pagereplacePreviewErrorPagePUTReplaces the preview error page.
Replace the preview sign-in pagereplacePreviewSignInPagePUTReplaces the preview sign-in page.
Replace the sign-out page settingsreplaceSignOutPageSettingsPUTReplaces the sign-out page settings
Retrieve the customized error pagegetCustomizedErrorPageGETRetrieves the customized error page.
Retrieve the customized sign-in pagegetCustomizedSignInPageGETRetrieves the customized sign-in page.
Retrieve the default error pagegetDefaultErrorPageGETRetrieves the default error page.
Retrieve the default sign-in pagegetDefaultSignInPageGETRetrieves the default sign-in page.
Retrieve the error page sub-resourcesgetErrorPageGETRetrieves the error page sub-resources.
Retrieve the preview error page previewgetPreviewErrorPageGETRetrieves the preview error page.
Retrieve the preview sign-in page previewgetPreviewSignInPageGETRetrieves the preview sign-in page.
Retrieve the sign-in page sub-resourcesgetSignInPageGETRetrieves the sign-in page sub-resources.
Retrieve the sign-out page settingsgetSignOutPageSettingsGETRetrieves the sign-out page settings
CustomTelephonyProvider9
Activate a custom telephony provideractivateCustomTelephonyCredentialPOSTActivates a custom telephony provider by its ID.
Create a custom telephony providercreateCustomTelephonyProviderCredentialsPOSTCreates a custom telephony provider with the provided credentials
Deactivate a custom telephony providerdeactivateCustomTelephonyCredentialPOSTDeactivates a custom telephony provider by its ID.
Delete a custom telephony providerdeleteCustomTelephonyProviderCredentialDELETEDeletes a custom telephony provider by its ID.
List all custom telephony providerslistAllCustomTelephonyProviderCredentialsGETLists all custom telephony providers that are configured in your org
Retrieve a custom telephony providergetCustomTelephonyProviderCredentialGETRetrieves the details of a custom telephony provider by its ID
Send a test message from a custom telephony providersendTestCustomTelephonyProviderCredentialPOSTSends 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 providersetAsPrimaryCustomTelephonyCredentialPOSTSets a custom telephony provider as the primary telephony provider for the org.
Update a custom telephony provider credentialupdateCustomTelephonyProviderCredentialPATCHUpdates the credentials of an existing custom telephony provider
CustomTemplate14
Create an email customizationcreateEmailCustomizationPOSTCreates a new Email Customization
Delete all email customizationsdeleteAllCustomizationsDELETEDeletes all customizations for an email template
Delete an email customizationdeleteEmailCustomizationDELETEDeletes an Email Customization by its unique identifier
List all email customizationslistEmailCustomizationsGETLists all customizations of an email template
List all email templateslistEmailTemplatesGETLists all supported email templates
Replace an email customizationreplaceEmailCustomizationPUTReplaces an email customization using property values
Replace the email template settingsreplaceEmailSettingsPUTReplaces an email template's settings
Retrieve a preview of an email customizationgetCustomizationPreviewGETRetrieves a Preview of an Email Customization.
Retrieve a preview of the email template default contentgetEmailDefaultPreviewGETRetrieves a preview of an Email Template's default content.
Retrieve an email customizationgetEmailCustomizationGETRetrieves an email customization by its unique identifier
Retrieve an email templategetEmailTemplateGETRetrieves the details of an email template by name
Retrieve an email template default contentgetEmailDefaultContentGETRetrieves an email template's default content
Retrieve the email template settingsgetEmailSettingsGETRetrieves an email template's settings
Send a test emailsendTestEmailPOSTSends a test email to the current user's primary and secondary email addresses.
Device10
Activate a deviceactivateDevicePOSTActivates a device by setting its status to ACTIVE by deviceId.
Deactivate a devicedeactivateDevicePOSTDeactivates a device by setting its status to DEACTIVATED by deviceId.
Delete a devicedeleteDeviceDELETEDeletes (permanently) a device by deviceId if it has a status of DEACTIVATED.
List all deviceslistDevicesGETLists all devices with pagination support.
List all OS accounts for a devicelistDeviceOSAccountsGETLists all OS accounts for a device by deviceId
List all users for a devicelistDeviceUsersGETLists all Users for a device by deviceId
Retrieve a devicegetDeviceGETRetrieves a device by deviceId
Retrieve an OS accountgetDeviceOSAccountGETRetrieves an OS account by osAccountId for a device
Suspend a DevicesuspendDevicePOSTSuspends a device by setting its status to SUSPENDED.
Unsuspend a DeviceunsuspendDevicePOSTUnsuspends a device by returning its status to ACTIVE.
DeviceAssurance5
Create a device assurance policycreateDeviceAssurancePolicyPOSTCreates a new device assurance policy
Delete a device assurance policydeleteDeviceAssurancePolicyDELETEDeletes a device assurance policy by deviceAssuranceId.
List all device assurance policieslistDeviceAssurancePoliciesGETLists all device assurance policies
Replace a device assurance policyreplaceDeviceAssurancePolicyPUTReplaces a device assurance policy by deviceAssuranceId
Retrieve a device assurance policygetDeviceAssurancePolicyGETRetrieves a device assurance policy by deviceAssuranceId
DeviceIntegration4
Activate a device integrationactivateDeviceIntegrationPOSTActivates a device integration and populates the related configurations by deviceIntegrationId
Deactivate a device integrationdeactivateDeviceIntegrationPOSTDeactivates a device integration by deviceIntegrationId
List all device integrationslistDeviceIntegrationsGETLists all device integrations for your org.
Retrieve a device integrationgetDeviceIntegrationGETRetrieves a device integration by deviceIntegrationId
DevicePostureCheck6
Create a device posture checkcreateDevicePostureCheckPOSTCreates a device posture check
Delete a device posture checkdeleteDevicePostureCheckDELETEDeletes a device posture check by postureCheckId.
List all default device posture checkslistDefaultDevicePostureChecksGETLists all default device posture checks.
List all device posture checkslistDevicePostureChecksGETLists all device posture checks
Replace a device posture checkreplaceDevicePostureCheckPUTReplaces a device posture check by postureCheckId
Retrieve a device posture checkgetDevicePostureCheckGETRetrieves a device posture check by postureCheckId
DirectoriesIntegration3
Retrieve the results of an AD group querygetGroupAttributeQueryResultGETRetrieves 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 GroupsubmitGroupAttributeQueryPOSTSubmits a query search on the on-premises agent to asynchronously fetch specific Active Directory (AD) attributes for a group.
Update an external directory group membershipupdateGroupMembershipPOSTUpdates an Active Directory or LDAP group membership directly in the Active Directory or LDAP server.
DisasterRecovery4
Retrieve the disaster recovery status for a domaingetDRStatusForDomainGETRetrieves the failover or failback status for the domain specified in the request path
Retrieve the disaster recovery status for all domainsgetDRStatusGETRetrieves the failover or failback status for all the domains for your org
Start the failback of your orgstartOrgFailbackPOSTStarts the failback of your org
Start the failover of your orgstartOrgFailoverPOSTStarts the failover of your org
EmailCustomization1
Remove bounced emailsbulkRemoveEmailAddressBouncesPOSTRemoves emails from an email service bounce list.
EmailDomain6
Create an email domaincreateEmailDomainPOSTCreates an Email Domain in your org
Delete an email domaindeleteEmailDomainDELETEDeletes an Email Domain by emailDomainId
List all email domainslistEmailDomainsGETLists all the Email Domains in your org
Replace an email domainreplaceEmailDomainPUTReplaces associated username and sender display name by emailDomainId
Retrieve an email domaingetEmailDomainGETRetrieves an Email Domain by emailDomainId
Verify an email domainverifyEmailDomainPOSTVerifies an Email Domain by emailDomainId
EmailServer6
Create a custom SMTP servercreateEmailServerPOSTCreates a custom email SMTP server configuration for your org.
Delete an SMTP server configurationdeleteEmailServerDELETEDeletes the specified custom SMTP server configuration
List all enrolled SMTP serverslistEmailServersGETLists all the enrolled custom SMTP server configurations
Retrieve an SMTP server configurationgetEmailServerGETRetrieves the specified custom SMTP server configuration
Test an SMTP server configurationtestEmailServerPOSTTests the specified custom SMTP server configuration
Update an SMTP server configurationupdateEmailServerPATCHUpdates the specified custom SMTP server configuration
EventHook8
Activate an event hookactivateEventHookPOSTActivates the event hook that matches the provided id
Create an event hookcreateEventHookPOSTCreates a new event hook for your organization in ACTIVE status.
Deactivate an event hookdeactivateEventHookPOSTDeactivates the event hook that matches the provided id
Delete an event hookdeleteEventHookDELETEDeletes the event hook that matches the provided id.
List all event hookslistEventHooksGETLists all event hooks
Replace an event hookreplaceEventHookPUTReplaces an event hook.
Retrieve an event hookgetEventHookGETRetrieves an event hook
Verify an event hookverifyEventHookPOSTVerifies that the event hook matches the provided eventHookId.
Feature5
List all dependencieslistFeatureDependenciesGETLists all feature dependencies for a specified feature.
List all dependentslistFeatureDependentsGETLists all feature dependents for the specified feature.
List all featureslistFeaturesGETLists all self-service features for your org
Retrieve a featuregetFeatureGETRetrieves a feature by ID
Update a feature lifecycleupdateFeatureLifecyclePOSTUpdates a feature's lifecycle status.
GovernanceBundle10
Create a governance bundlecreateGovernanceBundlePOSTCreates a governance bundle of entitlements for the Admin Console
Delete a governance bundledeleteGovernanceBundleDELETEDeletes an Admin Console governance bundle
List all entitlements for a governance bundlelistBundleEntitlementsGETLists all entitlements specific to a governance bundle
List all governance bundleslistGovernanceBundlesGETLists all governance bundles for the Admin Console in your org
List all values for a governance bundle entitlementlistBundleEntitlementValuesGETLists all entitlement values that are specific to a governance bundle entitlement
Opt in the Admin Console to entitlement managementoptInPOSTOpts in the Admin Console to entitlement management
Opt out the Admin Console from entitlement managementoptOutPOSTOpts out the Admin Console from entitlement management
Replace a governance bundlereplaceGovernanceBundlePUTReplaces the properties of a governance bundle for the Admin Console
Retrieve a governance bundlegetGovernanceBundleGETRetrieves a governance bundle for the Admin Console
Retrieve the Admin Console opt-in statusgetOptInStatusGETRetrieves the entitlement management opt-in status for the Admin Console
Group9
Add a groupaddGroupPOSTAdds a new group with the OKTA GROUP type to your org.
Assign a user to a groupassignUserToGroupPUTAssigns a user to a group with the OKTA GROUP type.
Delete a groupdeleteGroupDELETEDeletes a group of the OKTA GROUP or APP GROUP type from your org.
List all assigned appslistAssignedApplicationsForGroupGETLists all apps that are assigned to a group.
List all groupslistGroupsGETLists all groups with pagination support.
List all member userslistGroupUsersGETLists all users that are a member of a group.
Replace a groupreplaceGroupPUTReplaces the profile for a group of OKTA GROUP type from your org.
Retrieve a groupgetGroupGETRetrieves a specific group by id from your org
Unassign a user from a groupunassignUserFromGroupDELETEUnassigns a user from a group with the OKTA GROUP type.
GroupOwner3
Assign a group ownerassignGroupOwnerPOSTAssigns a group owner
Delete a group ownerdeleteGroupOwnerDELETEDeletes a group owner from a specific group
List all group ownerslistGroupOwnersGETLists all owners for a specific group
GroupPushMapping5
Create a group push mappingcreateGroupPushMappingPOSTCreates or links a group push mapping.
Delete a group push mappingdeleteGroupPushMappingDELETEDeletes a specific group push mapping.
List all group push mappingslistGroupPushMappingsGETLists all group push mappings with pagination support
Retrieve a group push mappinggetGroupPushMappingGETRetrieves a group push mapping by ID
Update a group push mappingupdateGroupPushMappingPATCHUpdates the status of a group push mapping
GroupRule7
Activate a group ruleactivateGroupRulePOSTActivates a specific group rule by ID from your org
Create a group rulecreateGroupRulePOSTCreates a group rule to dynamically add users to the specified group if they match the condition.
Deactivate a group ruledeactivateGroupRulePOSTDeactivates a specific group rule by ID from your org
Delete a group ruledeleteGroupRuleDELETEDeletes a specific group rule by groupRuleId
List all group ruleslistGroupRulesGETLists all group rules for your org
Replace a group rulereplaceGroupRulePUTReplaces a group rule Notes: You can only update rules with a group whose status is set to INACTIVE.
Retrieve a group rulegetGroupRuleGETRetrieves a specific group rule by ID from your org
HookKey6
Create a keycreateHookKeyPOSTCreates a key for use with other parts of the application, such as inline hooks
Delete a keydeleteHookKeyDELETEDeletes a key by id.
List all keyslistHookKeysGETLists all keys
Replace a keyreplaceHookKeyPUTReplaces a key by id
Retrieve a key by IDgetHookKeyGETRetrieves the public portion of the Key object using the id parameter
Retrieve a public keygetPublicKeyGETRetrieves a public key by keyId
IdentityProvider7
Activate an IdPactivateIdentityProviderPOSTActivates an inactive identity provider (IdP)
Create an IdPcreateIdentityProviderPOSTCreates a new identity provider (IdP) integration.
Deactivate an IdPdeactivateIdentityProviderPOSTDeactivates an active identity provider (IdP)
Delete an IdPdeleteIdentityProviderDELETEDeletes 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 IdPslistIdentityProvidersGETLists all identity provider (IdP) integrations with pagination.
Replace an IdPreplaceIdentityProviderPUTReplaces an identity provider (IdP) integration by idpId
Retrieve an IdPgetIdentityProviderGETRetrieves an identity provider (IdP) integration by idpId
IdentityProviderKey5
Create an IdP key credentialcreateIdentityProviderKeyPOSTCreates 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 credentialdeleteIdentityProviderKeyDELETEDeletes 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 credentialslistIdentityProviderKeysGETLists all identity provider (IdP) key credentials
Replace an IdP key credentialreplaceIdentityProviderKeyPUTReplaces an identity provider (IdP) key credential by kid
Retrieve an IdP key credentialgetIdentityProviderKeyGETRetrieves a specific identity provider (IdP) key credential by kid
IdentityProviderSigningKey10
Clone a signing key credential for IdPcloneIdentityProviderKeyPOSTClones 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 requestgenerateCsrForIdentityProviderPOSTGenerates 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 IdPgenerateIdentityProviderSigningKeyPOSTGenerates 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 requestslistCsrsForIdentityProviderGETLists all certificate signing requests (CSRs) for an identity provider (IdP)
List all signing key credentials for IdPlistIdentityProviderSigningKeysGETLists all signing key credentials for an identity provider (IdP)
List the active signing key credential for IdPlistActiveIdentityProviderSigningKeyGETLists the active signing key credential for an identity provider (IdP)
Publish a certificate signing requestpublishCsrForIdentityProviderPOSTPublishes 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 requestgetCsrForIdentityProviderGETRetrieves a specific certificate signing request (CSR) by id
Retrieve a signing key credential for IdPgetIdentityProviderSigningKeyGETRetrieves a specific identity provider (IdP) key credential by kid
Revoke a certificate signing requestrevokeCsrForIdentityProviderDELETERevokes a certificate signing request (CSR) and deletes the key pair from the identity provider (IdP)
IdentityProviderUser6
Link a user to IdPlinkUserToIdentityProviderPOSTLinks an Okta user to an existing SAML or social identity provider (IdP).
List all IdPs for userlistUserIdentityProvidersGETLists the identity providers (IdPs) associated with the user
List all tokens from OIDC IdPlistSocialAuthTokensGETLists the tokens minted by the social authentication provider when the user authenticates with Okta via Social Auth.
List all users for IdPlistIdentityProviderApplicationUsersGETLists all the users linked to an identity provider (IdP)
Retrieve a user for IdPgetIdentityProviderApplicationUserGETRetrieves a linked identity provider (IdP) user by ID
Unlink a user from IdPunlinkUserFromIdentityProviderDELETEUnlinks the Okta user and the identity provider (IdP) user.
IdentitySource23
Create an identity source groupcreateIdentitySourceGroupsPOSTCreates a group in an identity source for the given identity source instance
Create an identity source sessioncreateIdentitySourceSessionPOSTCreates an identity source session for the given identity source instance
Create an identity source usercreateIdentitySourceUserPOSTCreates a user in an identity source for the given identity source instance
Create the memberships for the given identity source groupcreateIdentitySourceGroupsMembershipsPOSTCreates the group memberships for the given identity source group
Delete an identity source groupdeleteIdentitySourceGroupDELETEDeletes a group in an identity source for a given identity source ID and group ID
Delete an identity source sessiondeleteIdentitySourceSessionDELETEDeletes an identity source session for a given identity source ID and session Id
Delete an identity source userdeleteIdentitySourceUserDELETEDeletes a user in an identity source for the given identity source instance and external ID
Delete the memberships for the specified identity source groupdeleteIdentitySourceGroupMembershipsDELETEDeletes group memberships for the specified identity source group using member external IDs
List all identity source sessionslistIdentitySourceSessionsGETLists all identity source sessions for the given identity source instance
Replace an existing identity source userreplaceExistingIdentitySourceUserPUTReplaces an existing user for the given identity source instance and external ID
Retrieve an identity source groupgetIdentitySourceGroupGETRetrieves a group from an identity source for a given identity source ID and group ID or external ID
Retrieve an identity source sessiongetIdentitySourceSessionGETRetrieves an identity source session for a given identity source ID and session ID
Retrieve an identity source usergetIdentitySourceUserGETRetrieves a user by external ID in an identity source for the given identity source instance
Retrieve the memberships for the given identity source groupgetIdentitySourceGroupMembershipsGETRetrieves the group memberships for the given identity source group in the given identity source instance
Start the import from the identity sourcestartImportFromIdentitySourcePOSTStarts the import from the identity source described by the uploaded bulk operations
Update an identity source groupupdateIdentitySourceGroupsPOSTUpdates a group to an identity source for the given identity source instance and group ID
Update an identity source userupdateIdentitySourceUsersPATCHUpdates a user to an identity source for the given identity source instance and external ID
Upload the data to be deleted in OktauploadIdentitySourceDataForDeletePOSTUploads 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 OktauploadIdentitySourceDataForUpsertPOSTUploads 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 OktauploadIdentitySourceGroupsDataForDeletePOSTUploads 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 OktauploadIdentitySourceGroupMembershipsForDeletePOSTUploads 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 OktauploadIdentitySourceGroupMembershipsForUpsertPOSTUploads 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 inuploadIdentitySourceGroupsForUpsertPOSTUploads 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 hookactivateInlineHookPOSTActivates the inline hook by inlineHookId
Create an inline hookcreateInlineHookPOSTCreates an inline hook
Deactivate an inline hookdeactivateInlineHookPOSTDeactivates the inline hook by inlineHookId
Delete an inline hookdeleteInlineHookDELETEDeletes an inline hook by inlineHookId.
Execute an inline hookexecuteInlineHookPOSTExecutes the inline hook that matches the provided inlineHookId by using the request body as the input.
List all inline hookslistInlineHooksGETLists all inline hooks or all inline hooks of a specific type.
Replace an inline hookreplaceInlineHookPUTReplaces an inline hook by inlineHookId.
Retrieve an inline hookgetInlineHookGETRetrieves an inline hook by inlineHookId
Update an inline hookupdateInlineHookPOSTUpdates an inline hook by inlineHookId
LinkedObject4
Create a linked object definitioncreateLinkedObjectDefinitionPOSTCreates a Linked Object definition
Delete a linked object definitiondeleteLinkedObjectDefinitionDELETEDeletes the Linked Object definition specified by either the primary or associated name.
List all linked object definitionslistLinkedObjectDefinitionsGETLists all Linked Object definitions
Retrieve a linked object definitiongetLinkedObjectDefinitionGETRetrieves a Linked Object definition
LogStream7
Activate a log streamactivateLogStreamPOSTActivates a log stream by logStreamId
Create a log streamcreateLogStreamPOSTCreates a new log stream object
Deactivate a log streamdeactivateLogStreamPOSTDeactivates a log stream by logStreamId
Delete a log streamdeleteLogStreamDELETEDeletes a log stream object from your org by ID
List all log streamslistLogStreamsGETLists all log stream objects in your org.
Replace a log streamreplaceLogStreamPUTReplaces the log stream object properties for a given ID.
Retrieve a log streamgetLogStreamGETRetrieves a log stream object by ID
NetworkZone7
Activate a network zoneactivateNetworkZonePOSTActivates a Network Zone by zoneId
Create a network zonecreateNetworkZonePOSTCreates a Network Zone For an IP Network Zone, you must define either gateways or proxies.
Deactivate a network zonedeactivateNetworkZonePOSTDeactivates a Network Zone by zoneId
Delete a network zonedeleteNetworkZoneDELETEDeletes a Network Zone by zoneId Notes: You can't delete a Network Zone that's used by a Policy or Rule.
List all network zoneslistNetworkZonesGETLists all Network Zones with pagination.
Replace a network zonereplaceNetworkZonePUTReplaces a Network Zone by zoneId.
Retrieve a network zonegetNetworkZoneGETRetrieves a Network Zone by zoneId
OAuth2ResourceServerCredentialsKey6
Activate a Custom Authorization Server Public JSON Web KeyactivateOAuth2ResourceServerJsonWebKeyPOSTActivates a custom authorization server public JSON web key by key id.
Add a JSON Web KeyaddOAuth2ResourceServerJsonWebKeyPOSTAdds a new JSON Web Key to the custom authorization servers JSON web keys.
Deactivate a Custom Authorization Server Public JSON Web KeydeactivateOAuth2ResourceServerJsonWebKeyPOSTDeactivates a custom authorization server public JSON web key by key id.
Delete a Custom Authorization Server Public JSON Web KeydeleteOAuth2ResourceServerJsonWebKeyDELETEDeletes a custom authorization server public JSON web key by key id.
List all Custom Authorization Server Public JSON Web KeyslistOAuth2ResourceServerJsonWebKeysGETLists all the public keys used by the custom authorization server
Retrieve a Custom Authorization Server Public JSON Web KeygetOAuth2ResourceServerJsonWebKeyGETRetrieves a custom authorization server public JSON web key by key id
OktaApplicationSetting2
Replace the Okta application settingsreplaceFirstPartyAppSettingsPUTReplaces the settings for an Okta app (also known as an Okta first-party app)
Retrieve the Okta application settingsgetFirstPartyAppSettingsGETRetrieves the settings for an Okta app (also known as an Okta first-party app)
OktaManagedUserAccount5
Create an Okta managed user accountcreateOktaManagedUserAccountPOSTCreates a new Okta managed user account for managing a Universal Directory user as a service account.
Delete an Okta managed user accountdeleteOktaManagedUserAccountDELETEDeletes an Okta managed user account specified by ID.
List all Okta managed user accountslistOktaManagedUserAccountsGETLists all Okta managed user accounts in your org.
Retrieve an Okta managed user accountgetOktaManagedUserAccountGETRetrieves an Okta managed user account specified by ID
Update an Okta managed user accountupdateOktaManagedUserAccountPATCHUpdates an existing Okta managed user account specified by ID.
OktaPersonalSetting3
List all blocked email domainslistPersonalAppsExportBlockListGETLists all blocked email domains which are excluded from app migration
Replace the blocked email domainsreplaceBlockedEmailDomainsPUTReplaces the list of blocked email domains which are excluded from app migration
Replace the Okta Personal admin settingsreplaceOktaPersonalAdminSettingsPUTReplaces Okta Personal admin settings in a Workforce org
OrgCreator1
Create an orgcreateChildOrgPOSTCreates an org (child org) that has the same features as the current requesting org (parent org).
OrgSettingAdmin6
Assign the default public client app role settingassignClientPrivilegesSettingPUTAssigns the Super Admin role as the default role for new public client apps
Retrieve the default public client app role settinggetClientPrivilegesSettingGETRetrieves the org setting to assign the Super Admin role to new public client apps
Retrieve the Okta Admin Console assignment settinggetAutoAssignAdminAppSettingGETRetrieves the org setting to automatically assign the Okta Admin Console when an admin role is assigned
Retrieve the org third-party admin settinggetThirdPartyAdminSettingGETRetrieves the third-party admin setting.
Update the Okta Admin Console assignment settingupdateAutoAssignAdminAppSettingPOSTUpdates the org setting to automatically assign the Okta Admin Console when an admin role is assigned
Update the org third-party admin settingupdateThirdPartyAdminSettingPOSTUpdates the third-party admin setting.
OrgSettingCommunication3
Opt in to Okta user communication emailsoptInUsersToOktaCommunicationEmailsPOSTOpts in all users of this org to Okta communication emails
Opt out of Okta user communication emailsoptOutUsersFromOktaCommunicationEmailsPOSTOpts out all users of this org from Okta communication emails
Retrieve the Okta communication settingsgetOktaCommunicationSettingsGETRetrieves Okta Communication Settings of your org
OrgSettingContact3
List all org contact typeslistOrgContactTypesGETLists all org contact types for your Okta org
Replace the contact type userreplaceOrgContactUserPUTReplaces the user associated with the specified contact type
Retrieve the contact type usergetOrgContactUserGETRetrieves the ID and the user resource associated with the specified contact type
OrgSettingCustomization3
Retrieve the org preferencesgetOrgPreferencesGETRetrieves preferences of your Okta org
Set the hide dashboard footer preferencesetOrgHideOktaUIFooterPOSTSets the preference to hide the Okta End-User Dashboard footer for all end users of your org
Set the show dashboard footer preferencesetOrgShowOktaUIFooterPOSTSets the preference to show the Okta UI footer for all end users of your org
OrgSettingGeneral3
Replace the Org general settingsreplaceOrgSettingsPUTReplaces the Org General Settings for your Okta org
Retrieve the Org general settingsgetOrgSettingsGETRetrieves the Org General Settings
Update the Org general settingsupdateOrgSettingsPOSTUpdates partial Org General Settings
OrgSettingMetadata1
Retrieve the Org metadatagetWellknownOrgMetadataGETRetrieves the org metadata, which includes the org ID, configured custom domains, and authentication pipeline
OrgSettingSupport9
Extend Okta Support accessextendOktaSupportPOSTExtends the length of time that Okta Support can access your org by 24 hours.
Grant Okta Aerial access to your orggrantAerialConsentPOSTGrants an Okta Aerial account consent to manage your org.
Grant Okta Support accessgrantOktaSupportPOSTGrants Okta Support temporary access to your org as an administrator for eight hours
List all Okta Support caseslistOktaSupportCasesGETLists all Okta Support cases that the requesting principal has permission to view
Retrieve Okta Aerial consent for your orggetAerialConsentGETRetrieves the Okta Aerial consent grant details for your Org.
Retrieve the Okta Support settingsgetOrgOktaSupportSettingsGETRetrieves Okta Support Settings for your org
Revoke Okta Aerial access to your orgrevokeAerialConsentPOSTRevokes access of an Okta Aerial account to your Org.
Revoke Okta Support accessrevokeOktaSupportPOSTRevokes Okta Support access to your org
Update an Okta Support caseupdateOktaSupportCasePATCHUpdates access to the org for an Okta Support case:
Policy21
Activate a policyactivatePolicyPOSTActivates a policy
Activate a policy ruleactivatePolicyRulePOSTActivates a policy rule identified by policyId and ruleId
Clone an existing policyclonePolicyPOSTClones an existing policy
Create a policycreatePolicyPOSTCreates a policy.
Create a policy rulecreatePolicyRulePOSTCreates a policy rule
Create a policy simulationcreatePolicySimulationPOSTCreates a policy or policy rule simulation.
Deactivate a policydeactivatePolicyPOSTDeactivates a policy
Deactivate a policy ruledeactivatePolicyRulePOSTDeactivates a policy rule identified by policyId and ruleId
Delete a policydeletePolicyDELETEDeletes a policy
Delete a policy resource mappingdeletePolicyResourceMappingDELETEDeletes the resource mapping for a policy identified by policyId and mappingId
Delete a policy ruledeletePolicyRuleDELETEDeletes a policy rule identified by policyId and ruleId
List all apps mapped to a policylistPolicyAppsGETLists all applications mapped to a policy identified by policyId
List all policieslistPoliciesGETLists all policies with the specified type
List all policy ruleslistPolicyRulesGETLists all policy rules
List all resources mapped to a policylistPolicyMappingsGETLists all resources mapped to a policy identified by policyId
Map a resource to a policymapResourceToPolicyPOSTMaps a resource to a policy identified by policyId
Replace a policyreplacePolicyPUTReplaces the properties of a policy identified by policyId
Replace a policy rulereplacePolicyRulePUTReplaces the properties for a policy rule identified by policyId and ruleId
Retrieve a policygetPolicyGETRetrieves a policy
Retrieve a policy resource mappinggetPolicyMappingGETRetrieves a resource mapping for a policy identified by policyId and mappingId
Retrieve a policy rulegetPolicyRuleGETRetrieves a policy rule
PrincipalRateLimit4
Create a principal rate limitcreatePrincipalRateLimitEntityPOSTCreates a new principal rate limit entity.
List all principal rate limitslistPrincipalRateLimitEntitiesGETLists all Principal Rate Limit entities considering the provided parameters
Replace a principal rate limitreplacePrincipalRateLimitEntityPUTReplaces a principal rate limit entity by principalRateLimitId
Retrieve a principal rate limitgetPrincipalRateLimitEntityGETRetrieves a principal rate limit entity by principalRateLimitId
ProfileMapping3
List all profile mappingslistProfileMappingsGETLists all profile mappings in your org with pagination.
Retrieve a profile mappinggetProfileMappingGETRetrieves a single profile mapping referenced by its ID
Update a profile mappingupdateProfileMappingPOSTUpdates an existing profile mapping by adding, updating, or removing one or many property mappings
PushProvider5
Create a push providercreatePushProviderPOSTCreates a new push provider.
Delete a push providerdeletePushProviderDELETEDeletes a push provider by pushProviderId.
List all push providerslistPushProvidersGETLists all push providers
Replace a push providerreplacePushProviderPUTReplaces a push provider by pushProviderId
Retrieve a push providergetPushProviderGETRetrieves a push provider by pushProviderId
RateLimitSetting6
Replace the per-client rate limit settingsreplaceRateLimitSettingsPerClientPUTReplaces the Per-Client Rate Limit Settings and returns the configured properties
Replace the rate limit admin notification settingsreplaceRateLimitSettingsAdminNotificationsPUTReplaces the Rate Limit Admin Notification Settings and returns the configured properties
Replace the rate limit warning threshold percentagereplaceRateLimitSettingsWarningThresholdPUTReplaces the Rate Limit Warning Threshold Percentage and returns the configured property
Retrieve the per-client rate limit settingsgetRateLimitSettingsPerClientGETRetrieves the currently configured Per-Client Rate Limit Settings
Retrieve the rate limit admin notification settingsgetRateLimitSettingsAdminNotificationsGETRetrieves the currently configured Rate Limit Admin Notification Settings
Retrieve the rate limit warning threshold percentagegetRateLimitSettingsWarningThresholdGETRetrieves the currently configured threshold for warning notifications when the API's rate limit is exceeded
Realm5
Create a realmcreateRealmPOSTCreates a new realm
Delete a realmdeleteRealmDELETEDeletes a realm permanently.
List all realmslistRealmsGETLists all realms.
Replace the realm profilereplaceRealmPUTReplaces the realm profile
Retrieve a realmgetRealmGETRetrieves a realm
RealmAssignment9
Activate a realm assignmentactivateRealmAssignmentPOSTActivates a realm assignment
Create a realm assignmentcreateRealmAssignmentPOSTCreates a new realm assignment
Deactivate a realm assignmentdeactivateRealmAssignmentPOSTDeactivates a realm assignment
Delete a realm assignmentdeleteRealmAssignmentDELETEDeletes a realm assignment
Execute a realm assignmentexecuteRealmAssignmentPOSTExecutes a realm assignment
List all realm assignment operationslistRealmAssignmentOperationsGETLists all realm assignment operations.
List all realm assignmentslistRealmAssignmentsGETLists all realm assignments
Replace a realm assignmentreplaceRealmAssignmentPUTReplaces a realm assignment
Retrieve a realm assignmentgetRealmAssignmentGETRetrieves a realm assignment
RoleAssignmentAUser8
Assign a user roleassignRoleToUserPOSTAssigns a standard role to a user.
List all user role assignmentslistAssignedRolesForUserGETLists all roles assigned to a user (identified by userId)
List all users with role assignmentslistUsersWithRoleAssignmentsGETLists all users with role assignments
Retrieve a user role assignmentgetUserAssignedRoleGETRetrieves a role assigned to a user (identified by userId).
Retrieve a user role governance sourcegetRoleAssignmentGovernanceGrantGETRetrieves 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 sourcesgetUserAssignedRoleGovernanceGETRetrieves the governance sources of a role (identified by roleAssignmentId) that's assigned to a user (identified by userId)
Retrieve the user role governance source resourcesgetRoleAssignmentGovernanceGrantResourcesGETRetrieves 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 roleunassignRoleFromUserDELETEUnassigns a role assignment (identified by roleAssignmentId) from a user (identified by userId)
RoleAssignmentBGroup4
Assign a role to a groupassignRoleToGroupPOSTAssigns a standard role to a group.
List all group role assignmentslistGroupAssignedRolesGETLists all assigned roles of a group by groupId
Retrieve a group role assignmentgetGroupAssignedRoleGETRetrieves a role assigned to a group (identified by the groupId).
Unassign a group roleunassignRoleFromGroupDELETEUnassigns a role assignment (identified by roleAssignmentId) from a group (identified by the groupId)
RoleAssignmentClient4
Assign a client roleassignRoleToClientPOSTAssigns a standard role to a client app.
List all client role assignmentslistRolesForClientGETLists all roles assigned to a client app identified by clientId
Retrieve a client roleretrieveClientRoleGETRetrieves a role assignment (identified by roleAssignmentId) for a client app (identified by clientId)
Unassign a client roledeleteRoleFromClientDELETEUnassigns a role assignment (identified by roleAssignmentId) from a client app (identified by clientId)
RoleBTargetAdmin10
Assign all apps as target to admin roleassignAllAppsAsTargetToRoleForUserPUTAssigns all apps as target to an APP ADMIN role
Assign an admin role app instance targetassignAppInstanceTargetToAppAdminRoleForUserPUTAssigns an app instance target to an APP ADMIN role assignment to an admin user.
Assign an admin role app targetassignAppTargetToAdminRoleForUserPUTAssigns an OIN app target for an APP ADMIN role assignment to an admin user.
Assign an admin role group targetassignGroupTargetToUserRolePUTAssigns 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 targetslistApplicationTargetsForApplicationAdministratorRoleForUserGETLists all app targets for an APP ADMIN role assigned to a user.
List all admin role group targetslistGroupTargetsForRoleGETLists 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 typegetRoleTargetsByUserIdAndRoleIdGETRetrieves 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 targetunassignAppInstanceTargetFromAdminRoleForUserDELETEUnassigns an app instance target from an APP ADMIN role assignment to an admin user.
Unassign an admin role app targetunassignAppTargetFromAppAdminRoleForUserDELETEUnassigns an OIN app target from an APP ADMIN role assignment to an admin user.
Unassign an admin role group targetunassignGroupTargetFromUserAdminRoleDELETEUnassigns 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 targetassignAppInstanceTargetToAppAdminRoleForGroupPUTAssigns an app instance target to an APP ADMIN role assignment to a group.
Assign a group role app targetassignAppTargetToAdminRoleForGroupPUTAssigns an OIN app target to an APP ADMIN role assignment to a group.
Assign a group role group targetassignGroupTargetToGroupAdminRolePUTAssigns a group target to a USER ADMIN, HELP DESK ADMIN, or GROUP MEMBERSHIP ADMIN role assignment to a group.
List all group role app targetslistApplicationTargetsForApplicationAdministratorRoleForGroupGETLists all app targets for an APP ADMIN role assignment to a group.
List all group role group targetslistGroupTargetsForGroupRoleGETLists 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 targetunassignAppInstanceTargetToAppAdminRoleForGroupDELETEUnassigns an app instance target from an APP ADMIN role assignment to a group
Unassign a group role app targetunassignAppTargetToAdminRoleForGroupDELETEUnassigns an OIN app target from an APP ADMIN role assignment to a group
Unassign a group role group targetunassignGroupTargetFromGroupAdminRoleDELETEUnassigns 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 targetassignAppTargetInstanceRoleForClientPUTAssigns an app instance target to an APP ADMIN role assignment to a client.
Assign a client role app targetassignAppTargetRoleToClientPUTAssigns an OIN app target for an APP ADMIN role assignment to a client.
Assign a client role group targetassignGroupTargetRoleForClientPUTAssigns 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 targetslistAppTargetRoleToClientGETLists all OIN app targets for an APP ADMIN role that's assigned to a client (by clientId).
List all client role group targetslistGroupTargetRoleForClientGETLists 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 targetremoveAppTargetInstanceRoleForClientDELETEUnassigns an app instance target from a role assignment to a client app
Unassign a client role app targetremoveAppTargetRoleFromClientDELETEUnassigns an OIN app target for a role assignment to a client app
Unassign a client role group targetremoveGroupTargetRoleFromClientDELETEUnassigns a Group target from a USER ADMIN, HELP DESK ADMIN, or GROUP MEMBERSHIP ADMIN role assignment to a client app.
RoleCResourceSet5
Create a resource setcreateResourceSetPOSTCreates a new resource set.
Delete a resource setdeleteResourceSetDELETEDeletes a resource set by resourceSetIdOrLabel
List all resource setslistResourceSetsGETLists all resource sets with pagination support
Replace a resource setreplaceResourceSetPUTReplaces the label and description of a resource set.
Retrieve a resource setgetResourceSetGETRetrieves a resource set by resourceSetIdOrLabel
RoleCResourceSetResource6
Add a resource set resource with conditionsaddResourceSetResourcePOSTAdds a resource with conditions for a resource set
Add more resources to a resource setaddResourceSetResourcesPATCHAdds more resources to a resource set
Delete a resource set resourcedeleteResourceSetResourceDELETEDeletes a resource (identified by resourceId) from a resource set
List all resource set resourceslistResourceSetResourcesGETLists all resources for the resource set
Replace the resource set resource conditionsreplaceResourceSetResourcePUTReplaces the conditions of a resource identified by resourceId in a resource set
Retrieve a resource set resourcegetResourceSetResourceGETRetrieves a resource identified by resourceId in a resource set
RoleDResourceSetBinding4
Create a role resource set bindingcreateResourceSetBindingPOSTCreates a binding for the resource set, custom role, and members (users or groups)
Delete a role resource set bindingdeleteBindingDELETEDeletes a binding of a role (identified by roleIdOrLabel) and a resource set (identified by resourceSetIdOrLabel)
List all role resource set bindingslistBindingsGETLists all bindings for a resource set with pagination support.
Retrieve a role resource set bindinggetBindingGETRetrieves the binding of a role (identified by roleIdOrLabel) for a resource set (identified by resourceSetIdOrLabel)
RoleDResourceSetBindingMember4
Add more role resource set binding membersaddMembersToBindingPATCHAdds more members to a role resource set binding
List all role resource set binding memberslistMembersOfBindingGETLists all members of a role resource set binding with pagination support
Retrieve a role resource set binding membergetMemberOfBindingGETRetrieves a member (identified by memberId) that belongs to a role resource set binding
Unassign a role resource set binding memberunassignMemberFromBindingDELETEUnassigns a member (identified by memberId) from a role resource set binding
RoleECustom5
Create a custom rolecreateRolePOSTCreates a custom role
Delete a custom roledeleteRoleDELETEDeletes a custom role by roleIdOrLabel
List all custom roleslistRolesGETLists all custom roles with pagination support
Replace a custom rolereplaceRolePUTReplaces the label and description for a custom role by roleIdOrLabel
Retrieve a rolegetRoleGETRetrieves a role by roleIdOrLabel
RoleECustomPermission5
Create a custom role permissioncreateRolePermissionPOSTCreates a permission (specified by permissionType) for a custom role
Delete a custom role permissiondeleteRolePermissionDELETEDeletes a permission (identified by permissionType) from a custom role
List all custom role permissionslistRolePermissionsGETLists all permissions for a custom role by roleIdOrLabel
Replace a custom role permissionreplaceRolePermissionPUTReplaces a permission (specified by permissionType) for a custom role
Retrieve a custom role permissiongetRolePermissionGETRetrieves a permission (identified by permissionType) for a custom role
Schema8
List the log stream schemaslistLogStreamSchemasGETLists the schema for all log stream types visible for this org
Retrieve a user schemagetUserSchemaGETRetrieves the schema for a user type
Retrieve the default app user schema for an appgetApplicationUserSchemaGETRetrieves the default schema for an app user.
Retrieve the default group schemagetGroupSchemaGETRetrieves the group schema
Retrieve the log stream schema for the schema typegetLogStreamSchemaGETRetrieves the schema for a log stream type.
Update a user schemaupdateUserProfilePOSTUpdates a user schema.
Update the app user profile schema for an appupdateApplicationUserProfilePOSTUpdates the app user schema.
Update the group profile schemaupdateGroupSchemaPOSTUpdates the group profile schema.
ServiceAccount5
Create an app service accountcreateAppServiceAccountPOSTCreates a new app service account for managing an app account
Delete an app service accountdeleteAppServiceAccountDELETEDeletes an app service account specified by ID
List all app service accountslistAppServiceAccountsGETLists all app service accounts
Retrieve an app service accountgetAppServiceAccountGETRetrieves an app service account specified by ID
Update an existing app service accountupdateAppServiceAccountPATCHUpdates an existing app service account specified by ID
Session3
Refresh a sessionrefreshSessionPOSTRefreshes an existing session using the id for that session.
Retrieve a sessiongetSessionGETRetrieves information about the session specified by the given session ID
Revoke a sessionrevokeSessionDELETERevokes the specified session
SSFReceiver7
Activate a security events provideractivateSecurityEventsProviderInstancePOSTActivates a security events provider instance by setting its status to ACTIVE.
Create a security events providercreateSecurityEventsProviderInstancePOSTCreates a security events provider instance
Deactivate a security events providerdeactivateSecurityEventsProviderInstancePOSTDeactivates a security events provider instance by setting its status to INACTIVE.
Delete a security events providerdeleteSecurityEventsProviderInstanceDELETEDeletes a security events provider instance specified by id
List all security events providerslistSecurityEventsProviderInstancesGETLists all security events provider instances
Replace a security events providerreplaceSecurityEventsProviderInstancePUTReplaces a security events provider instance specified by id
Retrieve the security events providergetSecurityEventsProviderInstanceGETRetrieves the security events provider instance specified by id
SSFSecurityEventToken1
Publish a security event tokenpublishSecurityEventTokensPOSTPublishes a security event token (SET) sent by a security events provider.
SSFTransmitter8
Create an SSF streamcreateSsfStreamPOSTCreates 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 streamdeleteSsfStreamDELETEDeletes the specified SSF stream.
Replace an SSF streamreplaceSsfStreamPUTReplaces all properties for an existing SSF stream configuration.
Retrieve the SSF stream configuration(s)getSsfStreamsGETRetrieves either a list of all known SSF stream configurations or the individual configuration if specified by ID.
Retrieve the SSF stream statusgetSsfStreamStatusGETRetrieves the status of an SSF stream.
Retrieve the SSF transmitter metadatagetWellknownSsfMetadataGETRetrieves SSF transmitter configuration metadata.
Update an SSF streamupdateSsfStreamPATCHUpdates properties for an existing SSF stream configuration.
Verify an SSF streamverifySsfStreamPOSTVerifies an SSF stream by publishing a verification event requested by a security events provider.
Subscription8
List all subscriptions for a rolelistSubscriptionsRoleGETLists all subscriptions available to a specified Role
List all subscriptions for a userlistSubscriptionsUserGETLists all subscriptions available to a specified user.
Retrieve a subscription for a rolegetSubscriptionsNotificationTypeRoleGETRetrieves a subscription by notificationType for a specified Role
Retrieve a subscription for a usergetSubscriptionsNotificationTypeUserGETRetrieves a subscription by notificationType for a specified user.
Subscribe a role to a specific notification typesubscribeByNotificationTypeRolePOSTSubscribes a Role to a specified notification type.
Subscribe a user to a specific notification typesubscribeByNotificationTypeUserPOSTSubscribes the current user to a specified notification type.
Unsubscribe a role from a specific notification typeunsubscribeByNotificationTypeRolePOSTUnsubscribes a Role from a specified notification type.
Unsubscribe a user from a specific notification typeunsubscribeByNotificationTypeUserPOSTUnsubscribes the current user from a specified notification type.
SystemLog1
List all System Log eventslistLogEventsGETLists all System Log events
Template6
Create an SMS templatecreateSmsTemplatePOSTCreates a new custom SMS template
Delete an SMS templatedeleteSmsTemplateDELETEDeletes an SMS template
List all SMS templateslistSmsTemplatesGETLists all custom SMS templates.
Replace an SMS templatereplaceSmsTemplatePUTReplaces the SMS Template Notes: You can't update the default SMS Template.
Retrieve an SMS templategetSmsTemplateGETRetrieves a specific template by id
Update an SMS templateupdateSmsTemplatePOSTUpdates only some of the SMS Template properties: All properties within the custom SMS Template that have values are updated.
Theme9
Delete the background imagedeleteBrandThemeBackgroundImageDELETEDeletes a theme background image
Delete the favicondeleteBrandThemeFaviconDELETEDeletes a theme favicon.
Delete the logodeleteBrandThemeLogoDELETEDeletes a Theme logo.
List all themeslistBrandThemesGETLists all the themes in your brand.
Replace a themereplaceBrandThemePUTReplaces a theme for a brand
Retrieve a themegetBrandThemeGETRetrieves a theme for a brand
Upload the background imageuploadBrandThemeBackgroundImagePOSTUploads and replaces the background image for the theme.
Upload the faviconuploadBrandThemeFaviconPOSTUploads and replaces the favicon for the theme
Upload the logouploadBrandThemeLogoPOSTUploads and replaces the logo for the theme.
ThreatInsight2
Retrieve the ThreatInsight configurationgetCurrentConfigurationGETRetrieves the ThreatInsight configuration for the org
Update the ThreatInsight configurationupdateConfigurationPOSTUpdates the ThreatInsight configuration for the org
TrustedOrigin7
Activate a trusted originactivateTrustedOriginPOSTActivates a trusted origin.
Create a trusted origincreateTrustedOriginPOSTCreates a trusted origin
Deactivate a trusted origindeactivateTrustedOriginPOSTDeactivates a trusted origin.
Delete a trusted origindeleteTrustedOriginDELETEDeletes a trusted origin
List all trusted originslistTrustedOriginsGETLists all trusted origins
Replace a trusted originreplaceTrustedOriginPUTReplaces a trusted origin
Retrieve a trusted origingetTrustedOriginGETRetrieves a trusted origin
UISchema5
Create a UI schemacreateUISchemaPOSTCreates an input for an enrollment form
Delete a UI schemadeleteUISchemasDELETEDeletes a UI Schema by id
List all UI schemaslistUISchemasGETLists all UI Schemas in your org
Replace a UI schemareplaceUISchemasPUTReplaces a UI Schema by id
Retrieve a UI schemagetUISchemaGETRetrieves a UI Schema by id
User7
Create a usercreateUserPOSTCreates a new user in your Okta org with or without credentials.
Delete a userdeleteUserDELETEDeletes a user permanently.
List all user blockslistUserBlocksGETLists information about how the user is blocked from accessing their account
List all userslistUsersGETLists users in your org, with pagination in most cases.
Replace a userreplaceUserPUTReplaces a user's profile, credentials, or both using strict-update semantics.
Retrieve a usergetUserGETRetrieves a user from your Okta org.
Update a userupdateUserPOSTUpdates a user's profile or credentials with partial update semantics.
UserAuthenticatorEnrollment5
Create an auto-activated Phone authenticator enrollmentcreateAuthenticatorEnrollmentPOSTCreates a Phone authenticator enrollment that's automatically activated
Create an auto-activated TAC authenticator enrollmentcreateTacAuthenticatorEnrollmentPOSTCreates an auto-activated Temporary access code (TAC) authenticator enrollment
Delete an authenticator enrollmentdeleteAuthenticatorEnrollmentDELETEDeletes an existing enrollment for the specified user.
List all authenticator enrollmentslistAuthenticatorEnrollmentsGETLists all authenticator enrollments of the specified user
Retrieve an authenticator enrollmentgetAuthenticatorEnrollmentGETRetrieves a user's authenticator enrollment by enrollmentId
UserClassification2
Replace the user's classificationreplaceUserClassificationPUTReplaces the user's classification
Retrieve a user's classificationgetUserClassificationGETRetrieves a user's classification
UserCred7
Expire the passwordexpirePasswordPOSTExpires the password.
Expire the password with a temporary passwordexpirePasswordWithTempPasswordPOSTExpires the password and resets the user's password to a temporary password.
Reset a passwordresetPasswordPOSTResets a password.
Reset password with recovery questionforgotPasswordSetNewPasswordPOSTResets the user's password to the specified password if the provided answer to the recovery question is correct.
Start forgot password flowforgotPasswordPOSTStarts the forgot password flow.
Update passwordchangePasswordPOSTUpdates a user's password by validating the user's current password.
Update recovery questionchangeRecoveryQuestionPOSTUpdates a user's recovery question and answer credential by validating the user's current password.
UserFactor13
Activate a factoractivateFactorPOSTActivates a factor.
Enroll a factorenrollFactorPOSTEnrolls a supported factor for the specified user
List all enrolled factorslistFactorsGETLists 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 factorslistSupportedFactorsGETLists 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 questionslistSupportedSecurityQuestionsGETLists all available security questions for the specified user
List all YubiKey OTP tokenslistYubikeyOtpTokensGETLists all YubiKey OTP tokens
Resend a factor enrollmentresendEnrollFactorPOSTResends an sms, call, or email factor challenge as part of an enrollment flow.
Retrieve a factorgetFactorGETRetrieves an existing factor for the specified user
Retrieve a factor transaction statusgetFactorTransactionStatusGETRetrieves the status of a push factor verification transaction
Retrieve a YubiKey OTP tokengetYubikeyOtpTokenByIdGETRetrieves the specified YubiKey OTP token by id
Unenroll a factorunenrollFactorDELETEUnenrolls an existing factor for the specified user.
Upload a YubiKey OTP seeduploadYubikeyOtpTokenSeedPOSTUploads a seed for a user to enroll a YubiKey OTP
Verify a factorverifyFactorPOSTVerifies an OTP for a factor.
UserGrant6
List all grants for a clientlistGrantsForUserAndClientGETLists all grants for a specified user and client
List all user grantslistUserGrantsGETLists all grants for the specified user
Retrieve a user grantgetUserGrantGETRetrieves a grant for the specified user
Revoke a user grantrevokeUserGrantDELETERevokes one grant for a specified user
Revoke all grants for a clientrevokeGrantsForUserAndClientDELETERevokes all grants for the specified user and client
Revoke all user grantsrevokeUserGrantsDELETERevokes all grants for a specified user
UserLifecycle7
Activate a useractivateUserPOSTActivates a user.
Deactivate a userdeactivateUserPOSTDeactivates a user.
Reactivate a userreactivateUserPOSTReactivates a user.
Reset the factorsresetFactorsPOSTResets all factors for the specified user.
Suspend a usersuspendUserPOSTSuspends a user.
Unlock a userunlockUserPOSTUnlocks a user with a LOCKED OUT status or unlocks a user with an ACTIVE status that's blocked from unknown devices.
Unsuspend a userunsuspendUserPOSTUnsuspends a user and returns them to the ACTIVE state.
UserLinkedObject3
Assign a linked object value for primaryassignLinkedObjectValueForPrimaryPUTAssigns the first user as the associated and the second user as the primary for the specified relationship.
Delete a linked object valuedeleteLinkedObjectForUserDELETEDeletes any existing relationship between the associated and primary user.
List the primary or all of the associated linked object valueslistLinkedObjectsForUserGETLists 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 clientlistRefreshTokensForUserAndClientGETLists all refresh tokens issued for the specified user and client
Retrieve a refresh token for a clientgetRefreshTokenForUserAndClientGETRetrieves a refresh token issued for the specified user and client
Revoke a token for a clientrevokeTokenForUserAndClientDELETERevokes the specified refresh and access tokens
Revoke all refresh tokens for a clientrevokeTokensForUserAndClientDELETERevokes all refresh tokens issued for the specified user and client
UserResource4
List all assigned app linkslistAppLinksGETLists all app links for all direct or indirect (through group membership) assigned apps
List all clientslistUserClientsGETLists all client resources for which the specified user has grants or tokens
List all devices for an enrolled userlistUserDevicesGETLists all devices enrolled by a user
List all groupslistUserGroupsGETLists 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 riskgetUserRiskGETRetrieves the user risk object for a user ID
Upsert the user's riskupsertUserRiskPUTUpserts (creates or updates) the user risk object for a user ID.
UserSession1
Revoke all user sessionsrevokeUserSessionsDELETERevokes all active identity provider sessions of the user.
UserType6
Create a user typecreateUserTypePOSTCreates a new user type.
Delete a user typedeleteUserTypeDELETEDeletes a user type permanently.
List all user typeslistUserTypesGETLists all user types in your org
Replace a user typereplaceUserTypePUTReplaces an existing user type.
Retrieve a user typegetUserTypeGETRetrieves a user type by ID.
Update a user typeupdateUserTypePOSTUpdates an existing user type.
WebAuthnPreregistration7
Activate a preregistered WebAuthn factoractivatePreregistrationEnrollmentPOSTActivates a preregistered WebAuthn factor.
Assign the fulfillment error status to a WebAuthnassignFulfillmentErrorWebAuthnPreregistrationFactorPOSTAssigns the fulfillment error status to a WebAuthn preregistration factor for a user.
Delete a WebAuthn preregistration factordeleteWebAuthnPreregistrationFactorDELETEDeletes a specific WebAuthn preregistration factor for a user
Enroll a preregistered WebAuthn factorenrollPreregistrationEnrollmentPOSTEnrolls a preregistered WebAuthn factor.
Generate a fulfillment requestgenerateFulfillmentRequestPOSTGenerates a fulfillment request by sending a WebAuthn preregistration event to start the flow.
List all WebAuthn preregistration factorslistWebAuthnPreregistrationFactorsGETLists all WebAuthn preregistration factors for the specified user
Send a PIN to usersendPinPOSTSends the decoded PIN for the specified WebAuthn preregistration enrollment.