Uses of Class
com.okta.sdk.resource.client.ApiException
Package
Description
-
Uses of ApiException in com.okta.sdk.helper
Modifier and TypeMethodDescriptionstatic Error
ApiExceptionHelper.getError
(ApiException e) Translates anApiException
to anError
-
Uses of ApiException in com.okta.sdk.impl.resource
Modifier and TypeMethodDescriptionDefaultApplicationBuilder.buildAndCreate
(ApplicationApi client) DefaultGroupBuilder.buildAndCreate
(GroupApi client) DefaultOIDCApplicationBuilder.buildAndCreate
(ApplicationApi client) DefaultOktaSignOnPolicyBuilder.buildAndCreate
(PolicyApi client) DefaultPasswordPolicyBuilder.buildAndCreate
(PolicyApi client) DefaultPolicyBuilder.buildAndCreate
(PolicyApi client) DefaultUserBuilder.buildAndCreate
(UserApi client) -
Uses of ApiException in com.okta.sdk.resource.api
Modifier and TypeMethodDescriptionAgentPoolsApi.activateAgentPoolsUpdate
(String poolId, String updateId) Activate an Agent Pool update Activates scheduled Agent pool updateAgentPoolsApi.activateAgentPoolsUpdate
(String poolId, String updateId, Map<String, String> additionalHeaders) Activate an Agent Pool update Activates scheduled Agent pool updateApiServiceIntegrationsApi.activateApiServiceIntegrationInstanceSecret
(String apiServiceId, String secretId) Activate an API Service Integration instance Secret Activates an API Service Integration instance Secret by `secretId`ApiServiceIntegrationsApi.activateApiServiceIntegrationInstanceSecret
(String apiServiceId, String secretId, Map<String, String> additionalHeaders) Activate an API Service Integration instance Secret Activates an API Service Integration instance Secret by `secretId`void
ApplicationApi.activateApplication
(String appId) Activate an Application Activates an inactive applicationvoid
ApplicationApi.activateApplication
(String appId, Map<String, String> additionalHeaders) Activate an Application Activates an inactive applicationAuthenticatorApi.activateAuthenticator
(String authenticatorId) Activate an Authenticator Activates an authenticator by `authenticatorId`AuthenticatorApi.activateAuthenticator
(String authenticatorId, Map<String, String> additionalHeaders) Activate an Authenticator Activates an authenticator by `authenticatorId`AuthenticatorApi.activateAuthenticatorMethod
(String authenticatorId, AuthenticatorMethodType methodType) Activate an Authenticator Method Activates a Method for an Authenticator identified by `authenticatorId` and `methodType` > **Note:** <x-lifecycle class=\"ea\"></x-lifecycle> > The AAGUID Group object supports the Early Access (Self-Service) Allow List for FIDO2 (WebAuthn) Authenticators feature.AuthenticatorApi.activateAuthenticatorMethod
(String authenticatorId, AuthenticatorMethodType methodType, Map<String, String> additionalHeaders) Activate an Authenticator Method Activates a Method for an Authenticator identified by `authenticatorId` and `methodType` > **Note:** <x-lifecycle class=\"ea\"></x-lifecycle> > The AAGUID Group object supports the Early Access (Self-Service) Allow List for FIDO2 (WebAuthn) Authenticators feature.void
AuthorizationServerApi.activateAuthorizationServer
(String authServerId) Activate an Authorization Server Activates an authorization servervoid
AuthorizationServerApi.activateAuthorizationServer
(String authServerId, Map<String, String> additionalHeaders) Activate an Authorization Server Activates an authorization servervoid
AuthorizationServerPoliciesApi.activateAuthorizationServerPolicy
(String authServerId, String policyId) Activate a Policy Activates an authorization server policyvoid
AuthorizationServerPoliciesApi.activateAuthorizationServerPolicy
(String authServerId, String policyId, Map<String, String> additionalHeaders) Activate a Policy Activates an authorization server policyvoid
AuthorizationServerRulesApi.activateAuthorizationServerPolicyRule
(String authServerId, String policyId, String ruleId) Activate a Policy Rule Activates an authorization server policy rulevoid
AuthorizationServerRulesApi.activateAuthorizationServerPolicyRule
(String authServerId, String policyId, String ruleId, Map<String, String> additionalHeaders) Activate a Policy Rule Activates an authorization server policy ruleBehaviorApi.activateBehaviorDetectionRule
(String behaviorId) Activate a Behavior Detection Rule Activates a behavior detection ruleBehaviorApi.activateBehaviorDetectionRule
(String behaviorId, Map<String, String> additionalHeaders) Activate a Behavior Detection Rule Activates a behavior detection rulevoid
ApplicationConnectionsApi.activateDefaultProvisioningConnectionForApplication
(String appId) Activate the default Provisioning Connection Activates the default Provisioning Connection for an appvoid
ApplicationConnectionsApi.activateDefaultProvisioningConnectionForApplication
(String appId, Map<String, String> additionalHeaders) Activate the default Provisioning Connection Activates the default Provisioning Connection for an appvoid
DeviceApi.activateDevice
(String deviceId) Activate a Device Activates a Device by setting its status to ACTIVE by `deviceId`.void
DeviceApi.activateDevice
(String deviceId, Map<String, String> additionalHeaders) Activate a Device Activates a Device by setting its status to ACTIVE by `deviceId`.EventHookApi.activateEventHook
(String eventHookId) Activate an Event Hook Activates the event hook that matches the provided `id`EventHookApi.activateEventHook
(String eventHookId, Map<String, String> additionalHeaders) Activate an Event Hook Activates the event hook that matches the provided `id`UserFactorApi.activateFactor
(String userId, String factorId, UserFactorActivateRequest body) Activate a Factor Activates a Factor.UserFactorApi.activateFactor
(String userId, String factorId, UserFactorActivateRequest body, Map<String, String> additionalHeaders) Activate a Factor Activates a Factor.void
GroupRuleApi.activateGroupRule
(String groupRuleId) Activate a Group Rule Activates a specific Group rule by ID from your orgvoid
GroupRuleApi.activateGroupRule
(String groupRuleId, Map<String, String> additionalHeaders) Activate a Group Rule Activates a specific Group rule by ID from your orgIdentityProviderApi.activateIdentityProvider
(String idpId) Activate an Identity Provider Activates an inactive IdPIdentityProviderApi.activateIdentityProvider
(String idpId, Map<String, String> additionalHeaders) Activate an Identity Provider Activates an inactive IdPInlineHookApi.activateInlineHook
(String inlineHookId) Activate an Inline Hook Activates the inline hook by `inlineHookId`InlineHookApi.activateInlineHook
(String inlineHookId, Map<String, String> additionalHeaders) Activate an Inline Hook Activates the inline hook by `inlineHookId`LogStreamApi.activateLogStream
(String logStreamId) Activate a Log Stream Activates a log stream by `logStreamId`LogStreamApi.activateLogStream
(String logStreamId, Map<String, String> additionalHeaders) Activate a Log Stream Activates a log stream by `logStreamId`NetworkZoneApi.activateNetworkZone
(String zoneId) Activate a Network Zone Activates a Network Zone by `zoneId`NetworkZoneApi.activateNetworkZone
(String zoneId, Map<String, String> additionalHeaders) Activate a Network Zone Activates a Network Zone by `zoneId`ApplicationSsoCredentialOAuth2ClientAuthApi.activateOAuth2ClientJsonWebKey
(String appId, String keyId) Activate an OAuth 2.0 Client JSON Web Key Activates an OAuth 2.0 Client JSON Web Key by `keyId`ApplicationSsoCredentialOAuth2ClientAuthApi.activateOAuth2ClientJsonWebKey
(String appId, String keyId, Map<String, String> additionalHeaders) Activate an OAuth 2.0 Client JSON Web Key Activates an OAuth 2.0 Client JSON Web Key by `keyId`ApplicationSsoCredentialOAuth2ClientAuthApi.activateOAuth2ClientSecret
(String appId, String secretId) Activate an OAuth 2.0 Client Secret Activates an OAuth 2.0 Client Secret by `secretId`ApplicationSsoCredentialOAuth2ClientAuthApi.activateOAuth2ClientSecret
(String appId, String secretId, Map<String, String> additionalHeaders) Activate an OAuth 2.0 Client Secret Activates an OAuth 2.0 Client Secret by `secretId`void
PolicyApi.activatePolicy
(String policyId) Activate a Policy Activates a policyvoid
PolicyApi.activatePolicy
(String policyId, Map<String, String> additionalHeaders) Activate a Policy Activates a policyvoid
PolicyApi.activatePolicyRule
(String policyId, String ruleId) Activate a Policy Rule Activates a Policy Rule identified by `policyId` and `ruleId`void
Activate a Policy Rule Activates a Policy Rule identified by `policyId` and `ruleId`WebAuthnPreregistrationApi.activatePreregistrationEnrollment
(EnrollmentActivationRequest body) Activate a Preregistered WebAuthn Factor Activates a preregistered WebAuthn Factor.WebAuthnPreregistrationApi.activatePreregistrationEnrollment
(EnrollmentActivationRequest body, Map<String, String> additionalHeaders) Activate a Preregistered WebAuthn Factor Activates a preregistered WebAuthn Factor.void
RealmAssignmentApi.activateRealmAssignment
(String assignmentId) Activate a Realm Assignment Activates a Realm Assignmentvoid
RealmAssignmentApi.activateRealmAssignment
(String assignmentId, Map<String, String> additionalHeaders) Activate a Realm Assignment Activates a Realm AssignmentSsfReceiverApi.activateSecurityEventsProviderInstance
(String securityEventProviderId) Activate a Security Events Provider Activates a Security Events Provider instance by setting its status to `ACTIVE`.SsfReceiverApi.activateSecurityEventsProviderInstance
(String securityEventProviderId, Map<String, String> additionalHeaders) Activate a Security Events Provider Activates a Security Events Provider instance by setting its status to `ACTIVE`.TrustedOriginApi.activateTrustedOrigin
(String trustedOriginId) Activate a Trusted Origin Activates a Trusted Origin.TrustedOriginApi.activateTrustedOrigin
(String trustedOriginId, Map<String, String> additionalHeaders) Activate a Trusted Origin Activates a Trusted Origin.UserLifecycleApi.activateUser
(String userId, Boolean sendEmail) Activate a User Activates a User.UserLifecycleApi.activateUser
(String userId, Boolean sendEmail, Map<String, String> additionalHeaders) Activate a User Activates a User.GroupApi.addGroup
(AddGroupRequest group) Add a Group Adds a new Group with the `OKTA_GROUP` type to your org > **Note:** App import operations are responsible for syncing Groups with `APP_GROUP` type such as Active Directory Groups.GroupApi.addGroup
(AddGroupRequest group, Map<String, String> additionalHeaders) Add a Group Adds a new Group with the `OKTA_GROUP` type to your org > **Note:** App import operations are responsible for syncing Groups with `APP_GROUP` type such as Active Directory Groups.ApplicationSsoCredentialOAuth2ClientAuthApi.addJwk
(String appId, OAuth2ClientJsonWebKeyRequestBody oauth2ClientJsonWebKeyRequestBody) Add a JSON Web Key Adds a new JSON Web Key to the client’s JSON Web Keys.ApplicationSsoCredentialOAuth2ClientAuthApi.addJwk
(String appId, OAuth2ClientJsonWebKeyRequestBody oauth2ClientJsonWebKeyRequestBody, Map<String, String> additionalHeaders) Add a JSON Web Key Adds a new JSON Web Key to the client’s JSON Web Keys.RoleDResourceSetBindingMemberApi.addMembersToBinding
(String resourceSetIdOrLabel, String roleIdOrLabel, ResourceSetBindingAddMembersRequest instance) Add more Role Resource Set Binding Members Adds more members to a Role Resource Set BindingRoleDResourceSetBindingMemberApi.addMembersToBinding
(String resourceSetIdOrLabel, String roleIdOrLabel, ResourceSetBindingAddMembersRequest instance, Map<String, String> additionalHeaders) Add more Role Resource Set Binding Members Adds more members to a Role Resource Set BindingRoleCResourceSetResourceApi.addResourceSetResources
(String resourceSetIdOrLabel, ResourceSetResourcePatchRequest instance) Add more Resources to a Resource Set Adds more Resources to a Resource SetRoleCResourceSetResourceApi.addResourceSetResources
(String resourceSetIdOrLabel, ResourceSetResourcePatchRequest instance, Map<String, String> additionalHeaders) Add more Resources to a Resource Set Adds more Resources to a Resource Setvoid
RoleBTargetAdminApi.assignAllAppsAsTargetToRoleForUser
(String userId, String roleAssignmentId) Assign all Apps as Target to Role Assigns all Apps as Target to Rolevoid
RoleBTargetAdminApi.assignAllAppsAsTargetToRoleForUser
(String userId, String roleAssignmentId, Map<String, String> additionalHeaders) Assign all Apps as Target to Role Assigns all Apps as Target to Rolevoid
RoleBTargetBGroupApi.assignAppInstanceTargetToAppAdminRoleForGroup
(String groupId, String roleAssignmentId, String appName, String appId) Assign an Group Role Application Instance Target Assigns an app instance target to an `APP_ADMIN` Role Assignment to a Group.void
RoleBTargetBGroupApi.assignAppInstanceTargetToAppAdminRoleForGroup
(String groupId, String roleAssignmentId, String appName, String appId, Map<String, String> additionalHeaders) Assign an Group Role Application Instance Target Assigns an app instance target to an `APP_ADMIN` Role Assignment to a Group.void
RoleBTargetAdminApi.assignAppInstanceTargetToAppAdminRoleForUser
(String userId, String roleAssignmentId, String appName, String appId) Assign an Admin Role Application Instance Target Assigns an app instance target to an `APP_ADMIN` Role Assignment to an admin User.void
RoleBTargetAdminApi.assignAppInstanceTargetToAppAdminRoleForUser
(String userId, String roleAssignmentId, String appName, String appId, Map<String, String> additionalHeaders) Assign an Admin Role Application Instance Target Assigns an app instance target to an `APP_ADMIN` Role Assignment to an admin User.void
ApplicationPoliciesApi.assignApplicationPolicy
(String appId, String policyId) Assign an Authentication Policy Assigns an app to an [authentication policy](/openapi/okta-management/management/tag/Policy/), identified by `policyId`.void
ApplicationPoliciesApi.assignApplicationPolicy
(String appId, String policyId, Map<String, String> additionalHeaders) Assign an Authentication Policy Assigns an app to an [authentication policy](/openapi/okta-management/management/tag/Policy/), identified by `policyId`.void
RoleBTargetClientApi.assignAppTargetInstanceRoleForClient
(String clientId, String roleAssignmentId, String appName, String appId) Assign a Client Role Application Instance Target Assigns an app instance target to an `APP_ADMIN` Role Assignment to a client Application.void
RoleBTargetClientApi.assignAppTargetInstanceRoleForClient
(String clientId, String roleAssignmentId, String appName, String appId, Map<String, String> additionalHeaders) Assign a Client Role Application Instance Target Assigns an app instance target to an `APP_ADMIN` Role Assignment to a client Application.void
RoleBTargetClientApi.assignAppTargetRoleToClient
(String clientId, String roleAssignmentId, String appName) Assign a Client Role Application Target Assigns an OIN app target for an `APP_ADMIN` Role Assignment to a client Application.void
RoleBTargetClientApi.assignAppTargetRoleToClient
(String clientId, String roleAssignmentId, String appName, Map<String, String> additionalHeaders) Assign a Client Role Application Target Assigns an OIN app target for an `APP_ADMIN` Role Assignment to a client Application.void
RoleBTargetBGroupApi.assignAppTargetToAdminRoleForGroup
(String groupId, String roleAssignmentId, String appName) Assign an Group Role Application Target Assigns an OIN app target to an `APP_ADMIN` Role Assignment to a Group.void
RoleBTargetBGroupApi.assignAppTargetToAdminRoleForGroup
(String groupId, String roleAssignmentId, String appName, Map<String, String> additionalHeaders) Assign an Group Role Application Target Assigns an OIN app target to an `APP_ADMIN` Role Assignment to a Group.void
RoleBTargetAdminApi.assignAppTargetToAdminRoleForUser
(String userId, String roleAssignmentId, String appName) Assign an Admin Role Application Target Assigns an OIN app target for an `APP_ADMIN` Role Assignment to an admin User.void
RoleBTargetAdminApi.assignAppTargetToAdminRoleForUser
(String userId, String roleAssignmentId, String appName, Map<String, String> additionalHeaders) Assign an Admin Role Application Target Assigns an OIN app target for an `APP_ADMIN` Role Assignment to an admin User.OrgSettingAdminApi.assignClientPrivilegesSetting
(ClientPrivilegesSetting clientPrivilegesSetting) Assign the Default Public Client App Role Setting Assigns the [Super Admin role](https://help.okta.com/okta_help.htm?type=oie&id=ext_superadmin) as the default role for new public client appsOrgSettingAdminApi.assignClientPrivilegesSetting
(ClientPrivilegesSetting clientPrivilegesSetting, Map<String, String> additionalHeaders) Assign the Default Public Client App Role Setting Assigns the [Super Admin role](https://help.okta.com/okta_help.htm?type=oie&id=ext_superadmin) as the default role for new public client appsGroupOwnerApi.assignGroupOwner
(String groupId, AssignGroupOwnerRequestBody assignGroupOwnerRequestBody) Assign a Group Owner Assigns a group ownerGroupOwnerApi.assignGroupOwner
(String groupId, AssignGroupOwnerRequestBody assignGroupOwnerRequestBody, Map<String, String> additionalHeaders) Assign a Group Owner Assigns a group ownervoid
RoleBTargetClientApi.assignGroupTargetRoleForClient
(String clientId, String roleAssignmentId, String groupId) Assign a Client Role Group Target Assigns a Group target to a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to a client Application.void
RoleBTargetClientApi.assignGroupTargetRoleForClient
(String clientId, String roleAssignmentId, String groupId, Map<String, String> additionalHeaders) Assign a Client Role Group Target Assigns a Group target to a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to a client Application.void
RoleBTargetBGroupApi.assignGroupTargetToGroupAdminRole
(String groupId, String roleAssignmentId, String targetGroupId) Assign a Group Role Group Target Assigns a Group target to a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to a Group.void
RoleBTargetBGroupApi.assignGroupTargetToGroupAdminRole
(String groupId, String roleAssignmentId, String targetGroupId, Map<String, String> additionalHeaders) Assign a Group Role Group Target Assigns a Group target to a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to a Group.void
RoleBTargetAdminApi.assignGroupTargetToUserRole
(String userId, String roleAssignmentId, String groupId) Assign an Admin Role Group Target Assigns a Group target for a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to an admin User.void
RoleBTargetAdminApi.assignGroupTargetToUserRole
(String userId, String roleAssignmentId, String groupId, Map<String, String> additionalHeaders) Assign an Admin Role Group Target Assigns a Group target for a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to an admin User.ApplicationGroupsApi.assignGroupToApplication
(String appId, String groupId, ApplicationGroupAssignment applicationGroupAssignment) Assign an Application Group Assigns a [Group](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Group/) to an app, which in turn assigns the app to each [User](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/User/) that belongs to the group.ApplicationGroupsApi.assignGroupToApplication
(String appId, String groupId, ApplicationGroupAssignment applicationGroupAssignment, Map<String, String> additionalHeaders) Assign an Application Group Assigns a [Group](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Group/) to an app, which in turn assigns the app to each [User](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/User/) that belongs to the group.void
UserLinkedObjectApi.assignLinkedObjectValueForPrimary
(String userIdOrLogin, String primaryRelationshipName, String primaryUserId) Assign a Linked Object value for primary Assigns the first User as the `associated` and the second User as the `primary` for the specified relationship.void
UserLinkedObjectApi.assignLinkedObjectValueForPrimary
(String userIdOrLogin, String primaryRelationshipName, String primaryUserId, Map<String, String> additionalHeaders) Assign a Linked Object value for primary Assigns the first User as the `associated` and the second User as the `primary` for the specified relationship.RoleAssignmentClientApi.assignRoleToClient
(String clientId, AssignRoleToGroupRequest assignRoleToGroupRequest) Assign a Client Role Assigns a [standard role](/openapi/okta-management/guides/roles/#standard-roles) to a Client Application.RoleAssignmentClientApi.assignRoleToClient
(String clientId, AssignRoleToGroupRequest assignRoleToGroupRequest, Map<String, String> additionalHeaders) Assign a Client Role Assigns a [standard role](/openapi/okta-management/guides/roles/#standard-roles) to a Client Application.RoleAssignmentBGroupApi.assignRoleToGroup
(String groupId, AssignRoleToGroupRequest assignRoleRequest, Boolean disableNotifications) Assign a Role to a Group Assigns a [standard role](/openapi/okta-management/guides/roles/#standard-roles) to a Group.RoleAssignmentBGroupApi.assignRoleToGroup
(String groupId, AssignRoleToGroupRequest assignRoleRequest, Boolean disableNotifications, Map<String, String> additionalHeaders) Assign a Role to a Group Assigns a [standard role](/openapi/okta-management/guides/roles/#standard-roles) to a Group.RoleAssignmentAUserApi.assignRoleToUser
(String userId, AssignRoleToUserRequest assignRoleRequest, Boolean disableNotifications) Assign a User Role Assigns a [standard role](/openapi/okta-management/guides/roles/#standard-roles) to a User.RoleAssignmentAUserApi.assignRoleToUser
(String userId, AssignRoleToUserRequest assignRoleRequest, Boolean disableNotifications, Map<String, String> additionalHeaders) Assign a User Role Assigns a [standard role](/openapi/okta-management/guides/roles/#standard-roles) to a User.ApplicationUsersApi.assignUserToApplication
(String appId, AppUserAssignRequest appUser) Assign an Application User Assigns a user to an app for: * SSO only<br> Assignments to SSO apps typically don't include a user profile.ApplicationUsersApi.assignUserToApplication
(String appId, AppUserAssignRequest appUser, Map<String, String> additionalHeaders) Assign an Application User Assigns a user to an app for: * SSO only<br> Assignments to SSO apps typically don't include a user profile.void
GroupApi.assignUserToGroup
(String groupId, String userId) Assign a User to a Group Assigns a User to a Group with the `OKTA_GROUP` type > **Note:** You only can modify memberships for Groups of the `OKTA_GROUP` type.void
Assign a User to a Group Assigns a User to a Group with the `OKTA_GROUP` type > **Note:** You only can modify memberships for Groups of the `OKTA_GROUP` type.EmailCustomizationApi.bulkRemoveEmailAddressBounces
(BouncesRemoveListObj bouncesRemoveListObj) Remove Bounced Emails Removes emails from an email service bounce list.EmailCustomizationApi.bulkRemoveEmailAddressBounces
(BouncesRemoveListObj bouncesRemoveListObj, Map<String, String> additionalHeaders) Remove Bounced Emails Removes emails from an email service bounce list.UserCredApi.changePassword
(String userId, ChangePasswordRequest changePasswordRequest, Boolean strict) Update Password Updates a User's password by validating the User's current Password.UserCredApi.changePassword
(String userId, ChangePasswordRequest changePasswordRequest, Boolean strict, Map<String, String> additionalHeaders) Update Password Updates a User's password by validating the User's current Password.UserCredApi.changeRecoveryQuestion
(String userId, UserCredentials userCredentials) Update Recovery Question Updates a User's Recovery Question and answer credential by validating the User's current Password.UserCredApi.changeRecoveryQuestion
(String userId, UserCredentials userCredentials, Map<String, String> additionalHeaders) Update Recovery Question Updates a User's Recovery Question and answer credential by validating the User's current Password.ApplicationSsoCredentialKeyApi.cloneApplicationKey
(String appId, String keyId, String targetAid) Clone a Key Credential Clones an X.509 certificate for an Application Key Credential from a source app to a target app.ApplicationSsoCredentialKeyApi.cloneApplicationKey
(String appId, String keyId, String targetAid, Map<String, String> additionalHeaders) Clone a Key Credential Clones an X.509 certificate for an Application Key Credential from a source app to a target app.IdentityProviderSigningKeysApi.cloneIdentityProviderKey
(String idpId, String kid, String targetIdpId) Clone a signing Key Credential for IdP Clones an X.509 certificate for an IdP signing Key Credential from a source IdP to target IdP > **Caution:** Sharing certificates isn't a recommended security practice.IdentityProviderSigningKeysApi.cloneIdentityProviderKey
(String idpId, String kid, String targetIdpId, Map<String, String> additionalHeaders) Clone a signing Key Credential for IdP Clones an X.509 certificate for an IdP signing Key Credential from a source IdP to target IdP > **Caution:** Sharing certificates isn't a recommended security practice.PolicyApi.clonePolicy
(String policyId) Clone an existing Policy Clones an existing policyPolicyApi.clonePolicy
(String policyId, Map<String, String> additionalHeaders) Clone an existing Policy Clones an existing policyvoid
SessionApi.closeCurrentSession
(String cookie) Close the current Session Closes the Session for the user who is currently signed in.void
SessionApi.closeCurrentSession
(String cookie, Map<String, String> additionalHeaders) Close the current Session Closes the Session for the user who is currently signed in.AgentPoolsApi.createAgentPoolsUpdate
(String poolId, AgentPoolUpdate agentPoolUpdate) Create an Agent Pool update Creates an Agent pool update \\n For user flow 2 manual update, starts the update immediately.AgentPoolsApi.createAgentPoolsUpdate
(String poolId, AgentPoolUpdate agentPoolUpdate, Map<String, String> additionalHeaders) Create an Agent Pool update Creates an Agent pool update \\n For user flow 2 manual update, starts the update immediately.ApiServiceIntegrationsApi.createApiServiceIntegrationInstance
(PostAPIServiceIntegrationInstanceRequest postAPIServiceIntegrationInstanceRequest) Create an API Service Integration instance Creates and authorizes an API Service Integration instanceApiServiceIntegrationsApi.createApiServiceIntegrationInstance
(PostAPIServiceIntegrationInstanceRequest postAPIServiceIntegrationInstanceRequest, Map<String, String> additionalHeaders) Create an API Service Integration instance Creates and authorizes an API Service Integration instanceApiServiceIntegrationsApi.createApiServiceIntegrationInstanceSecret
(String apiServiceId) Create an API Service Integration instance Secret Creates an API Service Integration instance Secret object with a new active client secret.ApiServiceIntegrationsApi.createApiServiceIntegrationInstanceSecret
(String apiServiceId, Map<String, String> additionalHeaders) Create an API Service Integration instance Secret Creates an API Service Integration instance Secret object with a new active client secret.ApplicationApi.createApplication
(Application application, Boolean activate, String oktaAccessGatewayAgent) Create an Application Creates an app instance in your Okta org.ApplicationApi.createApplication
(Application application, Boolean activate, String oktaAccessGatewayAgent, Map<String, String> additionalHeaders) Create an Application Creates an app instance in your Okta org.AuthorizationServerAssocApi.createAssociatedServers
(String authServerId, AssociatedServerMediated associatedServerMediated) Create an associated Authorization Server Creates trusted relationships between the given authorization server and other authorization serversAuthorizationServerAssocApi.createAssociatedServers
(String authServerId, AssociatedServerMediated associatedServerMediated, Map<String, String> additionalHeaders) Create an associated Authorization Server Creates trusted relationships between the given authorization server and other authorization serversAuthenticatorApi.createAuthenticator
(AuthenticatorBase authenticator, Boolean activate) Create an Authenticator Creates an authenticatorAuthenticatorApi.createAuthenticator
(AuthenticatorBase authenticator, Boolean activate, Map<String, String> additionalHeaders) Create an Authenticator Creates an authenticatorAuthorizationServerApi.createAuthorizationServer
(AuthorizationServer authorizationServer) Create an Authorization Server Creates an authorization serverAuthorizationServerApi.createAuthorizationServer
(AuthorizationServer authorizationServer, Map<String, String> additionalHeaders) Create an Authorization Server Creates an authorization serverAuthorizationServerPoliciesApi.createAuthorizationServerPolicy
(String authServerId, AuthorizationServerPolicy policy) Create a Policy Creates a policyAuthorizationServerPoliciesApi.createAuthorizationServerPolicy
(String authServerId, AuthorizationServerPolicy policy, Map<String, String> additionalHeaders) Create a Policy Creates a policyAuthorizationServerRulesApi.createAuthorizationServerPolicyRule
(String authServerId, String policyId, AuthorizationServerPolicyRuleRequest policyRule) Create a Policy Rule Creates a policy rule for the specified Custom Authorization Server and PolicyAuthorizationServerRulesApi.createAuthorizationServerPolicyRule
(String authServerId, String policyId, AuthorizationServerPolicyRuleRequest policyRule, Map<String, String> additionalHeaders) Create a Policy Rule Creates a policy rule for the specified Custom Authorization Server and PolicyBehaviorApi.createBehaviorDetectionRule
(BehaviorRule rule) Create a Behavior Detection Rule Creates a new behavior detection ruleBehaviorApi.createBehaviorDetectionRule
(BehaviorRule rule, Map<String, String> additionalHeaders) Create a Behavior Detection Rule Creates a new behavior detection ruleBrandsApi.createBrand
(CreateBrandRequest createBrandRequest) Create a Brand Creates a new brand in your orgBrandsApi.createBrand
(CreateBrandRequest createBrandRequest, Map<String, String> additionalHeaders) Create a Brand Creates a new brand in your orgCaptchaApi.createCaptchaInstance
(CAPTCHAInstance instance) Create a CAPTCHA instance Creates a new CAPTCHA instance.CaptchaApi.createCaptchaInstance
(CAPTCHAInstance instance, Map<String, String> additionalHeaders) Create a CAPTCHA instance Creates a new CAPTCHA instance.OrgCreatorApi.createChildOrg
(ChildOrg childOrg) Create an Org Creates an Org (child org) that has the same features as the current requesting org (parent org).OrgCreatorApi.createChildOrg
(ChildOrg childOrg, Map<String, String> additionalHeaders) Create an Org Creates an Org (child org) that has the same features as the current requesting org (parent org).CustomDomainApi.createCustomDomain
(DomainRequest domain) Create a Custom Domain Creates your custom domainCustomDomainApi.createCustomDomain
(DomainRequest domain, Map<String, String> additionalHeaders) Create a Custom Domain Creates your custom domainDeviceAssuranceApi.createDeviceAssurancePolicy
(DeviceAssurance deviceAssurance) Create a Device Assurance Policy Creates a new Device Assurance PolicyDeviceAssuranceApi.createDeviceAssurancePolicy
(DeviceAssurance deviceAssurance, Map<String, String> additionalHeaders) Create a Device Assurance Policy Creates a new Device Assurance PolicyCustomTemplatesApi.createEmailCustomization
(String brandId, String templateName, EmailCustomization instance) Create an Email Customization Creates a new Email Customization <x-lifecycle class=\"ea\"></x-lifecycle> If Custom languages for Okta Email Templates is enabled, you can create a customization for any BCP47 language in addition to the Okta-supported languages.CustomTemplatesApi.createEmailCustomization
(String brandId, String templateName, EmailCustomization instance, Map<String, String> additionalHeaders) Create an Email Customization Creates a new Email Customization <x-lifecycle class=\"ea\"></x-lifecycle> If Custom languages for Okta Email Templates is enabled, you can create a customization for any BCP47 language in addition to the Okta-supported languages.EmailDomainApi.createEmailDomain
(EmailDomain emailDomain, List<String> expand) Create an Email Domain Creates an Email Domain in your orgEmailDomainApi.createEmailDomain
(EmailDomain emailDomain, List<String> expand, Map<String, String> additionalHeaders) Create an Email Domain Creates an Email Domain in your orgEmailServerApi.createEmailServer
(EmailServerPost emailServerPost) Create a custom SMTP server Creates a custom email SMTP server configuration for your orgEmailServerApi.createEmailServer
(EmailServerPost emailServerPost, Map<String, String> additionalHeaders) Create a custom SMTP server Creates a custom email SMTP server configuration for your orgEventHookApi.createEventHook
(EventHook eventHook) Create an Event Hook Creates a new event hook for your organization in `ACTIVE` status.EventHookApi.createEventHook
(EventHook eventHook, Map<String, String> additionalHeaders) Create an Event Hook Creates a new event hook for your organization in `ACTIVE` status.GroupRuleApi.createGroupRule
(CreateGroupRuleRequest groupRule) Create a Group rule Creates a Group rule to dynamically add Users to the specified Group if they match the condition > **Note:** Group rules are created with the status set to `'INACTIVE'`.GroupRuleApi.createGroupRule
(CreateGroupRuleRequest groupRule, Map<String, String> additionalHeaders) Create a Group rule Creates a Group rule to dynamically add Users to the specified Group if they match the condition > **Note:** Group rules are created with the status set to `'INACTIVE'`.HookKeyApi.createHookKey
(KeyRequest keyRequest) Create a key Creates a key for use with other parts of the application, such as inline hooks > **Note:** Use the key name to access this key for inline hook operations.HookKeyApi.createHookKey
(KeyRequest keyRequest, Map<String, String> additionalHeaders) Create a key Creates a key for use with other parts of the application, such as inline hooks > **Note:** Use the key name to access this key for inline hook operations.IdentityProviderApi.createIdentityProvider
(IdentityProvider identityProvider) Create an Identity Provider Creates a new Identity Provider integration.IdentityProviderApi.createIdentityProvider
(IdentityProvider identityProvider, Map<String, String> additionalHeaders) Create an Identity Provider Creates a new Identity Provider integration.IdentityProviderKeysApi.createIdentityProviderKey
(IdPCertificateCredential jsonWebKey) Create an IdP Key Credential Creates a new X.509 certificate credential in the IdP key store > **Note:** RSA-based certificates are supported for all IdP types.IdentityProviderKeysApi.createIdentityProviderKey
(IdPCertificateCredential jsonWebKey, Map<String, String> additionalHeaders) Create an IdP Key Credential Creates a new X.509 certificate credential in the IdP key store > **Note:** RSA-based certificates are supported for all IdP types.IdentitySourceApi.createIdentitySourceSession
(String identitySourceId) Create an Identity Source Session Creates an Identity Source Session for the given Identity Source instanceIdentitySourceApi.createIdentitySourceSession
(String identitySourceId, Map<String, String> additionalHeaders) Create an Identity Source Session Creates an Identity Source Session for the given Identity Source instanceInlineHookApi.createInlineHook
(InlineHook inlineHook) Create an Inline Hook Creates an inline hookInlineHookApi.createInlineHook
(InlineHook inlineHook, Map<String, String> additionalHeaders) Create an Inline Hook Creates an inline hookLinkedObjectApi.createLinkedObjectDefinition
(LinkedObject linkedObject) Create a Linked Object Definition Creates a Linked Object definitionLinkedObjectApi.createLinkedObjectDefinition
(LinkedObject linkedObject, Map<String, String> additionalHeaders) Create a Linked Object Definition Creates a Linked Object definitionLogStreamApi.createLogStream
(LogStream instance) Create a Log Stream Creates a new Log Stream objectLogStreamApi.createLogStream
(LogStream instance, Map<String, String> additionalHeaders) Create a Log Stream Creates a new Log Stream objectNetworkZoneApi.createNetworkZone
(NetworkZone zone) Create a Network Zone Creates a Network Zone * For an IP Network Zone, you must define either `gateways` or `proxies`.NetworkZoneApi.createNetworkZone
(NetworkZone zone, Map<String, String> additionalHeaders) Create a Network Zone Creates a Network Zone * For an IP Network Zone, you must define either `gateways` or `proxies`.AuthorizationServerClaimsApi.createOAuth2Claim
(String authServerId, OAuth2Claim oAuth2Claim) Create a custom token Claim Creates a custom token Claim for a custom authorization serverAuthorizationServerClaimsApi.createOAuth2Claim
(String authServerId, OAuth2Claim oAuth2Claim, Map<String, String> additionalHeaders) Create a custom token Claim Creates a custom token Claim for a custom authorization serverApplicationSsoCredentialOAuth2ClientAuthApi.createOAuth2ClientSecret
(String appId, OAuth2ClientSecretRequestBody oauth2ClientSecretRequestBody) Create an OAuth 2.0 Client Secret Creates an OAuth 2.0 Client Secret object with a new active client secret.ApplicationSsoCredentialOAuth2ClientAuthApi.createOAuth2ClientSecret
(String appId, OAuth2ClientSecretRequestBody oauth2ClientSecretRequestBody, Map<String, String> additionalHeaders) Create an OAuth 2.0 Client Secret Creates an OAuth 2.0 Client Secret object with a new active client secret.AuthorizationServerScopesApi.createOAuth2Scope
(String authServerId, OAuth2Scope oAuth2Scope) Create a Custom Token Scope Creates a custom token scopeAuthorizationServerScopesApi.createOAuth2Scope
(String authServerId, OAuth2Scope oAuth2Scope, Map<String, String> additionalHeaders) Create a Custom Token Scope Creates a custom token scopePolicyApi.createPolicy
(Policy policy, Boolean activate) Create a Policy Creates a policy.Create a Policy Creates a policy.PolicyApi.createPolicyRule
(String policyId, PolicyRule policyRule, String limit, Boolean activate) Create a Policy Rule Creates a policy rule > **Note:** You can't create additional rules for the `PROFILE_ENROLLMENT` or `POST_AUTH_SESSION` policies.PolicyApi.createPolicyRule
(String policyId, PolicyRule policyRule, String limit, Boolean activate, Map<String, String> additionalHeaders) Create a Policy Rule Creates a policy rule > **Note:** You can't create additional rules for the `PROFILE_ENROLLMENT` or `POST_AUTH_SESSION` policies.PolicyApi.createPolicySimulation
(List<SimulatePolicyBody> simulatePolicy, String expand) Create a Policy Simulation Creates a policy or policy rule simulation.PolicyApi.createPolicySimulation
(List<SimulatePolicyBody> simulatePolicy, String expand, Map<String, String> additionalHeaders) Create a Policy Simulation Creates a policy or policy rule simulation.PrincipalRateLimitApi.createPrincipalRateLimitEntity
(PrincipalRateLimitEntity entity) Create a Principal Rate Limit Creates a new Principal Rate Limit entity.PrincipalRateLimitApi.createPrincipalRateLimitEntity
(PrincipalRateLimitEntity entity, Map<String, String> additionalHeaders) Create a Principal Rate Limit Creates a new Principal Rate Limit entity.PushProviderApi.createPushProvider
(PushProvider pushProvider) Create a Push Provider Creates a new push provider.PushProviderApi.createPushProvider
(PushProvider pushProvider, Map<String, String> additionalHeaders) Create a Push Provider Creates a new push provider.RealmApi.createRealm
(CreateRealmRequest body) Create a Realm Creates a new RealmRealmApi.createRealm
(CreateRealmRequest body, Map<String, String> additionalHeaders) Create a Realm Creates a new RealmRealmAssignmentApi.createRealmAssignment
(CreateRealmAssignmentRequest body) Create a Realm Assignment Creates a new Realm AssignmentRealmAssignmentApi.createRealmAssignment
(CreateRealmAssignmentRequest body, Map<String, String> additionalHeaders) Create a Realm Assignment Creates a new Realm AssignmentRoleCResourceSetApi.createResourceSet
(CreateResourceSetRequest instance) Create a Resource Set Creates a new Resource Set.RoleCResourceSetApi.createResourceSet
(CreateResourceSetRequest instance, Map<String, String> additionalHeaders) Create a Resource Set Creates a new Resource Set.RoleDResourceSetBindingApi.createResourceSetBinding
(String resourceSetIdOrLabel, ResourceSetBindingCreateRequest instance) Create a Role Resource Set Binding Creates a Binding for the Resource Set, Custom Role, and members (Users or Groups)RoleDResourceSetBindingApi.createResourceSetBinding
(String resourceSetIdOrLabel, ResourceSetBindingCreateRequest instance, Map<String, String> additionalHeaders) Create a Role Resource Set Binding Creates a Binding for the Resource Set, Custom Role, and members (Users or Groups)RiskProviderApi.createRiskProvider
(RiskProvider instance) Create a Risk Provider Creates a Risk Provider object.RiskProviderApi.createRiskProvider
(RiskProvider instance, Map<String, String> additionalHeaders) Create a Risk Provider Creates a Risk Provider object.RoleECustomApi.createRole
(CreateIamRoleRequest instance) Create a Custom Role Creates a Custom RoleRoleECustomApi.createRole
(CreateIamRoleRequest instance, Map<String, String> additionalHeaders) Create a Custom Role Creates a Custom Rolevoid
RoleECustomPermissionApi.createRolePermission
(String roleIdOrLabel, String permissionType, CreateUpdateIamRolePermissionRequest instance) Create a Custom Role Permission Creates a permission (specified by `permissionType`) for a Custom Rolevoid
RoleECustomPermissionApi.createRolePermission
(String roleIdOrLabel, String permissionType, CreateUpdateIamRolePermissionRequest instance, Map<String, String> additionalHeaders) Create a Custom Role Permission Creates a permission (specified by `permissionType`) for a Custom RoleSsfReceiverApi.createSecurityEventsProviderInstance
(SecurityEventsProviderRequest instance) Create a Security Events Provider Creates a Security Events Provider instanceSsfReceiverApi.createSecurityEventsProviderInstance
(SecurityEventsProviderRequest instance, Map<String, String> additionalHeaders) Create a Security Events Provider Creates a Security Events Provider instanceSessionApi.createSession
(CreateSessionRequest createSessionRequest) Create a Session with session token Creates a new Session for a user with a valid session token.SessionApi.createSession
(CreateSessionRequest createSessionRequest, Map<String, String> additionalHeaders) Create a Session with session token Creates a new Session for a user with a valid session token.TemplateApi.createSmsTemplate
(SmsTemplate smsTemplate) Create an SMS Template Creates a new custom SMS templateTemplateApi.createSmsTemplate
(SmsTemplate smsTemplate, Map<String, String> additionalHeaders) Create an SMS Template Creates a new custom SMS templateSsfTransmitterApi.createSsfStream
(StreamConfigurationCreateRequest instance) Create an SSF Stream Creates an SSF Stream for an event receiver to start receiving security events in the form of Security Event Tokens (SETs) from Okta.SsfTransmitterApi.createSsfStream
(StreamConfigurationCreateRequest instance, Map<String, String> additionalHeaders) Create an SSF Stream Creates an SSF Stream for an event receiver to start receiving security events in the form of Security Event Tokens (SETs) from Okta.TrustedOriginApi.createTrustedOrigin
(TrustedOriginWrite trustedOrigin) Create a Trusted Origin Creates a trusted originTrustedOriginApi.createTrustedOrigin
(TrustedOriginWrite trustedOrigin, Map<String, String> additionalHeaders) Create a Trusted Origin Creates a trusted originUiSchemaApi.createUISchema
(CreateUISchema uischemabody) Create a UI Schema Creates an input for an enrollment formUiSchemaApi.createUISchema
(CreateUISchema uischemabody, Map<String, String> additionalHeaders) Create a UI Schema Creates an input for an enrollment formUserApi.createUser
(CreateUserRequest body, Boolean activate, Boolean provider, UserNextLogin nextLogin) Create a User Creates a new User in your Okta org with or without credentials.<br> > **Legal Disclaimer** > > After a User is added to the Okta directory, they receive an activation email.UserApi.createUser
(CreateUserRequest body, Boolean activate, Boolean provider, UserNextLogin nextLogin, Map<String, String> additionalHeaders) Create a User Creates a new User in your Okta org with or without credentials.<br> > **Legal Disclaimer** > > After a User is added to the Okta directory, they receive an activation email.UserTypeApi.createUserType
(CreateUserTypeRequest userType) Create a User Type Creates a new User Type.UserTypeApi.createUserType
(CreateUserTypeRequest userType, Map<String, String> additionalHeaders) Create a User Type Creates a new User Type.AgentPoolsApi.deactivateAgentPoolsUpdate
(String poolId, String updateId) Deactivate an Agent Pool update Deactivates scheduled Agent pool updateAgentPoolsApi.deactivateAgentPoolsUpdate
(String poolId, String updateId, Map<String, String> additionalHeaders) Deactivate an Agent Pool update Deactivates scheduled Agent pool updateApiServiceIntegrationsApi.deactivateApiServiceIntegrationInstanceSecret
(String apiServiceId, String secretId) Deactivate an API Service Integration instance Secret Deactivates an API Service Integration instance Secret by `secretId`ApiServiceIntegrationsApi.deactivateApiServiceIntegrationInstanceSecret
(String apiServiceId, String secretId, Map<String, String> additionalHeaders) Deactivate an API Service Integration instance Secret Deactivates an API Service Integration instance Secret by `secretId`void
ApplicationApi.deactivateApplication
(String appId) Deactivate an Application Deactivates an active applicationvoid
ApplicationApi.deactivateApplication
(String appId, Map<String, String> additionalHeaders) Deactivate an Application Deactivates an active applicationAuthenticatorApi.deactivateAuthenticator
(String authenticatorId) Deactivate an Authenticator Deactivates an authenticator by `authenticatorId`AuthenticatorApi.deactivateAuthenticator
(String authenticatorId, Map<String, String> additionalHeaders) Deactivate an Authenticator Deactivates an authenticator by `authenticatorId`AuthenticatorApi.deactivateAuthenticatorMethod
(String authenticatorId, AuthenticatorMethodType methodType) Deactivate an Authenticator Method Deactivates a Method for an Authenticator identified by `authenticatorId` and `methodType` > **Note:** <x-lifecycle class=\"ea\"></x-lifecycle> > The AAGUID Group object supports the Early Access (Self-Service) Allow List for FIDO2 (WebAuthn) Authenticators feature.AuthenticatorApi.deactivateAuthenticatorMethod
(String authenticatorId, AuthenticatorMethodType methodType, Map<String, String> additionalHeaders) Deactivate an Authenticator Method Deactivates a Method for an Authenticator identified by `authenticatorId` and `methodType` > **Note:** <x-lifecycle class=\"ea\"></x-lifecycle> > The AAGUID Group object supports the Early Access (Self-Service) Allow List for FIDO2 (WebAuthn) Authenticators feature.void
AuthorizationServerApi.deactivateAuthorizationServer
(String authServerId) Deactivate an Authorization Server Deactivates an authorization servervoid
AuthorizationServerApi.deactivateAuthorizationServer
(String authServerId, Map<String, String> additionalHeaders) Deactivate an Authorization Server Deactivates an authorization servervoid
AuthorizationServerPoliciesApi.deactivateAuthorizationServerPolicy
(String authServerId, String policyId) Deactivate a Policy Deactivates an authorization server policyvoid
AuthorizationServerPoliciesApi.deactivateAuthorizationServerPolicy
(String authServerId, String policyId, Map<String, String> additionalHeaders) Deactivate a Policy Deactivates an authorization server policyvoid
AuthorizationServerRulesApi.deactivateAuthorizationServerPolicyRule
(String authServerId, String policyId, String ruleId) Deactivate a Policy Rule Deactivates an authorization server policy rulevoid
AuthorizationServerRulesApi.deactivateAuthorizationServerPolicyRule
(String authServerId, String policyId, String ruleId, Map<String, String> additionalHeaders) Deactivate a Policy Rule Deactivates an authorization server policy ruleBehaviorApi.deactivateBehaviorDetectionRule
(String behaviorId) Deactivate a Behavior Detection Rule Deactivates a behavior detection ruleBehaviorApi.deactivateBehaviorDetectionRule
(String behaviorId, Map<String, String> additionalHeaders) Deactivate a Behavior Detection Rule Deactivates a behavior detection rulevoid
ApplicationConnectionsApi.deactivateDefaultProvisioningConnectionForApplication
(String appId) Deactivate the default Provisioning Connection Deactivates the default Provisioning Connection for an appvoid
ApplicationConnectionsApi.deactivateDefaultProvisioningConnectionForApplication
(String appId, Map<String, String> additionalHeaders) Deactivate the default Provisioning Connection Deactivates the default Provisioning Connection for an appvoid
DeviceApi.deactivateDevice
(String deviceId) Deactivate a Device Deactivates a Device by setting its status to DEACTIVATED by `deviceId`.void
DeviceApi.deactivateDevice
(String deviceId, Map<String, String> additionalHeaders) Deactivate a Device Deactivates a Device by setting its status to DEACTIVATED by `deviceId`.EventHookApi.deactivateEventHook
(String eventHookId) Deactivate an Event Hook Deactivates the event hook that matches the provided `id`EventHookApi.deactivateEventHook
(String eventHookId, Map<String, String> additionalHeaders) Deactivate an Event Hook Deactivates the event hook that matches the provided `id`void
GroupRuleApi.deactivateGroupRule
(String groupRuleId) Deactivate a Group Rule Deactivates a specific Group rule by ID from your orgvoid
GroupRuleApi.deactivateGroupRule
(String groupRuleId, Map<String, String> additionalHeaders) Deactivate a Group Rule Deactivates a specific Group rule by ID from your orgIdentityProviderApi.deactivateIdentityProvider
(String idpId) Deactivate an Identity Provider Deactivates an active IdPIdentityProviderApi.deactivateIdentityProvider
(String idpId, Map<String, String> additionalHeaders) Deactivate an Identity Provider Deactivates an active IdPInlineHookApi.deactivateInlineHook
(String inlineHookId) Deactivate an Inline Hook Deactivates the inline hook by `inlineHookId`InlineHookApi.deactivateInlineHook
(String inlineHookId, Map<String, String> additionalHeaders) Deactivate an Inline Hook Deactivates the inline hook by `inlineHookId`LogStreamApi.deactivateLogStream
(String logStreamId) Deactivate a Log Stream Deactivates a log stream by `logStreamId`LogStreamApi.deactivateLogStream
(String logStreamId, Map<String, String> additionalHeaders) Deactivate a Log Stream Deactivates a log stream by `logStreamId`NetworkZoneApi.deactivateNetworkZone
(String zoneId) Deactivate a Network Zone Deactivates a Network Zone by `zoneId`NetworkZoneApi.deactivateNetworkZone
(String zoneId, Map<String, String> additionalHeaders) Deactivate a Network Zone Deactivates a Network Zone by `zoneId`ApplicationSsoCredentialOAuth2ClientAuthApi.deactivateOAuth2ClientJsonWebKey
(String appId, String keyId) Deactivate an OAuth 2.0 Client JSON Web Key Deactivates an OAuth 2.0 Client JSON Web Key by `keyId`.ApplicationSsoCredentialOAuth2ClientAuthApi.deactivateOAuth2ClientJsonWebKey
(String appId, String keyId, Map<String, String> additionalHeaders) Deactivate an OAuth 2.0 Client JSON Web Key Deactivates an OAuth 2.0 Client JSON Web Key by `keyId`.ApplicationSsoCredentialOAuth2ClientAuthApi.deactivateOAuth2ClientSecret
(String appId, String secretId) Deactivate an OAuth 2.0 Client Secret Deactivates an OAuth 2.0 Client Secret by `secretId`.ApplicationSsoCredentialOAuth2ClientAuthApi.deactivateOAuth2ClientSecret
(String appId, String secretId, Map<String, String> additionalHeaders) Deactivate an OAuth 2.0 Client Secret Deactivates an OAuth 2.0 Client Secret by `secretId`.void
PolicyApi.deactivatePolicy
(String policyId) Deactivate a Policy Deactivates a policyvoid
PolicyApi.deactivatePolicy
(String policyId, Map<String, String> additionalHeaders) Deactivate a Policy Deactivates a policyvoid
PolicyApi.deactivatePolicyRule
(String policyId, String ruleId) Deactivate a Policy Rule Deactivates a Policy Rule identified by `policyId` and `ruleId`void
PolicyApi.deactivatePolicyRule
(String policyId, String ruleId, Map<String, String> additionalHeaders) Deactivate a Policy Rule Deactivates a Policy Rule identified by `policyId` and `ruleId`void
RealmAssignmentApi.deactivateRealmAssignment
(String assignmentId) Deactivate a Realm Assignment Deactivates a Realm Assignmentvoid
RealmAssignmentApi.deactivateRealmAssignment
(String assignmentId, Map<String, String> additionalHeaders) Deactivate a Realm Assignment Deactivates a Realm AssignmentSsfReceiverApi.deactivateSecurityEventsProviderInstance
(String securityEventProviderId) Deactivate a Security Events Provider Deactivates a Security Events Provider instance by setting its status to `INACTIVE`.SsfReceiverApi.deactivateSecurityEventsProviderInstance
(String securityEventProviderId, Map<String, String> additionalHeaders) Deactivate a Security Events Provider Deactivates a Security Events Provider instance by setting its status to `INACTIVE`.TrustedOriginApi.deactivateTrustedOrigin
(String trustedOriginId) Deactivate a Trusted Origin Deactivates a Trusted Origin.TrustedOriginApi.deactivateTrustedOrigin
(String trustedOriginId, Map<String, String> additionalHeaders) Deactivate a Trusted Origin Deactivates a Trusted Origin.void
UserLifecycleApi.deactivateUser
(String userId, Boolean sendEmail, String prefer) Deactivate a User Deactivates a User.void
UserLifecycleApi.deactivateUser
(String userId, Boolean sendEmail, String prefer, Map<String, String> additionalHeaders) Deactivate a User Deactivates a User.void
AgentPoolsApi.deleteAgentPoolsUpdate
(String poolId, String updateId) Delete an Agent Pool update Deletes Agent pool updatevoid
AgentPoolsApi.deleteAgentPoolsUpdate
(String poolId, String updateId, Map<String, String> additionalHeaders) Delete an Agent Pool update Deletes Agent pool updatevoid
CustomTemplatesApi.deleteAllCustomizations
(String brandId, String templateName) Delete all Email Customizations Deletes all customizations for an email template <x-lifecycle class=\"ea\"></x-lifecycle> If Custom languages for Okta Email Templates is enabled, all customizations are deleted, including customizations for additional languages.void
CustomTemplatesApi.deleteAllCustomizations
(String brandId, String templateName, Map<String, String> additionalHeaders) Delete all Email Customizations Deletes all customizations for an email template <x-lifecycle class=\"ea\"></x-lifecycle> If Custom languages for Okta Email Templates is enabled, all customizations are deleted, including customizations for additional languages.void
ApiServiceIntegrationsApi.deleteApiServiceIntegrationInstance
(String apiServiceId) Delete an API Service Integration instance Deletes an API Service Integration instance by `id`.void
ApiServiceIntegrationsApi.deleteApiServiceIntegrationInstance
(String apiServiceId, Map<String, String> additionalHeaders) Delete an API Service Integration instance Deletes an API Service Integration instance by `id`.void
ApiServiceIntegrationsApi.deleteApiServiceIntegrationInstanceSecret
(String apiServiceId, String secretId) Delete an API Service Integration instance Secret Deletes an API Service Integration instance Secret by `secretId`.void
ApiServiceIntegrationsApi.deleteApiServiceIntegrationInstanceSecret
(String apiServiceId, String secretId, Map<String, String> additionalHeaders) Delete an API Service Integration instance Secret Deletes an API Service Integration instance Secret by `secretId`.void
ApplicationApi.deleteApplication
(String appId) Delete an Application Deletes an inactive applicationvoid
ApplicationApi.deleteApplication
(String appId, Map<String, String> additionalHeaders) Delete an Application Deletes an inactive applicationvoid
AuthorizationServerAssocApi.deleteAssociatedServer
(String authServerId, String associatedServerId) Delete an associated Authorization Server Deletes an associated Authorization Servervoid
AuthorizationServerAssocApi.deleteAssociatedServer
(String authServerId, String associatedServerId, Map<String, String> additionalHeaders) Delete an associated Authorization Server Deletes an associated Authorization Servervoid
AuthorizationServerApi.deleteAuthorizationServer
(String authServerId) Delete an Authorization Server Deletes an authorization servervoid
AuthorizationServerApi.deleteAuthorizationServer
(String authServerId, Map<String, String> additionalHeaders) Delete an Authorization Server Deletes an authorization servervoid
AuthorizationServerPoliciesApi.deleteAuthorizationServerPolicy
(String authServerId, String policyId) Delete a Policy Deletes a policyvoid
AuthorizationServerPoliciesApi.deleteAuthorizationServerPolicy
(String authServerId, String policyId, Map<String, String> additionalHeaders) Delete a Policy Deletes a policyvoid
AuthorizationServerRulesApi.deleteAuthorizationServerPolicyRule
(String authServerId, String policyId, String ruleId) Delete a Policy Rule Deletes a Policy Rule defined in the specified Custom Authorization Server and Policyvoid
AuthorizationServerRulesApi.deleteAuthorizationServerPolicyRule
(String authServerId, String policyId, String ruleId, Map<String, String> additionalHeaders) Delete a Policy Rule Deletes a Policy Rule defined in the specified Custom Authorization Server and Policyvoid
BehaviorApi.deleteBehaviorDetectionRule
(String behaviorId) Delete a Behavior Detection Rule Deletes a Behavior Detection Rule by `behaviorId`void
BehaviorApi.deleteBehaviorDetectionRule
(String behaviorId, Map<String, String> additionalHeaders) Delete a Behavior Detection Rule Deletes a Behavior Detection Rule by `behaviorId`void
RoleDResourceSetBindingApi.deleteBinding
(String resourceSetIdOrLabel, String roleIdOrLabel) Delete a Role Resource Set Binding Deletes a Binding of a Role (identified by `roleIdOrLabel`) and a Resource Set (identified by `resourceSetIdOrLabel`)void
RoleDResourceSetBindingApi.deleteBinding
(String resourceSetIdOrLabel, String roleIdOrLabel, Map<String, String> additionalHeaders) Delete a Role Resource Set Binding Deletes a Binding of a Role (identified by `roleIdOrLabel`) and a Resource Set (identified by `resourceSetIdOrLabel`)void
BrandsApi.deleteBrand
(String brandId) Delete a brand Deletes a brand by `brandId`void
BrandsApi.deleteBrand
(String brandId, Map<String, String> additionalHeaders) Delete a brand Deletes a brand by `brandId`void
ThemesApi.deleteBrandThemeBackgroundImage
(String brandId, String themeId) Delete the Background Image Deletes a Theme background imagevoid
ThemesApi.deleteBrandThemeBackgroundImage
(String brandId, String themeId, Map<String, String> additionalHeaders) Delete the Background Image Deletes a Theme background imagevoid
ThemesApi.deleteBrandThemeFavicon
(String brandId, String themeId) Delete the Favicon Deletes a Theme favicon.void
ThemesApi.deleteBrandThemeFavicon
(String brandId, String themeId, Map<String, String> additionalHeaders) Delete the Favicon Deletes a Theme favicon.void
ThemesApi.deleteBrandThemeLogo
(String brandId, String themeId) Delete the Logo Deletes a Theme logo.void
ThemesApi.deleteBrandThemeLogo
(String brandId, String themeId, Map<String, String> additionalHeaders) Delete the Logo Deletes a Theme logo.void
CaptchaApi.deleteCaptchaInstance
(String captchaId) Delete a CAPTCHA Instance Deletes a specified CAPTCHA instance > **Note:** If your CAPTCHA instance is still associated with your org, the request fails.void
CaptchaApi.deleteCaptchaInstance
(String captchaId, Map<String, String> additionalHeaders) Delete a CAPTCHA Instance Deletes a specified CAPTCHA instance > **Note:** If your CAPTCHA instance is still associated with your org, the request fails.void
CustomDomainApi.deleteCustomDomain
(String domainId) Delete a Custom Domain Deletes a custom domain by `domainId`void
CustomDomainApi.deleteCustomDomain
(String domainId, Map<String, String> additionalHeaders) Delete a Custom Domain Deletes a custom domain by `domainId`void
CustomPagesApi.deleteCustomizedErrorPage
(String brandId) Delete the Customized Error Page Deletes the customized error page.void
CustomPagesApi.deleteCustomizedErrorPage
(String brandId, Map<String, String> additionalHeaders) Delete the Customized Error Page Deletes the customized error page.void
CustomPagesApi.deleteCustomizedSignInPage
(String brandId) Delete the Customized Sign-in Page Deletes the customized sign-in page.void
CustomPagesApi.deleteCustomizedSignInPage
(String brandId, Map<String, String> additionalHeaders) Delete the Customized Sign-in Page Deletes the customized sign-in page.void
DeviceApi.deleteDevice
(String deviceId) Delete a Device Deletes (permanently) a device by `deviceId` if it has a status of `DEACTIVATED`.void
DeviceApi.deleteDevice
(String deviceId, Map<String, String> additionalHeaders) Delete a Device Deletes (permanently) a device by `deviceId` if it has a status of `DEACTIVATED`.void
DeviceAssuranceApi.deleteDeviceAssurancePolicy
(String deviceAssuranceId) Delete a Device Assurance Policy Deletes a Device Assurance Policy by `deviceAssuranceId`.void
DeviceAssuranceApi.deleteDeviceAssurancePolicy
(String deviceAssuranceId, Map<String, String> additionalHeaders) Delete a Device Assurance Policy Deletes a Device Assurance Policy by `deviceAssuranceId`.void
CustomTemplatesApi.deleteEmailCustomization
(String brandId, String templateName, String customizationId) Delete an Email Customization Deletes an Email Customization by its unique identifier <x-lifecycle class=\"ea\"></x-lifecycle> If Custom languages for Okta Email Templates is disabled, deletion of an existing additional language customization by ID doesn't register.void
CustomTemplatesApi.deleteEmailCustomization
(String brandId, String templateName, String customizationId, Map<String, String> additionalHeaders) Delete an Email Customization Deletes an Email Customization by its unique identifier <x-lifecycle class=\"ea\"></x-lifecycle> If Custom languages for Okta Email Templates is disabled, deletion of an existing additional language customization by ID doesn't register.void
EmailDomainApi.deleteEmailDomain
(String emailDomainId, List<String> expand) Delete an Email Domain Deletes an Email Domain by `emailDomainId`void
EmailDomainApi.deleteEmailDomain
(String emailDomainId, List<String> expand, Map<String, String> additionalHeaders) Delete an Email Domain Deletes an Email Domain by `emailDomainId`void
EmailServerApi.deleteEmailServer
(String emailServerId) Delete an SMTP Server configuration Deletes the specified custom SMTP server configurationvoid
EmailServerApi.deleteEmailServer
(String emailServerId, Map<String, String> additionalHeaders) Delete an SMTP Server configuration Deletes the specified custom SMTP server configurationvoid
EventHookApi.deleteEventHook
(String eventHookId) Delete an Event Hook Deletes the event hook that matches the provided `id`.void
EventHookApi.deleteEventHook
(String eventHookId, Map<String, String> additionalHeaders) Delete an Event Hook Deletes the event hook that matches the provided `id`.void
GroupApi.deleteGroup
(String groupId) Delete a Group Deletes a Group of the `OKTA_GROUP` or `APP_GROUP` type from your org > **Note:** You can't remove Groups of type `APP_GROUP` if they are used in a group push mapping.void
GroupApi.deleteGroup
(String groupId, Map<String, String> additionalHeaders) Delete a Group Deletes a Group of the `OKTA_GROUP` or `APP_GROUP` type from your org > **Note:** You can't remove Groups of type `APP_GROUP` if they are used in a group push mapping.void
GroupOwnerApi.deleteGroupOwner
(String groupId, String ownerId) Delete a Group Owner Deletes a group owner from a specific groupvoid
GroupOwnerApi.deleteGroupOwner
(String groupId, String ownerId, Map<String, String> additionalHeaders) Delete a Group Owner Deletes a group owner from a specific groupvoid
GroupRuleApi.deleteGroupRule
(String groupRuleId, Boolean removeUsers) Delete a Group Rule Deletes a specific group rule by `groupRuleId`void
GroupRuleApi.deleteGroupRule
(String groupRuleId, Boolean removeUsers, Map<String, String> additionalHeaders) Delete a Group Rule Deletes a specific group rule by `groupRuleId`void
HookKeyApi.deleteHookKey
(String id) Delete a key Deletes a key by `id`.void
HookKeyApi.deleteHookKey
(String id, Map<String, String> additionalHeaders) Delete a key Deletes a key by `id`.void
IdentityProviderApi.deleteIdentityProvider
(String idpId) Delete an Identity Provider Deletes an identity provider integration by `idpId` * All existing IdP users are unlinked with the highest order profile source taking precedence for each IdP user.void
IdentityProviderApi.deleteIdentityProvider
(String idpId, Map<String, String> additionalHeaders) Delete an Identity Provider Deletes an identity provider integration by `idpId` * All existing IdP users are unlinked with the highest order profile source taking precedence for each IdP user.void
IdentityProviderKeysApi.deleteIdentityProviderKey
(String kid) Delete an IdP Key Credential Deletes a specific IdP Key Credential by `kid` if it isn't currently being used by an active or inactive IdPvoid
IdentityProviderKeysApi.deleteIdentityProviderKey
(String kid, Map<String, String> additionalHeaders) Delete an IdP Key Credential Deletes a specific IdP Key Credential by `kid` if it isn't currently being used by an active or inactive IdPvoid
IdentitySourceApi.deleteIdentitySourceSession
(String identitySourceId, String sessionId) Delete an Identity Source Session Deletes an Identity Source Session for a given `identitySourceId` and `sessionId`void
IdentitySourceApi.deleteIdentitySourceSession
(String identitySourceId, String sessionId, Map<String, String> additionalHeaders) Delete an Identity Source Session Deletes an Identity Source Session for a given `identitySourceId` and `sessionId`void
InlineHookApi.deleteInlineHook
(String inlineHookId) Delete an Inline Hook Deletes an inline hook by `inlineHookId`.void
InlineHookApi.deleteInlineHook
(String inlineHookId, Map<String, String> additionalHeaders) Delete an Inline Hook Deletes an inline hook by `inlineHookId`.void
Delete an OAuth 2.0 Client JSON Web Key Deletes an OAuth 2.0 Client JSON Web Key by `keyId`.void
ApplicationSsoCredentialOAuth2ClientAuthApi.deletejwk
(String appId, String keyId, Map<String, String> additionalHeaders) Delete an OAuth 2.0 Client JSON Web Key Deletes an OAuth 2.0 Client JSON Web Key by `keyId`.void
LinkedObjectApi.deleteLinkedObjectDefinition
(String linkedObjectName) Delete a Linked Object Definition Deletes the Linked Object definition specified by either the `primary` or `associated` name.void
LinkedObjectApi.deleteLinkedObjectDefinition
(String linkedObjectName, Map<String, String> additionalHeaders) Delete a Linked Object Definition Deletes the Linked Object definition specified by either the `primary` or `associated` name.void
UserLinkedObjectApi.deleteLinkedObjectForUser
(String userIdOrLogin, String relationshipName) Delete a Linked Object value Deletes any existing relationship between the `associated` and `primary` user.void
UserLinkedObjectApi.deleteLinkedObjectForUser
(String userIdOrLogin, String relationshipName, Map<String, String> additionalHeaders) Delete a Linked Object value Deletes any existing relationship between the `associated` and `primary` user.void
LogStreamApi.deleteLogStream
(String logStreamId) Delete a Log Stream Deletes a Log Stream object from your org by IDvoid
LogStreamApi.deleteLogStream
(String logStreamId, Map<String, String> additionalHeaders) Delete a Log Stream Deletes a Log Stream object from your org by IDvoid
NetworkZoneApi.deleteNetworkZone
(String zoneId) Delete a Network Zone Deletes a Network Zone by `zoneId` > **Notes:** > * You can't delete a Network Zone that's used by a [Policy](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Policy/) or [Rule](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Policy/#tag/Policy/operation/listPolicyRules).void
NetworkZoneApi.deleteNetworkZone
(String zoneId, Map<String, String> additionalHeaders) Delete a Network Zone Deletes a Network Zone by `zoneId` > **Notes:** > * You can't delete a Network Zone that's used by a [Policy](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Policy/) or [Rule](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Policy/#tag/Policy/operation/listPolicyRules).void
AuthorizationServerClaimsApi.deleteOAuth2Claim
(String authServerId, String claimId) Delete a custom token Claim Deletes a custom token Claim specified by the `claimId`void
AuthorizationServerClaimsApi.deleteOAuth2Claim
(String authServerId, String claimId, Map<String, String> additionalHeaders) Delete a custom token Claim Deletes a custom token Claim specified by the `claimId`void
ApplicationSsoCredentialOAuth2ClientAuthApi.deleteOAuth2ClientSecret
(String appId, String secretId) Delete an OAuth 2.0 Client Secret Deletes an OAuth 2.0 Client Secret by `secretId`.void
ApplicationSsoCredentialOAuth2ClientAuthApi.deleteOAuth2ClientSecret
(String appId, String secretId, Map<String, String> additionalHeaders) Delete an OAuth 2.0 Client Secret Deletes an OAuth 2.0 Client Secret by `secretId`.void
AuthorizationServerScopesApi.deleteOAuth2Scope
(String authServerId, String scopeId) Delete a Custom Token Scope Deletes a custom token scopevoid
AuthorizationServerScopesApi.deleteOAuth2Scope
(String authServerId, String scopeId, Map<String, String> additionalHeaders) Delete a Custom Token Scope Deletes a custom token scopevoid
CaptchaApi.deleteOrgCaptchaSettings()
Delete the Org-wide CAPTCHA Settings Deletes the CAPTCHA settings object for your organizationvoid
CaptchaApi.deleteOrgCaptchaSettings
(Map<String, String> additionalHeaders) Delete the Org-wide CAPTCHA Settings Deletes the CAPTCHA settings object for your organizationvoid
PolicyApi.deletePolicy
(String policyId) Delete a Policy Deletes a policyvoid
PolicyApi.deletePolicy
(String policyId, Map<String, String> additionalHeaders) Delete a Policy Deletes a policyvoid
PolicyApi.deletePolicyResourceMapping
(String policyId, String mappingId) Delete a policy resource Mapping Deletes the resource Mapping for a Policy identified by `policyId` and `mappingId`void
PolicyApi.deletePolicyResourceMapping
(String policyId, String mappingId, Map<String, String> additionalHeaders) Delete a policy resource Mapping Deletes the resource Mapping for a Policy identified by `policyId` and `mappingId`void
PolicyApi.deletePolicyRule
(String policyId, String ruleId) Delete a Policy Rule Deletes a Policy Rule identified by `policyId` and `ruleId`void
Delete a Policy Rule Deletes a Policy Rule identified by `policyId` and `ruleId`void
CustomPagesApi.deletePreviewErrorPage
(String brandId) Delete the Preview Error Page Deletes the preview error page.void
CustomPagesApi.deletePreviewErrorPage
(String brandId, Map<String, String> additionalHeaders) Delete the Preview Error Page Deletes the preview error page.void
CustomPagesApi.deletePreviewSignInPage
(String brandId) Delete the Preview Sign-in Page Deletes the preview sign-in page.void
CustomPagesApi.deletePreviewSignInPage
(String brandId, Map<String, String> additionalHeaders) Delete the Preview Sign-in Page Deletes the preview sign-in page.void
PushProviderApi.deletePushProvider
(String pushProviderId) Delete a Push Provider Deletes a push provider by `pushProviderId`.void
PushProviderApi.deletePushProvider
(String pushProviderId, Map<String, String> additionalHeaders) Delete a Push Provider Deletes a push provider by `pushProviderId`.void
RealmApi.deleteRealm
(String realmId) Delete a Realm Deletes a Realm permanently.void
RealmApi.deleteRealm
(String realmId, Map<String, String> additionalHeaders) Delete a Realm Deletes a Realm permanently.void
RealmAssignmentApi.deleteRealmAssignment
(String assignmentId) Delete a Realm Assignment Deletes a Realm Assignmentvoid
RealmAssignmentApi.deleteRealmAssignment
(String assignmentId, Map<String, String> additionalHeaders) Delete a Realm Assignment Deletes a Realm Assignmentvoid
RoleCResourceSetApi.deleteResourceSet
(String resourceSetIdOrLabel) Delete a Resource Set Deletes a Resource Set by `resourceSetIdOrLabel`void
RoleCResourceSetApi.deleteResourceSet
(String resourceSetIdOrLabel, Map<String, String> additionalHeaders) Delete a Resource Set Deletes a Resource Set by `resourceSetIdOrLabel`void
RoleCResourceSetResourceApi.deleteResourceSetResource
(String resourceSetIdOrLabel, String resourceId) Delete a Resource Set Resource Deletes a Resource (identified by `resourceId`) from a Resource Setvoid
RoleCResourceSetResourceApi.deleteResourceSetResource
(String resourceSetIdOrLabel, String resourceId, Map<String, String> additionalHeaders) Delete a Resource Set Resource Deletes a Resource (identified by `resourceId`) from a Resource Setvoid
RiskProviderApi.deleteRiskProvider
(String riskProviderId) Delete a Risk Provider Deletes a Risk Provider object by its IDvoid
RiskProviderApi.deleteRiskProvider
(String riskProviderId, Map<String, String> additionalHeaders) Delete a Risk Provider Deletes a Risk Provider object by its IDvoid
RoleECustomApi.deleteRole
(String roleIdOrLabel) Delete a Custom Role Deletes a Custom Role by `roleIdOrLabel`void
RoleECustomApi.deleteRole
(String roleIdOrLabel, Map<String, String> additionalHeaders) Delete a Custom Role Deletes a Custom Role by `roleIdOrLabel`void
RoleAssignmentClientApi.deleteRoleFromClient
(String clientId, String roleAssignmentId) Unassign a Client Role Unassigns a Role Assignment (identified by `roleAssignmentId`) from a Client Application (identified by `clientId`)void
RoleAssignmentClientApi.deleteRoleFromClient
(String clientId, String roleAssignmentId, Map<String, String> additionalHeaders) Unassign a Client Role Unassigns a Role Assignment (identified by `roleAssignmentId`) from a Client Application (identified by `clientId`)void
RoleECustomPermissionApi.deleteRolePermission
(String roleIdOrLabel, String permissionType) Delete a Custom Role Permission Deletes a permission (identified by `permissionType`) from a Custom Rolevoid
RoleECustomPermissionApi.deleteRolePermission
(String roleIdOrLabel, String permissionType, Map<String, String> additionalHeaders) Delete a Custom Role Permission Deletes a permission (identified by `permissionType`) from a Custom Rolevoid
SsfReceiverApi.deleteSecurityEventsProviderInstance
(String securityEventProviderId) Delete a Security Events Provider Deletes a Security Events Provider instance specified by `id`void
SsfReceiverApi.deleteSecurityEventsProviderInstance
(String securityEventProviderId, Map<String, String> additionalHeaders) Delete a Security Events Provider Deletes a Security Events Provider instance specified by `id`void
TemplateApi.deleteSmsTemplate
(String templateId) Delete an SMS Template Deletes an SMS templatevoid
TemplateApi.deleteSmsTemplate
(String templateId, Map<String, String> additionalHeaders) Delete an SMS Template Deletes an SMS templatevoid
SsfTransmitterApi.deleteSsfStream
(String streamId) Delete an SSF Stream Deletes the specified SSF Stream.void
SsfTransmitterApi.deleteSsfStream
(String streamId, Map<String, String> additionalHeaders) Delete an SSF Stream Deletes the specified SSF Stream.void
TrustedOriginApi.deleteTrustedOrigin
(String trustedOriginId) Delete a Trusted Origin Deletes a trusted originvoid
TrustedOriginApi.deleteTrustedOrigin
(String trustedOriginId, Map<String, String> additionalHeaders) Delete a Trusted Origin Deletes a trusted originvoid
UiSchemaApi.deleteUISchemas
(String id) Delete a UI Schema Deletes a UI Schema by `id`void
UiSchemaApi.deleteUISchemas
(String id, Map<String, String> additionalHeaders) Delete a UI Schema Deletes a UI Schema by `id`void
UserApi.deleteUser
(String id, Boolean sendEmail, String prefer) Delete a User Deletes a User permanently.void
UserApi.deleteUser
(String id, Boolean sendEmail, String prefer, Map<String, String> additionalHeaders) Delete a User Deletes a User permanently.void
UserTypeApi.deleteUserType
(String typeId) Delete a User Type Deletes a User Type permanently.void
UserTypeApi.deleteUserType
(String typeId, Map<String, String> additionalHeaders) Delete a User Type Deletes a User Type permanently.void
WebAuthnPreregistrationApi.deleteWebAuthnPreregistrationFactor
(String userId, String authenticatorEnrollmentId) Delete a WebAuthn Preregistration Factor Deletes a specific WebAuthn Preregistration Factor for a uservoid
WebAuthnPreregistrationApi.deleteWebAuthnPreregistrationFactor
(String userId, String authenticatorEnrollmentId, Map<String, String> additionalHeaders) Delete a WebAuthn Preregistration Factor Deletes a specific WebAuthn Preregistration Factor for a uservoid
UserSessionsApi.endUserSessions
(KeepCurrent keepCurrent) End a current User session Ends Okta sessions for the currently signed in User.void
UserSessionsApi.endUserSessions
(KeepCurrent keepCurrent, Map<String, String> additionalHeaders) End a current User session Ends Okta sessions for the currently signed in User.UserFactorApi.enrollFactor
(String userId, UserFactor body, Boolean updatePhone, String templateId, Integer tokenLifetimeSeconds, Boolean activate, String acceptLanguage) Enroll a Factor Enrolls a supported Factor for the specified user > **Note:** All responses return the enrolled Factor with a status of either `PENDING_ACTIVATION`` or `ACTIVE`.UserFactorApi.enrollFactor
(String userId, UserFactor body, Boolean updatePhone, String templateId, Integer tokenLifetimeSeconds, Boolean activate, String acceptLanguage, Map<String, String> additionalHeaders) Enroll a Factor Enrolls a supported Factor for the specified user > **Note:** All responses return the enrolled Factor with a status of either `PENDING_ACTIVATION`` or `ACTIVE`.WebAuthnPreregistrationApi.enrollPreregistrationEnrollment
(EnrollmentInitializationRequest body) Enroll a Preregistered WebAuthn Factor Enrolls a preregistered WebAuthn Factor.WebAuthnPreregistrationApi.enrollPreregistrationEnrollment
(EnrollmentInitializationRequest body, Map<String, String> additionalHeaders) Enroll a Preregistered WebAuthn Factor Enrolls a preregistered WebAuthn Factor.InlineHookApi.executeInlineHook
(String inlineHookId, Object payloadData) Execute an Inline Hook Executes the inline hook by `inlineHookId` using the request body as the input.InlineHookApi.executeInlineHook
(String inlineHookId, Object payloadData, Map<String, String> additionalHeaders) Execute an Inline Hook Executes the inline hook by `inlineHookId` using the request body as the input.RealmAssignmentApi.executeRealmAssignment
(OperationRequest body) Execute a Realm Assignment Executes a Realm AssignmentRealmAssignmentApi.executeRealmAssignment
(OperationRequest body, Map<String, String> additionalHeaders) Execute a Realm Assignment Executes a Realm AssignmentUserCredApi.expirePassword
(String userId) Expire Password Expires the password.UserCredApi.expirePassword
(String userId, Map<String, String> additionalHeaders) Expire Password Expires the password.UserCredApi.expirePasswordWithTempPassword
(String userId, Boolean revokeSessions) Expire Password with temporary password Expires the password and resets the User's Password to a temporary password.UserCredApi.expirePasswordWithTempPassword
(String userId, Boolean revokeSessions, Map<String, String> additionalHeaders) Expire Password with temporary password Expires the password and resets the User's Password to a temporary password.OrgSettingSupportApi.extendOktaSupport()
Extend Okta Support Access Extends the length of time that Okta Support can access your org by 24 hours.OrgSettingSupportApi.extendOktaSupport
(Map<String, String> additionalHeaders) Extend Okta Support Access Extends the length of time that Okta Support can access your org by 24 hours.UserCredApi.forgotPassword
(String userId, Boolean sendEmail) Start forgot password flow Starts the forgot password flow.Start forgot password flow Starts the forgot password flow.UserCredApi.forgotPasswordSetNewPassword
(String userId, UserCredentials userCredentials, Boolean sendEmail) Reset Password with Recovery Question Resets the User's password to the specified password if the provided answer to the recovery question is correct.UserCredApi.forgotPasswordSetNewPassword
(String userId, UserCredentials userCredentials, Boolean sendEmail, Map<String, String> additionalHeaders) Reset Password with Recovery Question Resets the User's password to the specified password if the provided answer to the recovery question is correct.ApplicationSsoCredentialKeyApi.generateApplicationKey
(String appId, Integer validityYears) Generate a Key Credential Generates a new X.509 certificate for an app key credential > **Note:** To update an Application with the newly generated key credential, use the [Replace an Application](/openapi/okta-management/management/tag/Application/#tag/Application/operation/replaceApplication) request with the new [credentials.signing.kid](/openapi/okta-management/management/tag/Application/#tag/Application/operation/replaceApplication!path=4/credentials/signing/kid&t=request) value in the request body.ApplicationSsoCredentialKeyApi.generateApplicationKey
(String appId, Integer validityYears, Map<String, String> additionalHeaders) Generate a Key Credential Generates a new X.509 certificate for an app key credential > **Note:** To update an Application with the newly generated key credential, use the [Replace an Application](/openapi/okta-management/management/tag/Application/#tag/Application/operation/replaceApplication) request with the new [credentials.signing.kid](/openapi/okta-management/management/tag/Application/#tag/Application/operation/replaceApplication!path=4/credentials/signing/kid&t=request) value in the request body.ApplicationSsoCredentialKeyApi.generateCsrForApplication
(String appId, CsrMetadata metadata) Generate a Certificate Signing Request Generates a new key pair and returns the Certificate Signing Request(CSR) for it.ApplicationSsoCredentialKeyApi.generateCsrForApplication
(String appId, CsrMetadata metadata, Map<String, String> additionalHeaders) Generate a Certificate Signing Request Generates a new key pair and returns the Certificate Signing Request(CSR) for it.IdentityProviderSigningKeysApi.generateCsrForIdentityProvider
(String idpId, CsrMetadata metadata) Generate a Certificate Signing Request 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 IdP](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProviderSigningKeys/#tag/IdentityProviderSigningKeys/operation/listIdentityProviderSigningKeys) until it's published.IdentityProviderSigningKeysApi.generateCsrForIdentityProvider
(String idpId, CsrMetadata metadata, Map<String, String> additionalHeaders) Generate a Certificate Signing Request 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 IdP](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProviderSigningKeys/#tag/IdentityProviderSigningKeys/operation/listIdentityProviderSigningKeys) until it's published.void
WebAuthnPreregistrationApi.generateFulfillmentRequest
(FulfillmentRequest body) Generate a Fulfillment Request Generates a fulfillment request by sending a WebAuthn Preregistration event to start the flow.void
WebAuthnPreregistrationApi.generateFulfillmentRequest
(FulfillmentRequest body, Map<String, String> additionalHeaders) Generate a Fulfillment Request Generates a fulfillment request by sending a WebAuthn Preregistration event to start the flow.IdentityProviderSigningKeysApi.generateIdentityProviderSigningKey
(String idpId, Integer validityYears) Generate a new signing Key Credential for IdP Generates a new X.509 certificate for an IdP signing Key Credential to be used for signing assertions sent to the IdP.IdentityProviderSigningKeysApi.generateIdentityProviderSigningKey
(String idpId, Integer validityYears, Map<String, String> additionalHeaders) Generate a new signing Key Credential for IdP Generates a new X.509 certificate for an IdP signing Key Credential to be used for signing assertions sent to the IdP.OrgSettingSupportApi.getAerialConsent()
Retrieve Okta Aerial consent for your Org Retrieves the Okta Aerial consent grant details for your Org.OrgSettingSupportApi.getAerialConsent
(Map<String, String> additionalHeaders) Retrieve Okta Aerial consent for your Org Retrieves the Okta Aerial consent grant details for your Org.AgentPoolsApi.getAgentPoolsUpdateInstance
(String poolId, String updateId) Retrieve an Agent Pool update by id Retrieves Agent pool update from updateIdAgentPoolsApi.getAgentPoolsUpdateInstance
(String poolId, String updateId, Map<String, String> additionalHeaders) Retrieve an Agent Pool update by id Retrieves Agent pool update from updateIdAgentPoolsApi.getAgentPoolsUpdateSettings
(String poolId) Retrieve an Agent Pool update's settings Retrieves the current state of the agent pool update instance settingsAgentPoolsApi.getAgentPoolsUpdateSettings
(String poolId, Map<String, String> additionalHeaders) Retrieve an Agent Pool update's settings Retrieves the current state of the agent pool update instance settingsApiServiceIntegrationsApi.getApiServiceIntegrationInstance
(String apiServiceId) Retrieve an API Service Integration instance Retrieves an API Service Integration instance by `id`ApiServiceIntegrationsApi.getApiServiceIntegrationInstance
(String apiServiceId, Map<String, String> additionalHeaders) Retrieve an API Service Integration instance Retrieves an API Service Integration instance by `id`ApiTokenApi.getApiToken
(String apiTokenId) Retrieve an API Token's Metadata Retrieves the metadata for an active API token by `apiTokenId`ApiTokenApi.getApiToken
(String apiTokenId, Map<String, String> additionalHeaders) Retrieve an API Token's Metadata Retrieves the metadata for an active API token by `apiTokenId`ApplicationApi.getApplication
(String appId, String expand) Retrieve an Application Retrieves an application from your Okta organization by `id`Retrieve an Application Retrieves an application from your Okta organization by `id`ApplicationGroupsApi.getApplicationGroupAssignment
(String appId, String groupId, String expand) Retrieve an Application Group Retrieves an app group assignmentApplicationGroupsApi.getApplicationGroupAssignment
(String appId, String groupId, String expand, Map<String, String> additionalHeaders) Retrieve an Application Group Retrieves an app group assignmentApplicationSsoCredentialKeyApi.getApplicationKey
(String appId, String keyId) Retrieve a Key Credential Retrieves a specific Application Key Credential by `kid`ApplicationSsoCredentialKeyApi.getApplicationKey
(String appId, String keyId, Map<String, String> additionalHeaders) Retrieve a Key Credential Retrieves a specific Application Key Credential by `kid`ApplicationUsersApi.getApplicationUser
(String appId, String userId, String expand) Retrieve an Application User Retrieves a specific user assignment for a specific appApplicationUsersApi.getApplicationUser
(String appId, String userId, String expand, Map<String, String> additionalHeaders) Retrieve an Application User Retrieves a specific user assignment for a specific appSchemaApi.getApplicationUserSchema
(String appId) Retrieve the default App User Schema for an App Retrieves the default Schema for an App User.SchemaApi.getApplicationUserSchema
(String appId, Map<String, String> additionalHeaders) Retrieve the default App User Schema for an App Retrieves the default Schema for an App User.AuthenticatorApi.getAuthenticator
(String authenticatorId) Retrieve an Authenticator Retrieves an authenticator from your Okta organization by `authenticatorId`AuthenticatorApi.getAuthenticator
(String authenticatorId, Map<String, String> additionalHeaders) Retrieve an Authenticator Retrieves an authenticator from your Okta organization by `authenticatorId`AuthenticatorApi.getAuthenticatorMethod
(String authenticatorId, AuthenticatorMethodType methodType) Retrieve an Authenticator Method Retrieves a Method identified by `methodType` of an Authenticator identified by `authenticatorId` > **Note:** <x-lifecycle class=\"ea\"></x-lifecycle> > The AAGUID Group object supports the Early Access (Self-Service) Allow List for FIDO2 (WebAuthn) Authenticators feature.AuthenticatorApi.getAuthenticatorMethod
(String authenticatorId, AuthenticatorMethodType methodType, Map<String, String> additionalHeaders) Retrieve an Authenticator Method Retrieves a Method identified by `methodType` of an Authenticator identified by `authenticatorId` > **Note:** <x-lifecycle class=\"ea\"></x-lifecycle> > The AAGUID Group object supports the Early Access (Self-Service) Allow List for FIDO2 (WebAuthn) Authenticators feature.AttackProtectionApi.getAuthenticatorSettings()
Retrieve the Authenticator Settings Retrieves the Authenticator Settings for an orgAttackProtectionApi.getAuthenticatorSettings
(Map<String, String> additionalHeaders) Retrieve the Authenticator Settings Retrieves the Authenticator Settings for an orgAuthorizationServerApi.getAuthorizationServer
(String authServerId) Retrieve an Authorization Server Retrieves an authorization serverAuthorizationServerApi.getAuthorizationServer
(String authServerId, Map<String, String> additionalHeaders) Retrieve an Authorization Server Retrieves an authorization serverAuthorizationServerKeysApi.getAuthorizationServerKey
(String authServerId, String keyId) Retrieve an Authorization Server Key Retrieves an Authorization Server Key specified by the `keyId`AuthorizationServerKeysApi.getAuthorizationServerKey
(String authServerId, String keyId, Map<String, String> additionalHeaders) Retrieve an Authorization Server Key Retrieves an Authorization Server Key specified by the `keyId`AuthorizationServerPoliciesApi.getAuthorizationServerPolicy
(String authServerId, String policyId) Retrieve a Policy Retrieves a policyAuthorizationServerPoliciesApi.getAuthorizationServerPolicy
(String authServerId, String policyId, Map<String, String> additionalHeaders) Retrieve a Policy Retrieves a policyAuthorizationServerRulesApi.getAuthorizationServerPolicyRule
(String authServerId, String policyId, String ruleId) Retrieve a Policy Rule Retrieves a policy rule by `ruleId`AuthorizationServerRulesApi.getAuthorizationServerPolicyRule
(String authServerId, String policyId, String ruleId, Map<String, String> additionalHeaders) Retrieve a Policy Rule Retrieves a policy rule by `ruleId`BehaviorApi.getBehaviorDetectionRule
(String behaviorId) Retrieve a Behavior Detection Rule Retrieves a Behavior Detection Rule by `behaviorId`BehaviorApi.getBehaviorDetectionRule
(String behaviorId, Map<String, String> additionalHeaders) Retrieve a Behavior Detection Rule Retrieves a Behavior Detection Rule by `behaviorId`RoleDResourceSetBindingApi.getBinding
(String resourceSetIdOrLabel, String roleIdOrLabel) Retrieve a Role Resource Set Binding Retrieves the Binding of a Role (identified by `roleIdOrLabel`) in a Resource Set (identified by `resourceSetIdOrLabel`)RoleDResourceSetBindingApi.getBinding
(String resourceSetIdOrLabel, String roleIdOrLabel, Map<String, String> additionalHeaders) Retrieve a Role Resource Set Binding Retrieves the Binding of a Role (identified by `roleIdOrLabel`) in a Resource Set (identified by `resourceSetIdOrLabel`)Retrieve a Brand Retrieves a brand by `brandId`Retrieve a Brand Retrieves a brand by `brandId`ThemesApi.getBrandTheme
(String brandId, String themeId) Retrieve a Theme Retrieves a theme for a brandRetrieve a Theme Retrieves a theme for a brandCaptchaApi.getCaptchaInstance
(String captchaId) Retrieve a CAPTCHA Instance Retrieves the properties of a specified CAPTCHA instanceCaptchaApi.getCaptchaInstance
(String captchaId, Map<String, String> additionalHeaders) Retrieve a CAPTCHA Instance Retrieves the properties of a specified CAPTCHA instanceOrgSettingAdminApi.getClientPrivilegesSetting()
Retrieve the Default Public Client App Role Setting Retrieves the org setting to assign the [Super Admin role](https://help.okta.com/okta_help.htm?type=oie&id=ext_superadmin) to new public client appsOrgSettingAdminApi.getClientPrivilegesSetting
(Map<String, String> additionalHeaders) Retrieve the Default Public Client App Role Setting Retrieves the org setting to assign the [Super Admin role](https://help.okta.com/okta_help.htm?type=oie&id=ext_superadmin) to new public client appsApplicationSsoCredentialKeyApi.getCsrForApplication
(String appId, String csrId) Retrieve a Certificate Signing Request Retrieves a Certificate Signing Request (CSR) for the app by `csrId`.ApplicationSsoCredentialKeyApi.getCsrForApplication
(String appId, String csrId, Map<String, String> additionalHeaders) Retrieve a Certificate Signing Request Retrieves a Certificate Signing Request (CSR) for the app by `csrId`.IdentityProviderSigningKeysApi.getCsrForIdentityProvider
(String idpId, String idpCsrId) Retrieve a Certificate Signing Request Retrieves a specific Certificate Signing Request by `id`IdentityProviderSigningKeysApi.getCsrForIdentityProvider
(String idpId, String idpCsrId, Map<String, String> additionalHeaders) Retrieve a Certificate Signing Request Retrieves a specific Certificate Signing Request by `id`ThreatInsightApi.getCurrentConfiguration()
Retrieve the ThreatInsight Configuration Retrieves the ThreatInsight configuration for the orgThreatInsightApi.getCurrentConfiguration
(Map<String, String> additionalHeaders) Retrieve the ThreatInsight Configuration Retrieves the ThreatInsight configuration for the orgSessionApi.getCurrentSession
(String cookie) Retrieve the current Session Retrieves Session information for the current user.SessionApi.getCurrentSession
(String cookie, Map<String, String> additionalHeaders) Retrieve the current Session Retrieves Session information for the current user.CustomDomainApi.getCustomDomain
(String domainId) Retrieve a Custom Domain Retrieves a custom domain by `domainId`CustomDomainApi.getCustomDomain
(String domainId, Map<String, String> additionalHeaders) Retrieve a Custom Domain Retrieves a custom domain by `domainId`CustomTemplatesApi.getCustomizationPreview
(String brandId, String templateName, String customizationId) Retrieve a Preview of an Email Customization Retrieves a Preview of an Email Customization.CustomTemplatesApi.getCustomizationPreview
(String brandId, String templateName, String customizationId, Map<String, String> additionalHeaders) Retrieve a Preview of an Email Customization Retrieves a Preview of an Email Customization.CustomPagesApi.getCustomizedErrorPage
(String brandId) Retrieve the Customized Error Page Retrieves the customized error page.CustomPagesApi.getCustomizedErrorPage
(String brandId, Map<String, String> additionalHeaders) Retrieve the Customized Error Page Retrieves the customized error page.CustomPagesApi.getCustomizedSignInPage
(String brandId) Retrieve the Customized Sign-in Page Retrieves the customized sign-in page.CustomPagesApi.getCustomizedSignInPage
(String brandId, Map<String, String> additionalHeaders) Retrieve the Customized Sign-in Page Retrieves the customized sign-in page.CustomPagesApi.getDefaultErrorPage
(String brandId) Retrieve the Default Error Page Retrieves the default error page.CustomPagesApi.getDefaultErrorPage
(String brandId, Map<String, String> additionalHeaders) Retrieve the Default Error Page Retrieves the default error page.ApplicationConnectionsApi.getDefaultProvisioningConnectionForApplication
(String appId) Retrieve the default Provisioning Connection Retrieves the default Provisioning Connection for an appApplicationConnectionsApi.getDefaultProvisioningConnectionForApplication
(String appId, Map<String, String> additionalHeaders) Retrieve the default Provisioning Connection Retrieves the default Provisioning Connection for an appCustomPagesApi.getDefaultSignInPage
(String brandId) Retrieve the Default Sign-in Page Retrieves the default sign-in page.CustomPagesApi.getDefaultSignInPage
(String brandId, Map<String, String> additionalHeaders) Retrieve the Default Sign-in Page Retrieves the default sign-in page.DeviceAccessApi.getDesktopMFARecoveryPinOrgSetting()
Retrieve the Desktop MFA Recovery PIN Org setting Retrieves the status of the Desktop MFA Recovery PIN feature.DeviceAccessApi.getDesktopMFARecoveryPinOrgSetting
(Map<String, String> additionalHeaders) Retrieve the Desktop MFA Recovery PIN Org setting Retrieves the status of the Desktop MFA Recovery PIN feature.Retrieve a Device Retrieves a device by `deviceId`Retrieve a Device Retrieves a device by `deviceId`DeviceAssuranceApi.getDeviceAssurancePolicy
(String deviceAssuranceId) Retrieve a Device Assurance Policy Retrieves a Device Assurance Policy by `deviceAssuranceId`DeviceAssuranceApi.getDeviceAssurancePolicy
(String deviceAssuranceId, Map<String, String> additionalHeaders) Retrieve a Device Assurance Policy Retrieves a Device Assurance Policy by `deviceAssuranceId`CustomTemplatesApi.getEmailCustomization
(String brandId, String templateName, String customizationId) Retrieve an Email Customization Retrieves an email customization by its unique identifier <x-lifecycle class=\"ea\"></x-lifecycle> If Custom languages for Okta Email Templates is disabled, requests to retrieve an additional language customization by ID result in a `404 Not Found` error response.CustomTemplatesApi.getEmailCustomization
(String brandId, String templateName, String customizationId, Map<String, String> additionalHeaders) Retrieve an Email Customization Retrieves an email customization by its unique identifier <x-lifecycle class=\"ea\"></x-lifecycle> If Custom languages for Okta Email Templates is disabled, requests to retrieve an additional language customization by ID result in a `404 Not Found` error response.CustomTemplatesApi.getEmailDefaultContent
(String brandId, String templateName, String language) Retrieve an Email Template Default Content Retrieves an email template's default content <x-lifecycle class=\"ea\"></x-lifecycle> Defaults to the current user's language given the following: - Custom languages for Okta Email Templates is enabled - An additional language is specified for the `language` parameterCustomTemplatesApi.getEmailDefaultContent
(String brandId, String templateName, String language, Map<String, String> additionalHeaders) Retrieve an Email Template Default Content Retrieves an email template's default content <x-lifecycle class=\"ea\"></x-lifecycle> Defaults to the current user's language given the following: - Custom languages for Okta Email Templates is enabled - An additional language is specified for the `language` parameterCustomTemplatesApi.getEmailDefaultPreview
(String brandId, String templateName, String language) Retrieve a Preview of the Email Template default content Retrieves a preview of an Email Template's default content.CustomTemplatesApi.getEmailDefaultPreview
(String brandId, String templateName, String language, Map<String, String> additionalHeaders) Retrieve a Preview of the Email Template default content Retrieves a preview of an Email Template's default content.EmailDomainApi.getEmailDomain
(String emailDomainId, List<String> expand) Retrieve an Email Domain Retrieves an Email Domain by `emailDomainId`EmailDomainApi.getEmailDomain
(String emailDomainId, List<String> expand, Map<String, String> additionalHeaders) Retrieve an Email Domain Retrieves an Email Domain by `emailDomainId`EmailServerApi.getEmailServer
(String emailServerId) Retrieve an SMTP Server configuration Retrieves the specified custom SMTP server configurationEmailServerApi.getEmailServer
(String emailServerId, Map<String, String> additionalHeaders) Retrieve an SMTP Server configuration Retrieves the specified custom SMTP server configurationCustomTemplatesApi.getEmailSettings
(String brandId, String templateName) Retrieve the Email Template Settings Retrieves an email template's settingsCustomTemplatesApi.getEmailSettings
(String brandId, String templateName, Map<String, String> additionalHeaders) Retrieve the Email Template Settings Retrieves an email template's settingsCustomTemplatesApi.getEmailTemplate
(String brandId, String templateName, List<String> expand) Retrieve an Email Template Retrieves the details of an email template by nameCustomTemplatesApi.getEmailTemplate
(String brandId, String templateName, List<String> expand, Map<String, String> additionalHeaders) Retrieve an Email Template Retrieves the details of an email template by nameCustomPagesApi.getErrorPage
(String brandId, List<String> expand) Retrieve the Error Page Sub-Resources Retrieves the error page sub-resources.CustomPagesApi.getErrorPage
(String brandId, List<String> expand, Map<String, String> additionalHeaders) Retrieve the Error Page Sub-Resources Retrieves the error page sub-resources.EventHookApi.getEventHook
(String eventHookId) Retrieve an Event Hook Retrieves an event hookEventHookApi.getEventHook
(String eventHookId, Map<String, String> additionalHeaders) Retrieve an Event Hook Retrieves an event hookRetrieve a Factor Retrieves an existing Factor for the specified userRetrieve a Factor Retrieves an existing Factor for the specified userUserFactorApi.getFactorTransactionStatus
(String userId, String factorId, String transactionId) Retrieve a Factor transaction status Retrieves the status of a `push` Factor verification transactionUserFactorApi.getFactorTransactionStatus
(String userId, String factorId, String transactionId, Map<String, String> additionalHeaders) Retrieve a Factor transaction status Retrieves the status of a `push` Factor verification transactionFeatureApi.getFeature
(String featureId) Retrieve a Feature Retrieves a feature by IDFeatureApi.getFeature
(String featureId, Map<String, String> additionalHeaders) Retrieve a Feature Retrieves a feature by IDApplicationFeaturesApi.getFeatureForApplication
(String appId, ApplicationFeatureType featureName) Retrieve a Feature Retrieves a Feature object for an appApplicationFeaturesApi.getFeatureForApplication
(String appId, ApplicationFeatureType featureName, Map<String, String> additionalHeaders) Retrieve a Feature Retrieves a Feature object for an appOktaApplicationSettingsApi.getFirstPartyAppSettings
(String appName) Retrieve the Okta Application Settings Retrieves the settings for an Okta app (also known as an Okta first-party app)OktaApplicationSettingsApi.getFirstPartyAppSettings
(String appName, Map<String, String> additionalHeaders) Retrieve the Okta Application Settings Retrieves the settings for an Okta app (also known as an Okta first-party app)Retrieve a Group Retrieves a specific Group by `id` from your orgRetrieve a Group Retrieves a specific Group by `id` from your orgRoleAssignmentBGroupApi.getGroupAssignedRole
(String groupId, String roleAssignmentId) Retrieve a Group Role Assignment Retrieves a Role assigned to a Group (identified by the `groupId`).RoleAssignmentBGroupApi.getGroupAssignedRole
(String groupId, String roleAssignmentId, Map<String, String> additionalHeaders) Retrieve a Group Role Assignment Retrieves a Role assigned to a Group (identified by the `groupId`).GroupRuleApi.getGroupRule
(String groupRuleId, String expand) Retrieve a Group rule Retrieves a specific Group rule by ID from your orgRetrieve a Group rule Retrieves a specific Group rule by ID from your orgSchemaApi.getGroupSchema()
Retrieve the default Group Schema Retrieves the Group Schema The [User Types](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserType/) feature does not extend to groups.SchemaApi.getGroupSchema
(Map<String, String> additionalHeaders) Retrieve the default Group Schema Retrieves the Group Schema The [User Types](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserType/) feature does not extend to groups.HookKeyApi.getHookKey
(String id) Retrieve a key by ID Retrieves the public portion of the Key object using the `id` parameter >**Note:** The `?expand=publickey` query parameter optionally returns the full object including the details of the public key in the response body's `_embedded` property.HookKeyApi.getHookKey
(String id, Map<String, String> additionalHeaders) Retrieve a key by ID Retrieves the public portion of the Key object using the `id` parameter >**Note:** The `?expand=publickey` query parameter optionally returns the full object including the details of the public key in the response body's `_embedded` property.IdentityProviderApi.getIdentityProvider
(String idpId) Retrieve an Identity Provider Retrieves an identity provider integration by `idpId`IdentityProviderApi.getIdentityProvider
(String idpId, Map<String, String> additionalHeaders) Retrieve an Identity Provider Retrieves an identity provider integration by `idpId`IdentityProviderUsersApi.getIdentityProviderApplicationUser
(String idpId, String userId) Retrieve a User for IdP Retrieves a linked IdP User by IDIdentityProviderUsersApi.getIdentityProviderApplicationUser
(String idpId, String userId, Map<String, String> additionalHeaders) Retrieve a User for IdP Retrieves a linked IdP User by IDIdentityProviderKeysApi.getIdentityProviderKey
(String kid) Retrieve an IdP Key Credential Retrieves a specific IdP Key Credential by `kid`IdentityProviderKeysApi.getIdentityProviderKey
(String kid, Map<String, String> additionalHeaders) Retrieve an IdP Key Credential Retrieves a specific IdP Key Credential by `kid`IdentityProviderSigningKeysApi.getIdentityProviderSigningKey
(String idpId, String kid) Retrieve a signing Key Credential for IdP Retrieves a specific IdP Key Credential by `kid`IdentityProviderSigningKeysApi.getIdentityProviderSigningKey
(String idpId, String kid, Map<String, String> additionalHeaders) Retrieve a signing Key Credential for IdP Retrieves a specific IdP Key Credential by `kid`IdentitySourceApi.getIdentitySourceSession
(String identitySourceId, String sessionId) Retrieve an Identity Source Session Retrieves an Identity Source Session for a given Identity Source ID and session IDIdentitySourceApi.getIdentitySourceSession
(String identitySourceId, String sessionId, Map<String, String> additionalHeaders) Retrieve an Identity Source Session Retrieves an Identity Source Session for a given Identity Source ID and session IDInlineHookApi.getInlineHook
(String inlineHookId) Retrieve an Inline Hook Retrieves an inline hook by `inlineHookId`InlineHookApi.getInlineHook
(String inlineHookId, Map<String, String> additionalHeaders) Retrieve an Inline Hook Retrieves an inline hook by `inlineHookId`Retrieve an OAuth 2.0 Client JSON Web Key Retrieves an OAuth 2.0 Client JSON Web Key by `keyId`.ApplicationSsoCredentialOAuth2ClientAuthApi.getJwk
(String appId, String keyId, Map<String, String> additionalHeaders) Retrieve an OAuth 2.0 Client JSON Web Key Retrieves an OAuth 2.0 Client JSON Web Key by `keyId`.LinkedObjectApi.getLinkedObjectDefinition
(String linkedObjectName) Retrieve a Linked Object Definition Retrieves a Linked Object definitionLinkedObjectApi.getLinkedObjectDefinition
(String linkedObjectName, Map<String, String> additionalHeaders) Retrieve a Linked Object Definition Retrieves a Linked Object definitionLogStreamApi.getLogStream
(String logStreamId) Retrieve a Log Stream Retrieves a Log Stream object by IDLogStreamApi.getLogStream
(String logStreamId, Map<String, String> additionalHeaders) Retrieve a Log Stream Retrieves a Log Stream object by IDSchemaApi.getLogStreamSchema
(LogStreamType logStreamType) Retrieve the Log Stream Schema for the schema type Retrieves the Schema for a Log Stream type.SchemaApi.getLogStreamSchema
(LogStreamType logStreamType, Map<String, String> additionalHeaders) Retrieve the Log Stream Schema for the schema type Retrieves the Schema for a Log Stream type.RoleDResourceSetBindingMemberApi.getMemberOfBinding
(String resourceSetIdOrLabel, String roleIdOrLabel, String memberId) Retrieve a Role Resource Set Binding Member Retrieves a Member (identified by `memberId`) that belongs to a Role Resource Set BindingRoleDResourceSetBindingMemberApi.getMemberOfBinding
(String resourceSetIdOrLabel, String roleIdOrLabel, String memberId, Map<String, String> additionalHeaders) Retrieve a Role Resource Set Binding Member Retrieves a Member (identified by `memberId`) that belongs to a Role Resource Set BindingNetworkZoneApi.getNetworkZone
(String zoneId) Retrieve a Network Zone Retrieves a Network Zone by `zoneId`NetworkZoneApi.getNetworkZone
(String zoneId, Map<String, String> additionalHeaders) Retrieve a Network Zone Retrieves a Network Zone by `zoneId`AuthorizationServerClaimsApi.getOAuth2Claim
(String authServerId, String claimId) Retrieve a custom token Claim Retrieves a custom token Claim by the specified `claimId`AuthorizationServerClaimsApi.getOAuth2Claim
(String authServerId, String claimId, Map<String, String> additionalHeaders) Retrieve a custom token Claim Retrieves a custom token Claim by the specified `claimId`ApplicationSsoCredentialOAuth2ClientAuthApi.getOAuth2ClientSecret
(String appId, String secretId) Retrieve an OAuth 2.0 Client Secret Retrieves an OAuth 2.0 Client Secret by `secretId`ApplicationSsoCredentialOAuth2ClientAuthApi.getOAuth2ClientSecret
(String appId, String secretId, Map<String, String> additionalHeaders) Retrieve an OAuth 2.0 Client Secret Retrieves an OAuth 2.0 Client Secret by `secretId`AuthorizationServerScopesApi.getOAuth2Scope
(String authServerId, String scopeId) Retrieve a Custom Token Scope Retrieves a custom token scopeAuthorizationServerScopesApi.getOAuth2Scope
(String authServerId, String scopeId, Map<String, String> additionalHeaders) Retrieve a Custom Token Scope Retrieves a custom token scopeApplicationTokensApi.getOAuth2TokenForApplication
(String appId, String tokenId, String expand) Retrieve an Application Token Retrieves a refresh token for the specified appApplicationTokensApi.getOAuth2TokenForApplication
(String appId, String tokenId, String expand, Map<String, String> additionalHeaders) Retrieve an Application Token Retrieves a refresh token for the specified appOrgSettingCommunicationApi.getOktaCommunicationSettings()
Retrieve the Okta Communication Settings Retrieves Okta Communication Settings of your orgOrgSettingCommunicationApi.getOktaCommunicationSettings
(Map<String, String> additionalHeaders) Retrieve the Okta Communication Settings Retrieves Okta Communication Settings of your orgCaptchaApi.getOrgCaptchaSettings()
Retrieve the Org-wide CAPTCHA Settings Retrieves the CAPTCHA settings object for your organization > **Note**: If the current organization hasn't configured CAPTCHA Settings, the request returns an empty object.CaptchaApi.getOrgCaptchaSettings
(Map<String, String> additionalHeaders) Retrieve the Org-wide CAPTCHA Settings Retrieves the CAPTCHA settings object for your organization > **Note**: If the current organization hasn't configured CAPTCHA Settings, the request returns an empty object.OrgSettingContactApi.getOrgContactUser
(String contactType) Retrieve the Contact Type User Retrieves the ID and the User resource associated with the specified Contact TypeOrgSettingContactApi.getOrgContactUser
(String contactType, Map<String, String> additionalHeaders) Retrieve the Contact Type User Retrieves the ID and the User resource associated with the specified Contact TypeOrgSettingSupportApi.getOrgOktaSupportSettings()
Retrieve the Okta Support Settings Retrieves Okta Support Settings for your orgOrgSettingSupportApi.getOrgOktaSupportSettings
(Map<String, String> additionalHeaders) Retrieve the Okta Support Settings Retrieves Okta Support Settings for your orgOrgSettingCustomizationApi.getOrgPreferences()
Retrieve the Org Preferences Retrieves preferences of your Okta orgOrgSettingCustomizationApi.getOrgPreferences
(Map<String, String> additionalHeaders) Retrieve the Org Preferences Retrieves preferences of your Okta orgOrgSettingGeneralApi.getOrgSettings()
Retrieve the Org General Settings Retrieves the Org General SettingsOrgSettingGeneralApi.getOrgSettings
(Map<String, String> additionalHeaders) Retrieve the Org General Settings Retrieves the Org General SettingsRetrieve a Policy Retrieves a policyRetrieve a Policy Retrieves a policyPolicyApi.getPolicyMapping
(String policyId, String mappingId) Retrieve a policy resource Mapping Retrieves a resource Mapping for a Policy identified by `policyId` and `mappingId`Retrieve a policy resource Mapping Retrieves a resource Mapping for a Policy identified by `policyId` and `mappingId`PolicyApi.getPolicyRule
(String policyId, String ruleId) Retrieve a Policy Rule Retrieves a policy ruleRetrieve a Policy Rule Retrieves a policy ruleCustomPagesApi.getPreviewErrorPage
(String brandId) Retrieve the Preview Error Page Preview Retrieves the preview error page.CustomPagesApi.getPreviewErrorPage
(String brandId, Map<String, String> additionalHeaders) Retrieve the Preview Error Page Preview Retrieves the preview error page.CustomPagesApi.getPreviewSignInPage
(String brandId) Retrieve the Preview Sign-in Page Preview Retrieves the preview sign-in page.CustomPagesApi.getPreviewSignInPage
(String brandId, Map<String, String> additionalHeaders) Retrieve the Preview Sign-in Page Preview Retrieves the preview sign-in page.PrincipalRateLimitApi.getPrincipalRateLimitEntity
(String principalRateLimitId) Retrieve a Principal Rate Limit Retrieves a Principal Rate Limit entity by `principalRateLimitId`PrincipalRateLimitApi.getPrincipalRateLimitEntity
(String principalRateLimitId, Map<String, String> additionalHeaders) Retrieve a Principal Rate Limit Retrieves a Principal Rate Limit entity by `principalRateLimitId`ProfileMappingApi.getProfileMapping
(String mappingId) Retrieve a Profile Mapping Retrieves a single Profile Mapping referenced by its IDProfileMappingApi.getProfileMapping
(String mappingId, Map<String, String> additionalHeaders) Retrieve a Profile Mapping Retrieves a single Profile Mapping referenced by its IDHookKeyApi.getPublicKey
(String keyId) Retrieve a public key Retrieves a public key by `keyId` >**Note:** keyId is the alias of the public key.HookKeyApi.getPublicKey
(String keyId, Map<String, String> additionalHeaders) Retrieve a public key Retrieves a public key by `keyId` >**Note:** keyId is the alias of the public key.PushProviderApi.getPushProvider
(String pushProviderId) Retrieve a Push Provider Retrieves a push provider by `pushProviderId`PushProviderApi.getPushProvider
(String pushProviderId, Map<String, String> additionalHeaders) Retrieve a Push Provider Retrieves a push provider by `pushProviderId`RateLimitSettingsApi.getRateLimitSettingsAdminNotifications()
Retrieve the Rate Limit Admin Notification Settings Retrieves the currently configured Rate Limit Admin Notification SettingsRateLimitSettingsApi.getRateLimitSettingsAdminNotifications
(Map<String, String> additionalHeaders) Retrieve the Rate Limit Admin Notification Settings Retrieves the currently configured Rate Limit Admin Notification SettingsRateLimitSettingsApi.getRateLimitSettingsPerClient()
Retrieve the Per-Client Rate Limit Settings Retrieves the currently configured Per-Client Rate Limit SettingsRateLimitSettingsApi.getRateLimitSettingsPerClient
(Map<String, String> additionalHeaders) Retrieve the Per-Client Rate Limit Settings Retrieves the currently configured Per-Client Rate Limit SettingsRateLimitSettingsApi.getRateLimitSettingsWarningThreshold()
Retrieve the Rate Limit Warning Threshold Percentage Retrieves the currently configured threshold for warning notifications when the API's rate limit is exceededRateLimitSettingsApi.getRateLimitSettingsWarningThreshold
(Map<String, String> additionalHeaders) Retrieve the Rate Limit Warning Threshold Percentage Retrieves the currently configured threshold for warning notifications when the API's rate limit is exceededRetrieve a Realm Retrieves a RealmRetrieve a Realm Retrieves a RealmRealmAssignmentApi.getRealmAssignment
(String assignmentId) Retrieve a Realm Assignment Retrieves a Realm AssignmentRealmAssignmentApi.getRealmAssignment
(String assignmentId, Map<String, String> additionalHeaders) Retrieve a Realm Assignment Retrieves a Realm AssignmentAuthorizationServerClientsApi.getRefreshTokenForAuthorizationServerAndClient
(String authServerId, String clientId, String tokenId, String expand) Retrieve a refresh token for a Client Retrieves a refresh token for a ClientAuthorizationServerClientsApi.getRefreshTokenForAuthorizationServerAndClient
(String authServerId, String clientId, String tokenId, String expand, Map<String, String> additionalHeaders) Retrieve a refresh token for a Client Retrieves a refresh token for a ClientUserOAuthApi.getRefreshTokenForUserAndClient
(String userId, String clientId, String tokenId, String expand) Retrieve a Refresh Token for a Client Retrieves a refresh Token issued for the specified User and clientUserOAuthApi.getRefreshTokenForUserAndClient
(String userId, String clientId, String tokenId, String expand, Map<String, String> additionalHeaders) Retrieve a Refresh Token for a Client Retrieves a refresh Token issued for the specified User and clientRoleCResourceSetApi.getResourceSet
(String resourceSetIdOrLabel) Retrieve a Resource Set Retrieves a Resource Set by `resourceSetIdOrLabel`RoleCResourceSetApi.getResourceSet
(String resourceSetIdOrLabel, Map<String, String> additionalHeaders) Retrieve a Resource Set Retrieves a Resource Set by `resourceSetIdOrLabel`RiskProviderApi.getRiskProvider
(String riskProviderId) Retrieve a Risk Provider Retrieves a Risk Provider object by IDRiskProviderApi.getRiskProvider
(String riskProviderId, Map<String, String> additionalHeaders) Retrieve a Risk Provider Retrieves a Risk Provider object by IDRetrieve a Role Retrieves a role by `roleIdOrLabel`Retrieve a Role Retrieves a role by `roleIdOrLabel`RoleECustomPermissionApi.getRolePermission
(String roleIdOrLabel, String permissionType) Retrieve a Custom Role Permission Retrieves a permission (identified by `permissionType`) for a Custom RoleRoleECustomPermissionApi.getRolePermission
(String roleIdOrLabel, String permissionType, Map<String, String> additionalHeaders) Retrieve a Custom Role Permission Retrieves a permission (identified by `permissionType`) for a Custom RoleApplicationGrantsApi.getScopeConsentGrant
(String appId, String grantId, String expand) Retrieve an app Grant Retrieves a single scope consent Grant object for the appApplicationGrantsApi.getScopeConsentGrant
(String appId, String grantId, String expand, Map<String, String> additionalHeaders) Retrieve an app Grant Retrieves a single scope consent Grant object for the appSsfReceiverApi.getSecurityEventsProviderInstance
(String securityEventProviderId) Retrieve the Security Events Provider Retrieves the Security Events Provider instance specified by `id`SsfReceiverApi.getSecurityEventsProviderInstance
(String securityEventProviderId, Map<String, String> additionalHeaders) Retrieve the Security Events Provider Retrieves the Security Events Provider instance specified by `id`SessionApi.getSession
(String sessionId) Retrieve a Session Retrieves information about the Session specified by the given session IDSessionApi.getSession
(String sessionId, Map<String, String> additionalHeaders) Retrieve a Session Retrieves information about the Session specified by the given session IDCustomPagesApi.getSignInPage
(String brandId, List<String> expand) Retrieve the Sign-in Page Sub-Resources Retrieves the sign-in page sub-resources.CustomPagesApi.getSignInPage
(String brandId, List<String> expand, Map<String, String> additionalHeaders) Retrieve the Sign-in Page Sub-Resources Retrieves the sign-in page sub-resources.CustomPagesApi.getSignOutPageSettings
(String brandId) Retrieve the Sign-out Page Settings Retrieves the sign-out page settingsCustomPagesApi.getSignOutPageSettings
(String brandId, Map<String, String> additionalHeaders) Retrieve the Sign-out Page Settings Retrieves the sign-out page settingsTemplateApi.getSmsTemplate
(String templateId) Retrieve an SMS Template Retrieves a specific template by `id`TemplateApi.getSmsTemplate
(String templateId, Map<String, String> additionalHeaders) Retrieve an SMS Template Retrieves a specific template by `id`SsfTransmitterApi.getSsfStreams
(String streamId) Retrieve the SSF Stream configuration(s) Retrieves either a list of all known SSF Stream configurations or the individual configuration if specified by ID.SsfTransmitterApi.getSsfStreams
(String streamId, Map<String, String> additionalHeaders) Retrieve the SSF Stream configuration(s) Retrieves either a list of all known SSF Stream configurations or the individual configuration if specified by ID.SubscriptionApi.getSubscriptionsNotificationTypeRole
(ListSubscriptionsRoleRoleRefParameter roleRef, NotificationType notificationType) Retrieve a Subscription for a Role Retrieves a subscription by `notificationType` for a specified RoleSubscriptionApi.getSubscriptionsNotificationTypeRole
(ListSubscriptionsRoleRoleRefParameter roleRef, NotificationType notificationType, Map<String, String> additionalHeaders) Retrieve a Subscription for a Role Retrieves a subscription by `notificationType` for a specified RoleSubscriptionApi.getSubscriptionsNotificationTypeUser
(NotificationType notificationType, String userId) Retrieve a Subscription for a User Retrieves a subscription by `notificationType` for a specified User.SubscriptionApi.getSubscriptionsNotificationTypeUser
(NotificationType notificationType, String userId, Map<String, String> additionalHeaders) Retrieve a Subscription for a User Retrieves a subscription by `notificationType` for a specified User.OrgSettingAdminApi.getThirdPartyAdminSetting()
Retrieve the Org Third-Party Admin Setting Retrieves the Third-Party Admin Setting.OrgSettingAdminApi.getThirdPartyAdminSetting
(Map<String, String> additionalHeaders) Retrieve the Org Third-Party Admin Setting Retrieves the Third-Party Admin Setting.TrustedOriginApi.getTrustedOrigin
(String trustedOriginId) Retrieve a Trusted Origin Retrieves a trusted originTrustedOriginApi.getTrustedOrigin
(String trustedOriginId, Map<String, String> additionalHeaders) Retrieve a Trusted Origin Retrieves a trusted originUiSchemaApi.getUISchema
(String id) Retrieve a UI Schema Retrieves a UI Schema by `id`UiSchemaApi.getUISchema
(String id, Map<String, String> additionalHeaders) Retrieve a UI Schema Retrieves a UI Schema by `id`Retrieve a User Retrieves a User from your Okta org.Retrieve a User Retrieves a User from your Okta org.RoleAssignmentAUserApi.getUserAssignedRole
(String userId, String roleAssignmentId) Retrieve a User Role Assignment Retrieves a Role assigned to a User (identified by `userId`).RoleAssignmentAUserApi.getUserAssignedRole
(String userId, String roleAssignmentId, Map<String, String> additionalHeaders) Retrieve a User Role Assignment Retrieves a Role assigned to a User (identified by `userId`).UserGrantApi.getUserGrant
(String userId, String grantId, String expand) Retrieve a User Grant Retrieves a Grant for the specified UserUserGrantApi.getUserGrant
(String userId, String grantId, String expand, Map<String, String> additionalHeaders) Retrieve a User Grant Retrieves a Grant for the specified UserAttackProtectionApi.getUserLockoutSettings()
Retrieve the User Lockout Settings Retrieves the User Lockout Settings for an orgAttackProtectionApi.getUserLockoutSettings
(Map<String, String> additionalHeaders) Retrieve the User Lockout Settings Retrieves the User Lockout Settings for an orgSchemaApi.getUserSchema
(String schemaId) Retrieve a User Schema Retrieves the Schema for a User TypeSchemaApi.getUserSchema
(String schemaId, Map<String, String> additionalHeaders) Retrieve a User Schema Retrieves the Schema for a User TypeUserTypeApi.getUserType
(String typeId) Retrieve a User Type Retrieves a User Type by ID.UserTypeApi.getUserType
(String typeId, Map<String, String> additionalHeaders) Retrieve a User Type Retrieves a User Type by ID.AuthenticatorApi.getWellKnownAppAuthenticatorConfiguration
(String oauthClientId) Retrieve the Well-Known App Authenticator Configuration Retrieves the well-known app authenticator configuration.AuthenticatorApi.getWellKnownAppAuthenticatorConfiguration
(String oauthClientId, Map<String, String> additionalHeaders) Retrieve the Well-Known App Authenticator Configuration Retrieves the well-known app authenticator configuration.OrgSettingMetadataApi.getWellknownOrgMetadata()
Retrieve the Well-Known Org Metadata Retrieves the well-known org metadata, which includes the org ID, configured custom domains, authentication pipeline, and various other org settingsOrgSettingMetadataApi.getWellknownOrgMetadata
(Map<String, String> additionalHeaders) Retrieve the Well-Known Org Metadata Retrieves the well-known org metadata, which includes the org ID, configured custom domains, authentication pipeline, and various other org settingsSsfTransmitterApi.getWellknownSsfMetadata()
Retrieve the SSF Transmitter metadata Retrieves SSF Transmitter configuration metadata.SsfTransmitterApi.getWellknownSsfMetadata
(Map<String, String> additionalHeaders) Retrieve the SSF Transmitter metadata Retrieves SSF Transmitter configuration metadata.UserFactorApi.getYubikeyOtpTokenById
(String tokenId) Retrieve a YubiKey OTP Token Retrieves the specified YubiKey OTP Token by `id`UserFactorApi.getYubikeyOtpTokenById
(String tokenId, Map<String, String> additionalHeaders) Retrieve a YubiKey OTP Token Retrieves the specified YubiKey OTP Token by `id`OrgSettingSupportApi.grantAerialConsent
(OrgAerialConsent orgAerialConsent) Grant Okta Aerial access to your Org Grants an Okta Aerial account access to your Org.OrgSettingSupportApi.grantAerialConsent
(OrgAerialConsent orgAerialConsent, Map<String, String> additionalHeaders) Grant Okta Aerial access to your Org Grants an Okta Aerial account access to your Org.ApplicationGrantsApi.grantConsentToScope
(String appId, OAuth2ScopeConsentGrant oAuth2ScopeConsentGrant) Grant consent to scope Grants consent for the app to request an OAuth 2.0 Okta scopeApplicationGrantsApi.grantConsentToScope
(String appId, OAuth2ScopeConsentGrant oAuth2ScopeConsentGrant, Map<String, String> additionalHeaders) Grant consent to scope Grants consent for the app to request an OAuth 2.0 Okta scopeOrgSettingSupportApi.grantOktaSupport()
Grant Okta Support Access Grants Okta Support temporary access your org as an administrator for eight hoursOrgSettingSupportApi.grantOktaSupport
(Map<String, String> additionalHeaders) Grant Okta Support Access Grants Okta Support temporary access your org as an administrator for eight hoursIdentityProviderUsersApi.linkUserToIdentityProvider
(String idpId, String userId, UserIdentityProviderLinkRequest userIdentityProviderLinkRequest) Link a User to IdP Links an Okta User to an existing SAML or social Identity Provider.IdentityProviderUsersApi.linkUserToIdentityProvider
(String idpId, String userId, UserIdentityProviderLinkRequest userIdentityProviderLinkRequest, Map<String, String> additionalHeaders) Link a User to IdP Links an Okta User to an existing SAML or social Identity Provider.AgentPoolsApi.listAgentPools
(Integer limitPerPoolType, AgentType poolType, String after) List all Agent Pools Lists all agent pools with pagination supportAgentPoolsApi.listAgentPools
(Integer limitPerPoolType, AgentType poolType, String after, Map<String, String> additionalHeaders) List all Agent Pools Lists all agent pools with pagination supportAgentPoolsApi.listAgentPoolsUpdates
(String poolId, Boolean scheduled) List all Agent Pool updates Lists all agent pool updatesAgentPoolsApi.listAgentPoolsUpdates
(String poolId, Boolean scheduled, Map<String, String> additionalHeaders) List all Agent Pool updates Lists all agent pool updatesCustomPagesApi.listAllSignInWidgetVersions
(String brandId) List all Sign-in Widget Versions Lists all sign-in widget versions supported by the current orgCustomPagesApi.listAllSignInWidgetVersions
(String brandId, Map<String, String> additionalHeaders) List all Sign-in Widget Versions Lists all sign-in widget versions supported by the current orgApiServiceIntegrationsApi.listApiServiceIntegrationInstances
(String after) List all API Service Integration instances Lists all API Service Integration instances with a pagination optionApiServiceIntegrationsApi.listApiServiceIntegrationInstances
(String after, Map<String, String> additionalHeaders) List all API Service Integration instances Lists all API Service Integration instances with a pagination optionApiServiceIntegrationsApi.listApiServiceIntegrationInstanceSecrets
(String apiServiceId) List all API Service Integration instance Secrets Lists all client secrets for an API Service Integration instance by `apiServiceId`ApiServiceIntegrationsApi.listApiServiceIntegrationInstanceSecrets
(String apiServiceId, Map<String, String> additionalHeaders) List all API Service Integration instance Secrets Lists all client secrets for an API Service Integration instance by `apiServiceId`ApiTokenApi.listApiTokens()
List all API Token Metadata Lists all the metadata of the active API tokensApiTokenApi.listApiTokens
(Map<String, String> additionalHeaders) List all API Token Metadata Lists all the metadata of the active API tokensApplicationGroupsApi.listApplicationGroupAssignments
(String appId, String q, String after, Integer limit, String expand) List all Application Groups Lists all app group assignmentsApplicationGroupsApi.listApplicationGroupAssignments
(String appId, String q, String after, Integer limit, String expand, Map<String, String> additionalHeaders) List all Application Groups Lists all app group assignmentsApplicationSsoCredentialKeyApi.listApplicationKeys
(String appId) List all Key Credentials Lists all key credentials for an appApplicationSsoCredentialKeyApi.listApplicationKeys
(String appId, Map<String, String> additionalHeaders) List all Key Credentials Lists all key credentials for an appApplicationApi.listApplications
(String q, String after, Boolean useOptimization, Integer limit, String filter, String expand, Boolean includeNonDeleted) List all Applications Lists all apps in the org with pagination.ApplicationApi.listApplications
(String q, String after, Boolean useOptimization, Integer limit, String filter, String expand, Boolean includeNonDeleted, Map<String, String> additionalHeaders) List all Applications Lists all apps in the org with pagination.RoleBTargetBGroupApi.listApplicationTargetsForApplicationAdministratorRoleForGroup
(String groupId, String roleAssignmentId, String after, Integer limit) List all Group Role Application Targets Lists all app targets for an `APP_ADMIN` Role Assignment to a Group.RoleBTargetBGroupApi.listApplicationTargetsForApplicationAdministratorRoleForGroup
(String groupId, String roleAssignmentId, String after, Integer limit, Map<String, String> additionalHeaders) List all Group Role Application Targets Lists all app targets for an `APP_ADMIN` Role Assignment to a Group.RoleBTargetAdminApi.listApplicationTargetsForApplicationAdministratorRoleForUser
(String userId, String roleAssignmentId, String after, Integer limit) List all Admin Role Application Targets Lists all app targets for an `APP_ADMIN` Role Assigned to a User.RoleBTargetAdminApi.listApplicationTargetsForApplicationAdministratorRoleForUser
(String userId, String roleAssignmentId, String after, Integer limit, Map<String, String> additionalHeaders) List all Admin Role Application Targets Lists all app targets for an `APP_ADMIN` Role Assigned to a User.ApplicationUsersApi.listApplicationUsers
(String appId, String after, Integer limit, String q, String expand) List all Application Users Lists all assigned users for an appApplicationUsersApi.listApplicationUsers
(String appId, String after, Integer limit, String q, String expand, Map<String, String> additionalHeaders) List all Application Users Lists all assigned users for an appUserResourcesApi.listAppLinks
(String userId) List all Assigned App Links Lists all App Links for all direct or indirect (via group membership) assigned appsUserResourcesApi.listAppLinks
(String userId, Map<String, String> additionalHeaders) List all Assigned App Links Lists all App Links for all direct or indirect (via group membership) assigned appsRoleBTargetClientApi.listAppTargetRoleToClient
(String clientId, String roleAssignmentId, String after, Integer limit) List all Client Role Application Targets Lists all OIN app targets for an `APP_ADMIN` Role that's assigned to a client Application (by `clientId`).RoleBTargetClientApi.listAppTargetRoleToClient
(String clientId, String roleAssignmentId, String after, Integer limit, Map<String, String> additionalHeaders) List all Client Role Application Targets Lists all OIN app targets for an `APP_ADMIN` Role that's assigned to a client Application (by `clientId`).GroupApi.listAssignedApplicationsForGroup
(String groupId, String after, Integer limit) List all Assigned Applications Lists all apps that are assigned to a Group.GroupApi.listAssignedApplicationsForGroup
(String groupId, String after, Integer limit, Map<String, String> additionalHeaders) List all Assigned Applications Lists all apps that are assigned to a Group.RoleAssignmentAUserApi.listAssignedRolesForUser
(String userId, String expand) List all User Role Assignments Lists all roles assigned to a User (identified by `userId`)RoleAssignmentAUserApi.listAssignedRolesForUser
(String userId, String expand, Map<String, String> additionalHeaders) List all User Role Assignments Lists all roles assigned to a User (identified by `userId`)AuthorizationServerAssocApi.listAssociatedServersByTrustedType
(String authServerId, Boolean trusted, String q, Integer limit, String after) List all associated Authorization Servers Lists all associated Authorization Servers by trusted type for the given `authServerId`AuthorizationServerAssocApi.listAssociatedServersByTrustedType
(String authServerId, Boolean trusted, String q, Integer limit, String after, Map<String, String> additionalHeaders) List all associated Authorization Servers Lists all associated Authorization Servers by trusted type for the given `authServerId`AuthenticatorApi.listAuthenticatorMethods
(String authenticatorId) List all Methods of an Authenticator Lists all Methods of an Authenticator identified by `authenticatorId` > **Note:** <x-lifecycle class=\"ea\"></x-lifecycle> > The AAGUID Group object supports the Early Access (Self-Service) Allow List for FIDO2 (WebAuthn) Authenticators feature.AuthenticatorApi.listAuthenticatorMethods
(String authenticatorId, Map<String, String> additionalHeaders) List all Methods of an Authenticator Lists all Methods of an Authenticator identified by `authenticatorId` > **Note:** <x-lifecycle class=\"ea\"></x-lifecycle> > The AAGUID Group object supports the Early Access (Self-Service) Allow List for FIDO2 (WebAuthn) Authenticators feature.AuthenticatorApi.listAuthenticators()
List all Authenticators Lists all authenticatorsAuthenticatorApi.listAuthenticators
(Map<String, String> additionalHeaders) List all Authenticators Lists all authenticatorsAuthorizationServerKeysApi.listAuthorizationServerKeys
(String authServerId) List all Credential Keys Lists all of the current, future, and expired Keys used by the Custom Authorization ServerAuthorizationServerKeysApi.listAuthorizationServerKeys
(String authServerId, Map<String, String> additionalHeaders) List all Credential Keys Lists all of the current, future, and expired Keys used by the Custom Authorization ServerAuthorizationServerPoliciesApi.listAuthorizationServerPolicies
(String authServerId) List all Policies Lists all policiesAuthorizationServerPoliciesApi.listAuthorizationServerPolicies
(String authServerId, Map<String, String> additionalHeaders) List all Policies Lists all policiesAuthorizationServerRulesApi.listAuthorizationServerPolicyRules
(String authServerId, String policyId) List all Policy Rules Lists all policy rules for the specified Custom Authorization Server and PolicyAuthorizationServerRulesApi.listAuthorizationServerPolicyRules
(String authServerId, String policyId, Map<String, String> additionalHeaders) List all Policy Rules Lists all policy rules for the specified Custom Authorization Server and PolicyAuthorizationServerApi.listAuthorizationServers
(String q, Integer limit, String after) List all Authorization Servers Lists all custom authorization servers in the orgAuthorizationServerApi.listAuthorizationServers
(String q, Integer limit, String after, Map<String, String> additionalHeaders) List all Authorization Servers Lists all custom authorization servers in the orgBehaviorApi.listBehaviorDetectionRules()
List all Behavior Detection Rules Lists all behavior detection rules with pagination supportBehaviorApi.listBehaviorDetectionRules
(Map<String, String> additionalHeaders) List all Behavior Detection Rules Lists all behavior detection rules with pagination supportRoleDResourceSetBindingApi.listBindings
(String resourceSetIdOrLabel, String after) List all Role Resource Set Bindings Lists all Bindings for a Resource Set with pagination supportRoleDResourceSetBindingApi.listBindings
(String resourceSetIdOrLabel, String after, Map<String, String> additionalHeaders) List all Role Resource Set Bindings Lists all Bindings for a Resource Set with pagination supportBrandsApi.listBrandDomains
(String brandId) List all Domains associated with a Brand Lists all domains associated with a brand by `brandId`BrandsApi.listBrandDomains
(String brandId, Map<String, String> additionalHeaders) List all Domains associated with a Brand Lists all domains associated with a brand by `brandId`List all Brands Lists all the brands in your orgBrandsApi.listBrands
(List<String> expand, String after, Integer limit, String q, Map<String, String> additionalHeaders) List all Brands Lists all the brands in your orgThemesApi.listBrandThemes
(String brandId) List all Themes Lists all the themes in your brand.ThemesApi.listBrandThemes
(String brandId, Map<String, String> additionalHeaders) List all Themes Lists all the themes in your brand.CaptchaApi.listCaptchaInstances()
List all CAPTCHA Instances Lists all CAPTCHA instances with pagination support.CaptchaApi.listCaptchaInstances
(Map<String, String> additionalHeaders) List all CAPTCHA Instances Lists all CAPTCHA instances with pagination support.ApplicationSsoCredentialKeyApi.listCsrsForApplication
(String appId) List all Certificate Signing Requests Lists all Certificate Signing Requests for an applicationApplicationSsoCredentialKeyApi.listCsrsForApplication
(String appId, Map<String, String> additionalHeaders) List all Certificate Signing Requests Lists all Certificate Signing Requests for an applicationIdentityProviderSigningKeysApi.listCsrsForIdentityProvider
(String idpId) List all Certificate Signing Requests Lists all Certificate Signing Requests for an IdPIdentityProviderSigningKeysApi.listCsrsForIdentityProvider
(String idpId, Map<String, String> additionalHeaders) List all Certificate Signing Requests Lists all Certificate Signing Requests for an IdPCustomDomainApi.listCustomDomains()
List all Custom Domains Lists all verified custom domains for the orgCustomDomainApi.listCustomDomains
(Map<String, String> additionalHeaders) List all Custom Domains Lists all verified custom domains for the orgDeviceAssuranceApi.listDeviceAssurancePolicies()
List all Device Assurance Policies Lists all device assurance policiesDeviceAssuranceApi.listDeviceAssurancePolicies
(Map<String, String> additionalHeaders) List all Device Assurance Policies Lists all device assurance policiesDeviceApi.listDevices
(String after, Integer limit, String search, String expand) List all Devices Lists all devices with pagination support.DeviceApi.listDevices
(String after, Integer limit, String search, String expand, Map<String, String> additionalHeaders) List all Devices Lists all devices with pagination support.DeviceApi.listDeviceUsers
(String deviceId) List all Users for a Device Lists all Users for a Device by `deviceId`DeviceApi.listDeviceUsers
(String deviceId, Map<String, String> additionalHeaders) List all Users for a Device Lists all Users for a Device by `deviceId`CustomTemplatesApi.listEmailCustomizations
(String brandId, String templateName, String after, Integer limit) List all Email Customizations Lists all customizations of an email template <x-lifecycle class=\"ea\"></x-lifecycle> If Custom languages for Okta Email Templates is enabled, all existing customizations are retrieved, including customizations for additional languages.CustomTemplatesApi.listEmailCustomizations
(String brandId, String templateName, String after, Integer limit, Map<String, String> additionalHeaders) List all Email Customizations Lists all customizations of an email template <x-lifecycle class=\"ea\"></x-lifecycle> If Custom languages for Okta Email Templates is enabled, all existing customizations are retrieved, including customizations for additional languages.EmailDomainApi.listEmailDomains
(List<String> expand) List all Email Domains Lists all the Email Domains in your orgList all Email Domains Lists all the Email Domains in your orgEmailServerApi.listEmailServers()
List all enrolled SMTP servers Lists all the enrolled custom SMTP server configurationsEmailServerApi.listEmailServers
(Map<String, String> additionalHeaders) List all enrolled SMTP servers Lists all the enrolled custom SMTP server configurationsCustomTemplatesApi.listEmailTemplates
(String brandId, String after, Integer limit, List<String> expand) List all Email Templates Lists all supported email templatesCustomTemplatesApi.listEmailTemplates
(String brandId, String after, Integer limit, List<String> expand, Map<String, String> additionalHeaders) List all Email Templates Lists all supported email templatesEventHookApi.listEventHooks()
List all Event Hooks Lists all event hooksEventHookApi.listEventHooks
(Map<String, String> additionalHeaders) List all Event Hooks Lists all event hooksUserFactorApi.listFactors
(String userId) List all enrolled Factors Lists all enrolled Factors for the specified userUserFactorApi.listFactors
(String userId, Map<String, String> additionalHeaders) List all enrolled Factors Lists all enrolled Factors for the specified userFeatureApi.listFeatureDependencies
(String featureId) List all dependencies Lists all feature dependencies for a specified feature.FeatureApi.listFeatureDependencies
(String featureId, Map<String, String> additionalHeaders) List all dependencies Lists all feature dependencies for a specified feature.FeatureApi.listFeatureDependents
(String featureId) List all dependents Lists all feature dependents for the specified feature.FeatureApi.listFeatureDependents
(String featureId, Map<String, String> additionalHeaders) List all dependents Lists all feature dependents for the specified feature.FeatureApi.listFeatures()
List all Features Lists all self-service features for your orgFeatureApi.listFeatures
(Map<String, String> additionalHeaders) List all Features Lists all self-service features for your orgApplicationFeaturesApi.listFeaturesForApplication
(String appId) List all Features Lists all features for an app > **Note:** This request returns an error if provisioning isn't enabled for the app.ApplicationFeaturesApi.listFeaturesForApplication
(String appId, Map<String, String> additionalHeaders) List all Features Lists all features for an app > **Note:** This request returns an error if provisioning isn't enabled for the app.UserGrantApi.listGrantsForUserAndClient
(String userId, String clientId, String expand, String after, Integer limit) List all Grants for a Client Lists all Grants for a specified User and clientUserGrantApi.listGrantsForUserAndClient
(String userId, String clientId, String expand, String after, Integer limit, Map<String, String> additionalHeaders) List all Grants for a Client Lists all Grants for a specified User and clientRoleAssignmentBGroupApi.listGroupAssignedRoles
(String groupId, String expand) List all Group Role Assignments Lists all assigned roles of a Group by `groupId`RoleAssignmentBGroupApi.listGroupAssignedRoles
(String groupId, String expand, Map<String, String> additionalHeaders) List all Group Role Assignments Lists all assigned roles of a Group by `groupId`GroupOwnerApi.listGroupOwners
(String groupId, String search, String after, Integer limit) List all Group Owners Lists all owners for a specific groupGroupOwnerApi.listGroupOwners
(String groupId, String search, String after, Integer limit, Map<String, String> additionalHeaders) List all Group Owners Lists all owners for a specific groupGroupRuleApi.listGroupRules
(Integer limit, String after, String search, String expand) List all Group rules Lists all Group rules for your orgGroupRuleApi.listGroupRules
(Integer limit, String after, String search, String expand, Map<String, String> additionalHeaders) List all Group rules Lists all Group rules for your orgGroupApi.listGroups
(String q, String filter, String after, Integer limit, String expand, String search, String sortBy, String sortOrder) List all Groups Lists all Groups with pagination support.GroupApi.listGroups
(String q, String filter, String after, Integer limit, String expand, String search, String sortBy, String sortOrder, Map<String, String> additionalHeaders) List all Groups Lists all Groups with pagination support.RoleBTargetClientApi.listGroupTargetRoleForClient
(String clientId, String roleAssignmentId, String after, Integer limit) List all Client Role Group Targets Lists all Group targets for a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to a client.RoleBTargetClientApi.listGroupTargetRoleForClient
(String clientId, String roleAssignmentId, String after, Integer limit, Map<String, String> additionalHeaders) List all Client Role Group Targets Lists all Group targets for a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to a client.RoleBTargetBGroupApi.listGroupTargetsForGroupRole
(String groupId, String roleAssignmentId, String after, Integer limit) List all Group Role Group Targets Lists all Group targets for a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to a Group.RoleBTargetBGroupApi.listGroupTargetsForGroupRole
(String groupId, String roleAssignmentId, String after, Integer limit, Map<String, String> additionalHeaders) List all Group Role Group Targets Lists all Group targets for a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to a Group.RoleBTargetAdminApi.listGroupTargetsForRole
(String userId, String roleAssignmentId, String after, Integer limit) List all Admin Role Group Targets Lists all Group targets for a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to an admin User.RoleBTargetAdminApi.listGroupTargetsForRole
(String userId, String roleAssignmentId, String after, Integer limit, Map<String, String> additionalHeaders) List all Admin Role Group Targets Lists all Group targets for a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to an admin User.GroupApi.listGroupUsers
(String groupId, String after, Integer limit) List all Member Users Lists all users that are a member of a Group.GroupApi.listGroupUsers
(String groupId, String after, Integer limit, Map<String, String> additionalHeaders) List all Member Users Lists all users that are a member of a Group.HookKeyApi.listHookKeys()
List all keys Lists all keysHookKeyApi.listHookKeys
(Map<String, String> additionalHeaders) List all keys Lists all keysIdentityProviderUsersApi.listIdentityProviderApplicationUsers
(String idpId, String q, String after, Integer limit, String expand) List all Users for IdP Lists all the Users linked to an Identity ProviderIdentityProviderUsersApi.listIdentityProviderApplicationUsers
(String idpId, String q, String after, Integer limit, String expand, Map<String, String> additionalHeaders) List all Users for IdP Lists all the Users linked to an Identity ProviderIdentityProviderKeysApi.listIdentityProviderKeys
(String after, Integer limit) List all IdP Key Credentials Lists all IdP Key CredentialsIdentityProviderKeysApi.listIdentityProviderKeys
(String after, Integer limit, Map<String, String> additionalHeaders) List all IdP Key Credentials Lists all IdP Key CredentialsIdentityProviderApi.listIdentityProviders
(String q, String after, Integer limit, IdentityProviderType type) List all Identity Providers Lists all identity provider integrations with pagination.IdentityProviderApi.listIdentityProviders
(String q, String after, Integer limit, IdentityProviderType type, Map<String, String> additionalHeaders) List all Identity Providers Lists all identity provider integrations with pagination.IdentityProviderSigningKeysApi.listIdentityProviderSigningKeys
(String idpId) List all signing Key Credentials for IdP Lists all signing Key Credentials for an IdPIdentityProviderSigningKeysApi.listIdentityProviderSigningKeys
(String idpId, Map<String, String> additionalHeaders) List all signing Key Credentials for IdP Lists all signing Key Credentials for an IdPIdentitySourceApi.listIdentitySourceSessions
(String identitySourceId) List all Identity Source Sessions Lists all Identity Source Sessions for the given Identity Source instanceIdentitySourceApi.listIdentitySourceSessions
(String identitySourceId, Map<String, String> additionalHeaders) List all Identity Source Sessions Lists all Identity Source Sessions for the given Identity Source instanceInlineHookApi.listInlineHooks
(String type) List all Inline Hooks Lists all inline hooksInlineHookApi.listInlineHooks
(String type, Map<String, String> additionalHeaders) List all Inline Hooks Lists all inline hooksList all the OAuth 2.0 Client JSON Web Keys Lists all JSON Web Keys for an OAuth 2.0 client appApplicationSsoCredentialOAuth2ClientAuthApi.listJwk
(String appId, Map<String, String> additionalHeaders) List all the OAuth 2.0 Client JSON Web Keys Lists all JSON Web Keys for an OAuth 2.0 client appLinkedObjectApi.listLinkedObjectDefinitions()
List all Linked Object Definitions Lists all Linked Object definitionsLinkedObjectApi.listLinkedObjectDefinitions
(Map<String, String> additionalHeaders) List all Linked Object Definitions Lists all Linked Object definitionsUserLinkedObjectApi.listLinkedObjectsForUser
(String userIdOrLogin, String relationshipName) List the primary or all of the associated Linked Object values Lists either the `self` link for the primary User or all associated Users in the relationship specified by `relationshipName`.UserLinkedObjectApi.listLinkedObjectsForUser
(String userIdOrLogin, String relationshipName, Map<String, String> additionalHeaders) List the primary or all of the associated Linked Object values Lists either the `self` link for the primary User or all associated Users in the relationship specified by `relationshipName`.SystemLogApi.listLogEvents
(String since, String until, String after, String filter, String q, Integer limit, String sortOrder) List all System Log Events Lists all System Log EventsSystemLogApi.listLogEvents
(String since, String until, String after, String filter, String q, Integer limit, String sortOrder, Map<String, String> additionalHeaders) List all System Log Events Lists all System Log EventsLogStreamApi.listLogStreams
(String after, Integer limit, String filter) List all Log Streams Lists all Log Stream objects in your org.LogStreamApi.listLogStreams
(String after, Integer limit, String filter, Map<String, String> additionalHeaders) List all Log Streams Lists all Log Stream objects in your org.SchemaApi.listLogStreamSchemas()
List the Log Stream Schemas Lists the Schema for all Log Stream types visible for this orgSchemaApi.listLogStreamSchemas
(Map<String, String> additionalHeaders) List the Log Stream Schemas Lists the Schema for all Log Stream types visible for this orgRoleDResourceSetBindingMemberApi.listMembersOfBinding
(String resourceSetIdOrLabel, String roleIdOrLabel, String after) List all Role Resource Set Binding Members Lists all members of a Role Resource Set Binding with pagination supportRoleDResourceSetBindingMemberApi.listMembersOfBinding
(String resourceSetIdOrLabel, String roleIdOrLabel, String after, Map<String, String> additionalHeaders) List all Role Resource Set Binding Members Lists all members of a Role Resource Set Binding with pagination supportNetworkZoneApi.listNetworkZones
(String after, Integer limit, String filter) List all Network Zones Lists all Network Zones with pagination.NetworkZoneApi.listNetworkZones
(String after, Integer limit, String filter, Map<String, String> additionalHeaders) List all Network Zones Lists all Network Zones with pagination.AuthorizationServerClaimsApi.listOAuth2Claims
(String authServerId) List all custom token Claims Lists all custom token Claims defined for a specified custom authorization serverAuthorizationServerClaimsApi.listOAuth2Claims
(String authServerId, Map<String, String> additionalHeaders) List all custom token Claims Lists all custom token Claims defined for a specified custom authorization serverApplicationSsoCredentialOAuth2ClientAuthApi.listOAuth2ClientSecrets
(String appId) List all OAuth 2.0 Client Secrets Lists all client secrets for an OAuth 2.0 client appApplicationSsoCredentialOAuth2ClientAuthApi.listOAuth2ClientSecrets
(String appId, Map<String, String> additionalHeaders) List all OAuth 2.0 Client Secrets Lists all client secrets for an OAuth 2.0 client appAuthorizationServerClientsApi.listOAuth2ClientsForAuthorizationServer
(String authServerId) List all Client resources for an authorization server Lists all Client resources for which the specified authorization server has tokensAuthorizationServerClientsApi.listOAuth2ClientsForAuthorizationServer
(String authServerId, Map<String, String> additionalHeaders) List all Client resources for an authorization server Lists all Client resources for which the specified authorization server has tokensAuthorizationServerScopesApi.listOAuth2Scopes
(String authServerId, String q, String filter, String after, Integer limit) List all Custom Token Scopes Lists all custom token scopesAuthorizationServerScopesApi.listOAuth2Scopes
(String authServerId, String q, String filter, String after, Integer limit, Map<String, String> additionalHeaders) List all Custom Token Scopes Lists all custom token scopesApplicationTokensApi.listOAuth2TokensForApplication
(String appId, String expand, String after, Integer limit) List all Application Refresh Tokens Lists all refresh tokens for an app > **Note:** The results are [paginated](/#pagination) according to the `limit` parameter.ApplicationTokensApi.listOAuth2TokensForApplication
(String appId, String expand, String after, Integer limit, Map<String, String> additionalHeaders) List all Application Refresh Tokens Lists all refresh tokens for an app > **Note:** The results are [paginated](/#pagination) according to the `limit` parameter.OrgSettingContactApi.listOrgContactTypes()
List all Org Contact Types Lists all Org Contact Types for your Okta orgOrgSettingContactApi.listOrgContactTypes
(Map<String, String> additionalHeaders) List all Org Contact Types Lists all Org Contact Types for your Okta orgPolicyApi.listPolicies
(String type, String status, String q, String expand, String sortBy, String limit, String resourceId, String after) List all Policies Lists all policies with the specified typePolicyApi.listPolicies
(String type, String status, String q, String expand, String sortBy, String limit, String resourceId, String after, Map<String, String> additionalHeaders) List all Policies Lists all policies with the specified typePolicyApi.listPolicyApps
(String policyId) Deprecated.PolicyApi.listPolicyApps
(String policyId, Map<String, String> additionalHeaders) Deprecated.PolicyApi.listPolicyMappings
(String policyId) List all resources mapped to a Policy Lists all resources mapped to a Policy identified by `policyId`PolicyApi.listPolicyMappings
(String policyId, Map<String, String> additionalHeaders) List all resources mapped to a Policy Lists all resources mapped to a Policy identified by `policyId`PolicyApi.listPolicyRules
(String policyId, String limit) List all Policy Rules Lists all policy rulesList all Policy Rules Lists all policy rulesPrincipalRateLimitApi.listPrincipalRateLimitEntities
(String filter, String after, Integer limit) List all Principal Rate Limits Lists all Principal Rate Limit entities considering the provided parametersPrincipalRateLimitApi.listPrincipalRateLimitEntities
(String filter, String after, Integer limit, Map<String, String> additionalHeaders) List all Principal Rate Limits Lists all Principal Rate Limit entities considering the provided parametersProfileMappingApi.listProfileMappings
(String after, Integer limit, String sourceId, String targetId) List all Profile Mappings Lists all profile mappings in your organization with [pagination](https://developer.okta.com/docs/api/#pagination).ProfileMappingApi.listProfileMappings
(String after, Integer limit, String sourceId, String targetId, Map<String, String> additionalHeaders) List all Profile Mappings Lists all profile mappings in your organization with [pagination](https://developer.okta.com/docs/api/#pagination).PushProviderApi.listPushProviders
(ProviderType type) List all Push Providers Lists all push providersPushProviderApi.listPushProviders
(ProviderType type, Map<String, String> additionalHeaders) List all Push Providers Lists all push providersRealmAssignmentApi.listRealmAssignmentOperations
(Integer limit, String after) List all Realm Assignment operations Lists all Realm Assignment operations.RealmAssignmentApi.listRealmAssignmentOperations
(Integer limit, String after, Map<String, String> additionalHeaders) List all Realm Assignment operations Lists all Realm Assignment operations.RealmAssignmentApi.listRealmAssignments
(Integer limit, String after) List all Realm Assignments Lists all Realm AssignmentsRealmAssignmentApi.listRealmAssignments
(Integer limit, String after, Map<String, String> additionalHeaders) List all Realm Assignments Lists all Realm AssignmentsList all Realms Lists all RealmsRealmApi.listRealms
(Integer limit, String after, String search, String sortBy, String sortOrder, Map<String, String> additionalHeaders) List all Realms Lists all RealmsAuthorizationServerClientsApi.listRefreshTokensForAuthorizationServerAndClient
(String authServerId, String clientId, String expand, String after, Integer limit) List all refresh tokens for a Client Lists all refresh tokens issued by an authorization server for a specific ClientAuthorizationServerClientsApi.listRefreshTokensForAuthorizationServerAndClient
(String authServerId, String clientId, String expand, String after, Integer limit, Map<String, String> additionalHeaders) List all refresh tokens for a Client Lists all refresh tokens issued by an authorization server for a specific ClientUserOAuthApi.listRefreshTokensForUserAndClient
(String userId, String clientId, String expand, String after, Integer limit) List all Refresh Tokens for a Client Lists all refresh Tokens issued for the specified User and clientUserOAuthApi.listRefreshTokensForUserAndClient
(String userId, String clientId, String expand, String after, Integer limit, Map<String, String> additionalHeaders) List all Refresh Tokens for a Client Lists all refresh Tokens issued for the specified User and clientRoleCResourceSetResourceApi.listResourceSetResources
(String resourceSetIdOrLabel) List all Resource Set Resources Lists all Resources for the Resource SetRoleCResourceSetResourceApi.listResourceSetResources
(String resourceSetIdOrLabel, Map<String, String> additionalHeaders) List all Resource Set Resources Lists all Resources for the Resource SetRoleCResourceSetApi.listResourceSets
(String after) List all Resource Sets Lists all Resource Sets with pagination supportRoleCResourceSetApi.listResourceSets
(String after, Map<String, String> additionalHeaders) List all Resource Sets Lists all Resource Sets with pagination supportRiskProviderApi.listRiskProviders()
List all Risk Providers Lists all Risk Provider objectsRiskProviderApi.listRiskProviders
(Map<String, String> additionalHeaders) List all Risk Providers Lists all Risk Provider objectsRoleECustomPermissionApi.listRolePermissions
(String roleIdOrLabel) List all Custom Role Permissions Lists all permissions for a Custom Role by `roleIdOrLabel`RoleECustomPermissionApi.listRolePermissions
(String roleIdOrLabel, Map<String, String> additionalHeaders) List all Custom Role Permissions Lists all permissions for a Custom Role by `roleIdOrLabel`List all Custom Roles Lists all Custom Roles with pagination supportList all Custom Roles Lists all Custom Roles with pagination supportRoleAssignmentClientApi.listRolesForClient
(String clientId) List all Client Role Assignments Lists all roles assigned to a Client Application identified by `clientId`RoleAssignmentClientApi.listRolesForClient
(String clientId, Map<String, String> additionalHeaders) List all Client Role Assignments Lists all roles assigned to a Client Application identified by `clientId`ApplicationGrantsApi.listScopeConsentGrants
(String appId, String expand) List all app Grants Lists all scope consent Grants for the appApplicationGrantsApi.listScopeConsentGrants
(String appId, String expand, Map<String, String> additionalHeaders) List all app Grants Lists all scope consent Grants for the appSsfReceiverApi.listSecurityEventsProviderInstances()
List all Security Events Providers Lists all Security Events Provider instancesSsfReceiverApi.listSecurityEventsProviderInstances
(Map<String, String> additionalHeaders) List all Security Events Providers Lists all Security Events Provider instancesTemplateApi.listSmsTemplates
(SmsTemplateType templateType) List all SMS Templates Lists all custom SMS templates.TemplateApi.listSmsTemplates
(SmsTemplateType templateType, Map<String, String> additionalHeaders) List all SMS Templates Lists all custom SMS templates.IdentityProviderUsersApi.listSocialAuthTokens
(String idpId, String userId) List all Tokens from OIDC IdP Lists the tokens minted by the Social Authentication Provider when the user authenticates with Okta via Social Auth.IdentityProviderUsersApi.listSocialAuthTokens
(String idpId, String userId, Map<String, String> additionalHeaders) List all Tokens from OIDC IdP Lists the tokens minted by the Social Authentication Provider when the user authenticates with Okta via Social Auth.SubscriptionApi.listSubscriptionsRole
(ListSubscriptionsRoleRoleRefParameter roleRef) List all Subscriptions for a Role Lists all subscriptions available to a specified RoleSubscriptionApi.listSubscriptionsRole
(ListSubscriptionsRoleRoleRefParameter roleRef, Map<String, String> additionalHeaders) List all Subscriptions for a Role Lists all subscriptions available to a specified RoleSubscriptionApi.listSubscriptionsUser
(String userId) List all Subscriptions for a User Lists all subscriptions available to a specified User.SubscriptionApi.listSubscriptionsUser
(String userId, Map<String, String> additionalHeaders) List all Subscriptions for a User Lists all subscriptions available to a specified User.UserFactorApi.listSupportedFactors
(String userId) List all supported Factors Lists all the supported Factors that can be enrolled for the specified userUserFactorApi.listSupportedFactors
(String userId, Map<String, String> additionalHeaders) List all supported Factors Lists all the supported Factors that can be enrolled for the specified userUserFactorApi.listSupportedSecurityQuestions
(String userId) List all supported Security Questions Lists all available Security Questions for the specified userUserFactorApi.listSupportedSecurityQuestions
(String userId, Map<String, String> additionalHeaders) List all supported Security Questions Lists all available Security Questions for the specified userTrustedOriginApi.listTrustedOrigins
(String q, String filter, String after, Integer limit) List all Trusted Origins Lists all trusted originsTrustedOriginApi.listTrustedOrigins
(String q, String filter, String after, Integer limit, Map<String, String> additionalHeaders) List all Trusted Origins Lists all trusted originsUiSchemaApi.listUISchemas()
List all UI Schemas Lists all UI Schemas in your orgUiSchemaApi.listUISchemas
(Map<String, String> additionalHeaders) List all UI Schemas Lists all UI Schemas in your orgUserApi.listUserBlocks
(String userId) List all User Blocks Lists information about how the User is blocked from accessing their accountUserApi.listUserBlocks
(String userId, Map<String, String> additionalHeaders) List all User Blocks Lists information about how the User is blocked from accessing their accountUserResourcesApi.listUserClients
(String userId) List all Clients Lists all Client resources for which the specified User has grants or tokensUserResourcesApi.listUserClients
(String userId, Map<String, String> additionalHeaders) List all Clients Lists all Client resources for which the specified User has grants or tokensUserGrantApi.listUserGrants
(String userId, String scopeId, String expand, String after, Integer limit) List all User Grants Lists all Grants for the specified userUserGrantApi.listUserGrants
(String userId, String scopeId, String expand, String after, Integer limit, Map<String, String> additionalHeaders) List all User Grants Lists all Grants for the specified userUserResourcesApi.listUserGroups
(String userId) List all Groups Lists all Groups of which the User is a memberUserResourcesApi.listUserGroups
(String userId, Map<String, String> additionalHeaders) List all Groups Lists all Groups of which the User is a memberIdentityProviderUsersApi.listUserIdentityProviders
(String userId) List all Identity Providers for User Lists the IdPs associated with the UserIdentityProviderUsersApi.listUserIdentityProviders
(String userId, Map<String, String> additionalHeaders) List all Identity Providers for User Lists the IdPs associated with the UserUserApi.listUsers
(String contentType, String q, String after, Integer limit, String filter, String search, String sortBy, String sortOrder) List all Users Lists Users in your org, with pagination in most cases.UserApi.listUsers
(String contentType, String q, String after, Integer limit, String filter, String search, String sortBy, String sortOrder, Map<String, String> additionalHeaders) List all Users Lists Users in your org, with pagination in most cases.RoleAssignmentAUserApi.listUsersWithRoleAssignments
(String after, Integer limit) List all Users with Role Assignments Lists all users with Role AssignmentsRoleAssignmentAUserApi.listUsersWithRoleAssignments
(String after, Integer limit, Map<String, String> additionalHeaders) List all Users with Role Assignments Lists all users with Role AssignmentsUserTypeApi.listUserTypes()
List all User Types Lists all User Types in your orgUserTypeApi.listUserTypes
(Map<String, String> additionalHeaders) List all User Types Lists all User Types in your orgWebAuthnPreregistrationApi.listWebAuthnPreregistrationFactors
(String userId) List all WebAuthn Preregistration Factors Lists all WebAuthn Preregistration Factors for the specified userWebAuthnPreregistrationApi.listWebAuthnPreregistrationFactors
(String userId, Map<String, String> additionalHeaders) List all WebAuthn Preregistration Factors Lists all WebAuthn Preregistration Factors for the specified userUserFactorApi.listYubikeyOtpTokens
(String after, String expand, String filter, Boolean forDownload, Integer limit, String sortBy, String sortOrder) List all YubiKey OTP Tokens Lists all YubiKey OTP TokensUserFactorApi.listYubikeyOtpTokens
(String after, String expand, String filter, Boolean forDownload, Integer limit, String sortBy, String sortOrder, Map<String, String> additionalHeaders) List all YubiKey OTP Tokens Lists all YubiKey OTP TokensPolicyApi.mapResourceToPolicy
(String policyId, PolicyMappingRequest policyMappingRequest) Map a resource to a Policy Maps a resource to a Policy identified by `policyId`PolicyApi.mapResourceToPolicy
(String policyId, PolicyMappingRequest policyMappingRequest, Map<String, String> additionalHeaders) Map a resource to a Policy Maps a resource to a Policy identified by `policyId`OrgSettingCommunicationApi.optInUsersToOktaCommunicationEmails()
Opt in to Okta User Communication Emails Opts in all users of this org to Okta communication emailsOrgSettingCommunicationApi.optInUsersToOktaCommunicationEmails
(Map<String, String> additionalHeaders) Opt in to Okta User Communication Emails Opts in all users of this org to Okta communication emailsOrgSettingCommunicationApi.optOutUsersFromOktaCommunicationEmails()
Opt out of Okta User Communication Emails Opts out all users of this org from Okta communication emailsOrgSettingCommunicationApi.optOutUsersFromOktaCommunicationEmails
(Map<String, String> additionalHeaders) Opt out of Okta User Communication Emails Opts out all users of this org from Okta communication emailsAgentPoolsApi.pauseAgentPoolsUpdate
(String poolId, String updateId) Pause an Agent Pool update Pauses running or queued Agent pool updateAgentPoolsApi.pauseAgentPoolsUpdate
(String poolId, String updateId, Map<String, String> additionalHeaders) Pause an Agent Pool update Pauses running or queued Agent pool updateApplicationSsoApi.previewSAMLmetadataForApplication
(String appId, Integer kid) Preview the application SAML metadata Previews the SSO SAML metadata for an applicationApplicationSsoApi.previewSAMLmetadataForApplication
(String appId, Integer kid, Map<String, String> additionalHeaders) Preview the application SAML metadata Previews the SSO SAML metadata for an applicationIdentityProviderSigningKeysApi.publishCsrForIdentityProvider
(String idpId, String idpCsrId, File body) Publish a Certificate Signing Request Publishes the CSR with a signed X.509 certificate and adds it into the signing Key Credentials for the IdP > **Notes:** > * Publishing a certificate completes the lifecycle of the CSR, and it's no longer accessible.IdentityProviderSigningKeysApi.publishCsrForIdentityProvider
(String idpId, String idpCsrId, File body, Map<String, String> additionalHeaders) Publish a Certificate Signing Request Publishes the CSR with a signed X.509 certificate and adds it into the signing Key Credentials for the IdP > **Notes:** > * Publishing a certificate completes the lifecycle of the CSR, and it's no longer accessible.ApplicationSsoCredentialKeyApi.publishCsrFromApplication
(String appId, String csrId, File body) Publish a Certificate Signing Request Publishes a Certificate Signing Request (CSR) for the app with a signed X.509 certificate and adds it into the Application Key Credentials.ApplicationSsoCredentialKeyApi.publishCsrFromApplication
(String appId, String csrId, File body, Map<String, String> additionalHeaders) Publish a Certificate Signing Request Publishes a Certificate Signing Request (CSR) for the app with a signed X.509 certificate and adds it into the Application Key Credentials.void
SsfSecurityEventTokenApi.publishSecurityEventTokens
(String securityEventToken) Publish a Security Event Token Publishes a Security Event Token (SET) sent by a Security Events Provider.void
SsfSecurityEventTokenApi.publishSecurityEventTokens
(String securityEventToken, Map<String, String> additionalHeaders) Publish a Security Event Token Publishes a Security Event Token (SET) sent by a Security Events Provider.UserLifecycleApi.reactivateUser
(String id, Boolean sendEmail) Reactivate a User Reactivates a user.Reactivate a User Reactivates a user.SessionApi.refreshCurrentSession
(String cookie) Refresh the current Session Refreshes the Session for the current user > **Note:** This operation requires a session cookie for the user.SessionApi.refreshCurrentSession
(String cookie, Map<String, String> additionalHeaders) Refresh the current Session Refreshes the Session for the current user > **Note:** This operation requires a session cookie for the user.SessionApi.refreshSession
(String sessionId) Refresh a Session Refreshes an existing Session using the `id` for that Session.SessionApi.refreshSession
(String sessionId, Map<String, String> additionalHeaders) Refresh a Session Refreshes an existing Session using the `id` for that Session.void
RoleBTargetClientApi.removeAppTargetInstanceRoleForClient
(String clientId, String roleAssignmentId, String appName, String appId) Unassign a Client Role Application Instance Target Unassigns an OIN app instance target from a Role Assignment to a client Application > **Note:** You can't remove the last app instance target from a Role Assignment since this causes an exception.void
RoleBTargetClientApi.removeAppTargetInstanceRoleForClient
(String clientId, String roleAssignmentId, String appName, String appId, Map<String, String> additionalHeaders) Unassign a Client Role Application Instance Target Unassigns an OIN app instance target from a Role Assignment to a client Application > **Note:** You can't remove the last app instance target from a Role Assignment since this causes an exception.void
RoleBTargetClientApi.removeAppTargetRoleFromClient
(String clientId, String roleAssignmentId, String appName) Unassign a Client Role Application Target Unassigns an OIN app target for a Role Assignment to a client Application > **Note:** You can't remove the last OIN app target from a Role Assignment since operation causes an exception.void
RoleBTargetClientApi.removeAppTargetRoleFromClient
(String clientId, String roleAssignmentId, String appName, Map<String, String> additionalHeaders) Unassign a Client Role Application Target Unassigns an OIN app target for a Role Assignment to a client Application > **Note:** You can't remove the last OIN app target from a Role Assignment since operation causes an exception.void
RoleBTargetClientApi.removeGroupTargetRoleFromClient
(String clientId, String roleAssignmentId, String groupId) Unassign a Client Role Group Target Unassigns a Group target from a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to a client Application.void
RoleBTargetClientApi.removeGroupTargetRoleFromClient
(String clientId, String roleAssignmentId, String groupId, Map<String, String> additionalHeaders) Unassign a Client Role Group Target Unassigns a Group target from a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to a client Application.ApplicationApi.replaceApplication
(String appId, Application application) Replace an Application 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`, and `lastUpdated`.ApplicationApi.replaceApplication
(String appId, Application application, Map<String, String> additionalHeaders) Replace an Application 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`, and `lastUpdated`.AuthenticatorApi.replaceAuthenticator
(String authenticatorId, AuthenticatorBase authenticator) Replace an Authenticator Replaces the properties for an Authenticator identified by `authenticatorId`AuthenticatorApi.replaceAuthenticator
(String authenticatorId, AuthenticatorBase authenticator, Map<String, String> additionalHeaders) Replace an Authenticator Replaces the properties for an Authenticator identified by `authenticatorId`AuthenticatorApi.replaceAuthenticatorMethod
(String authenticatorId, AuthenticatorMethodType methodType, AuthenticatorMethodBase authenticatorMethodBase) Replace an Authenticator Method Replaces a Method of `methodType` for an Authenticator identified by `authenticatorId` > **Note:** <x-lifecycle class=\"ea\"></x-lifecycle> > The AAGUID Group object supports the Early Access (Self-Service) Allow List for FIDO2 (WebAuthn) Authenticators feature.AuthenticatorApi.replaceAuthenticatorMethod
(String authenticatorId, AuthenticatorMethodType methodType, AuthenticatorMethodBase authenticatorMethodBase, Map<String, String> additionalHeaders) Replace an Authenticator Method Replaces a Method of `methodType` for an Authenticator identified by `authenticatorId` > **Note:** <x-lifecycle class=\"ea\"></x-lifecycle> > The AAGUID Group object supports the Early Access (Self-Service) Allow List for FIDO2 (WebAuthn) Authenticators feature.AttackProtectionApi.replaceAuthenticatorSettings
(AttackProtectionAuthenticatorSettings authenticatorSettings) Replace the Authenticator Settings Replaces the Authenticator Settings for an orgAttackProtectionApi.replaceAuthenticatorSettings
(AttackProtectionAuthenticatorSettings authenticatorSettings, Map<String, String> additionalHeaders) Replace the Authenticator Settings Replaces the Authenticator Settings for an orgAuthorizationServerApi.replaceAuthorizationServer
(String authServerId, AuthorizationServer authorizationServer) Replace an Authorization Server Replaces an authorization serverAuthorizationServerApi.replaceAuthorizationServer
(String authServerId, AuthorizationServer authorizationServer, Map<String, String> additionalHeaders) Replace an Authorization Server Replaces an authorization serverAuthorizationServerPoliciesApi.replaceAuthorizationServerPolicy
(String authServerId, String policyId, AuthorizationServerPolicy policy) Replace a Policy Replaces a policyAuthorizationServerPoliciesApi.replaceAuthorizationServerPolicy
(String authServerId, String policyId, AuthorizationServerPolicy policy, Map<String, String> additionalHeaders) Replace a Policy Replaces a policyAuthorizationServerRulesApi.replaceAuthorizationServerPolicyRule
(String authServerId, String policyId, String ruleId, AuthorizationServerPolicyRuleRequest policyRule) Replace a Policy Rule Replaces the configuration of the Policy Rule defined in the specified Custom Authorization Server and PolicyAuthorizationServerRulesApi.replaceAuthorizationServerPolicyRule
(String authServerId, String policyId, String ruleId, AuthorizationServerPolicyRuleRequest policyRule, Map<String, String> additionalHeaders) Replace a Policy Rule Replaces the configuration of the Policy Rule defined in the specified Custom Authorization Server and PolicyBehaviorApi.replaceBehaviorDetectionRule
(String behaviorId, BehaviorRule rule) Replace a Behavior Detection Rule Replaces a Behavior Detection Rule by `behaviorId`BehaviorApi.replaceBehaviorDetectionRule
(String behaviorId, BehaviorRule rule, Map<String, String> additionalHeaders) Replace a Behavior Detection Rule Replaces a Behavior Detection Rule by `behaviorId`BrandsApi.replaceBrand
(String brandId, BrandRequest brand) Replace a Brand Replaces a brand by `brandId` Passing an invalid `brandId` returns a `404 Not Found` status code with the error code `E0000007`.BrandsApi.replaceBrand
(String brandId, BrandRequest brand, Map<String, String> additionalHeaders) Replace a Brand Replaces a brand by `brandId` Passing an invalid `brandId` returns a `404 Not Found` status code with the error code `E0000007`.ThemesApi.replaceBrandTheme
(String brandId, String themeId, UpdateThemeRequest theme) Replace a Theme Replaces a theme for a brandThemesApi.replaceBrandTheme
(String brandId, String themeId, UpdateThemeRequest theme, Map<String, String> additionalHeaders) Replace a Theme Replaces a theme for a brandCaptchaApi.replaceCaptchaInstance
(String captchaId, CAPTCHAInstance instance) Replace a CAPTCHA Instance Replaces the properties for a specified CAPTCHA instanceCaptchaApi.replaceCaptchaInstance
(String captchaId, CAPTCHAInstance instance, Map<String, String> additionalHeaders) Replace a CAPTCHA Instance Replaces the properties for a specified CAPTCHA instanceCustomDomainApi.replaceCustomDomain
(String domainId, UpdateDomain updateDomain) Replace a Custom Domain's Brand Replaces a custom domain's brandCustomDomainApi.replaceCustomDomain
(String domainId, UpdateDomain updateDomain, Map<String, String> additionalHeaders) Replace a Custom Domain's Brand Replaces a custom domain's brandCustomPagesApi.replaceCustomizedErrorPage
(String brandId, ErrorPage errorPage) Replace the Customized Error Page Replaces the customized error page.CustomPagesApi.replaceCustomizedErrorPage
(String brandId, ErrorPage errorPage, Map<String, String> additionalHeaders) Replace the Customized Error Page Replaces the customized error page.CustomPagesApi.replaceCustomizedSignInPage
(String brandId, SignInPage signInPage) Replace the Customized Sign-in Page Replaces the customized sign-in page.CustomPagesApi.replaceCustomizedSignInPage
(String brandId, SignInPage signInPage, Map<String, String> additionalHeaders) Replace the Customized Sign-in Page Replaces the customized sign-in page.DeviceAccessApi.replaceDesktopMFARecoveryPinOrgSetting
(DesktopMFARecoveryPinOrgSetting desktopMFARecoveryPinOrgSetting) Replace the Desktop MFA Recovery PIN Org Setting Replaces the Desktop MFA Recovery PIN feature for your orgDeviceAccessApi.replaceDesktopMFARecoveryPinOrgSetting
(DesktopMFARecoveryPinOrgSetting desktopMFARecoveryPinOrgSetting, Map<String, String> additionalHeaders) Replace the Desktop MFA Recovery PIN Org Setting Replaces the Desktop MFA Recovery PIN feature for your orgDeviceAssuranceApi.replaceDeviceAssurancePolicy
(String deviceAssuranceId, DeviceAssurance deviceAssurance) Replace a Device Assurance Policy Replaces a Device Assurance Policy by `deviceAssuranceId`DeviceAssuranceApi.replaceDeviceAssurancePolicy
(String deviceAssuranceId, DeviceAssurance deviceAssurance, Map<String, String> additionalHeaders) Replace a Device Assurance Policy Replaces a Device Assurance Policy by `deviceAssuranceId`CustomTemplatesApi.replaceEmailCustomization
(String brandId, String templateName, String customizationId, EmailCustomization instance) Replace an Email Customization Replaces an email customization using property values <x-lifecycle class=\"ea\"></x-lifecycle> If Custom languages for Okta Email Templates is disabled, requests to update a customization for an additional language return a `404 Not Found` error response.CustomTemplatesApi.replaceEmailCustomization
(String brandId, String templateName, String customizationId, EmailCustomization instance, Map<String, String> additionalHeaders) Replace an Email Customization Replaces an email customization using property values <x-lifecycle class=\"ea\"></x-lifecycle> If Custom languages for Okta Email Templates is disabled, requests to update a customization for an additional language return a `404 Not Found` error response.EmailDomainApi.replaceEmailDomain
(String emailDomainId, UpdateEmailDomain updateEmailDomain, List<String> expand) Replace an Email Domain Replaces associated username and sender display name by `emailDomainId`EmailDomainApi.replaceEmailDomain
(String emailDomainId, UpdateEmailDomain updateEmailDomain, List<String> expand, Map<String, String> additionalHeaders) Replace an Email Domain Replaces associated username and sender display name by `emailDomainId`CustomTemplatesApi.replaceEmailSettings
(String brandId, String templateName, EmailSettings emailSettings) Replace the Email Template Settings Replaces an email template's settingsCustomTemplatesApi.replaceEmailSettings
(String brandId, String templateName, EmailSettings emailSettings, Map<String, String> additionalHeaders) Replace the Email Template Settings Replaces an email template's settingsEventHookApi.replaceEventHook
(String eventHookId, EventHook eventHook) Replace an Event Hook Replaces an event hook.EventHookApi.replaceEventHook
(String eventHookId, EventHook eventHook, Map<String, String> additionalHeaders) Replace an Event Hook Replaces an event hook.OktaApplicationSettingsApi.replaceFirstPartyAppSettings
(String appName, AdminConsoleSettings adminConsoleSettings) Replace the Okta Application Settings Replaces the settings for an Okta app (also known as an Okta first-party app)OktaApplicationSettingsApi.replaceFirstPartyAppSettings
(String appName, AdminConsoleSettings adminConsoleSettings, Map<String, String> additionalHeaders) Replace the Okta Application Settings Replaces the settings for an Okta app (also known as an Okta first-party app)GroupApi.replaceGroup
(String groupId, AddGroupRequest group) Replace a Group Replaces the profile for a Group of `OKTA_GROUP` type from your org > **Note :** You only can modify profiles for groups of the `OKTA_GROUP` type.GroupApi.replaceGroup
(String groupId, AddGroupRequest group, Map<String, String> additionalHeaders) Replace a Group Replaces the profile for a Group of `OKTA_GROUP` type from your org > **Note :** You only can modify profiles for groups of the `OKTA_GROUP` type.GroupRuleApi.replaceGroupRule
(String groupRuleId, GroupRule groupRule) Replace a Group rule Replaces a Group rule > **Notes:** You only can update rules with a Group whose status is set to `'INACTIVE'`.GroupRuleApi.replaceGroupRule
(String groupRuleId, GroupRule groupRule, Map<String, String> additionalHeaders) Replace a Group rule Replaces a Group rule > **Notes:** You only can update rules with a Group whose status is set to `'INACTIVE'`.HookKeyApi.replaceHookKey
(String id, KeyRequest keyRequest) Replace a key Replaces a key by `id` This request replaces existing properties after passing validation.HookKeyApi.replaceHookKey
(String id, KeyRequest keyRequest, Map<String, String> additionalHeaders) Replace a key Replaces a key by `id` This request replaces existing properties after passing validation.IdentityProviderApi.replaceIdentityProvider
(String idpId, IdentityProvider identityProvider) Replace an Identity Provider Replaces an identity provider integration by `idpId`IdentityProviderApi.replaceIdentityProvider
(String idpId, IdentityProvider identityProvider, Map<String, String> additionalHeaders) Replace an Identity Provider Replaces an identity provider integration by `idpId`IdentityProviderKeysApi.replaceIdentityProviderKey
(String kid, IdPKeyCredential idPKeyCredential) Replace an IdP Key Credential Replaces an IdP Key Credential by `kid`IdentityProviderKeysApi.replaceIdentityProviderKey
(String kid, IdPKeyCredential idPKeyCredential, Map<String, String> additionalHeaders) Replace an IdP Key Credential Replaces an IdP Key Credential by `kid`InlineHookApi.replaceInlineHook
(String inlineHookId, InlineHook inlineHook) Replace an Inline Hook Replaces an inline hook by `inlineHookId`InlineHookApi.replaceInlineHook
(String inlineHookId, InlineHook inlineHook, Map<String, String> additionalHeaders) Replace an Inline Hook Replaces an inline hook by `inlineHookId`LogStreamApi.replaceLogStream
(String logStreamId, LogStreamPutSchema instance) Replace a Log Stream Replaces the Log Stream object properties for a given ID.LogStreamApi.replaceLogStream
(String logStreamId, LogStreamPutSchema instance, Map<String, String> additionalHeaders) Replace a Log Stream Replaces the Log Stream object properties for a given ID.NetworkZoneApi.replaceNetworkZone
(String zoneId, NetworkZone zone) Replace a Network Zone Replaces a Network Zone by `zoneId`.NetworkZoneApi.replaceNetworkZone
(String zoneId, NetworkZone zone, Map<String, String> additionalHeaders) Replace a Network Zone Replaces a Network Zone by `zoneId`.AuthorizationServerClaimsApi.replaceOAuth2Claim
(String authServerId, String claimId, OAuth2Claim oAuth2Claim) Replace a custom token Claim Replaces a custom token Claim specified by the `claimId`AuthorizationServerClaimsApi.replaceOAuth2Claim
(String authServerId, String claimId, OAuth2Claim oAuth2Claim, Map<String, String> additionalHeaders) Replace a custom token Claim Replaces a custom token Claim specified by the `claimId`AuthorizationServerScopesApi.replaceOAuth2Scope
(String authServerId, String scopeId, OAuth2Scope oAuth2Scope) Replace a Custom Token Scope Replaces a custom token scopeAuthorizationServerScopesApi.replaceOAuth2Scope
(String authServerId, String scopeId, OAuth2Scope oAuth2Scope, Map<String, String> additionalHeaders) Replace a Custom Token Scope Replaces a custom token scopeOrgSettingContactApi.replaceOrgContactUser
(String contactType, OrgContactUser orgContactUser) Replace the Contact Type User Replaces the User associated with the specified Contact TypeOrgSettingContactApi.replaceOrgContactUser
(String contactType, OrgContactUser orgContactUser, Map<String, String> additionalHeaders) Replace the Contact Type User Replaces the User associated with the specified Contact TypeOrgSettingGeneralApi.replaceOrgSettings
(OrgSetting orgSetting) Replace the Org General Settings Replaces the Org General Settings for your Okta orgOrgSettingGeneralApi.replaceOrgSettings
(OrgSetting orgSetting, Map<String, String> additionalHeaders) Replace the Org General Settings Replaces the Org General Settings for your Okta orgPolicyApi.replacePolicy
(String policyId, Policy policy) Replace a Policy Replaces the properties of a Policy identified by `policyId`Replace a Policy Replaces the properties of a Policy identified by `policyId`PolicyApi.replacePolicyRule
(String policyId, String ruleId, PolicyRule policyRule) Replace a Policy Rule Replaces the properties for a Policy Rule identified by `policyId` and `ruleId`PolicyApi.replacePolicyRule
(String policyId, String ruleId, PolicyRule policyRule, Map<String, String> additionalHeaders) Replace a Policy Rule Replaces the properties for a Policy Rule identified by `policyId` and `ruleId`CustomPagesApi.replacePreviewErrorPage
(String brandId, ErrorPage errorPage) Replace the Preview Error Page Replaces the preview error page.CustomPagesApi.replacePreviewErrorPage
(String brandId, ErrorPage errorPage, Map<String, String> additionalHeaders) Replace the Preview Error Page Replaces the preview error page.CustomPagesApi.replacePreviewSignInPage
(String brandId, SignInPage signInPage) Replace the Preview Sign-in Page Replaces the preview sign-in page.CustomPagesApi.replacePreviewSignInPage
(String brandId, SignInPage signInPage, Map<String, String> additionalHeaders) Replace the Preview Sign-in Page Replaces the preview sign-in page.PrincipalRateLimitApi.replacePrincipalRateLimitEntity
(String principalRateLimitId, PrincipalRateLimitEntity entity) Replace a Principal Rate Limit Replaces a principal rate limit entity by `principalRateLimitId`PrincipalRateLimitApi.replacePrincipalRateLimitEntity
(String principalRateLimitId, PrincipalRateLimitEntity entity, Map<String, String> additionalHeaders) Replace a Principal Rate Limit Replaces a principal rate limit entity by `principalRateLimitId`PushProviderApi.replacePushProvider
(String pushProviderId, PushProvider pushProvider) Replace a Push Provider Replaces a push provider by `pushProviderId`PushProviderApi.replacePushProvider
(String pushProviderId, PushProvider pushProvider, Map<String, String> additionalHeaders) Replace a Push Provider Replaces a push provider by `pushProviderId`RateLimitSettingsApi.replaceRateLimitSettingsAdminNotifications
(RateLimitAdminNotifications rateLimitAdminNotifications) Replace the Rate Limit Admin Notification Settings Replaces the Rate Limit Admin Notification Settings and returns the configured propertiesRateLimitSettingsApi.replaceRateLimitSettingsAdminNotifications
(RateLimitAdminNotifications rateLimitAdminNotifications, Map<String, String> additionalHeaders) Replace the Rate Limit Admin Notification Settings Replaces the Rate Limit Admin Notification Settings and returns the configured propertiesRateLimitSettingsApi.replaceRateLimitSettingsPerClient
(PerClientRateLimitSettings perClientRateLimitSettings) Replace the Per-Client Rate Limit Settings Replaces the Per-Client Rate Limit Settings and returns the configured propertiesRateLimitSettingsApi.replaceRateLimitSettingsPerClient
(PerClientRateLimitSettings perClientRateLimitSettings, Map<String, String> additionalHeaders) Replace the Per-Client Rate Limit Settings Replaces the Per-Client Rate Limit Settings and returns the configured propertiesRateLimitSettingsApi.replaceRateLimitSettingsWarningThreshold
(RateLimitWarningThresholdRequest rateLimitWarningThreshold) Replace the Rate Limit Warning Threshold Percentage Replaces the Rate Limit Warning Threshold Percentage and returns the configured propertyRateLimitSettingsApi.replaceRateLimitSettingsWarningThreshold
(RateLimitWarningThresholdRequest rateLimitWarningThreshold, Map<String, String> additionalHeaders) Replace the Rate Limit Warning Threshold Percentage Replaces the Rate Limit Warning Threshold Percentage and returns the configured propertyRealmApi.replaceRealm
(String realmId, UpdateRealmRequest body) Replace the realm profile Replaces the realm profileRealmApi.replaceRealm
(String realmId, UpdateRealmRequest body, Map<String, String> additionalHeaders) Replace the realm profile Replaces the realm profileRealmAssignmentApi.replaceRealmAssignment
(String assignmentId, UpdateRealmAssignmentRequest body) Replace a Realm Assignment Replaces a Realm AssignmentRealmAssignmentApi.replaceRealmAssignment
(String assignmentId, UpdateRealmAssignmentRequest body, Map<String, String> additionalHeaders) Replace a Realm Assignment Replaces a Realm AssignmentRoleCResourceSetApi.replaceResourceSet
(String resourceSetIdOrLabel, ResourceSet instance) Replace a Resource Set Replaces the label and description of a Resource SetRoleCResourceSetApi.replaceResourceSet
(String resourceSetIdOrLabel, ResourceSet instance, Map<String, String> additionalHeaders) Replace a Resource Set Replaces the label and description of a Resource SetRiskProviderApi.replaceRiskProvider
(String riskProviderId, RiskProvider instance) Replace a Risk Provider Replaces the properties for a given Risk Provider object IDRiskProviderApi.replaceRiskProvider
(String riskProviderId, RiskProvider instance, Map<String, String> additionalHeaders) Replace a Risk Provider Replaces the properties for a given Risk Provider object IDRoleECustomApi.replaceRole
(String roleIdOrLabel, UpdateIamRoleRequest instance) Replace a Custom Role Replaces the label and description for a Custom Role by `roleIdOrLabel`RoleECustomApi.replaceRole
(String roleIdOrLabel, UpdateIamRoleRequest instance, Map<String, String> additionalHeaders) Replace a Custom Role Replaces the label and description for a Custom Role by `roleIdOrLabel`RoleECustomPermissionApi.replaceRolePermission
(String roleIdOrLabel, String permissionType, CreateUpdateIamRolePermissionRequest instance) Replace a Custom Role Permission Replaces a permission (specified by `permissionType`) for a Custom RoleRoleECustomPermissionApi.replaceRolePermission
(String roleIdOrLabel, String permissionType, CreateUpdateIamRolePermissionRequest instance, Map<String, String> additionalHeaders) Replace a Custom Role Permission Replaces a permission (specified by `permissionType`) for a Custom RoleSsfReceiverApi.replaceSecurityEventsProviderInstance
(String securityEventProviderId, SecurityEventsProviderRequest instance) Replace a Security Events Provider Replaces a Security Events Provider instance specified by `id`SsfReceiverApi.replaceSecurityEventsProviderInstance
(String securityEventProviderId, SecurityEventsProviderRequest instance, Map<String, String> additionalHeaders) Replace a Security Events Provider Replaces a Security Events Provider instance specified by `id`CustomPagesApi.replaceSignOutPageSettings
(String brandId, HostedPage hostedPage) Replace the Sign-out Page Settings Replaces the sign-out page settingsCustomPagesApi.replaceSignOutPageSettings
(String brandId, HostedPage hostedPage, Map<String, String> additionalHeaders) Replace the Sign-out Page Settings Replaces the sign-out page settingsTemplateApi.replaceSmsTemplate
(String templateId, SmsTemplate smsTemplate) Replace an SMS Template Replaces the SMS Template > **Notes:** You can't update the default SMS Template.TemplateApi.replaceSmsTemplate
(String templateId, SmsTemplate smsTemplate, Map<String, String> additionalHeaders) Replace an SMS Template Replaces the SMS Template > **Notes:** You can't update the default SMS Template.CaptchaApi.replacesOrgCaptchaSettings
(OrgCAPTCHASettings orgCAPTCHASettings) Replace the Org-wide CAPTCHA Settings Replaces the CAPTCHA settings object for your organization > **Note**: You can disable CAPTCHA for your organization by setting `captchaId` and `enabledPages` to `null`.CaptchaApi.replacesOrgCaptchaSettings
(OrgCAPTCHASettings orgCAPTCHASettings, Map<String, String> additionalHeaders) Replace the Org-wide CAPTCHA Settings Replaces the CAPTCHA settings object for your organization > **Note**: You can disable CAPTCHA for your organization by setting `captchaId` and `enabledPages` to `null`.SsfTransmitterApi.replaceSsfStream
(StreamConfiguration instance) Replace an SSF Stream Replaces all properties for an existing SSF Stream configuration.SsfTransmitterApi.replaceSsfStream
(StreamConfiguration instance, Map<String, String> additionalHeaders) Replace an SSF Stream Replaces all properties for an existing SSF Stream configuration.TrustedOriginApi.replaceTrustedOrigin
(String trustedOriginId, TrustedOrigin trustedOrigin) Replace a Trusted Origin Replaces a trusted originTrustedOriginApi.replaceTrustedOrigin
(String trustedOriginId, TrustedOrigin trustedOrigin, Map<String, String> additionalHeaders) Replace a Trusted Origin Replaces a trusted originUiSchemaApi.replaceUISchemas
(String id, UpdateUISchema updateUISchemaBody) Replace a UI Schema Replaces a UI Schema by `id`UiSchemaApi.replaceUISchemas
(String id, UpdateUISchema updateUISchemaBody, Map<String, String> additionalHeaders) Replace a UI Schema Replaces a UI Schema by `id`UserApi.replaceUser
(String id, UpdateUserRequest user, Boolean strict) Replace a User Replaces a User's profile, credentials, or both using strict-update semantics.UserApi.replaceUser
(String id, UpdateUserRequest user, Boolean strict, Map<String, String> additionalHeaders) Replace a User Replaces a User's profile, credentials, or both using strict-update semantics.AttackProtectionApi.replaceUserLockoutSettings
(UserLockoutSettings lockoutSettings) Replace the User Lockout Settings Replaces the User Lockout Settings for an orgAttackProtectionApi.replaceUserLockoutSettings
(UserLockoutSettings lockoutSettings, Map<String, String> additionalHeaders) Replace the User Lockout Settings Replaces the User Lockout Settings for an orgUserTypeApi.replaceUserType
(String typeId, UserTypePutRequest userType) Replace a User Type Replaces an existing User Type.UserTypeApi.replaceUserType
(String typeId, UserTypePutRequest userType, Map<String, String> additionalHeaders) Replace a User Type Replaces an existing User Type.UserFactorApi.resendEnrollFactor
(String userId, String factorId, ResendUserFactor resendUserFactor, String templateId) Resend a Factor enrollment Resends an `sms`, `call`, or `email` factor challenge as part of an enrollment flow For `call` and `sms` factors, Okta enforces a rate limit of one OTP challenge per device every 30 seconds.UserFactorApi.resendEnrollFactor
(String userId, String factorId, ResendUserFactor resendUserFactor, String templateId, Map<String, String> additionalHeaders) Resend a Factor enrollment Resends an `sms`, `call`, or `email` factor challenge as part of an enrollment flow For `call` and `sms` factors, Okta enforces a rate limit of one OTP challenge per device every 30 seconds.void
UserLifecycleApi.resetFactors
(String userId) Reset Factors Resets all factors for the specified User.void
UserLifecycleApi.resetFactors
(String userId, Map<String, String> additionalHeaders) Reset Factors Resets all factors for the specified User.UserCredApi.resetPassword
(String userId, Boolean sendEmail, Boolean revokeSessions) Reset password Resets password.UserCredApi.resetPassword
(String userId, Boolean sendEmail, Boolean revokeSessions, Map<String, String> additionalHeaders) Reset password Resets password.AgentPoolsApi.resumeAgentPoolsUpdate
(String poolId, String updateId) Resume an Agent Pool update Resumes running or queued Agent pool updateAgentPoolsApi.resumeAgentPoolsUpdate
(String poolId, String updateId, Map<String, String> additionalHeaders) Resume an Agent Pool update Resumes running or queued Agent pool updateRoleAssignmentClientApi.retrieveClientRole
(String clientId, String roleAssignmentId) Retrieve a Client Role Retrieves a Role Assignment (identified by `roleAssignmentId`) for a Client Application (identified by `clientId`)RoleAssignmentClientApi.retrieveClientRole
(String clientId, String roleAssignmentId, Map<String, String> additionalHeaders) Retrieve a Client Role Retrieves a Role Assignment (identified by `roleAssignmentId`) for a Client Application (identified by `clientId`)AgentPoolsApi.retryAgentPoolsUpdate
(String poolId, String updateId) Retry an Agent Pool update Retries Agent pool updateAgentPoolsApi.retryAgentPoolsUpdate
(String poolId, String updateId, Map<String, String> additionalHeaders) Retry an Agent Pool update Retries Agent pool updateOrgSettingSupportApi.revokeAerialConsent
(OrgAerialConsent orgAerialConsent) Revoke Okta Aerial access to your Org Revokes access of an Okta Aerial account to your Org.OrgSettingSupportApi.revokeAerialConsent
(OrgAerialConsent orgAerialConsent, Map<String, String> additionalHeaders) Revoke Okta Aerial access to your Org Revokes access of an Okta Aerial account to your Org.void
ApiTokenApi.revokeApiToken
(String apiTokenId) Revoke an API Token Revokes an API token by `apiTokenId`void
ApiTokenApi.revokeApiToken
(String apiTokenId, Map<String, String> additionalHeaders) Revoke an API Token Revokes an API token by `apiTokenId`void
IdentityProviderSigningKeysApi.revokeCsrForIdentityProvider
(String idpId, String idpCsrId) Revoke a Certificate Signing Request Revokes a CSR and deletes the key pair from the IdPvoid
IdentityProviderSigningKeysApi.revokeCsrForIdentityProvider
(String idpId, String idpCsrId, Map<String, String> additionalHeaders) Revoke a Certificate Signing Request Revokes a CSR and deletes the key pair from the IdPvoid
ApplicationSsoCredentialKeyApi.revokeCsrFromApplication
(String appId, String csrId) Revoke a Certificate Signing Request Revokes a Certificate Signing Request and deletes the key pair from the appvoid
ApplicationSsoCredentialKeyApi.revokeCsrFromApplication
(String appId, String csrId, Map<String, String> additionalHeaders) Revoke a Certificate Signing Request Revokes a Certificate Signing Request and deletes the key pair from the appvoid
ApiTokenApi.revokeCurrentApiToken()
Revoke the Current API Token Revokes the API token provided in the Authorization headervoid
ApiTokenApi.revokeCurrentApiToken
(Map<String, String> additionalHeaders) Revoke the Current API Token Revokes the API token provided in the Authorization headervoid
UserGrantApi.revokeGrantsForUserAndClient
(String userId, String clientId) Revoke all Grants for a Client Revokes all Grants for the specified User and clientvoid
UserGrantApi.revokeGrantsForUserAndClient
(String userId, String clientId, Map<String, String> additionalHeaders) Revoke all Grants for a Client Revokes all Grants for the specified User and clientvoid
ApplicationTokensApi.revokeOAuth2TokenForApplication
(String appId, String tokenId) Revoke an Application Token Revokes the specified token for the specified appvoid
ApplicationTokensApi.revokeOAuth2TokenForApplication
(String appId, String tokenId, Map<String, String> additionalHeaders) Revoke an Application Token Revokes the specified token for the specified appvoid
ApplicationTokensApi.revokeOAuth2TokensForApplication
(String appId) Revoke all Application Tokens Revokes all OAuth 2.0 refresh tokens for the specified app.void
ApplicationTokensApi.revokeOAuth2TokensForApplication
(String appId, Map<String, String> additionalHeaders) Revoke all Application Tokens Revokes all OAuth 2.0 refresh tokens for the specified app.OrgSettingSupportApi.revokeOktaSupport()
Revoke Okta Support Access Revokes Okta Support access to your orgOrgSettingSupportApi.revokeOktaSupport
(Map<String, String> additionalHeaders) Revoke Okta Support Access Revokes Okta Support access to your orgvoid
AuthorizationServerClientsApi.revokeRefreshTokenForAuthorizationServerAndClient
(String authServerId, String clientId, String tokenId) Revoke a refresh token for a Client Revokes a refresh token for a Clientvoid
AuthorizationServerClientsApi.revokeRefreshTokenForAuthorizationServerAndClient
(String authServerId, String clientId, String tokenId, Map<String, String> additionalHeaders) Revoke a refresh token for a Client Revokes a refresh token for a Clientvoid
AuthorizationServerClientsApi.revokeRefreshTokensForAuthorizationServerAndClient
(String authServerId, String clientId) Revoke all refresh tokens for a Client Revokes all refresh tokens for a Clientvoid
AuthorizationServerClientsApi.revokeRefreshTokensForAuthorizationServerAndClient
(String authServerId, String clientId, Map<String, String> additionalHeaders) Revoke all refresh tokens for a Client Revokes all refresh tokens for a Clientvoid
ApplicationGrantsApi.revokeScopeConsentGrant
(String appId, String grantId) Revoke an app Grant Revokes permission for the app to grant the given scopevoid
ApplicationGrantsApi.revokeScopeConsentGrant
(String appId, String grantId, Map<String, String> additionalHeaders) Revoke an app Grant Revokes permission for the app to grant the given scopevoid
SessionApi.revokeSession
(String sessionId) Revoke a Session Revokes the specified Sessionvoid
SessionApi.revokeSession
(String sessionId, Map<String, String> additionalHeaders) Revoke a Session Revokes the specified Sessionvoid
UserOAuthApi.revokeTokenForUserAndClient
(String userId, String clientId, String tokenId) Revoke a Token for a Client Revokes the specified refresh Tokenvoid
UserOAuthApi.revokeTokenForUserAndClient
(String userId, String clientId, String tokenId, Map<String, String> additionalHeaders) Revoke a Token for a Client Revokes the specified refresh Tokenvoid
UserOAuthApi.revokeTokensForUserAndClient
(String userId, String clientId) Revoke all Refresh Tokens for a Client Revokes all refresh Tokens issued for the specified User and clientvoid
UserOAuthApi.revokeTokensForUserAndClient
(String userId, String clientId, Map<String, String> additionalHeaders) Revoke all Refresh Tokens for a Client Revokes all refresh Tokens issued for the specified User and clientvoid
UserGrantApi.revokeUserGrant
(String userId, String grantId) Revoke a User Grant Revokes one Grant for a specified Uservoid
Revoke a User Grant Revokes one Grant for a specified Uservoid
UserGrantApi.revokeUserGrants
(String userId) Revoke all User Grants Revokes all Grants for a specified Uservoid
UserGrantApi.revokeUserGrants
(String userId, Map<String, String> additionalHeaders) Revoke all User Grants Revokes all Grants for a specified Uservoid
UserSessionsApi.revokeUserSessions
(String userId, Boolean oauthTokens) Revoke all User sessions Revokes all active Identity Provider sessions of the User.void
UserSessionsApi.revokeUserSessions
(String userId, Boolean oauthTokens, Map<String, String> additionalHeaders) Revoke all User sessions Revokes all active Identity Provider sessions of the User.AuthorizationServerKeysApi.rotateAuthorizationServerKeys
(String authServerId, JwkUse use) Rotate all Credential Keys Rotates the current Keys for a Custom Authorization Server.AuthorizationServerKeysApi.rotateAuthorizationServerKeys
(String authServerId, JwkUse use, Map<String, String> additionalHeaders) Rotate all Credential Keys Rotates the current Keys for a Custom Authorization Server.void
WebAuthnPreregistrationApi.sendPin
(PinRequest body) Send a PIN to user Sends the decoded PIN for the specified WebAuthn Preregistration Enrollment.void
WebAuthnPreregistrationApi.sendPin
(PinRequest body, Map<String, String> additionalHeaders) Send a PIN to user Sends the decoded PIN for the specified WebAuthn Preregistration Enrollment.void
RiskEventApi.sendRiskEvents
(List<RiskEvent> instance) Send multiple Risk Events Sends multiple IP risk events to Okta.void
Send multiple Risk Events Sends multiple IP risk events to Okta.void
CustomTemplatesApi.sendTestEmail
(String brandId, String templateName, String language) Send a Test Email Sends a test email to the current user’s primary and secondary email addresses.void
CustomTemplatesApi.sendTestEmail
(String brandId, String templateName, String language, Map<String, String> additionalHeaders) Send a Test Email Sends a test email to the current user’s primary and secondary email addresses.OrgSettingCustomizationApi.setOrgHideOktaUIFooter()
Set the Hide Dashboard Footer Preference Sets the preference to hide the Okta UI footer for all end users of your orgOrgSettingCustomizationApi.setOrgHideOktaUIFooter
(Map<String, String> additionalHeaders) Set the Hide Dashboard Footer Preference Sets the preference to hide the Okta UI footer for all end users of your orgOrgSettingCustomizationApi.setOrgShowOktaUIFooter()
Set the Show Dashboard Footer Preference Sets the preference to show the Okta UI footer for all end users of your orgOrgSettingCustomizationApi.setOrgShowOktaUIFooter
(Map<String, String> additionalHeaders) Set the Show Dashboard Footer Preference Sets the preference to show the Okta UI footer for all end users of your orgIdentitySourceApi.startImportFromIdentitySource
(String identitySourceId, String sessionId) Start the import from the Identity Source Starts the import from the Identity Source described by the uploaded bulk operationsIdentitySourceApi.startImportFromIdentitySource
(String identitySourceId, String sessionId, Map<String, String> additionalHeaders) Start the import from the Identity Source Starts the import from the Identity Source described by the uploaded bulk operationsAgentPoolsApi.stopAgentPoolsUpdate
(String poolId, String updateId) Stop an Agent Pool update Stops Agent pool updateAgentPoolsApi.stopAgentPoolsUpdate
(String poolId, String updateId, Map<String, String> additionalHeaders) Stop an Agent Pool update Stops Agent pool updatevoid
SubscriptionApi.subscribeByNotificationTypeRole
(ListSubscriptionsRoleRoleRefParameter roleRef, NotificationType notificationType) Subscribe a Role to a Specific Notification Type Subscribes a Role to a specified notification type.void
SubscriptionApi.subscribeByNotificationTypeRole
(ListSubscriptionsRoleRoleRefParameter roleRef, NotificationType notificationType, Map<String, String> additionalHeaders) Subscribe a Role to a Specific Notification Type Subscribes a Role to a specified notification type.void
SubscriptionApi.subscribeByNotificationTypeUser
(NotificationType notificationType, String userId) Subscribe a User to a Specific Notification Type Subscribes the current User to a specified notification type.void
SubscriptionApi.subscribeByNotificationTypeUser
(NotificationType notificationType, String userId, Map<String, String> additionalHeaders) Subscribe a User to a Specific Notification Type Subscribes the current User to a specified notification type.void
DeviceApi.suspendDevice
(String deviceId) Suspend a Device Suspends a Device by setting its status to SUSPENDED.void
DeviceApi.suspendDevice
(String deviceId, Map<String, String> additionalHeaders) Suspend a Device Suspends a Device by setting its status to SUSPENDED.void
UserLifecycleApi.suspendUser
(String userId) Suspend a User Suspends a user.void
UserLifecycleApi.suspendUser
(String userId, Map<String, String> additionalHeaders) Suspend a User Suspends a user.void
EmailServerApi.testEmailServer
(String emailServerId, EmailTestAddresses emailTestAddresses) Test an SMTP Server configuration Tests the specified custom SMTP Server configurationvoid
EmailServerApi.testEmailServer
(String emailServerId, EmailTestAddresses emailTestAddresses, Map<String, String> additionalHeaders) Test an SMTP Server configuration Tests the specified custom SMTP Server configurationvoid
RoleBTargetAdminApi.unassignAppInstanceTargetFromAdminRoleForUser
(String userId, String roleAssignmentId, String appName, String appId) Unassign an Admin Role Application Instance Target Unassigns an app instance target from an `APP_ADMIN` Role Assignment to an admin User.void
RoleBTargetAdminApi.unassignAppInstanceTargetFromAdminRoleForUser
(String userId, String roleAssignmentId, String appName, String appId, Map<String, String> additionalHeaders) Unassign an Admin Role Application Instance Target Unassigns an app instance target from an `APP_ADMIN` Role Assignment to an admin User.void
RoleBTargetBGroupApi.unassignAppInstanceTargetToAppAdminRoleForGroup
(String groupId, String roleAssignmentId, String appName, String appId) Unassign an Group Role Application Instance Target Unassigns an app instance target from an `APP_ADMIN` Role Assignment to a Group > **Note:** You can't remove the last app instance target from a Role Assignment since this causes an exception.void
RoleBTargetBGroupApi.unassignAppInstanceTargetToAppAdminRoleForGroup
(String groupId, String roleAssignmentId, String appName, String appId, Map<String, String> additionalHeaders) Unassign an Group Role Application Instance Target Unassigns an app instance target from an `APP_ADMIN` Role Assignment to a Group > **Note:** You can't remove the last app instance target from a Role Assignment since this causes an exception.void
ApplicationGroupsApi.unassignApplicationFromGroup
(String appId, String groupId) Unassign an Application Group Unassigns a Group from an appvoid
ApplicationGroupsApi.unassignApplicationFromGroup
(String appId, String groupId, Map<String, String> additionalHeaders) Unassign an Application Group Unassigns a Group from an appvoid
RoleBTargetAdminApi.unassignAppTargetFromAppAdminRoleForUser
(String userId, String roleAssignmentId, String appName) Unassign an Admin Role Application Target Unassigns an OIN app target from an `APP_ADMIN` Role Assignment to an admin User.void
RoleBTargetAdminApi.unassignAppTargetFromAppAdminRoleForUser
(String userId, String roleAssignmentId, String appName, Map<String, String> additionalHeaders) Unassign an Admin Role Application Target Unassigns an OIN app target from an `APP_ADMIN` Role Assignment to an admin User.void
RoleBTargetBGroupApi.unassignAppTargetToAdminRoleForGroup
(String groupId, String roleAssignmentId, String appName) Unassign a Group Role Application Target Unassigns an OIN app target from an `APP_ADMIN` Role Assignment to a Group > **Note:** You can't remove the last app target from a Role Assignment, since this causes an exception.void
RoleBTargetBGroupApi.unassignAppTargetToAdminRoleForGroup
(String groupId, String roleAssignmentId, String appName, Map<String, String> additionalHeaders) Unassign a Group Role Application Target Unassigns an OIN app target from an `APP_ADMIN` Role Assignment to a Group > **Note:** You can't remove the last app target from a Role Assignment, since this causes an exception.void
RoleBTargetBGroupApi.unassignGroupTargetFromGroupAdminRole
(String groupId, String roleAssignmentId, String targetGroupId) Unassign a Group Role Group Target Unassigns a Group target from a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to a Group.void
RoleBTargetBGroupApi.unassignGroupTargetFromGroupAdminRole
(String groupId, String roleAssignmentId, String targetGroupId, Map<String, String> additionalHeaders) Unassign a Group Role Group Target Unassigns a Group target from a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to a Group.void
RoleBTargetAdminApi.unassignGroupTargetFromUserAdminRole
(String userId, String roleAssignmentId, String groupId) Unassign an Admin Role Group Target Unassigns a Group target from a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to an admin User.void
RoleBTargetAdminApi.unassignGroupTargetFromUserAdminRole
(String userId, String roleAssignmentId, String groupId, Map<String, String> additionalHeaders) Unassign an Admin Role Group Target Unassigns a Group target from a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to an admin User.void
RoleDResourceSetBindingMemberApi.unassignMemberFromBinding
(String resourceSetIdOrLabel, String roleIdOrLabel, String memberId) Unassign a Role Resource Set Bindiing Member Unassigns a Member (identified by `memberId`) from a Role Resource Set Bindingvoid
RoleDResourceSetBindingMemberApi.unassignMemberFromBinding
(String resourceSetIdOrLabel, String roleIdOrLabel, String memberId, Map<String, String> additionalHeaders) Unassign a Role Resource Set Bindiing Member Unassigns a Member (identified by `memberId`) from a Role Resource Set Bindingvoid
RoleAssignmentBGroupApi.unassignRoleFromGroup
(String groupId, String roleAssignmentId) Unassign a Group Role Unassigns a Role Assignment (identified by `roleAssignmentId`) from a Group (identified by the `groupId`)void
RoleAssignmentBGroupApi.unassignRoleFromGroup
(String groupId, String roleAssignmentId, Map<String, String> additionalHeaders) Unassign a Group Role Unassigns a Role Assignment (identified by `roleAssignmentId`) from a Group (identified by the `groupId`)void
RoleAssignmentAUserApi.unassignRoleFromUser
(String userId, String roleAssignmentId) Unassign a User Role Unassigns a Role Assignment (identified by `roleAssignmentId`) from a User (identified by `userId`)void
RoleAssignmentAUserApi.unassignRoleFromUser
(String userId, String roleAssignmentId, Map<String, String> additionalHeaders) Unassign a User Role Unassigns a Role Assignment (identified by `roleAssignmentId`) from a User (identified by `userId`)void
ApplicationUsersApi.unassignUserFromApplication
(String appId, String userId, Boolean sendEmail) Unassign an Application User Unassigns a user from an app For directories like Active Directory and LDAP, they act as the owner of the user's credential with Okta delegating authentication (DelAuth) to that directory.void
ApplicationUsersApi.unassignUserFromApplication
(String appId, String userId, Boolean sendEmail, Map<String, String> additionalHeaders) Unassign an Application User Unassigns a user from an app For directories like Active Directory and LDAP, they act as the owner of the user's credential with Okta delegating authentication (DelAuth) to that directory.void
GroupApi.unassignUserFromGroup
(String groupId, String userId) Unassign a User from a Group Unassigns a User from a Group with the `OKTA_GROUP` type > **Note:** You only can modify memberships for groups of the `OKTA_GROUP` type.void
Unassign a User from a Group Unassigns a User from a Group with the `OKTA_GROUP` type > **Note:** You only can modify memberships for groups of the `OKTA_GROUP` type.void
UserFactorApi.unenrollFactor
(String userId, String factorId, Boolean removeRecoveryEnrollment) Unenroll a Factor Unenrolls an existing Factor for the specified user.void
UserFactorApi.unenrollFactor
(String userId, String factorId, Boolean removeRecoveryEnrollment, Map<String, String> additionalHeaders) Unenroll a Factor Unenrolls an existing Factor for the specified user.void
IdentityProviderUsersApi.unlinkUserFromIdentityProvider
(String idpId, String userId) Unlink a User from IdP Unlinks the Okta User and the IdP User.void
IdentityProviderUsersApi.unlinkUserFromIdentityProvider
(String idpId, String userId, Map<String, String> additionalHeaders) Unlink a User from IdP Unlinks the Okta User and the IdP User.void
UserLifecycleApi.unlockUser
(String userId) Unlock a User Unlocks a User with a `LOCKED_OUT` status or unlocks a User with an `ACTIVE` status that is blocked from unknown devices.void
UserLifecycleApi.unlockUser
(String userId, Map<String, String> additionalHeaders) Unlock a User Unlocks a User with a `LOCKED_OUT` status or unlocks a User with an `ACTIVE` status that is blocked from unknown devices.void
SubscriptionApi.unsubscribeByNotificationTypeRole
(ListSubscriptionsRoleRoleRefParameter roleRef, NotificationType notificationType) Unsubscribe a Role from a Specific Notification Type Unsubscribes a Role from a specified notification type.void
SubscriptionApi.unsubscribeByNotificationTypeRole
(ListSubscriptionsRoleRoleRefParameter roleRef, NotificationType notificationType, Map<String, String> additionalHeaders) Unsubscribe a Role from a Specific Notification Type Unsubscribes a Role from a specified notification type.void
SubscriptionApi.unsubscribeByNotificationTypeUser
(NotificationType notificationType, String userId) Unsubscribe a User from a Specific Notification Type Unsubscribes the current User from a specified notification type.void
SubscriptionApi.unsubscribeByNotificationTypeUser
(NotificationType notificationType, String userId, Map<String, String> additionalHeaders) Unsubscribe a User from a Specific Notification Type Unsubscribes the current User from a specified notification type.void
DeviceApi.unsuspendDevice
(String deviceId) Unsuspend a Device Unsuspends a Device by returning its `status` to ACTIVE.void
DeviceApi.unsuspendDevice
(String deviceId, Map<String, String> additionalHeaders) Unsuspend a Device Unsuspends a Device by returning its `status` to ACTIVE.void
UserLifecycleApi.unsuspendUser
(String userId) Unsuspend a User Unsuspends a user and returns them to the `ACTIVE` state.void
UserLifecycleApi.unsuspendUser
(String userId, Map<String, String> additionalHeaders) Unsuspend a User Unsuspends a user and returns them to the `ACTIVE` state.void
DirectoriesIntegrationApi.updateADGroupMembership
(String appInstanceId, AgentAction agentAction) Update an AD Group membership Updates an AD Group membership directly in ADvoid
DirectoriesIntegrationApi.updateADGroupMembership
(String appInstanceId, AgentAction agentAction, Map<String, String> additionalHeaders) Update an AD Group membership Updates an AD Group membership directly in ADAgentPoolsApi.updateAgentPoolsUpdate
(String poolId, String updateId, AgentPoolUpdate agentPoolUpdate) Update an Agent Pool update by id Updates Agent pool update and return latest agent pool updateAgentPoolsApi.updateAgentPoolsUpdate
(String poolId, String updateId, AgentPoolUpdate agentPoolUpdate, Map<String, String> additionalHeaders) Update an Agent Pool update by id Updates Agent pool update and return latest agent pool updateAgentPoolsApi.updateAgentPoolsUpdateSettings
(String poolId, AgentPoolUpdateSetting agentPoolUpdateSetting) Update an Agent Pool update settings Updates an agent pool update settingsAgentPoolsApi.updateAgentPoolsUpdateSettings
(String poolId, AgentPoolUpdateSetting agentPoolUpdateSetting, Map<String, String> additionalHeaders) Update an Agent Pool update settings Updates an agent pool update settingsApplicationUsersApi.updateApplicationUser
(String appId, String userId, AppUserUpdateRequest appUser) Update an Application User Updates the profile or credentials of a user assigned to an appApplicationUsersApi.updateApplicationUser
(String appId, String userId, AppUserUpdateRequest appUser, Map<String, String> additionalHeaders) Update an Application User Updates the profile or credentials of a user assigned to an appSchemaApi.updateApplicationUserProfile
(String appId, UserSchema body) Update the App User Profile Schema for an App Updates the App User Schema.SchemaApi.updateApplicationUserProfile
(String appId, UserSchema body, Map<String, String> additionalHeaders) Update the App User Profile Schema for an App Updates the App User Schema.CaptchaApi.updateCaptchaInstance
(String captchaId, CAPTCHAInstance instance) Update a CAPTCHA Instance Partially updates the properties of a specified CAPTCHA instanceCaptchaApi.updateCaptchaInstance
(String captchaId, CAPTCHAInstance instance, Map<String, String> additionalHeaders) Update a CAPTCHA Instance Partially updates the properties of a specified CAPTCHA instanceThreatInsightApi.updateConfiguration
(ThreatInsightConfiguration threatInsightConfiguration) Update the ThreatInsight Configuration Updates the ThreatInsight configuration for the orgThreatInsightApi.updateConfiguration
(ThreatInsightConfiguration threatInsightConfiguration, Map<String, String> additionalHeaders) Update the ThreatInsight Configuration Updates the ThreatInsight configuration for the orgApplicationConnectionsApi.updateDefaultProvisioningConnectionForApplication
(String appId, UpdateDefaultProvisioningConnectionForApplicationRequest updateDefaultProvisioningConnectionForApplicationRequest, Boolean activate) Update the default Provisioning Connection Updates the default Provisioning Connection for an appApplicationConnectionsApi.updateDefaultProvisioningConnectionForApplication
(String appId, UpdateDefaultProvisioningConnectionForApplicationRequest updateDefaultProvisioningConnectionForApplicationRequest, Boolean activate, Map<String, String> additionalHeaders) Update the default Provisioning Connection Updates the default Provisioning Connection for an appEmailServerApi.updateEmailServer
(String emailServerId, EmailServerRequest emailServerRequest) Update an SMTP Server configuration Updates the specified custom SMTP server configurationEmailServerApi.updateEmailServer
(String emailServerId, EmailServerRequest emailServerRequest, Map<String, String> additionalHeaders) Update an SMTP Server configuration Updates the specified custom SMTP server configurationApplicationFeaturesApi.updateFeatureForApplication
(String appId, ApplicationFeatureType featureName, UpdateFeatureForApplicationRequest updateFeatureForApplicationRequest) Update a Feature Updates a Feature object for an app > **Note:** This endpoint supports partial updates.ApplicationFeaturesApi.updateFeatureForApplication
(String appId, ApplicationFeatureType featureName, UpdateFeatureForApplicationRequest updateFeatureForApplicationRequest, Map<String, String> additionalHeaders) Update a Feature Updates a Feature object for an app > **Note:** This endpoint supports partial updates.FeatureApi.updateFeatureLifecycle
(String featureId, FeatureLifecycle lifecycle, String mode) Update a Feature lifecycle Updates a feature's lifecycle status.FeatureApi.updateFeatureLifecycle
(String featureId, FeatureLifecycle lifecycle, String mode, Map<String, String> additionalHeaders) Update a Feature lifecycle Updates a feature's lifecycle status.ApplicationGroupsApi.updateGroupAssignmentToApplication
(String appId, String groupId, List<JsonPatchOperation> jsonPatchOperation) Update an Application Group Updates a group assignment to an appApplicationGroupsApi.updateGroupAssignmentToApplication
(String appId, String groupId, List<JsonPatchOperation> jsonPatchOperation, Map<String, String> additionalHeaders) Update an Application Group Updates a group assignment to an appSchemaApi.updateGroupSchema
(GroupSchema groupSchema) Update the Group Profile Schema Updates the Group Profile schema.SchemaApi.updateGroupSchema
(GroupSchema groupSchema, Map<String, String> additionalHeaders) Update the Group Profile Schema Updates the Group Profile schema.InlineHookApi.updateInlineHook
(String inlineHookId, InlineHook inlineHook) Update an Inline Hook Updates an inline hook by `inlineHookId`InlineHookApi.updateInlineHook
(String inlineHookId, InlineHook inlineHook, Map<String, String> additionalHeaders) Update an Inline Hook Updates an inline hook by `inlineHookId`OrgSettingGeneralApi.updateOrgSettings
(OrgSetting orgSetting) Update the Org General Settings Updates partial Org General SettingsOrgSettingGeneralApi.updateOrgSettings
(OrgSetting orgSetting, Map<String, String> additionalHeaders) Update the Org General Settings Updates partial Org General SettingsProfileMappingApi.updateProfileMapping
(String mappingId, ProfileMappingRequest profileMapping) Update a Profile Mapping Updates an existing profile mapping by adding, updating, or removing one or many property mappingsProfileMappingApi.updateProfileMapping
(String mappingId, ProfileMappingRequest profileMapping, Map<String, String> additionalHeaders) Update a Profile Mapping Updates an existing profile mapping by adding, updating, or removing one or many property mappingsTemplateApi.updateSmsTemplate
(String templateId, SmsTemplate smsTemplate) Update an SMS Template Updates only some of the SMS Template properties: * All properties within the custom SMS Template that have values are updated.TemplateApi.updateSmsTemplate
(String templateId, SmsTemplate smsTemplate, Map<String, String> additionalHeaders) Update an SMS Template Updates only some of the SMS Template properties: * All properties within the custom SMS Template that have values are updated.SsfTransmitterApi.updateSsfStream
(StreamConfiguration instance) Update an SSF Stream Updates properties for an existing SSF Stream configuration.SsfTransmitterApi.updateSsfStream
(StreamConfiguration instance, Map<String, String> additionalHeaders) Update an SSF Stream Updates properties for an existing SSF Stream configuration.OrgSettingAdminApi.updateThirdPartyAdminSetting
(ThirdPartyAdminSetting thirdPartyAdminSetting) Update the Org Third-Party Admin Setting Updates the Third-Party Admin Setting.OrgSettingAdminApi.updateThirdPartyAdminSetting
(ThirdPartyAdminSetting thirdPartyAdminSetting, Map<String, String> additionalHeaders) Update the Org Third-Party Admin Setting Updates the Third-Party Admin Setting.UserApi.updateUser
(String id, UpdateUserRequest user, Boolean strict) Update a User Updates a user's profile or credentials with partial update semantics.UserApi.updateUser
(String id, UpdateUserRequest user, Boolean strict, Map<String, String> additionalHeaders) Update a User Updates a user's profile or credentials with partial update semantics.SchemaApi.updateUserProfile
(String schemaId, UserSchema userSchema) Update a User Schema Updates a User Schema.SchemaApi.updateUserProfile
(String schemaId, UserSchema userSchema, Map<String, String> additionalHeaders) Update a User Schema Updates a User Schema.UserTypeApi.updateUserType
(String typeId, UserTypePostRequest userType) Update a User Type Updates an existing User Type.UserTypeApi.updateUserType
(String typeId, UserTypePostRequest userType, Map<String, String> additionalHeaders) Update a User Type Updates an existing User Type.void
ApplicationLogosApi.uploadApplicationLogo
(String appId, File _file) Upload an application Logo Uploads a logo for the app instance.void
ApplicationLogosApi.uploadApplicationLogo
(String appId, File _file, Map<String, String> additionalHeaders) Upload an application Logo Uploads a logo for the app instance.ThemesApi.uploadBrandThemeBackgroundImage
(String brandId, String themeId, File _file) Upload the Background Image Uploads and replaces the background image for the theme.ThemesApi.uploadBrandThemeBackgroundImage
(String brandId, String themeId, File _file, Map<String, String> additionalHeaders) Upload the Background Image Uploads and replaces the background image for the theme.ThemesApi.uploadBrandThemeFavicon
(String brandId, String themeId, File _file) Upload the Favicon Uploads and replaces the favicon for the themeThemesApi.uploadBrandThemeFavicon
(String brandId, String themeId, File _file, Map<String, String> additionalHeaders) Upload the Favicon Uploads and replaces the favicon for the themeThemesApi.uploadBrandThemeLogo
(String brandId, String themeId, File _file) Upload the Logo Uploads and replaces the logo for the theme.ThemesApi.uploadBrandThemeLogo
(String brandId, String themeId, File _file, Map<String, String> additionalHeaders) Upload the Logo Uploads and replaces the logo for the theme.void
IdentitySourceApi.uploadIdentitySourceDataForDelete
(String identitySourceId, String sessionId, BulkDeleteRequestBody bulkDeleteRequestBody) Upload the data to be deleted in Okta Uploads external IDs of entities that need to be deleted in Okta from the Identity Source for the given sessionvoid
IdentitySourceApi.uploadIdentitySourceDataForDelete
(String identitySourceId, String sessionId, BulkDeleteRequestBody bulkDeleteRequestBody, Map<String, String> additionalHeaders) Upload the data to be deleted in Okta Uploads external IDs of entities that need to be deleted in Okta from the Identity Source for the given sessionvoid
IdentitySourceApi.uploadIdentitySourceDataForUpsert
(String identitySourceId, String sessionId, BulkUpsertRequestBody bulkUpsertRequestBody) Upload the data to be upserted in Okta Uploads entities that need to be inserted or updated in Okta from the Identity Source for the given sessionvoid
IdentitySourceApi.uploadIdentitySourceDataForUpsert
(String identitySourceId, String sessionId, BulkUpsertRequestBody bulkUpsertRequestBody, Map<String, String> additionalHeaders) Upload the data to be upserted in Okta Uploads entities that need to be inserted or updated in Okta from the Identity Source for the given sessionvoid
OrgSettingCustomizationApi.uploadOrgLogo
(File _file) Upload the Org Logo Uploads and replaces the logo for your organizationvoid
OrgSettingCustomizationApi.uploadOrgLogo
(File _file, Map<String, String> additionalHeaders) Upload the Org Logo Uploads and replaces the logo for your organizationUserFactorApi.uploadYubikeyOtpTokenSeed
(UploadYubikeyOtpTokenSeedRequest uploadYubikeyOtpTokenSeedRequest, String after, String expand, String filter, Boolean forDownload, Integer limit, String sortBy, String sortOrder) Upload a YubiKey OTP Seed Uploads a seed for a user to enroll a YubiKey OTPUserFactorApi.uploadYubikeyOtpTokenSeed
(UploadYubikeyOtpTokenSeedRequest uploadYubikeyOtpTokenSeedRequest, String after, String expand, String filter, Boolean forDownload, Integer limit, String sortBy, String sortOrder, Map<String, String> additionalHeaders) Upload a YubiKey OTP Seed Uploads a seed for a user to enroll a YubiKey OTPApiTokenApi.upsertApiToken
(String apiTokenId, ApiTokenUpdate apiTokenUpdate) Upsert an API Token Network Condition Upserts an API Token Network Condition by `apiTokenId`ApiTokenApi.upsertApiToken
(String apiTokenId, ApiTokenUpdate apiTokenUpdate, Map<String, String> additionalHeaders) Upsert an API Token Network Condition Upserts an API Token Network Condition by `apiTokenId`void
CustomDomainApi.upsertCertificate
(String domainId, DomainCertificate certificate) Upsert the Custom Domain's Certificate Upserts (creates or renews) the `MANUAL` certificate for the custom domain > **Notes:** > * If the existing `certificateSourceType` is `OKTA_MANAGED`, this operation changes the source type to `MANUAL`.void
CustomDomainApi.upsertCertificate
(String domainId, DomainCertificate certificate, Map<String, String> additionalHeaders) Upsert the Custom Domain's Certificate Upserts (creates or renews) the `MANUAL` certificate for the custom domain > **Notes:** > * If the existing `certificateSourceType` is `OKTA_MANAGED`, this operation changes the source type to `MANUAL`.CustomDomainApi.verifyDomain
(String domainId) Verify a Custom Domain Verifies the custom domain and validity of DNS records by `domainId`.CustomDomainApi.verifyDomain
(String domainId, Map<String, String> additionalHeaders) Verify a Custom Domain Verifies the custom domain and validity of DNS records by `domainId`.EmailDomainApi.verifyEmailDomain
(String emailDomainId) Verify an Email Domain Verifies an Email Domain by `emailDomainId`EmailDomainApi.verifyEmailDomain
(String emailDomainId, Map<String, String> additionalHeaders) Verify an Email Domain Verifies an Email Domain by `emailDomainId`EventHookApi.verifyEventHook
(String eventHookId) Verify an Event Hook Verifies that the event hook matches the provided `eventHookId`.EventHookApi.verifyEventHook
(String eventHookId, Map<String, String> additionalHeaders) Verify an Event Hook Verifies that the event hook matches the provided `eventHookId`.UserFactorApi.verifyFactor
(String userId, String factorId, String templateId, Integer tokenLifetimeSeconds, String xForwardedFor, String userAgent, String acceptLanguage, UserFactorVerifyRequest body) Verify a Factor Verifies an OTP for a Factor.UserFactorApi.verifyFactor
(String userId, String factorId, String templateId, Integer tokenLifetimeSeconds, String xForwardedFor, String userAgent, String acceptLanguage, UserFactorVerifyRequest body, Map<String, String> additionalHeaders) Verify a Factor Verifies an OTP for a Factor.void
ApplicationConnectionsApi.verifyProvisioningConnectionForApplication
(OAuthProvisioningEnabledApp appName, String appId, String code, String state) Verify the Provisioning Connection Verifies the OAuth 2.0-based connection as part of the OAuth 2.0 consent flow.void
ApplicationConnectionsApi.verifyProvisioningConnectionForApplication
(OAuthProvisioningEnabledApp appName, String appId, String code, String state, Map<String, String> additionalHeaders) Verify the Provisioning Connection Verifies the OAuth 2.0-based connection as part of the OAuth 2.0 consent flow. -
Uses of ApiException in com.okta.sdk.resource.application
-
Uses of ApiException in com.okta.sdk.resource.client
Modifier and TypeMethodDescription<T> T
ApiClient.deserialize
(org.apache.hc.client5.http.impl.classic.CloseableHttpResponse response, com.fasterxml.jackson.core.type.TypeReference<T> valueType) Deserialize response body to Java object according to the Content-Type.<T> T
ApiClient.invokeAPI
(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, String urlQueryDeepObject, Object body, Map<String, String> headerParams, Map<String, String> cookieParams, Map<String, Object> formParams, String accept, String contentType, String[] authNames, com.fasterxml.jackson.core.type.TypeReference<T> returnType) Invoke API by sending HTTP request with the given options.void
Directly invoke the API for the given URL.<T> T
BaseApi.invokeAPI
(String url, String method, com.fasterxml.jackson.core.type.TypeReference<T> returnType) Directly invoke the API for the given URL.void
Directly invoke the API for the given URL.<T> T
BaseApi.invokeAPI
(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType) Directly invoke the API for the given URL.abstract <T> T
BaseApi.invokeAPI
(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String, String> additionalHeaders) Directly invoke the API for the given URL.void
Directly invoke the API for the given URL.void
Directly invoke the API for the given URL.protected <T> T
ApiClient.processResponse
(org.apache.hc.client5.http.impl.classic.CloseableHttpResponse response, com.fasterxml.jackson.core.type.TypeReference<T> returnType) org.apache.hc.core5.http.HttpEntity
ApiClient.serialize
(Object obj, Map<String, Object> formParams, org.apache.hc.core5.http.ContentType contentType) Serialize the given Java object into string according the given Content-Type (only JSON is supported for now). -
Uses of ApiException in com.okta.sdk.resource.group
-
Uses of ApiException in com.okta.sdk.resource.policy
-
Uses of ApiException in com.okta.sdk.resource.user
-
Uses of ApiException in quickstart