package
0.0.1
Repository: https://github.com/okta/okta-cli-client.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# README

Go API client for sdk

Allows customers to easily access the Okta Management APIs

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 5.1.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://developer.okta.com/

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import sdk "github.com/GIT_USER_ID/GIT_REPO_ID"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), sdk.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), sdk.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), sdk.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sdk.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://subdomain.okta.com

ClassMethodHTTP requestDescription
AgentPoolsAPIActivateAgentPoolsUpdatePost /api/v1/agentPools/{poolId}/updates/{updateId}/activateActivate an Agent Pool update
AgentPoolsAPICreateAgentPoolsUpdatePost /api/v1/agentPools/{poolId}/updatesCreate an Agent Pool update
AgentPoolsAPIDeactivateAgentPoolsUpdatePost /api/v1/agentPools/{poolId}/updates/{updateId}/deactivateDeactivate an Agent Pool update
AgentPoolsAPIDeleteAgentPoolsUpdateDelete /api/v1/agentPools/{poolId}/updates/{updateId}Delete an Agent Pool update
AgentPoolsAPIGetAgentPoolsUpdateInstanceGet /api/v1/agentPools/{poolId}/updates/{updateId}Retrieve an Agent Pool update by id
AgentPoolsAPIGetAgentPoolsUpdateSettingsGet /api/v1/agentPools/{poolId}/updates/settingsRetrieve an Agent Pool update's settings
AgentPoolsAPIListAgentPoolsGet /api/v1/agentPoolsList all Agent Pools
AgentPoolsAPIListAgentPoolsUpdatesGet /api/v1/agentPools/{poolId}/updatesList all Agent Pool updates
AgentPoolsAPIPauseAgentPoolsUpdatePost /api/v1/agentPools/{poolId}/updates/{updateId}/pausePause an Agent Pool update
AgentPoolsAPIResumeAgentPoolsUpdatePost /api/v1/agentPools/{poolId}/updates/{updateId}/resumeResume an Agent Pool update
AgentPoolsAPIRetryAgentPoolsUpdatePost /api/v1/agentPools/{poolId}/updates/{updateId}/retryRetry an Agent Pool update
AgentPoolsAPIStopAgentPoolsUpdatePost /api/v1/agentPools/{poolId}/updates/{updateId}/stopStop an Agent Pool update
AgentPoolsAPIUpdateAgentPoolsUpdatePost /api/v1/agentPools/{poolId}/updates/{updateId}Update an Agent Pool update by id
AgentPoolsAPIUpdateAgentPoolsUpdateSettingsPost /api/v1/agentPools/{poolId}/updates/settingsUpdate an Agent Pool update settings
ApiServiceIntegrationsAPIActivateApiServiceIntegrationInstanceSecretPost /integrations/api/v1/api-services/{apiServiceId}/credentials/secrets/{secretId}/lifecycle/activateActivate an API Service Integration instance Secret
ApiServiceIntegrationsAPICreateApiServiceIntegrationInstancePost /integrations/api/v1/api-servicesCreate an API Service Integration instance
ApiServiceIntegrationsAPICreateApiServiceIntegrationInstanceSecretPost /integrations/api/v1/api-services/{apiServiceId}/credentials/secretsCreate an API Service Integration instance Secret
ApiServiceIntegrationsAPIDeactivateApiServiceIntegrationInstanceSecretPost /integrations/api/v1/api-services/{apiServiceId}/credentials/secrets/{secretId}/lifecycle/deactivateDeactivate an API Service Integration instance Secret
ApiServiceIntegrationsAPIDeleteApiServiceIntegrationInstanceDelete /integrations/api/v1/api-services/{apiServiceId}Delete an API Service Integration instance
ApiServiceIntegrationsAPIDeleteApiServiceIntegrationInstanceSecretDelete /integrations/api/v1/api-services/{apiServiceId}/credentials/secrets/{secretId}Delete an API Service Integration instance Secret
ApiServiceIntegrationsAPIGetApiServiceIntegrationInstanceGet /integrations/api/v1/api-services/{apiServiceId}Retrieve an API Service Integration instance
ApiServiceIntegrationsAPIListApiServiceIntegrationInstanceSecretsGet /integrations/api/v1/api-services/{apiServiceId}/credentials/secretsList all API Service Integration instance Secrets
ApiServiceIntegrationsAPIListApiServiceIntegrationInstancesGet /integrations/api/v1/api-servicesList all API Service Integration instances
ApiTokenAPIGetApiTokenGet /api/v1/api-tokens/{apiTokenId}Retrieve an API Token's Metadata
ApiTokenAPIListApiTokensGet /api/v1/api-tokensList all API Token Metadata
ApiTokenAPIRevokeApiTokenDelete /api/v1/api-tokens/{apiTokenId}Revoke an API Token
ApiTokenAPIRevokeCurrentApiTokenDelete /api/v1/api-tokens/currentRevoke the Current API Token
ApplicationAPIActivateApplicationPost /api/v1/apps/{appId}/lifecycle/activateActivate an Application
ApplicationAPICreateApplicationPost /api/v1/appsCreate an Application
ApplicationAPIDeactivateApplicationPost /api/v1/apps/{appId}/lifecycle/deactivateDeactivate an Application
ApplicationAPIDeleteApplicationDelete /api/v1/apps/{appId}Delete an Application
ApplicationAPIGetApplicationGet /api/v1/apps/{appId}Retrieve an Application
ApplicationAPIListApplicationsGet /api/v1/appsList all Applications
ApplicationAPIReplaceApplicationPut /api/v1/apps/{appId}Replace an Application
ApplicationConnectionsAPIActivateDefaultProvisioningConnectionForApplicationPost /api/v1/apps/{appId}/connections/default/lifecycle/activateActivate the default Provisioning Connection
ApplicationConnectionsAPIDeactivateDefaultProvisioningConnectionForApplicationPost /api/v1/apps/{appId}/connections/default/lifecycle/deactivateDeactivate the default Provisioning Connection
ApplicationConnectionsAPIGetDefaultProvisioningConnectionForApplicationGet /api/v1/apps/{appId}/connections/defaultRetrieve the default Provisioning Connection
ApplicationConnectionsAPIUpdateDefaultProvisioningConnectionForApplicationPost /api/v1/apps/{appId}/connections/defaultUpdate the default Provisioning Connection
ApplicationConnectionsAPIVerifyProvisioningConnectionForApplicationPost /api/v1/apps/{appName}/{appId}/oauth2/callbackVerify the Provisioning Connection
ApplicationConnectionsAPIVerifyProvisioningConnectionForGoogleApplicationPost /api/v1/apps/google/{appId}/oauth2/callbackVerify the Provisioning Connection for Google Workspace
ApplicationConnectionsAPIVerifyProvisioningConnectionForOfficeApplicationPost /api/v1/apps/office365/{appId}/oauth2/callbackVerify the Provisioning Connection for Microsoft Office 365
ApplicationCredentialsAPICloneApplicationKeyPost /api/v1/apps/{appId}/credentials/keys/{keyId}/cloneClone a Key Credential
ApplicationCredentialsAPIGenerateApplicationKeyPost /api/v1/apps/{appId}/credentials/keys/generateGenerate a Key Credential
ApplicationCredentialsAPIGenerateCsrForApplicationPost /api/v1/apps/{appId}/credentials/csrsGenerate a Certificate Signing Request
ApplicationCredentialsAPIGetApplicationKeyGet /api/v1/apps/{appId}/credentials/keys/{keyId}Retrieve a Key Credential
ApplicationCredentialsAPIGetCsrForApplicationGet /api/v1/apps/{appId}/credentials/csrs/{csrId}Retrieve a Certificate Signing Request
ApplicationCredentialsAPIListApplicationKeysGet /api/v1/apps/{appId}/credentials/keysList all Key Credentials
ApplicationCredentialsAPIListCsrsForApplicationGet /api/v1/apps/{appId}/credentials/csrsList all Certificate Signing Requests
ApplicationCredentialsAPIPublishCsrFromApplicationPost /api/v1/apps/{appId}/credentials/csrs/{csrId}/lifecycle/publishPublish a Certificate Signing Request
ApplicationCredentialsAPIRevokeCsrFromApplicationDelete /api/v1/apps/{appId}/credentials/csrs/{csrId}Revoke a Certificate Signing Request
ApplicationFeaturesAPIGetFeatureForApplicationGet /api/v1/apps/{appId}/features/{featureName}Retrieve a Feature
ApplicationFeaturesAPIListFeaturesForApplicationGet /api/v1/apps/{appId}/featuresList all Features
ApplicationFeaturesAPIUpdateFeatureForApplicationPut /api/v1/apps/{appId}/features/{featureName}Update a Feature
ApplicationGrantsAPIGetScopeConsentGrantGet /api/v1/apps/{appId}/grants/{grantId}Retrieve an app Grant
ApplicationGrantsAPIGrantConsentToScopePost /api/v1/apps/{appId}/grantsGrant consent to scope
ApplicationGrantsAPIListScopeConsentGrantsGet /api/v1/apps/{appId}/grantsList all app Grants
ApplicationGrantsAPIRevokeScopeConsentGrantDelete /api/v1/apps/{appId}/grants/{grantId}Revoke an app Grant
ApplicationGroupsAPIAssignGroupToApplicationPut /api/v1/apps/{appId}/groups/{groupId}Assign a Group
ApplicationGroupsAPIGetApplicationGroupAssignmentGet /api/v1/apps/{appId}/groups/{groupId}Retrieve an Assigned Group
ApplicationGroupsAPIListApplicationGroupAssignmentsGet /api/v1/apps/{appId}/groupsList all Assigned Groups
ApplicationGroupsAPIUnassignApplicationFromGroupDelete /api/v1/apps/{appId}/groups/{groupId}Unassign a Group
ApplicationLogosAPIUploadApplicationLogoPost /api/v1/apps/{appId}/logoUpload an application Logo
ApplicationOktaApplicationSettingsAPIGetFirstPartyAppSettingsGet /api/v1/first-party-app-settings/{appName}Retrieve the Okta app settings
ApplicationOktaApplicationSettingsAPIReplaceFirstPartyAppSettingsPut /api/v1/first-party-app-settings/{appName}Replace the Okta app settings
ApplicationPoliciesAPIAssignApplicationPolicyPut /api/v1/apps/{appId}/policies/{policyId}Assign an application to a Policy
ApplicationSSOAPIPreviewSAMLmetadataForApplicationGet /api/v1/apps/{appId}/sso/saml/metadataPreview the application SAML metadata
ApplicationTokensAPIGetOAuth2TokenForApplicationGet /api/v1/apps/{appId}/tokens/{tokenId}Retrieve an application Token
ApplicationTokensAPIListOAuth2TokensForApplicationGet /api/v1/apps/{appId}/tokensList all application refresh Tokens
ApplicationTokensAPIRevokeOAuth2TokenForApplicationDelete /api/v1/apps/{appId}/tokens/{tokenId}Revoke an application Token
ApplicationTokensAPIRevokeOAuth2TokensForApplicationDelete /api/v1/apps/{appId}/tokensRevoke all application Tokens
ApplicationUsersAPIAssignUserToApplicationPost /api/v1/apps/{appId}/usersAssign an Application User
ApplicationUsersAPIGetApplicationUserGet /api/v1/apps/{appId}/users/{userId}Retrieve an Application User
ApplicationUsersAPIListApplicationUsersGet /api/v1/apps/{appId}/usersList all Application Users
ApplicationUsersAPIUnassignUserFromApplicationDelete /api/v1/apps/{appId}/users/{userId}Unassign an Application User
ApplicationUsersAPIUpdateApplicationUserPost /api/v1/apps/{appId}/users/{userId}Update an Application User
AttackProtectionAPIGetAuthenticatorSettingsGet /attack-protection/api/v1/authenticator-settingsRetrieve the Authenticator Settings
AttackProtectionAPIGetUserLockoutSettingsGet /attack-protection/api/v1/user-lockout-settingsRetrieve the User Lockout Settings
AttackProtectionAPIReplaceAuthenticatorSettingsPut /attack-protection/api/v1/authenticator-settingsReplace the Authenticator Settings
AttackProtectionAPIReplaceUserLockoutSettingsPut /attack-protection/api/v1/user-lockout-settingsReplace the User Lockout Settings
AuthenticatorAPIActivateAuthenticatorPost /api/v1/authenticators/{authenticatorId}/lifecycle/activateActivate an Authenticator
AuthenticatorAPIActivateAuthenticatorMethodPost /api/v1/authenticators/{authenticatorId}/methods/{methodType}/lifecycle/activateActivate an Authenticator Method
AuthenticatorAPICreateAuthenticatorPost /api/v1/authenticatorsCreate an Authenticator
AuthenticatorAPIDeactivateAuthenticatorPost /api/v1/authenticators/{authenticatorId}/lifecycle/deactivateDeactivate an Authenticator
AuthenticatorAPIDeactivateAuthenticatorMethodPost /api/v1/authenticators/{authenticatorId}/methods/{methodType}/lifecycle/deactivateDeactivate an Authenticator Method
AuthenticatorAPIGetAuthenticatorGet /api/v1/authenticators/{authenticatorId}Retrieve an Authenticator
AuthenticatorAPIGetAuthenticatorMethodGet /api/v1/authenticators/{authenticatorId}/methods/{methodType}Retrieve a Method
AuthenticatorAPIGetWellKnownAppAuthenticatorConfigurationGet /.well-known/app-authenticator-configurationRetrieve the Well-Known App Authenticator Configuration
AuthenticatorAPIListAuthenticatorMethodsGet /api/v1/authenticators/{authenticatorId}/methodsList all Methods of an Authenticator
AuthenticatorAPIListAuthenticatorPolicyMappingsGet /api/v1/authenticators/{authenticatorId}/policiesList all Policies mapped to this Authenticator
AuthenticatorAPIListAuthenticatorsGet /api/v1/authenticatorsList all Authenticators
AuthenticatorAPIMapAuthenticatorPolicyMappingPost /api/v1/authenticators/{authenticatorId}/policiesMap an Authenticator to a Policy
AuthenticatorAPIReplaceAuthenticatorPut /api/v1/authenticators/{authenticatorId}Replace an Authenticator
AuthenticatorAPIReplaceAuthenticatorMethodPut /api/v1/authenticators/{authenticatorId}/methods/{methodType}Replace a Method
AuthenticatorAPIUnmapAuthenticatorPolicyMappingDelete /api/v1/authenticators/{authenticatorId}/policies/{mappingId}Unmap an Authenticator from a Policy
AuthorizationServerAPIActivateAuthorizationServerPost /api/v1/authorizationServers/{authServerId}/lifecycle/activateActivate an Authorization Server
AuthorizationServerAPICreateAuthorizationServerPost /api/v1/authorizationServersCreate an Authorization Server
AuthorizationServerAPIDeactivateAuthorizationServerPost /api/v1/authorizationServers/{authServerId}/lifecycle/deactivateDeactivate an Authorization Server
AuthorizationServerAPIDeleteAuthorizationServerDelete /api/v1/authorizationServers/{authServerId}Delete an Authorization Server
AuthorizationServerAPIGetAuthorizationServerGet /api/v1/authorizationServers/{authServerId}Retrieve an Authorization Server
AuthorizationServerAPIListAuthorizationServersGet /api/v1/authorizationServersList all Authorization Servers
AuthorizationServerAPIReplaceAuthorizationServerPut /api/v1/authorizationServers/{authServerId}Replace an Authorization Server
AuthorizationServerAssocAPICreateAssociatedServersPost /api/v1/authorizationServers/{authServerId}/associatedServersCreate an associated Authorization Server
AuthorizationServerAssocAPIDeleteAssociatedServerDelete /api/v1/authorizationServers/{authServerId}/associatedServers/{associatedServerId}Delete an associated Authorization Server
AuthorizationServerAssocAPIListAssociatedServersByTrustedTypeGet /api/v1/authorizationServers/{authServerId}/associatedServersList all associated Authorization Servers
AuthorizationServerClaimsAPICreateOAuth2ClaimPost /api/v1/authorizationServers/{authServerId}/claimsCreate a custom token Claim
AuthorizationServerClaimsAPIDeleteOAuth2ClaimDelete /api/v1/authorizationServers/{authServerId}/claims/{claimId}Delete a custom token Claim
AuthorizationServerClaimsAPIGetOAuth2ClaimGet /api/v1/authorizationServers/{authServerId}/claims/{claimId}Retrieve a custom token Claim
AuthorizationServerClaimsAPIListOAuth2ClaimsGet /api/v1/authorizationServers/{authServerId}/claimsList all custom token Claims
AuthorizationServerClaimsAPIReplaceOAuth2ClaimPut /api/v1/authorizationServers/{authServerId}/claims/{claimId}Replace a custom token Claim
AuthorizationServerClientsAPIGetRefreshTokenForAuthorizationServerAndClientGet /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens/{tokenId}Retrieve a refresh token for a Client
AuthorizationServerClientsAPIListOAuth2ClientsForAuthorizationServerGet /api/v1/authorizationServers/{authServerId}/clientsList all Client resources for an authorization server
AuthorizationServerClientsAPIListRefreshTokensForAuthorizationServerAndClientGet /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokensList all refresh tokens for a Client
AuthorizationServerClientsAPIRevokeRefreshTokenForAuthorizationServerAndClientDelete /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens/{tokenId}Revoke a refresh token for a Client
AuthorizationServerClientsAPIRevokeRefreshTokensForAuthorizationServerAndClientDelete /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokensRevoke all refresh tokens for a Client
AuthorizationServerKeysAPIListAuthorizationServerKeysGet /api/v1/authorizationServers/{authServerId}/credentials/keysList all Credential Keys
AuthorizationServerKeysAPIRotateAuthorizationServerKeysPost /api/v1/authorizationServers/{authServerId}/credentials/lifecycle/keyRotateRotate all Credential Keys
AuthorizationServerPoliciesAPIActivateAuthorizationServerPolicyPost /api/v1/authorizationServers/{authServerId}/policies/{policyId}/lifecycle/activateActivate a Policy
AuthorizationServerPoliciesAPICreateAuthorizationServerPolicyPost /api/v1/authorizationServers/{authServerId}/policiesCreate a Policy
AuthorizationServerPoliciesAPIDeactivateAuthorizationServerPolicyPost /api/v1/authorizationServers/{authServerId}/policies/{policyId}/lifecycle/deactivateDeactivate a Policy
AuthorizationServerPoliciesAPIDeleteAuthorizationServerPolicyDelete /api/v1/authorizationServers/{authServerId}/policies/{policyId}Delete a Policy
AuthorizationServerPoliciesAPIGetAuthorizationServerPolicyGet /api/v1/authorizationServers/{authServerId}/policies/{policyId}Retrieve a Policy
AuthorizationServerPoliciesAPIListAuthorizationServerPoliciesGet /api/v1/authorizationServers/{authServerId}/policiesList all Policies
AuthorizationServerPoliciesAPIReplaceAuthorizationServerPolicyPut /api/v1/authorizationServers/{authServerId}/policies/{policyId}Replace a Policy
AuthorizationServerRulesAPIActivateAuthorizationServerPolicyRulePost /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}/lifecycle/activateActivate a Policy Rule
AuthorizationServerRulesAPICreateAuthorizationServerPolicyRulePost /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rulesCreate a Policy Rule
AuthorizationServerRulesAPIDeactivateAuthorizationServerPolicyRulePost /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}/lifecycle/deactivateDeactivate a Policy Rule
AuthorizationServerRulesAPIDeleteAuthorizationServerPolicyRuleDelete /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}Delete a Policy Rule
AuthorizationServerRulesAPIGetAuthorizationServerPolicyRuleGet /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}Retrieve a Policy Rule
AuthorizationServerRulesAPIListAuthorizationServerPolicyRulesGet /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rulesList all Policy Rules
AuthorizationServerRulesAPIReplaceAuthorizationServerPolicyRulePut /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}Replace a Policy Rule
AuthorizationServerScopesAPICreateOAuth2ScopePost /api/v1/authorizationServers/{authServerId}/scopesCreate a Custom Token Scope
AuthorizationServerScopesAPIDeleteOAuth2ScopeDelete /api/v1/authorizationServers/{authServerId}/scopes/{scopeId}Delete a Custom Token Scope
AuthorizationServerScopesAPIGetOAuth2ScopeGet /api/v1/authorizationServers/{authServerId}/scopes/{scopeId}Retrieve a Custom Token Scope
AuthorizationServerScopesAPIListOAuth2ScopesGet /api/v1/authorizationServers/{authServerId}/scopesList all Custom Token Scopes
AuthorizationServerScopesAPIReplaceOAuth2ScopePut /api/v1/authorizationServers/{authServerId}/scopes/{scopeId}Replace a Custom Token Scope
BehaviorAPIActivateBehaviorDetectionRulePost /api/v1/behaviors/{behaviorId}/lifecycle/activateActivate a Behavior Detection Rule
BehaviorAPICreateBehaviorDetectionRulePost /api/v1/behaviorsCreate a Behavior Detection Rule
BehaviorAPIDeactivateBehaviorDetectionRulePost /api/v1/behaviors/{behaviorId}/lifecycle/deactivateDeactivate a Behavior Detection Rule
BehaviorAPIDeleteBehaviorDetectionRuleDelete /api/v1/behaviors/{behaviorId}Delete a Behavior Detection Rule
BehaviorAPIGetBehaviorDetectionRuleGet /api/v1/behaviors/{behaviorId}Retrieve a Behavior Detection Rule
BehaviorAPIListBehaviorDetectionRulesGet /api/v1/behaviorsList all Behavior Detection Rules
BehaviorAPIReplaceBehaviorDetectionRulePut /api/v1/behaviors/{behaviorId}Replace a Behavior Detection Rule
CAPTCHAAPICreateCaptchaInstancePost /api/v1/captchasCreate a CAPTCHA instance
CAPTCHAAPIDeleteCaptchaInstanceDelete /api/v1/captchas/{captchaId}Delete a CAPTCHA Instance
CAPTCHAAPIDeleteOrgCaptchaSettingsDelete /api/v1/org/captchaDelete the Org-wide CAPTCHA Settings
CAPTCHAAPIGetCaptchaInstanceGet /api/v1/captchas/{captchaId}Retrieve a CAPTCHA Instance
CAPTCHAAPIGetOrgCaptchaSettingsGet /api/v1/org/captchaRetrieve the Org-wide CAPTCHA Settings
CAPTCHAAPIListCaptchaInstancesGet /api/v1/captchasList all CAPTCHA Instances
CAPTCHAAPIReplaceCaptchaInstancePut /api/v1/captchas/{captchaId}Replace a CAPTCHA Instance
CAPTCHAAPIReplacesOrgCaptchaSettingsPut /api/v1/org/captchaReplace the Org-wide CAPTCHA Settings
CAPTCHAAPIUpdateCaptchaInstancePost /api/v1/captchas/{captchaId}Update a CAPTCHA Instance
CustomDomainAPICreateCustomDomainPost /api/v1/domainsCreate a Custom Domain
CustomDomainAPIDeleteCustomDomainDelete /api/v1/domains/{domainId}Delete a Custom Domain
CustomDomainAPIGetCustomDomainGet /api/v1/domains/{domainId}Retrieve a Custom Domain
CustomDomainAPIListCustomDomainsGet /api/v1/domainsList all Custom Domains
CustomDomainAPIReplaceCustomDomainPut /api/v1/domains/{domainId}Replace a Custom Domain's Brand
CustomDomainAPIUpsertCertificatePut /api/v1/domains/{domainId}/certificateUpsert the Custom Domain's Certificate
CustomDomainAPIVerifyDomainPost /api/v1/domains/{domainId}/verifyVerify a Custom Domain
CustomizationAPICreateBrandPost /api/v1/brandsCreate a Brand
CustomizationAPICreateEmailCustomizationPost /api/v1/brands/{brandId}/templates/email/{templateName}/customizationsCreate an Email Customization
CustomizationAPIDeleteAllCustomizationsDelete /api/v1/brands/{brandId}/templates/email/{templateName}/customizationsDelete all Email Customizations
CustomizationAPIDeleteBrandDelete /api/v1/brands/{brandId}Delete a brand
CustomizationAPIDeleteBrandThemeBackgroundImageDelete /api/v1/brands/{brandId}/themes/{themeId}/background-imageDelete the Background Image
CustomizationAPIDeleteBrandThemeFaviconDelete /api/v1/brands/{brandId}/themes/{themeId}/faviconDelete the Favicon
CustomizationAPIDeleteBrandThemeLogoDelete /api/v1/brands/{brandId}/themes/{themeId}/logoDelete the Logo
CustomizationAPIDeleteCustomizedErrorPageDelete /api/v1/brands/{brandId}/pages/error/customizedDelete the Customized Error Page
CustomizationAPIDeleteCustomizedSignInPageDelete /api/v1/brands/{brandId}/pages/sign-in/customizedDelete the Customized Sign-in Page
CustomizationAPIDeleteEmailCustomizationDelete /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}Delete an Email Customization
CustomizationAPIDeletePreviewErrorPageDelete /api/v1/brands/{brandId}/pages/error/previewDelete the Preview Error Page
CustomizationAPIDeletePreviewSignInPageDelete /api/v1/brands/{brandId}/pages/sign-in/previewDelete the Preview Sign-in Page
CustomizationAPIGetBrandGet /api/v1/brands/{brandId}Retrieve a Brand
CustomizationAPIGetBrandThemeGet /api/v1/brands/{brandId}/themes/{themeId}Retrieve a Theme
CustomizationAPIGetCustomizationPreviewGet /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}/previewRetrieve a Preview of an Email Customization
CustomizationAPIGetCustomizedErrorPageGet /api/v1/brands/{brandId}/pages/error/customizedRetrieve the Customized Error Page
CustomizationAPIGetCustomizedSignInPageGet /api/v1/brands/{brandId}/pages/sign-in/customizedRetrieve the Customized Sign-in Page
CustomizationAPIGetDefaultErrorPageGet /api/v1/brands/{brandId}/pages/error/defaultRetrieve the Default Error Page
CustomizationAPIGetDefaultSignInPageGet /api/v1/brands/{brandId}/pages/sign-in/defaultRetrieve the Default Sign-in Page
CustomizationAPIGetEmailCustomizationGet /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}Retrieve an Email Customization
CustomizationAPIGetEmailDefaultContentGet /api/v1/brands/{brandId}/templates/email/{templateName}/default-contentRetrieve an Email Template Default Content
CustomizationAPIGetEmailDefaultPreviewGet /api/v1/brands/{brandId}/templates/email/{templateName}/default-content/previewRetrieve a Preview of the Email Template default content
CustomizationAPIGetEmailSettingsGet /api/v1/brands/{brandId}/templates/email/{templateName}/settingsRetrieve the Email Template Settings
CustomizationAPIGetEmailTemplateGet /api/v1/brands/{brandId}/templates/email/{templateName}Retrieve an Email Template
CustomizationAPIGetErrorPageGet /api/v1/brands/{brandId}/pages/errorRetrieve the Error Page Sub-Resources
CustomizationAPIGetPreviewErrorPageGet /api/v1/brands/{brandId}/pages/error/previewRetrieve the Preview Error Page Preview
CustomizationAPIGetPreviewSignInPageGet /api/v1/brands/{brandId}/pages/sign-in/previewRetrieve the Preview Sign-in Page Preview
CustomizationAPIGetSignInPageGet /api/v1/brands/{brandId}/pages/sign-inRetrieve the Sign-in Page Sub-Resources
CustomizationAPIGetSignOutPageSettingsGet /api/v1/brands/{brandId}/pages/sign-out/customizedRetrieve the Sign-out Page Settings
CustomizationAPIListAllSignInWidgetVersionsGet /api/v1/brands/{brandId}/pages/sign-in/widget-versionsList all Sign-in Widget Versions
CustomizationAPIListBrandDomainsGet /api/v1/brands/{brandId}/domainsList all Domains associated with a Brand
CustomizationAPIListBrandThemesGet /api/v1/brands/{brandId}/themesList all Themes
CustomizationAPIListBrandsGet /api/v1/brandsList all Brands
CustomizationAPIListEmailCustomizationsGet /api/v1/brands/{brandId}/templates/email/{templateName}/customizationsList all Email Customizations
CustomizationAPIListEmailTemplatesGet /api/v1/brands/{brandId}/templates/emailList all Email Templates
CustomizationAPIReplaceBrandPut /api/v1/brands/{brandId}Replace a Brand
CustomizationAPIReplaceBrandThemePut /api/v1/brands/{brandId}/themes/{themeId}Replace a Theme
CustomizationAPIReplaceCustomizedErrorPagePut /api/v1/brands/{brandId}/pages/error/customizedReplace the Customized Error Page
CustomizationAPIReplaceCustomizedSignInPagePut /api/v1/brands/{brandId}/pages/sign-in/customizedReplace the Customized Sign-in Page
CustomizationAPIReplaceEmailCustomizationPut /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}Replace an Email Customization
CustomizationAPIReplaceEmailSettingsPut /api/v1/brands/{brandId}/templates/email/{templateName}/settingsReplace the Email Template Settings
CustomizationAPIReplacePreviewErrorPagePut /api/v1/brands/{brandId}/pages/error/previewReplace the Preview Error Page
CustomizationAPIReplacePreviewSignInPagePut /api/v1/brands/{brandId}/pages/sign-in/previewReplace the Preview Sign-in Page
CustomizationAPIReplaceSignOutPageSettingsPut /api/v1/brands/{brandId}/pages/sign-out/customizedReplace the Sign-out Page Settings
CustomizationAPISendTestEmailPost /api/v1/brands/{brandId}/templates/email/{templateName}/testSend a Test Email
CustomizationAPIUploadBrandThemeBackgroundImagePost /api/v1/brands/{brandId}/themes/{themeId}/background-imageUpload the Background Image
CustomizationAPIUploadBrandThemeFaviconPost /api/v1/brands/{brandId}/themes/{themeId}/faviconUpload the Favicon
CustomizationAPIUploadBrandThemeLogoPost /api/v1/brands/{brandId}/themes/{themeId}/logoUpload the Logo
DeviceAPIActivateDevicePost /api/v1/devices/{deviceId}/lifecycle/activateActivate a Device
DeviceAPIDeactivateDevicePost /api/v1/devices/{deviceId}/lifecycle/deactivateDeactivate a Device
DeviceAPIDeleteDeviceDelete /api/v1/devices/{deviceId}Delete a Device
DeviceAPIGetDeviceGet /api/v1/devices/{deviceId}Retrieve a Device
DeviceAPIListDeviceUsersGet /api/v1/devices/{deviceId}/usersList all Users for a Device
DeviceAPIListDevicesGet /api/v1/devicesList all Devices
DeviceAPISuspendDevicePost /api/v1/devices/{deviceId}/lifecycle/suspendSuspend a Device
DeviceAPIUnsuspendDevicePost /api/v1/devices/{deviceId}/lifecycle/unsuspendUnsuspend a Device
DeviceAssuranceAPICreateDeviceAssurancePolicyPost /api/v1/device-assurancesCreate a Device Assurance Policy
DeviceAssuranceAPIDeleteDeviceAssurancePolicyDelete /api/v1/device-assurances/{deviceAssuranceId}Delete a Device Assurance Policy
DeviceAssuranceAPIGetDeviceAssurancePolicyGet /api/v1/device-assurances/{deviceAssuranceId}Retrieve a Device Assurance Policy
DeviceAssuranceAPIListDeviceAssurancePoliciesGet /api/v1/device-assurancesList all Device Assurance Policies
DeviceAssuranceAPIReplaceDeviceAssurancePolicyPut /api/v1/device-assurances/{deviceAssuranceId}Replace a Device Assurance Policy
EmailDomainAPICreateEmailDomainPost /api/v1/email-domainsCreate an Email Domain
EmailDomainAPIDeleteEmailDomainDelete /api/v1/email-domains/{emailDomainId}Delete an Email Domain
EmailDomainAPIGetEmailDomainGet /api/v1/email-domains/{emailDomainId}Retrieve an Email Domain
EmailDomainAPIListEmailDomainsGet /api/v1/email-domainsList all Email Domains
EmailDomainAPIReplaceEmailDomainPut /api/v1/email-domains/{emailDomainId}Replace an Email Domain
EmailDomainAPIVerifyEmailDomainPost /api/v1/email-domains/{emailDomainId}/verifyVerify an Email Domain
EmailServerAPICreateEmailServerPost /api/v1/email-serversCreate a custom SMTP server
EmailServerAPIDeleteEmailServerDelete /api/v1/email-servers/{emailServerId}Delete an SMTP Server configuration
EmailServerAPIGetEmailServerGet /api/v1/email-servers/{emailServerId}Retrieve an SMTP Server configuration
EmailServerAPIListEmailServersGet /api/v1/email-serversList all enrolled SMTP servers
EmailServerAPITestEmailServerPost /api/v1/email-servers/{emailServerId}/testTest an SMTP Server configuration
EmailServerAPIUpdateEmailServerPatch /api/v1/email-servers/{emailServerId}Update an SMTP Server configuration
EventHookAPIActivateEventHookPost /api/v1/eventHooks/{eventHookId}/lifecycle/activateActivate an Event Hook
EventHookAPICreateEventHookPost /api/v1/eventHooksCreate an Event Hook
EventHookAPIDeactivateEventHookPost /api/v1/eventHooks/{eventHookId}/lifecycle/deactivateDeactivate an Event Hook
EventHookAPIDeleteEventHookDelete /api/v1/eventHooks/{eventHookId}Delete an Event Hook
EventHookAPIGetEventHookGet /api/v1/eventHooks/{eventHookId}Retrieve an Event Hook
EventHookAPIListEventHooksGet /api/v1/eventHooksList all Event Hooks
EventHookAPIReplaceEventHookPut /api/v1/eventHooks/{eventHookId}Replace an Event Hook
EventHookAPIVerifyEventHookPost /api/v1/eventHooks/{eventHookId}/lifecycle/verifyVerify an Event Hook
FeatureAPIGetFeatureGet /api/v1/features/{featureId}Retrieve a Feature
FeatureAPIListFeatureDependenciesGet /api/v1/features/{featureId}/dependenciesList all dependencies
FeatureAPIListFeatureDependentsGet /api/v1/features/{featureId}/dependentsList all dependents
FeatureAPIListFeaturesGet /api/v1/featuresList all Features
FeatureAPIUpdateFeatureLifecyclePost /api/v1/features/{featureId}/{lifecycle}Update a Feature lifecycle
GroupAPIActivateGroupRulePost /api/v1/groups/rules/{groupRuleId}/lifecycle/activateActivate a Group Rule
GroupAPIAssignUserToGroupPut /api/v1/groups/{groupId}/users/{userId}Assign a User
GroupAPICreateGroupPost /api/v1/groupsCreate a Group
GroupAPICreateGroupRulePost /api/v1/groups/rulesCreate a Group Rule
GroupAPIDeactivateGroupRulePost /api/v1/groups/rules/{groupRuleId}/lifecycle/deactivateDeactivate a Group Rule
GroupAPIDeleteGroupDelete /api/v1/groups/{groupId}Delete a Group
GroupAPIDeleteGroupRuleDelete /api/v1/groups/rules/{groupRuleId}Delete a group Rule
GroupAPIGetGroupGet /api/v1/groups/{groupId}Retrieve a Group
GroupAPIGetGroupRuleGet /api/v1/groups/rules/{groupRuleId}Retrieve a Group Rule
GroupAPIListAssignedApplicationsForGroupGet /api/v1/groups/{groupId}/appsList all Assigned Applications
GroupAPIListGroupRulesGet /api/v1/groups/rulesList all Group Rules
GroupAPIListGroupUsersGet /api/v1/groups/{groupId}/usersList all Member Users
GroupAPIListGroupsGet /api/v1/groupsList all Groups
GroupAPIReplaceGroupPut /api/v1/groups/{groupId}Replace a Group
GroupAPIReplaceGroupRulePut /api/v1/groups/rules/{groupRuleId}Replace a Group Rule
GroupAPIUnassignUserFromGroupDelete /api/v1/groups/{groupId}/users/{userId}Unassign a User
GroupOwnerAPIAssignGroupOwnerPost /api/v1/groups/{groupId}/ownersAssign a Group Owner
GroupOwnerAPIDeleteGroupOwnerDelete /api/v1/groups/{groupId}/owners/{ownerId}Delete a Group Owner
GroupOwnerAPIListGroupOwnersGet /api/v1/groups/{groupId}/ownersList all Group Owners
HookKeyAPICreateHookKeyPost /api/v1/hook-keysCreate a key
HookKeyAPIDeleteHookKeyDelete /api/v1/hook-keys/{hookKeyId}Delete a key
HookKeyAPIGetHookKeyGet /api/v1/hook-keys/{hookKeyId}Retrieve a key
HookKeyAPIGetPublicKeyGet /api/v1/hook-keys/public/{publicKeyId}Retrieve a public key
HookKeyAPIListHookKeysGet /api/v1/hook-keysList all keys
HookKeyAPIReplaceHookKeyPut /api/v1/hook-keys/{hookKeyId}Replace a key
HookPasswordAPICreatePasswordImportInlineHookPost /your-endpointCreate an Okta Password Import Inline Hook
IdentityProviderAPIActivateIdentityProviderPost /api/v1/idps/{idpId}/lifecycle/activateActivate an Identity Provider
IdentityProviderAPICloneIdentityProviderKeyPost /api/v1/idps/{idpId}/credentials/keys/{idpKeyId}/cloneClone a Signing Credential Key
IdentityProviderAPICreateIdentityProviderPost /api/v1/idpsCreate an Identity Provider
IdentityProviderAPICreateIdentityProviderKeyPost /api/v1/idps/credentials/keysCreate an X.509 Certificate Public Key
IdentityProviderAPIDeactivateIdentityProviderPost /api/v1/idps/{idpId}/lifecycle/deactivateDeactivate an Identity Provider
IdentityProviderAPIDeleteIdentityProviderDelete /api/v1/idps/{idpId}Delete an Identity Provider
IdentityProviderAPIDeleteIdentityProviderKeyDelete /api/v1/idps/credentials/keys/{idpKeyId}Delete a Signing Credential Key
IdentityProviderAPIGenerateCsrForIdentityProviderPost /api/v1/idps/{idpId}/credentials/csrsGenerate a Certificate Signing Request
IdentityProviderAPIGenerateIdentityProviderSigningKeyPost /api/v1/idps/{idpId}/credentials/keys/generateGenerate a new Signing Credential Key
IdentityProviderAPIGetCsrForIdentityProviderGet /api/v1/idps/{idpId}/credentials/csrs/{idpCsrId}Retrieve a Certificate Signing Request
IdentityProviderAPIGetIdentityProviderGet /api/v1/idps/{idpId}Retrieve an Identity Provider
IdentityProviderAPIGetIdentityProviderApplicationUserGet /api/v1/idps/{idpId}/users/{userId}Retrieve a User
IdentityProviderAPIGetIdentityProviderKeyGet /api/v1/idps/credentials/keys/{idpKeyId}Retrieve an Credential Key
IdentityProviderAPIGetIdentityProviderSigningKeyGet /api/v1/idps/{idpId}/credentials/keys/{idpKeyId}Retrieve a Signing Credential Key
IdentityProviderAPILinkUserToIdentityProviderPost /api/v1/idps/{idpId}/users/{userId}Link a User to a Social IdP
IdentityProviderAPIListCsrsForIdentityProviderGet /api/v1/idps/{idpId}/credentials/csrsList all Certificate Signing Requests
IdentityProviderAPIListIdentityProviderApplicationUsersGet /api/v1/idps/{idpId}/usersList all Users
IdentityProviderAPIListIdentityProviderKeysGet /api/v1/idps/credentials/keysList all Credential Keys
IdentityProviderAPIListIdentityProviderSigningKeysGet /api/v1/idps/{idpId}/credentials/keysList all Signing Credential Keys
IdentityProviderAPIListIdentityProvidersGet /api/v1/idpsList all Identity Providers
IdentityProviderAPIListSocialAuthTokensGet /api/v1/idps/{idpId}/users/{userId}/credentials/tokensList all Tokens from a OIDC Identity Provider
IdentityProviderAPIPublishCsrForIdentityProviderPost /api/v1/idps/{idpId}/credentials/csrs/{idpCsrId}/lifecycle/publishPublish a Certificate Signing Request
IdentityProviderAPIReplaceIdentityProviderPut /api/v1/idps/{idpId}Replace an Identity Provider
IdentityProviderAPIRevokeCsrForIdentityProviderDelete /api/v1/idps/{idpId}/credentials/csrs/{idpCsrId}Revoke a Certificate Signing Request
IdentityProviderAPIUnlinkUserFromIdentityProviderDelete /api/v1/idps/{idpId}/users/{userId}Unlink a User from IdP
IdentitySourceAPICreateIdentitySourceSessionPost /api/v1/identity-sources/{identitySourceId}/sessionsCreate an Identity Source Session
IdentitySourceAPIDeleteIdentitySourceSessionDelete /api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}Delete an Identity Source Session
IdentitySourceAPIGetIdentitySourceSessionGet /api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}Retrieve an Identity Source Session
IdentitySourceAPIListIdentitySourceSessionsGet /api/v1/identity-sources/{identitySourceId}/sessionsList all Identity Source Sessions
IdentitySourceAPIStartImportFromIdentitySourcePost /api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/start-importStart the import from the Identity Source
IdentitySourceAPIUploadIdentitySourceDataForDeletePost /api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-deleteUpload the data to be deleted in Okta
IdentitySourceAPIUploadIdentitySourceDataForUpsertPost /api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-upsertUpload the data to be upserted in Okta
InlineHookAPIActivateInlineHookPost /api/v1/inlineHooks/{inlineHookId}/lifecycle/activateActivate an Inline Hook
InlineHookAPICreateInlineHookPost /api/v1/inlineHooksCreate an Inline Hook
InlineHookAPIDeactivateInlineHookPost /api/v1/inlineHooks/{inlineHookId}/lifecycle/deactivateDeactivate an Inline Hook
InlineHookAPIDeleteInlineHookDelete /api/v1/inlineHooks/{inlineHookId}Delete an Inline Hook
InlineHookAPIExecuteInlineHookPost /api/v1/inlineHooks/{inlineHookId}/executeExecute an Inline Hook
InlineHookAPIGetInlineHookGet /api/v1/inlineHooks/{inlineHookId}Retrieve an Inline Hook
InlineHookAPIListInlineHooksGet /api/v1/inlineHooksList all Inline Hooks
InlineHookAPIReplaceInlineHookPut /api/v1/inlineHooks/{inlineHookId}Replace an Inline Hook
LinkedObjectAPICreateLinkedObjectDefinitionPost /api/v1/meta/schemas/user/linkedObjectsCreate a Linked Object Definition
LinkedObjectAPIDeleteLinkedObjectDefinitionDelete /api/v1/meta/schemas/user/linkedObjects/{linkedObjectName}Delete a Linked Object Definition
LinkedObjectAPIGetLinkedObjectDefinitionGet /api/v1/meta/schemas/user/linkedObjects/{linkedObjectName}Retrieve a Linked Object Definition
LinkedObjectAPIListLinkedObjectDefinitionsGet /api/v1/meta/schemas/user/linkedObjectsList all Linked Object Definitions
LogStreamAPIActivateLogStreamPost /api/v1/logStreams/{logStreamId}/lifecycle/activateActivate a Log Stream
LogStreamAPICreateLogStreamPost /api/v1/logStreamsCreate a Log Stream
LogStreamAPIDeactivateLogStreamPost /api/v1/logStreams/{logStreamId}/lifecycle/deactivateDeactivate a Log Stream
LogStreamAPIDeleteLogStreamDelete /api/v1/logStreams/{logStreamId}Delete a Log Stream
LogStreamAPIGetLogStreamGet /api/v1/logStreams/{logStreamId}Retrieve a Log Stream
LogStreamAPIListLogStreamsGet /api/v1/logStreamsList all Log Streams
LogStreamAPIReplaceLogStreamPut /api/v1/logStreams/{logStreamId}Replace a Log Stream
NetworkZoneAPIActivateNetworkZonePost /api/v1/zones/{zoneId}/lifecycle/activateActivate a Network Zone
NetworkZoneAPICreateNetworkZonePost /api/v1/zonesCreate a Network Zone
NetworkZoneAPIDeactivateNetworkZonePost /api/v1/zones/{zoneId}/lifecycle/deactivateDeactivate a Network Zone
NetworkZoneAPIDeleteNetworkZoneDelete /api/v1/zones/{zoneId}Delete a Network Zone
NetworkZoneAPIGetNetworkZoneGet /api/v1/zones/{zoneId}Retrieve a Network Zone
NetworkZoneAPIListNetworkZonesGet /api/v1/zonesList all Network Zones
NetworkZoneAPIReplaceNetworkZonePut /api/v1/zones/{zoneId}Replace a Network Zone
OrgSettingAPIAssignClientPrivilegesSettingPut /api/v1/org/settings/clientPrivilegesSettingAssign the Super Admin role to a public client app
OrgSettingAPIBulkRemoveEmailAddressBouncesPost /api/v1/org/email/bounces/remove-listRemove Emails from Email Provider Bounce List
OrgSettingAPIExtendOktaSupportPost /api/v1/org/privacy/oktaSupport/extendExtend Okta Support Access
OrgSettingAPIGetClientPrivilegesSettingGet /api/v1/org/settings/clientPrivilegesSettingRetrieve the Org settings to assign the Super Admin role
OrgSettingAPIGetOktaCommunicationSettingsGet /api/v1/org/privacy/oktaCommunicationRetrieve the Okta Communication Settings
OrgSettingAPIGetOrgContactTypesGet /api/v1/org/contactsRetrieve the Org Contact Types
OrgSettingAPIGetOrgContactUserGet /api/v1/org/contacts/{contactType}Retrieve the User of the Contact Type
OrgSettingAPIGetOrgOktaSupportSettingsGet /api/v1/org/privacy/oktaSupportRetrieve the Okta Support Settings
OrgSettingAPIGetOrgPreferencesGet /api/v1/org/preferencesRetrieve the Org Preferences
OrgSettingAPIGetOrgSettingsGet /api/v1/orgRetrieve the Org Settings
OrgSettingAPIGetThirdPartyAdminSettingGet /api/v1/org/orgSettings/thirdPartyAdminSettingRetrieve the Org Third-Party Admin setting
OrgSettingAPIGetWellknownOrgMetadataGet /.well-known/okta-organizationRetrieve the Well-Known Org Metadata
OrgSettingAPIGrantOktaSupportPost /api/v1/org/privacy/oktaSupport/grantGrant Okta Support Access to your Org
OrgSettingAPIOptInUsersToOktaCommunicationEmailsPost /api/v1/org/privacy/oktaCommunication/optInOpt in all Users to Okta Communication emails
OrgSettingAPIOptOutUsersFromOktaCommunicationEmailsPost /api/v1/org/privacy/oktaCommunication/optOutOpt out all Users from Okta Communication emails
OrgSettingAPIReplaceOrgContactUserPut /api/v1/org/contacts/{contactType}Replace the User of the Contact Type
OrgSettingAPIReplaceOrgSettingsPut /api/v1/orgReplace the Org Settings
OrgSettingAPIRevokeOktaSupportPost /api/v1/org/privacy/oktaSupport/revokeRevoke Okta Support Access
OrgSettingAPIUpdateOrgHideOktaUIFooterPost /api/v1/org/preferences/hideEndUserFooterUpdate the Preference to Hide the Okta Dashboard Footer
OrgSettingAPIUpdateOrgSettingsPost /api/v1/orgUpdate the Org Settings
OrgSettingAPIUpdateOrgShowOktaUIFooterPost /api/v1/org/preferences/showEndUserFooterUpdate the Preference to Show the Okta Dashboard Footer
OrgSettingAPIUpdateThirdPartyAdminSettingPost /api/v1/org/orgSettings/thirdPartyAdminSettingUpdate the Org Third-Party Admin setting
OrgSettingAPIUploadOrgLogoPost /api/v1/org/logoUpload the Org Logo
PolicyAPIActivatePolicyPost /api/v1/policies/{policyId}/lifecycle/activateActivate a Policy
PolicyAPIActivatePolicyRulePost /api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/activateActivate a Policy Rule
PolicyAPIClonePolicyPost /api/v1/policies/{policyId}/cloneClone an existing Policy
PolicyAPICreatePolicyPost /api/v1/policiesCreate a Policy
PolicyAPICreatePolicyRulePost /api/v1/policies/{policyId}/rulesCreate a Policy Rule
PolicyAPICreatePolicySimulationPost /api/v1/policies/simulateCreate a Policy Simulation
PolicyAPIDeactivatePolicyPost /api/v1/policies/{policyId}/lifecycle/deactivateDeactivate a Policy
PolicyAPIDeactivatePolicyRulePost /api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/deactivateDeactivate a Policy Rule
PolicyAPIDeletePolicyDelete /api/v1/policies/{policyId}Delete a Policy
PolicyAPIDeletePolicyResourceMappingDelete /api/v1/policies/{policyId}/mappings/{mappingId}Delete a policy resource Mapping
PolicyAPIDeletePolicyRuleDelete /api/v1/policies/{policyId}/rules/{ruleId}Delete a Policy Rule
PolicyAPIGetPolicyGet /api/v1/policies/{policyId}Retrieve a Policy
PolicyAPIGetPolicyMappingGet /api/v1/policies/{policyId}/mappings/{mappingId}Retrieve a policy resource Mapping
PolicyAPIGetPolicyRuleGet /api/v1/policies/{policyId}/rules/{ruleId}Retrieve a Policy Rule
PolicyAPIListPoliciesGet /api/v1/policiesList all Policies
PolicyAPIListPolicyAppsGet /api/v1/policies/{policyId}/appList all Applications mapped to a Policy
PolicyAPIListPolicyMappingsGet /api/v1/policies/{policyId}/mappingsList all resources mapped to a Policy
PolicyAPIListPolicyRulesGet /api/v1/policies/{policyId}/rulesList all Policy Rules
PolicyAPIMapResourceToPolicyPost /api/v1/policies/{policyId}/mappingsMap a resource to a Policy
PolicyAPIReplacePolicyPut /api/v1/policies/{policyId}Replace a Policy
PolicyAPIReplacePolicyRulePut /api/v1/policies/{policyId}/rules/{ruleId}Replace a Policy Rule
PrincipalRateLimitAPICreatePrincipalRateLimitEntityPost /api/v1/principal-rate-limitsCreate a Principal Rate Limit
PrincipalRateLimitAPIGetPrincipalRateLimitEntityGet /api/v1/principal-rate-limits/{principalRateLimitId}Retrieve a Principal Rate Limit
PrincipalRateLimitAPIListPrincipalRateLimitEntitiesGet /api/v1/principal-rate-limitsList all Principal Rate Limits
PrincipalRateLimitAPIReplacePrincipalRateLimitEntityPut /api/v1/principal-rate-limits/{principalRateLimitId}Replace a Principal Rate Limit
PrivilegedResourceAPIClaimPrivilegedResourcePost /api/v1/privileged-resource/{id}/claimClaim a privileged resource for management
PrivilegedResourceAPICreatePrivilegedResourcePost /api/v1/privileged-resourceCreate a privileged resource
PrivilegedResourceAPIDeletePrivilegedResourceDelete /api/v1/privileged-resource/{id}Delete a privileged resource
PrivilegedResourceAPIGetPrivilegedResourceGet /api/v1/privileged-resource/{id}Retrieve a privileged resource
PrivilegedResourceAPIReplacePrivilegedResourcePut /api/v1/privileged-resource/{id}Replace a privileged resource
ProfileMappingAPIGetProfileMappingGet /api/v1/mappings/{mappingId}Retrieve a Profile Mapping
ProfileMappingAPIListProfileMappingsGet /api/v1/mappingsList all Profile Mappings
ProfileMappingAPIUpdateProfileMappingPost /api/v1/mappings/{mappingId}Update a Profile Mapping
PushProviderAPICreatePushProviderPost /api/v1/push-providersCreate a Push Provider
PushProviderAPIDeletePushProviderDelete /api/v1/push-providers/{pushProviderId}Delete a Push Provider
PushProviderAPIGetPushProviderGet /api/v1/push-providers/{pushProviderId}Retrieve a Push Provider
PushProviderAPIListPushProvidersGet /api/v1/push-providersList all Push Providers
PushProviderAPIReplacePushProviderPut /api/v1/push-providers/{pushProviderId}Replace a Push Provider
RateLimitSettingsAPIGetRateLimitSettingsAdminNotificationsGet /api/v1/rate-limit-settings/admin-notificationsRetrieve the Rate Limit Admin Notification Settings
RateLimitSettingsAPIGetRateLimitSettingsPerClientGet /api/v1/rate-limit-settings/per-clientRetrieve the Per-Client Rate Limit Settings
RateLimitSettingsAPIGetRateLimitSettingsWarningThresholdGet /api/v1/rate-limit-settings/warning-thresholdRetrieve the Rate Limit Warning Threshold Percentage
RateLimitSettingsAPIReplaceRateLimitSettingsAdminNotificationsPut /api/v1/rate-limit-settings/admin-notificationsReplace the Rate Limit Admin Notification Settings
RateLimitSettingsAPIReplaceRateLimitSettingsPerClientPut /api/v1/rate-limit-settings/per-clientReplace the Per-Client Rate Limit Settings
RateLimitSettingsAPIReplaceRateLimitSettingsWarningThresholdPut /api/v1/rate-limit-settings/warning-thresholdReplace the Rate Limit Warning Threshold Percentage
RealmAPICreateRealmPost /api/v1/realmsCreate a Realm
RealmAPIDeleteRealmDelete /api/v1/realms/{realmId}Delete a Realm
RealmAPIGetRealmGet /api/v1/realms/{realmId}Retrieve a Realm
RealmAPIListRealmsGet /api/v1/realmsList all Realms
RealmAPIReplaceRealmPut /api/v1/realms/{realmId}Replace the realm profile
RealmAssignmentAPIActivateRealmAssignmentPost /api/v1/realm-assignments/{assignmentId}/lifecycle/activateActivate a Realm Assignment
RealmAssignmentAPICreateRealmAssignmentPost /api/v1/realm-assignmentsCreate a Realm Assignment
RealmAssignmentAPIDeactivateRealmAssignmentPost /api/v1/realm-assignments/{assignmentId}/lifecycle/deactivateDeactivate a Realm Assignment
RealmAssignmentAPIDeleteRealmAssignmentDelete /api/v1/realm-assignments/{assignmentId}Delete a Realm Assignment
RealmAssignmentAPIExecuteRealmAssignmentPost /api/v1/realm-assignments/operationsExecute a Realm Assignment
RealmAssignmentAPIGetRealmAssignmentGet /api/v1/realm-assignments/{assignmentId}Retrieve a Realm Assignment
RealmAssignmentAPIListRealmAssignmentOperationsGet /api/v1/realm-assignments/operationsList all Realm Assignment operations
RealmAssignmentAPIListRealmAssignmentsGet /api/v1/realm-assignmentsList all Realm Assignments
RealmAssignmentAPIReplaceRealmAssignmentPut /api/v1/realm-assignments/{assignmentId}Replace a Realm Assignment
ResourceSelectorsAPICreateResourceSelectorPost /api/v1/resource-selectorsCreate a Resource Selector
ResourceSelectorsAPIDeleteResourceSelectorDelete /api/v1/resource-selectors/{resourceSelectorId}Delete a Resource Selector
ResourceSelectorsAPIGetResourceSelectorGet /api/v1/resource-selectors/{resourceSelectorId}Retrieve a Resource Selector
ResourceSelectorsAPIListResourceSelectorsGet /api/v1/resource-selectorsList all Resource Selectors
ResourceSelectorsAPIUpdateResourceSelectorPatch /api/v1/resource-selectors/{resourceSelectorId}Update a Resource Selector
ResourceSetAPIAddMembersToBindingPatch /api/v1/iam/resource-sets/{resourceSetId}/bindings/{roleIdOrLabel}/membersAdd more Members to a binding
ResourceSetAPIAddResourceSetResourcePatch /api/v1/iam/resource-sets/{resourceSetId}/resourcesAdd more Resource to a Resource Set
ResourceSetAPICreateResourceSetPost /api/v1/iam/resource-setsCreate a Resource Set
ResourceSetAPICreateResourceSetBindingPost /api/v1/iam/resource-sets/{resourceSetId}/bindingsCreate a Resource Set Binding
ResourceSetAPIDeleteBindingDelete /api/v1/iam/resource-sets/{resourceSetId}/bindings/{roleIdOrLabel}Delete a Binding
ResourceSetAPIDeleteResourceSetDelete /api/v1/iam/resource-sets/{resourceSetId}Delete a Resource Set
ResourceSetAPIDeleteResourceSetResourceDelete /api/v1/iam/resource-sets/{resourceSetId}/resources/{resourceId}Delete a Resource from a Resource Set
ResourceSetAPIGetBindingGet /api/v1/iam/resource-sets/{resourceSetId}/bindings/{roleIdOrLabel}Retrieve a Binding
ResourceSetAPIGetMemberOfBindingGet /api/v1/iam/resource-sets/{resourceSetId}/bindings/{roleIdOrLabel}/members/{memberId}Retrieve a Member of a binding
ResourceSetAPIGetResourceSetGet /api/v1/iam/resource-sets/{resourceSetId}Retrieve a Resource Set
ResourceSetAPIListBindingsGet /api/v1/iam/resource-sets/{resourceSetId}/bindingsList all Bindings
ResourceSetAPIListMembersOfBindingGet /api/v1/iam/resource-sets/{resourceSetId}/bindings/{roleIdOrLabel}/membersList all Members of a binding
ResourceSetAPIListResourceSetResourcesGet /api/v1/iam/resource-sets/{resourceSetId}/resourcesList all Resources of a Resource Set
ResourceSetAPIListResourceSetsGet /api/v1/iam/resource-setsList all Resource Sets
ResourceSetAPIReplaceResourceSetPut /api/v1/iam/resource-sets/{resourceSetId}Replace a Resource Set
ResourceSetAPIUnassignMemberFromBindingDelete /api/v1/iam/resource-sets/{resourceSetId}/bindings/{roleIdOrLabel}/members/{memberId}Unassign a Member from a binding
RiskEventAPISendRiskEventsPost /api/v1/risk/events/ipSend multiple Risk Events
RiskProviderAPICreateRiskProviderPost /api/v1/risk/providersCreate a Risk Provider
RiskProviderAPIDeleteRiskProviderDelete /api/v1/risk/providers/{riskProviderId}Delete a Risk Provider
RiskProviderAPIGetRiskProviderGet /api/v1/risk/providers/{riskProviderId}Retrieve a Risk Provider
RiskProviderAPIListRiskProvidersGet /api/v1/risk/providersList all Risk Providers
RiskProviderAPIReplaceRiskProviderPut /api/v1/risk/providers/{riskProviderId}Replace a Risk Provider
RoleAPICreateRolePost /api/v1/iam/rolesCreate a Role
RoleAPICreateRolePermissionPost /api/v1/iam/roles/{roleIdOrLabel}/permissions/{permissionType}Create a Permission
RoleAPIDeleteRoleDelete /api/v1/iam/roles/{roleIdOrLabel}Delete a Role
RoleAPIDeleteRolePermissionDelete /api/v1/iam/roles/{roleIdOrLabel}/permissions/{permissionType}Delete a Permission
RoleAPIGetRoleGet /api/v1/iam/roles/{roleIdOrLabel}Retrieve a Role
RoleAPIGetRolePermissionGet /api/v1/iam/roles/{roleIdOrLabel}/permissions/{permissionType}Retrieve a Permission
RoleAPIListRolePermissionsGet /api/v1/iam/roles/{roleIdOrLabel}/permissionsList all Permissions
RoleAPIListRolesGet /api/v1/iam/rolesList all Roles
RoleAPIReplaceRolePut /api/v1/iam/roles/{roleIdOrLabel}Replace a Role
RoleAPIReplaceRolePermissionPut /api/v1/iam/roles/{roleIdOrLabel}/permissions/{permissionType}Replace a Permission
RoleAssignmentAPIAssignRoleToGroupPost /api/v1/groups/{groupId}/rolesAssign a Role to a Group
RoleAssignmentAPIAssignRoleToUserPost /api/v1/users/{userId}/rolesAssign a Role to a User
RoleAssignmentAPIGetGroupAssignedRoleGet /api/v1/groups/{groupId}/roles/{roleId}Retrieve a Role assigned to Group
RoleAssignmentAPIGetUserAssignedRoleGet /api/v1/users/{userId}/roles/{roleId}Retrieve a Role assigned to a User
RoleAssignmentAPIListAssignedRolesForUserGet /api/v1/users/{userId}/rolesList all Roles assigned to a User
RoleAssignmentAPIListGroupAssignedRolesGet /api/v1/groups/{groupId}/rolesList all Assigned Roles of Group
RoleAssignmentAPIListUsersWithRoleAssignmentsGet /api/v1/iam/assignees/usersList all Users with Role Assignments
RoleAssignmentAPIUnassignRoleFromGroupDelete /api/v1/groups/{groupId}/roles/{roleId}Unassign a Role from a Group
RoleAssignmentAPIUnassignRoleFromUserDelete /api/v1/users/{userId}/roles/{roleId}Unassign a Role from a User
RoleTargetAPIAssignAllAppsAsTargetToRoleForUserPut /api/v1/users/{userId}/roles/{roleId}/targets/catalog/appsAssign all Apps as Target to Role
RoleTargetAPIAssignAppInstanceTargetToAppAdminRoleForGroupPut /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}/{appId}Assign an Application Instance Target to Application Administrator Role
RoleTargetAPIAssignAppInstanceTargetToAppAdminRoleForUserPut /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}/{appId}Assign an Application Instance Target to an Application Administrator Role
RoleTargetAPIAssignAppTargetToAdminRoleForGroupPut /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}Assign an Application Target to Administrator Role
RoleTargetAPIAssignAppTargetToAdminRoleForUserPut /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}Assign an Application Target to Administrator Role
RoleTargetAPIAssignGroupTargetToGroupAdminRolePut /api/v1/groups/{groupId}/roles/{roleId}/targets/groups/{targetGroupId}Assign a Group Target to a Group Role
RoleTargetAPIAssignGroupTargetToUserRolePut /api/v1/users/{userId}/roles/{roleId}/targets/groups/{groupId}Assign a Group Target to Role
RoleTargetAPIListApplicationTargetsForApplicationAdministratorRoleForGroupGet /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/appsList all Application Targets for an Application Administrator Role
RoleTargetAPIListApplicationTargetsForApplicationAdministratorRoleForUserGet /api/v1/users/{userId}/roles/{roleId}/targets/catalog/appsList all Application Targets for Application Administrator Role
RoleTargetAPIListGroupTargetsForGroupRoleGet /api/v1/groups/{groupId}/roles/{roleId}/targets/groupsList all Group Targets for a Group Role
RoleTargetAPIListGroupTargetsForRoleGet /api/v1/users/{userId}/roles/{roleId}/targets/groupsList all Group Targets for Role
RoleTargetAPIUnassignAppInstanceTargetFromAdminRoleForUserDelete /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}/{appId}Unassign an Application Instance Target from an Application Administrator Role
RoleTargetAPIUnassignAppInstanceTargetToAppAdminRoleForGroupDelete /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}/{appId}Unassign an Application Instance Target from an Application Administrator Role
RoleTargetAPIUnassignAppTargetFromAppAdminRoleForUserDelete /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}Unassign an Application Target from an Application Administrator Role
RoleTargetAPIUnassignAppTargetToAdminRoleForGroupDelete /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}Unassign an Application Target from Application Administrator Role
RoleTargetAPIUnassignGroupTargetFromGroupAdminRoleDelete /api/v1/groups/{groupId}/roles/{roleId}/targets/groups/{targetGroupId}Unassign a Group Target from a Group Role
RoleTargetAPIUnassignGroupTargetFromUserAdminRoleDelete /api/v1/users/{userId}/roles/{roleId}/targets/groups/{groupId}Unassign a Group Target from Role
SchemaAPIGetAppUISchemaGet /api/v1/meta/layouts/apps/{appName}/sections/{section}/{operation}Retrieve the UI schema for a section
SchemaAPIGetAppUISchemaLinksGet /api/v1/meta/layouts/apps/{appName}Retrieve the links for UI schemas for an Application
SchemaAPIGetApplicationUserSchemaGet /api/v1/meta/schemas/apps/{appId}/defaultRetrieve the default Application User Schema for an Application
SchemaAPIGetGroupSchemaGet /api/v1/meta/schemas/group/defaultRetrieve the default Group Schema
SchemaAPIGetLogStreamSchemaGet /api/v1/meta/schemas/logStream/{logStreamType}Retrieve the Log Stream Schema for the schema type
SchemaAPIGetUserSchemaGet /api/v1/meta/schemas/user/{schemaId}Retrieve a User Schema
SchemaAPIListLogStreamSchemasGet /api/v1/meta/schemas/logStreamList the Log Stream Schemas
SchemaAPIUpdateApplicationUserProfilePost /api/v1/meta/schemas/apps/{appId}/defaultUpdate the default Application User Schema for an Application
SchemaAPIUpdateGroupSchemaPost /api/v1/meta/schemas/group/defaultUpdate the default Group Schema
SchemaAPIUpdateUserProfilePost /api/v1/meta/schemas/user/{schemaId}Update a User Schema
SessionAPICloseCurrentSessionDelete /api/v1/sessions/meClose the current Session
SessionAPICreateSessionPost /api/v1/sessionsCreate a Session with session token
SessionAPIGetCurrentSessionGet /api/v1/sessions/meRetrieve the current Session
SessionAPIGetSessionGet /api/v1/sessions/{sessionId}Retrieve a Session
SessionAPIRefreshCurrentSessionPost /api/v1/sessions/me/lifecycle/refreshRefresh the current Session
SessionAPIRefreshSessionPost /api/v1/sessions/{sessionId}/lifecycle/refreshRefresh a Session
SessionAPIRevokeSessionDelete /api/v1/sessions/{sessionId}Revoke a Session
SubscriptionAPIGetSubscriptionsNotificationTypeRoleGet /api/v1/roles/{roleRef}/subscriptions/{notificationType}Retrieve a Subscription for a Role
SubscriptionAPIGetSubscriptionsNotificationTypeUserGet /api/v1/users/{userId}/subscriptions/{notificationType}Retrieve a Subscription for a User
SubscriptionAPIListSubscriptionsRoleGet /api/v1/roles/{roleRef}/subscriptionsList all Subscriptions for a Role
SubscriptionAPIListSubscriptionsUserGet /api/v1/users/{userId}/subscriptionsList all Subscriptions for a User
SubscriptionAPISubscribeByNotificationTypeRolePost /api/v1/roles/{roleRef}/subscriptions/{notificationType}/subscribeSubscribe a Role to a Specific Notification Type
SubscriptionAPISubscribeByNotificationTypeUserPost /api/v1/users/{userId}/subscriptions/{notificationType}/subscribeSubscribe a User to a Specific Notification Type
SubscriptionAPIUnsubscribeByNotificationTypeRolePost /api/v1/roles/{roleRef}/subscriptions/{notificationType}/unsubscribeUnsubscribe a Role from a Specific Notification Type
SubscriptionAPIUnsubscribeByNotificationTypeUserPost /api/v1/users/{userId}/subscriptions/{notificationType}/unsubscribeUnsubscribe a User from a Specific Notification Type
SystemLogAPIListLogEventsGet /api/v1/logsList all System Log Events
TemplateAPICreateSmsTemplatePost /api/v1/templates/smsCreate an SMS Template
TemplateAPIDeleteSmsTemplateDelete /api/v1/templates/sms/{templateId}Delete an SMS Template
TemplateAPIGetSmsTemplateGet /api/v1/templates/sms/{templateId}Retrieve an SMS Template
TemplateAPIListSmsTemplatesGet /api/v1/templates/smsList all SMS Templates
TemplateAPIReplaceSmsTemplatePut /api/v1/templates/sms/{templateId}Replace an SMS Template
TemplateAPIUpdateSmsTemplatePost /api/v1/templates/sms/{templateId}Update an SMS Template
ThreatInsightAPIGetCurrentConfigurationGet /api/v1/threats/configurationRetrieve the ThreatInsight Configuration
ThreatInsightAPIUpdateConfigurationPost /api/v1/threats/configurationUpdate the ThreatInsight Configuration
TrustedOriginAPIActivateTrustedOriginPost /api/v1/trustedOrigins/{trustedOriginId}/lifecycle/activateActivate a Trusted Origin
TrustedOriginAPICreateTrustedOriginPost /api/v1/trustedOriginsCreate a Trusted Origin
TrustedOriginAPIDeactivateTrustedOriginPost /api/v1/trustedOrigins/{trustedOriginId}/lifecycle/deactivateDeactivate a Trusted Origin
TrustedOriginAPIDeleteTrustedOriginDelete /api/v1/trustedOrigins/{trustedOriginId}Delete a Trusted Origin
TrustedOriginAPIGetTrustedOriginGet /api/v1/trustedOrigins/{trustedOriginId}Retrieve a Trusted Origin
TrustedOriginAPIListTrustedOriginsGet /api/v1/trustedOriginsList all Trusted Origins
TrustedOriginAPIReplaceTrustedOriginPut /api/v1/trustedOrigins/{trustedOriginId}Replace a Trusted Origin
UISchemaAPICreateUISchemaPost /api/v1/meta/uischemasCreate a UI Schema
UISchemaAPIDeleteUISchemasDelete /api/v1/meta/uischemas/{id}Delete a UI Schema
UISchemaAPIGetUISchemaGet /api/v1/meta/uischemas/{id}Retrieve a UI Schema
UISchemaAPIListUISchemasGet /api/v1/meta/uischemasList all UI Schemas
UISchemaAPIReplaceUISchemasPut /api/v1/meta/uischemas/{id}Replace a UI Schema
UserAPIActivateUserPost /api/v1/users/{userId}/lifecycle/activateActivate a User
UserAPIChangePasswordPost /api/v1/users/{userId}/credentials/change_passwordChange Password
UserAPIChangeRecoveryQuestionPost /api/v1/users/{userId}/credentials/change_recovery_questionChange Recovery Question
UserAPICreateUserPost /api/v1/usersCreate a User
UserAPIDeactivateUserPost /api/v1/users/{userId}/lifecycle/deactivateDeactivate a User
UserAPIDeleteLinkedObjectForUserDelete /api/v1/users/{userId}/linkedObjects/{relationshipName}Delete a Linked Object
UserAPIDeleteUserDelete /api/v1/users/{userId}Delete a User
UserAPIExpirePasswordPost /api/v1/users/{userId}/lifecycle/expire_passwordExpire Password
UserAPIExpirePasswordAndGetTemporaryPasswordPost /api/v1/users/{userId}/lifecycle/expire_password_with_temp_passwordExpire Password and Set Temporary Password
UserAPIForgotPasswordPost /api/v1/users/{userId}/credentials/forgot_passwordInitiate Forgot Password
UserAPIForgotPasswordSetNewPasswordPost /api/v1/users/{userId}/credentials/forgot_password_recovery_questionReset Password with Recovery Question
UserAPIGenerateResetPasswordTokenPost /api/v1/users/{userId}/lifecycle/reset_passwordGenerate a Reset Password Token
UserAPIGetRefreshTokenForUserAndClientGet /api/v1/users/{userId}/clients/{clientId}/tokens/{tokenId}Retrieve a Refresh Token for a Client
UserAPIGetUserGet /api/v1/users/{userId}Retrieve a User
UserAPIGetUserGrantGet /api/v1/users/{userId}/grants/{grantId}Retrieve a User Grant
UserAPIListAppLinksGet /api/v1/users/{userId}/appLinksList all Assigned Application Links
UserAPIListGrantsForUserAndClientGet /api/v1/users/{userId}/clients/{clientId}/grantsList all Grants for a Client
UserAPIListLinkedObjectsForUserGet /api/v1/users/{userId}/linkedObjects/{relationshipName}List all Linked Objects
UserAPIListRefreshTokensForUserAndClientGet /api/v1/users/{userId}/clients/{clientId}/tokensList all Refresh Tokens for a Client
UserAPIListUserBlocksGet /api/v1/users/{userId}/blocksList all User Blocks
UserAPIListUserClientsGet /api/v1/users/{userId}/clientsList all Clients
UserAPIListUserGrantsGet /api/v1/users/{userId}/grantsList all User Grants
UserAPIListUserGroupsGet /api/v1/users/{userId}/groupsList all Groups
UserAPIListUserIdentityProvidersGet /api/v1/users/{userId}/idpsList all Identity Providers
UserAPIListUsersGet /api/v1/usersList all Users
UserAPIReactivateUserPost /api/v1/users/{userId}/lifecycle/reactivateReactivate a User
UserAPIReplaceUserPut /api/v1/users/{userId}Replace a User
UserAPIResetFactorsPost /api/v1/users/{userId}/lifecycle/reset_factorsReset all Factors
UserAPIRevokeGrantsForUserAndClientDelete /api/v1/users/{userId}/clients/{clientId}/grantsRevoke all Grants for a Client
UserAPIRevokeTokenForUserAndClientDelete /api/v1/users/{userId}/clients/{clientId}/tokens/{tokenId}Revoke a Token for a Client
UserAPIRevokeTokensForUserAndClientDelete /api/v1/users/{userId}/clients/{clientId}/tokensRevoke all Refresh Tokens for a Client
UserAPIRevokeUserGrantDelete /api/v1/users/{userId}/grants/{grantId}Revoke a User Grant
UserAPIRevokeUserGrantsDelete /api/v1/users/{userId}/grantsRevoke all User Grants
UserAPIRevokeUserSessionsDelete /api/v1/users/{userId}/sessionsRevoke all User Sessions
UserAPISetLinkedObjectForUserPut /api/v1/users/{userId}/linkedObjects/{primaryRelationshipName}/{primaryUserId}Create a Linked Object for two Users
UserAPISuspendUserPost /api/v1/users/{userId}/lifecycle/suspendSuspend a User
UserAPIUnlockUserPost /api/v1/users/{userId}/lifecycle/unlockUnlock a User
UserAPIUnsuspendUserPost /api/v1/users/{userId}/lifecycle/unsuspendUnsuspend a User
UserAPIUpdateUserPost /api/v1/users/{userId}Update a User
UserFactorAPIActivateFactorPost /api/v1/users/{userId}/factors/{factorId}/lifecycle/activateActivate a Factor
UserFactorAPIEnrollFactorPost /api/v1/users/{userId}/factorsEnroll a Factor
UserFactorAPIGetFactorGet /api/v1/users/{userId}/factors/{factorId}Retrieve a Factor
UserFactorAPIGetFactorTransactionStatusGet /api/v1/users/{userId}/factors/{factorId}/transactions/{transactionId}Retrieve a Factor transaction status
UserFactorAPIListFactorsGet /api/v1/users/{userId}/factorsList all enrolled Factors
UserFactorAPIListSupportedFactorsGet /api/v1/users/{userId}/factors/catalogList all supported Factors
UserFactorAPIListSupportedSecurityQuestionsGet /api/v1/users/{userId}/factors/questionsList all supported Security Questions
UserFactorAPIResendEnrollFactorPost /api/v1/users/{userId}/factors/{factorId}/resendResend a Factor enrollment
UserFactorAPIUnenrollFactorDelete /api/v1/users/{userId}/factors/{factorId}Unenroll a Factor
UserFactorAPIVerifyFactorPost /api/v1/users/{userId}/factors/{factorId}/verifyVerify a Factor
UserTypeAPICreateUserTypePost /api/v1/meta/types/userCreate a User Type
UserTypeAPIDeleteUserTypeDelete /api/v1/meta/types/user/{typeId}Delete a User Type
UserTypeAPIGetUserTypeGet /api/v1/meta/types/user/{typeId}Retrieve a User Type
UserTypeAPIListUserTypesGet /api/v1/meta/types/userList all User Types
UserTypeAPIReplaceUserTypePut /api/v1/meta/types/user/{typeId}Replace a User Type
UserTypeAPIUpdateUserTypePost /api/v1/meta/types/user/{typeId}Update a User Type
WebAuthnPreregistrationAPIActivatePreregistrationEnrollmentPost /webauthn-registration/api/v1/activateActivate a Preregistered WebAuthn Factor
WebAuthnPreregistrationAPIDeleteWebAuthnPreregistrationFactorDelete /webauthn-registration/api/v1/users/{userId}/enrollments/{authenticatorEnrollmentId}Delete a WebAuthn Preregistration Factor
WebAuthnPreregistrationAPIEnrollPreregistrationEnrollmentPost /webauthn-registration/api/v1/enrollEnroll a Preregistered WebAuthn Factor
WebAuthnPreregistrationAPIGenerateFulfillmentRequestPost /webauthn-registration/api/v1/initiate-fulfillment-requestGenerate a Fulfillment Request
WebAuthnPreregistrationAPIListWebAuthnPreregistrationFactorsGet /webauthn-registration/api/v1/users/{userId}/enrollmentsList all WebAuthn Preregistration Factors
WebAuthnPreregistrationAPISendPinPost /webauthn-registration/api/v1/send-pinSend a PIN to user
YourOinIntegrationsAPICreateSubmissionPost /integrations/api/v1/submissionsCreate an OIN Integration
YourOinIntegrationsAPIGetSubmissionByOperationIdGet /integrations/api/v1/submissions/{submissionId}Retrieve an OIN Integration
YourOinIntegrationsAPIGetSubmissionTestInfoGet /integrations/api/v1/submissions/{submissionId}/testingRetrieve an OIN Integration Testing Information
YourOinIntegrationsAPIListSubmissionsGet /integrations/api/v1/submissionsList all OIN Integrations
YourOinIntegrationsAPIReplaceSubmissionPut /integrations/api/v1/submissions/{submissionId}Replace an OIN Integration
YourOinIntegrationsAPISubmitSubmissionPost /integrations/api/v1/submissions/{submissionId}/submitSubmit an OIN Integration
YourOinIntegrationsAPIUploadSubmissionLogoPost /integrations/api/v1/submissions/logoUpload an OIN Integration logo
YourOinIntegrationsAPIUpsertSubmissionTestInfoPut /integrations/api/v1/submissions/{submissionId}/testingUpsert an OIN Integration Testing Information

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

apiToken

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: Authorization and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		sw.ContextAPIKeys,
		map[string]sw.APIKey{
			"Authorization": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

oauth2

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: /oauth2/v1/authorize
  • Scopes:
  • okta.agentPools.manage: Allows the app to create and manage agent pools in your Okta organization.
  • okta.agentPools.read: Allows the app to read agent pools in your Okta organization.
  • okta.apiTokens.manage: Allows the app to manage API Tokens in your Okta organization.
  • okta.apiTokens.read: Allows the app to read API Tokens in your Okta organization.
  • okta.appGrants.manage: Allows the app to create and manage grants in your Okta organization.
  • okta.appGrants.read: Allows the app to read grants in your Okta organization.
  • okta.apps.manage: Allows the app to create and manage Apps in your Okta organization.
  • okta.apps.read: Allows the app to read information about Apps in your Okta organization.
  • okta.authenticators.manage: Allows the app to manage all authenticators (e.g. enrollments, reset).
  • okta.authenticators.read: Allows the app to read org authenticators information.
  • okta.authorizationServers.manage: Allows the app to create and manage Authorization Servers in your Okta organization.
  • okta.authorizationServers.read: Allows the app to read information about Authorization Servers in your Okta organization.
  • okta.behaviors.manage: Allows the app to create and manage behavior detection rules in your Okta organization.
  • okta.behaviors.read: Allows the app to read behavior detection rules in your Okta organization.
  • okta.brands.manage: Allows the app to create and manage Brands and Themes in your Okta organization.
  • okta.brands.read: Allows the app to read information about Brands and Themes in your Okta organization.
  • okta.captchas.manage: Allows the app to create and manage CAPTCHAs in your Okta organization.
  • okta.captchas.read: Allows the app to read information about CAPTCHAs in your Okta organization.
  • okta.deviceAssurance.manage: Allows the app to manage device assurances.
  • okta.deviceAssurance.read: Allows the app to read device assurances.
  • okta.devices.manage: Allows the app to manage device status transitions and delete a device.
  • okta.devices.read: Allows the app to read the existing device's profile and search devices.
  • okta.domains.manage: Allows the app to manage custom Domains for your Okta organization.
  • okta.domains.read: Allows the app to read information about custom Domains for your Okta organization.
  • okta.emailDomains.manage: Allows the app to manage Email Domains for your Okta organization.
  • okta.emailDomains.read: Allows the app to read information about Email Domains for your Okta organization.
  • okta.emailServers.manage: Allows the app to manage Email Servers for your Okta organization.
  • okta.emailServers.read: Allows the app to read information about Email Servers for your Okta organization.
  • okta.eventHooks.manage: Allows the app to create and manage Event Hooks in your Okta organization.
  • okta.eventHooks.read: Allows the app to read information about Event Hooks in your Okta organization.
  • okta.features.manage: Allows the app to create and manage Features in your Okta organization.
  • okta.features.read: Allows the app to read information about Features in your Okta organization.
  • okta.groups.manage: Allows the app to manage existing groups in your Okta organization.
  • okta.groups.read: Allows the app to read information about groups and their members in your Okta organization.
  • okta.identitySources.manage: Allows the custom identity sources to manage user entities in your Okta organization
  • okta.identitySources.read: Allows to read session information for custom identity sources in your Okta organization
  • okta.idps.manage: Allows the app to create and manage Identity Providers in your Okta organization.
  • okta.idps.read: Allows the app to read information about Identity Providers in your Okta organization.
  • okta.inlineHooks.manage: Allows the app to create and manage Inline Hooks in your Okta organization.
  • okta.inlineHooks.read: Allows the app to read information about Inline Hooks in your Okta organization.
  • okta.linkedObjects.manage: Allows the app to manage linked object definitions in your Okta organization.
  • okta.linkedObjects.read: Allows the app to read linked object definitions in your Okta organization.
  • okta.logStreams.manage: Allows the app to create and manage log streams in your Okta organization.
  • okta.logStreams.read: Allows the app to read information about log streams in your Okta organization.
  • okta.logs.read: Allows the app to read information about System Log entries in your Okta organization.
  • okta.manifests.manage: Allows the app to manage OIN submissions in your Okta organization.
  • okta.manifests.read: Allows the app to read OIN submissions in your Okta organization.
  • okta.networkZones.manage: Allows the app to create and manage Network Zones in your Okta organization.
  • okta.networkZones.read: Allows the app to read Network Zones in your Okta organization.
  • okta.oauthIntegrations.manage: Allows the app to create and manage API service Integration instances in your Okta organization.
  • okta.oauthIntegrations.read: Allows the app to read API service Integration instances in your Okta organization.
  • okta.orgs.manage: Allows the app to manage organization-specific details for your Okta organization.
  • okta.orgs.read: Allows the app to read organization-specific details about your Okta organization.
  • okta.policies.manage: Allows the app to manage policies in your Okta organization.
  • okta.policies.read: Allows the app to read information about policies in your Okta organization.
  • okta.principalRateLimits.manage: Allows the app to create and manage Principal Rate Limits in your Okta organization.
  • okta.principalRateLimits.read: Allows the app to read information about Principal Rate Limits in your Okta organization.
  • okta.profileMappings.manage: Allows the app to manage user profile mappings in your Okta organization.
  • okta.profileMappings.read: Allows the app to read user profile mappings in your Okta organization.
  • okta.pushProviders.manage: Allows the app to create and manage push notification providers such as APNs and FCM.
  • okta.pushProviders.read: Allows the app to read push notification providers such as APNs and FCM.
  • okta.rateLimits.manage: Allows the app to create and manage rate limits in your Okta organization.
  • okta.rateLimits.read: Allows the app to read information about rate limits in your Okta organization.
  • okta.realmAssignments.manage: Allows a user to manage realm assignments.
  • okta.realmAssignments.read: Allows a user to read realm assignments.
  • okta.realms.manage: Allows the app to create new realms and to manage their details.
  • okta.realms.read: Allows the app to read the existing realms and their details.
  • okta.resourceSelectors.manage: Allows the app to manage resource selectors in your Okta org.
  • okta.resourceSelectors.read: Allows the app to read resource selectors in your Okta org.
  • okta.riskEvents.manage: Allows the app to publish risk events to your Okta organization.
  • okta.riskProviders.manage: Allows the app to create and manage risk provider integrations in your Okta organization.
  • okta.riskProviders.read: Allows the app to read all risk provider integrations in your Okta organization.
  • okta.roles.manage: Allows the app to manage administrative role assignments for users in your Okta organization. Delegated admins with this permission can only manage user credential fields and not the credential values themselves.
  • okta.roles.read: Allows the app to read administrative role assignments for users in your Okta organization. Delegated admins with this permission can only manage user credential fields and not the credential values themselves.
  • okta.schemas.manage: Allows the app to create and manage Schemas in your Okta organization.
  • okta.schemas.read: Allows the app to read information about Schemas in your Okta organization.
  • okta.securityEventsProviders.manage: Allows the app to create and manage Security Events Providers in your Okta organization.
  • okta.securityEventsProviders.read: Allows the app to read information about Security Events Providers in your Okta organization.
  • okta.sessions.manage: Allows the app to manage all sessions in your Okta organization.
  • okta.sessions.read: Allows the app to read all sessions in your Okta organization.
  • okta.templates.manage: Allows the app to manage all custom templates in your Okta organization.
  • okta.templates.read: Allows the app to read all custom templates in your Okta organization.
  • okta.threatInsights.manage: Allows the app to manage all ThreatInsight configurations in your Okta organization.
  • okta.threatInsights.read: Allows the app to read all ThreatInsight configurations in your Okta organization.
  • okta.trustedOrigins.manage: Allows the app to manage all Trusted Origins in your Okta organization.
  • okta.trustedOrigins.read: Allows the app to read all Trusted Origins in your Okta organization.
  • okta.uischemas.manage: Allows the app to manage all the UI Schemas in your Okta organization.
  • okta.uischemas.read: Allows the app to read all the UI Schemas in your Okta organization.
  • okta.userTypes.manage: Allows the app to manage user types in your Okta organization.
  • okta.userTypes.read: Allows the app to read user types in your Okta organization.
  • okta.users.manage: Allows the app to create new users and to manage all users' profile and credentials information.
  • okta.users.read: Allows the app to read the existing users' profiles and credentials.

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

[email protected]