okta

package
v3.0.14 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 18, 2022 License: Apache-2.0 Imports: 36 Imported by: 0

README

Go API client for okta

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: 4.0.0
  • Package version: 3.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://developer.okta.com/

Getting started

  • Install the OpenAPI generator CLI
  • Run openapi-generator generate -c ./.generator/config.yaml -i .generator/okta-management-APIs-oasv3-enum-inheritance.yaml

Note that config.yaml contains all the configuration required (templates, supporting files, global configuration, etc) to generate the Okta SDK. For more details about the generator's customization visit this link.

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 okta "github.com/duytiennguyen-okta/okta-sdk-golang"

To use a proxy, set the environment variable HTTP_PROXY or use configuration in okta.Configuration.Okta.Client.Proxy. In the event that environment variable and configuration are both set, the configuration will take precedence.

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(), okta.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(), okta.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(), okta.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), okta.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

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

Class Method HTTP request Description
AgentPoolsApi ActivateAgentPoolsUpdate Post /api/v1/agentPools/{poolId}/updates/{updateId}/activate Activate an Agent Pool update
AgentPoolsApi CreateAgentPoolsUpdate Post /api/v1/agentPools/{poolId}/updates Create an Agent Pool update
AgentPoolsApi DeactivateAgentPoolsUpdate Post /api/v1/agentPools/{poolId}/updates/{updateId}/deactivate Deactivate an Agent Pool update
AgentPoolsApi DeleteAgentPoolsUpdate Delete /api/v1/agentPools/{poolId}/updates/{updateId} Delete an Agent Pool update
AgentPoolsApi GetAgentPoolsUpdateInstance Get /api/v1/agentPools/{poolId}/updates/{updateId} Retrieve an Agent Pool update by id
AgentPoolsApi GetAgentPoolsUpdateSettings Get /api/v1/agentPools/{poolId}/updates/settings Retrieve an Agent Pool update's settings
AgentPoolsApi ListAgentPools Get /api/v1/agentPools List all Agent Pools
AgentPoolsApi ListAgentPoolsUpdates Get /api/v1/agentPools/{poolId}/updates List all Agent Pool updates
AgentPoolsApi PauseAgentPoolsUpdate Post /api/v1/agentPools/{poolId}/updates/{updateId}/pause Pause an Agent Pool update
AgentPoolsApi ResumeAgentPoolsUpdate Post /api/v1/agentPools/{poolId}/updates/{updateId}/resume Resume an Agent Pool update
AgentPoolsApi RetryAgentPoolsUpdate Post /api/v1/agentPools/{poolId}/updates/{updateId}/retry Retry an Agent Pool update
AgentPoolsApi StopAgentPoolsUpdate Post /api/v1/agentPools/{poolId}/updates/{updateId}/stop Stop an Agent Pool update
AgentPoolsApi UpdateAgentPoolsUpdate Post /api/v1/agentPools/{poolId}/updates/{updateId} Update an Agent Pool update by id
AgentPoolsApi UpdateAgentPoolsUpdateSettings Post /api/v1/agentPools/{poolId}/updates/settings Update an Agent Pool update settings
ApiTokenApi GetApiToken Get /api/v1/api-tokens/{apiTokenId} Retrieve an API Token's Metadata
ApiTokenApi ListApiTokens Get /api/v1/api-tokens List all API Token Metadata
ApiTokenApi RevokeApiToken Delete /api/v1/api-tokens/{apiTokenId} Revoke an API Token
ApiTokenApi RevokeCurrentApiToken Delete /api/v1/api-tokens/current Revoke the Current API Token
ApplicationApi ActivateApplication Post /api/v1/apps/{appId}/lifecycle/activate Activate an Application
ApplicationApi ActivateDefaultProvisioningConnectionForApplication Post /api/v1/apps/{appId}/connections/default/lifecycle/activate Activate the default Provisioning Connection
ApplicationApi AssignApplicationPolicy Put /api/v1/apps/{appId}/policies/{policyId} Assign an Application to a Policy
ApplicationApi AssignGroupToApplication Put /api/v1/apps/{appId}/groups/{groupId} Assign a Group
ApplicationApi AssignUserToApplication Post /api/v1/apps/{appId}/users Assign a User
ApplicationApi CloneApplicationKey Post /api/v1/apps/{appId}/credentials/keys/{keyId}/clone Clone a Key Credential
ApplicationApi CreateApplication Post /api/v1/apps Create an Application
ApplicationApi DeactivateApplication Post /api/v1/apps/{appId}/lifecycle/deactivate Deactivate an Application
ApplicationApi DeactivateDefaultProvisioningConnectionForApplication Post /api/v1/apps/{appId}/connections/default/lifecycle/deactivate Deactivate the default Provisioning Connection for an Application
ApplicationApi DeleteApplication Delete /api/v1/apps/{appId} Delete an Application
ApplicationApi GenerateApplicationKey Post /api/v1/apps/{appId}/credentials/keys/generate Generate a Key Credential
ApplicationApi GenerateCsrForApplication Post /api/v1/apps/{appId}/credentials/csrs Generate a Certificate Signing Request
ApplicationApi GetApplication Get /api/v1/apps/{appId} Retrieve an Application
ApplicationApi GetApplicationGroupAssignment Get /api/v1/apps/{appId}/groups/{groupId} Retrieve an Assigned Group
ApplicationApi GetApplicationKey Get /api/v1/apps/{appId}/credentials/keys/{keyId} Retrieve a Key Credential
ApplicationApi GetApplicationUser Get /api/v1/apps/{appId}/users/{userId} Retrieve an Assigned User
ApplicationApi GetCsrForApplication Get /api/v1/apps/{appId}/credentials/csrs/{csrId} Retrieve a Certificate Signing Request
ApplicationApi GetDefaultProvisioningConnectionForApplication Get /api/v1/apps/{appId}/connections/default Retrieve the default Provisioning Connection
ApplicationApi GetFeatureForApplication Get /api/v1/apps/{appId}/features/{name} Retrieve a Feature
ApplicationApi GetOAuth2TokenForApplication Get /api/v1/apps/{appId}/tokens/{tokenId} Retrieve an OAuth 2.0 Token
ApplicationApi GetScopeConsentGrant Get /api/v1/apps/{appId}/grants/{grantId} Retrieve a Scope Consent Grant
ApplicationApi GrantConsentToScope Post /api/v1/apps/{appId}/grants Grant Consent to Scope
ApplicationApi ListApplicationGroupAssignments Get /api/v1/apps/{appId}/groups List all Assigned Groups
ApplicationApi ListApplicationKeys Get /api/v1/apps/{appId}/credentials/keys List all Key Credentials
ApplicationApi ListApplicationUsers Get /api/v1/apps/{appId}/users List all Assigned Users
ApplicationApi ListApplications Get /api/v1/apps List all Applications
ApplicationApi ListCsrsForApplication Get /api/v1/apps/{appId}/credentials/csrs List all Certificate Signing Requests
ApplicationApi ListFeaturesForApplication Get /api/v1/apps/{appId}/features List all Features
ApplicationApi ListOAuth2TokensForApplication Get /api/v1/apps/{appId}/tokens List all OAuth 2.0 Tokens
ApplicationApi ListScopeConsentGrants Get /api/v1/apps/{appId}/grants List all Scope Consent Grants
ApplicationApi PublishCsrFromApplication Post /api/v1/apps/{appId}/credentials/csrs/{csrId}/lifecycle/publish Publish a Certificate Signing Request
ApplicationApi ReplaceApplication Put /api/v1/apps/{appId} Replace an Application
ApplicationApi RevokeCsrFromApplication Delete /api/v1/apps/{appId}/credentials/csrs/{csrId} Revoke a Certificate Signing Request
ApplicationApi RevokeOAuth2TokenForApplication Delete /api/v1/apps/{appId}/tokens/{tokenId} Revoke an OAuth 2.0 Token
ApplicationApi RevokeOAuth2TokensForApplication Delete /api/v1/apps/{appId}/tokens Revoke all OAuth 2.0 Tokens
ApplicationApi RevokeScopeConsentGrant Delete /api/v1/apps/{appId}/grants/{grantId} Revoke a Scope Consent Grant
ApplicationApi UnassignApplicationFromGroup Delete /api/v1/apps/{appId}/groups/{groupId} Unassign a Group
ApplicationApi UnassignUserFromApplication Delete /api/v1/apps/{appId}/users/{userId} Unassign a User
ApplicationApi UpdateApplicationUser Post /api/v1/apps/{appId}/users/{userId} Update an Application Profile for Assigned User
ApplicationApi UpdateDefaultProvisioningConnectionForApplication Post /api/v1/apps/{appId}/connections/default Update the default Provisioning Connection
ApplicationApi UpdateFeatureForApplication Put /api/v1/apps/{appId}/features/{name} Update a Feature
ApplicationApi UploadApplicationLogo Post /api/v1/apps/{appId}/logo Upload a Logo
AttackProtectionApi GetUserLockoutSettings Get /attack-protection/api/v1/user-lockout-settings Retrieve the User Lockout Settings
AttackProtectionApi ReplaceUserLockoutSettings Put /attack-protection/api/v1/user-lockout-settings Replace the User Lockout Settings
AuthenticatorApi ActivateAuthenticator Post /api/v1/authenticators/{authenticatorId}/lifecycle/activate Activate an Authenticator
AuthenticatorApi CreateAuthenticator Post /api/v1/authenticators Create an Authenticator
AuthenticatorApi DeactivateAuthenticator Post /api/v1/authenticators/{authenticatorId}/lifecycle/deactivate Deactivate an Authenticator
AuthenticatorApi GetAuthenticator Get /api/v1/authenticators/{authenticatorId} Retrieve an Authenticator
AuthenticatorApi ListAuthenticators Get /api/v1/authenticators List all Authenticators
AuthenticatorApi ReplaceAuthenticator Put /api/v1/authenticators/{authenticatorId} Replace an Authenticator
AuthorizationServerApi ActivateAuthorizationServer Post /api/v1/authorizationServers/{authServerId}/lifecycle/activate Activate an Authorization Server
AuthorizationServerApi ActivateAuthorizationServerPolicy Post /api/v1/authorizationServers/{authServerId}/policies/{policyId}/lifecycle/activate Activate a Policy
AuthorizationServerApi ActivateAuthorizationServerPolicyRule Post /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}/lifecycle/activate Activate a Policy Rule
AuthorizationServerApi CreateAuthorizationServer Post /api/v1/authorizationServers Create an Authorization Server
AuthorizationServerApi CreateAuthorizationServerPolicy Post /api/v1/authorizationServers/{authServerId}/policies Create a Policy
AuthorizationServerApi CreateAuthorizationServerPolicyRule Post /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules Create a Policy Rule
AuthorizationServerApi CreateOAuth2Claim Post /api/v1/authorizationServers/{authServerId}/claims Create a Custom Token Claim
AuthorizationServerApi CreateOAuth2Scope Post /api/v1/authorizationServers/{authServerId}/scopes Create a Custom Token Scope
AuthorizationServerApi DeactivateAuthorizationServer Post /api/v1/authorizationServers/{authServerId}/lifecycle/deactivate Deactivate an Authorization Server
AuthorizationServerApi DeactivateAuthorizationServerPolicy Post /api/v1/authorizationServers/{authServerId}/policies/{policyId}/lifecycle/deactivate Deactivate a Policy
AuthorizationServerApi DeactivateAuthorizationServerPolicyRule Post /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate Deactivate a Policy Rule
AuthorizationServerApi DeleteAuthorizationServer Delete /api/v1/authorizationServers/{authServerId} Delete an Authorization Server
AuthorizationServerApi DeleteAuthorizationServerPolicy Delete /api/v1/authorizationServers/{authServerId}/policies/{policyId} Delete a Policy
AuthorizationServerApi DeleteAuthorizationServerPolicyRule Delete /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId} Delete a Policy Rule
AuthorizationServerApi DeleteOAuth2Claim Delete /api/v1/authorizationServers/{authServerId}/claims/{claimId} Delete a Custom Token Claim
AuthorizationServerApi DeleteOAuth2Scope Delete /api/v1/authorizationServers/{authServerId}/scopes/{scopeId} Delete a Custom Token Scope
AuthorizationServerApi GetAuthorizationServer Get /api/v1/authorizationServers/{authServerId} Retrieve an Authorization Server
AuthorizationServerApi GetAuthorizationServerPolicy Get /api/v1/authorizationServers/{authServerId}/policies/{policyId} Retrieve a Policy
AuthorizationServerApi GetAuthorizationServerPolicyRule Get /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId} Retrieve a Policy Rule
AuthorizationServerApi GetOAuth2Claim Get /api/v1/authorizationServers/{authServerId}/claims/{claimId} Retrieve a Custom Token Claim
AuthorizationServerApi GetOAuth2Scope Get /api/v1/authorizationServers/{authServerId}/scopes/{scopeId} Retrieve a Custom Token Scope
AuthorizationServerApi GetRefreshTokenForAuthorizationServerAndClient Get /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens/{tokenId} Retrieve a Refresh Token for a Client
AuthorizationServerApi ListAuthorizationServerKeys Get /api/v1/authorizationServers/{authServerId}/credentials/keys List all Credential Keys
AuthorizationServerApi ListAuthorizationServerPolicies Get /api/v1/authorizationServers/{authServerId}/policies List all Policies
AuthorizationServerApi ListAuthorizationServerPolicyRules Get /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules List all Policy Rules
AuthorizationServerApi ListAuthorizationServers Get /api/v1/authorizationServers List all Authorization Servers
AuthorizationServerApi ListOAuth2Claims Get /api/v1/authorizationServers/{authServerId}/claims List all Custom Token Claims
AuthorizationServerApi ListOAuth2ClientsForAuthorizationServer Get /api/v1/authorizationServers/{authServerId}/clients List all Clients
AuthorizationServerApi ListOAuth2Scopes Get /api/v1/authorizationServers/{authServerId}/scopes List all Custom Token Scopes
AuthorizationServerApi ListRefreshTokensForAuthorizationServerAndClient Get /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens List all Refresh Tokens for a Client
AuthorizationServerApi ReplaceAuthorizationServer Put /api/v1/authorizationServers/{authServerId} Replace an Authorization Server
AuthorizationServerApi ReplaceAuthorizationServerPolicy Put /api/v1/authorizationServers/{authServerId}/policies/{policyId} Replace a Policy
AuthorizationServerApi ReplaceAuthorizationServerPolicyRule Put /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId} Replace a Policy Rule
AuthorizationServerApi ReplaceOAuth2Claim Put /api/v1/authorizationServers/{authServerId}/claims/{claimId} Replace a Custom Token Claim
AuthorizationServerApi ReplaceOAuth2Scope Put /api/v1/authorizationServers/{authServerId}/scopes/{scopeId} Replace a Custom Token Scope
AuthorizationServerApi RevokeRefreshTokenForAuthorizationServerAndClient Delete /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens/{tokenId} Revoke a Refresh Token for a Client
AuthorizationServerApi RevokeRefreshTokensForAuthorizationServerAndClient Delete /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens Revoke all Refresh Tokens for a Client
AuthorizationServerApi RotateAuthorizationServerKeys Post /api/v1/authorizationServers/{authServerId}/credentials/lifecycle/keyRotate Rotate all Credential Keys
BehaviorApi ActivateBehaviorDetectionRule Post /api/v1/behaviors/{behaviorId}/lifecycle/activate Activate a Behavior Detection Rule
BehaviorApi CreateBehaviorDetectionRule Post /api/v1/behaviors Create a Behavior Detection Rule
BehaviorApi DeactivateBehaviorDetectionRule Post /api/v1/behaviors/{behaviorId}/lifecycle/deactivate Deactivate a Behavior Detection Rule
BehaviorApi DeleteBehaviorDetectionRule Delete /api/v1/behaviors/{behaviorId} Delete a Behavior Detection Rule
BehaviorApi GetBehaviorDetectionRule Get /api/v1/behaviors/{behaviorId} Retrieve a Behavior Detection Rule
BehaviorApi ListBehaviorDetectionRules Get /api/v1/behaviors List all Behavior Detection Rules
BehaviorApi ReplaceBehaviorDetectionRule Put /api/v1/behaviors/{behaviorId} Replace a Behavior Detection Rule
CAPTCHAApi CreateCaptchaInstance Post /api/v1/captchas Create a CAPTCHA instance
CAPTCHAApi DeleteCaptchaInstance Delete /api/v1/captchas/{captchaId} Delete a CAPTCHA Instance
CAPTCHAApi GetCaptchaInstance Get /api/v1/captchas/{captchaId} Retrieve a CAPTCHA Instance
CAPTCHAApi ListCaptchaInstances Get /api/v1/captchas List all CAPTCHA instances
CAPTCHAApi ReplaceCaptchaInstance Put /api/v1/captchas/{captchaId} Replace a CAPTCHA instance
CAPTCHAApi UpdateCaptchaInstance Post /api/v1/captchas/{captchaId} Update a CAPTCHA instance
CustomizationApi CreateBrand Post /api/v1/brands Create a Brand
CustomizationApi CreateEmailCustomization Post /api/v1/brands/{brandId}/templates/email/{templateName}/customizations Create an Email Customization
CustomizationApi DeleteAllCustomizations Delete /api/v1/brands/{brandId}/templates/email/{templateName}/customizations Delete all Email Customizations
CustomizationApi DeleteBrand Delete /api/v1/brands/{brandId} Delete a brand
CustomizationApi DeleteBrandThemeBackgroundImage Delete /api/v1/brands/{brandId}/themes/{themeId}/background-image Delete the Background Image
CustomizationApi DeleteBrandThemeFavicon Delete /api/v1/brands/{brandId}/themes/{themeId}/favicon Delete the Favicon
CustomizationApi DeleteBrandThemeLogo Delete /api/v1/brands/{brandId}/themes/{themeId}/logo Delete the Logo
CustomizationApi DeleteEmailCustomization Delete /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId} Delete an Email Customization
CustomizationApi GetBrand Get /api/v1/brands/{brandId} Retrieve a Brand
CustomizationApi GetBrandTheme Get /api/v1/brands/{brandId}/themes/{themeId} Retrieve a Theme
CustomizationApi GetCustomizationPreview Get /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}/preview Retrieve a Preview of an Email Customization
CustomizationApi GetCustomizedErrorPage Get /api/v1/brands/{brandId}/pages/error/customized Retrieve the Customized Error Page
CustomizationApi GetCustomizedSignInPage Get /api/v1/brands/{brandId}/pages/sign-in/customized Retrieve the Customized Sign-in Page
CustomizationApi GetDefaultErrorPage Get /api/v1/brands/{brandId}/pages/error/default Retrieve the Default Error Page
CustomizationApi GetDefaultSignInPage Get /api/v1/brands/{brandId}/pages/sign-in/default Retrieve the Default Sign-in Page
CustomizationApi GetEmailCustomization Get /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId} Retrieve an Email Customization
CustomizationApi GetEmailDefaultContent Get /api/v1/brands/{brandId}/templates/email/{templateName}/default-content Retrieve an Email Template Default Content
CustomizationApi GetEmailDefaultPreview Get /api/v1/brands/{brandId}/templates/email/{templateName}/default-content/preview Retrieve a Preview of the Email Template Default Content
CustomizationApi GetEmailSettings Get /api/v1/brands/{brandId}/templates/email/{templateName}/settings Retrieve the Email Template Settings
CustomizationApi GetEmailTemplate Get /api/v1/brands/{brandId}/templates/email/{templateName} Retrieve an Email Template
CustomizationApi GetErrorPage Get /api/v1/brands/{brandId}/pages/error Retrieve the Error Page
CustomizationApi GetPreviewErrorPage Get /api/v1/brands/{brandId}/pages/error/preview Retrieve the Preview Error Page Preview
CustomizationApi GetPreviewSignInPage Get /api/v1/brands/{brandId}/pages/sign-in/preview Retrieve the Preview Sign-in Page Preview
CustomizationApi GetSignInPage Get /api/v1/brands/{brandId}/pages/sign-in Retrieve the Sign-in Page
CustomizationApi GetSignOutPageSettings Get /api/v1/brands/{brandId}/pages/sign-out/customized Retrieve the Sign-out Page Settings
CustomizationApi LinkBrandDomain Post /api/v1/brands/{brandId}/domains Link a Brand to a Domain
CustomizationApi ListAllSignInWidgetVersions Get /api/v1/brands/{brandId}/pages/sign-in/widget-versions List all Sign-in Widget Versions
CustomizationApi ListBrandDomains Get /api/v1/brands/{brandId}/domains List all Domains associated with a Brand
CustomizationApi ListBrandThemes Get /api/v1/brands/{brandId}/themes List all Themes
CustomizationApi ListBrands Get /api/v1/brands List all Brands
CustomizationApi ListEmailCustomizations Get /api/v1/brands/{brandId}/templates/email/{templateName}/customizations List all Email Customizations
CustomizationApi ListEmailTemplates Get /api/v1/brands/{brandId}/templates/email List all Email Templates
CustomizationApi ReplaceBrand Put /api/v1/brands/{brandId} Replace a Brand
CustomizationApi ReplaceBrandTheme Put /api/v1/brands/{brandId}/themes/{themeId} Replace a Theme
CustomizationApi ReplaceCustomizedErrorPage Put /api/v1/brands/{brandId}/pages/error/customized Replace the Customized Error Page
CustomizationApi ReplaceCustomizedSignInPage Put /api/v1/brands/{brandId}/pages/sign-in/customized Replace the Customized Sign-in Page
CustomizationApi ReplaceEmailCustomization Put /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId} Replace an Email Customization
CustomizationApi ReplaceEmailSettings Put /api/v1/brands/{brandId}/templates/email/{templateName}/settings Replace the Email Template Settings
CustomizationApi ReplacePreviewErrorPage Put /api/v1/brands/{brandId}/pages/error/preview Replace the Preview Error Page
CustomizationApi ReplacePreviewSignInPage Put /api/v1/brands/{brandId}/pages/sign-in/preview Replace the Preview Sign-in Page
CustomizationApi ReplaceSignOutPageSettings Put /api/v1/brands/{brandId}/pages/sign-out/customized Replace the Sign-out Page Settings
CustomizationApi ResetCustomizedErrorPage Delete /api/v1/brands/{brandId}/pages/error/customized Reset the Customized Error Page
CustomizationApi ResetCustomizedSignInPage Delete /api/v1/brands/{brandId}/pages/sign-in/customized Reset the Customized Sign-in Page
CustomizationApi ResetPreviewErrorPage Delete /api/v1/brands/{brandId}/pages/error/preview Reset the Preview Error Page
CustomizationApi ResetPreviewSignInPage Delete /api/v1/brands/{brandId}/pages/sign-in/preview Reset the Preview Sign-in Page
CustomizationApi SendTestEmail Post /api/v1/brands/{brandId}/templates/email/{templateName}/test Send a Test Email
CustomizationApi UnlinkBrandDomain Delete /api/v1/brands/{brandId}/domains/{domainId} Unlink a Brand from a Domain
CustomizationApi UploadBrandThemeBackgroundImage Post /api/v1/brands/{brandId}/themes/{themeId}/background-image Upload the Background Image
CustomizationApi UploadBrandThemeFavicon Post /api/v1/brands/{brandId}/themes/{themeId}/favicon Upload the Favicon
CustomizationApi UploadBrandThemeLogo Post /api/v1/brands/{brandId}/themes/{themeId}/logo Upload the Logo
DeviceApi ActivateDevice Post /api/v1/devices/{deviceId}/lifecycle/activate Activate a Device
DeviceApi DeactivateDevice Post /api/v1/devices/{deviceId}/lifecycle/deactivate Deactivate a Device
DeviceApi DeleteDevice Delete /api/v1/devices/{deviceId} Delete a Device
DeviceApi GetDevice Get /api/v1/devices/{deviceId} Retrieve a Device
DeviceApi ListDevices Get /api/v1/devices List all Devices
DeviceApi SuspendDevice Post /api/v1/devices/{deviceId}/lifecycle/suspend Suspend a Device
DeviceApi UnsuspendDevice Post /api/v1/devices/{deviceId}/lifecycle/unsuspend Unsuspend a Device
DeviceAssuranceApi CreateDeviceAssurancePolicy Post /api/v1/device-assurances Create a Device Assurance Policy
DeviceAssuranceApi DeleteDeviceAssurancePolicy Delete /api/v1/device-assurances/{deviceAssuranceId} Delete a Device Assurance Policy
DeviceAssuranceApi GetDeviceAssurancePolicy Get /api/v1/device-assurances/{deviceAssuranceId} Retrieve a Device Assurance Policy
DeviceAssuranceApi ListDeviceAssurancePolicies Get /api/v1/device-assurances List all Device Assurance Policies
DeviceAssuranceApi ReplaceDeviceAssurancePolicy Put /api/v1/device-assurances/{deviceAssuranceId} Replace a Device Assurance Policy
DomainApi CreateDomain Post /api/v1/domains Create a Domain
DomainApi DeleteDomain Delete /api/v1/domains/{domainId} Delete a Domain
DomainApi GetDomain Get /api/v1/domains/{domainId} Retrieve a Domain
DomainApi ListDomains Get /api/v1/domains List all Domains
DomainApi ReplaceDomain Put /api/v1/domains/{domainId} Replace a Domain's brandId
DomainApi UpsertCertificate Put /api/v1/domains/{domainId}/certificate Upsert the Certificate
DomainApi VerifyDomain Post /api/v1/domains/{domainId}/verify Verify a Domain
EmailDomainApi CreateEmailDomain Post /api/v1/email-domains Create an Email Domain
EmailDomainApi DeleteEmailDomain Delete /api/v1/email-domains/{emailDomainId} Delete an Email Domain
EmailDomainApi GetEmailDomain Get /api/v1/email-domains/{emailDomainId} Retrieve a Email Domain
EmailDomainApi ListEmailDomainBrands Get /api/v1/email-domains/{emailDomainId}/brands List all brands linked to an email domain
EmailDomainApi ListEmailDomains Get /api/v1/email-domains List all email domains
EmailDomainApi ReplaceEmailDomain Put /api/v1/email-domains/{emailDomainId} Replace an Email Domain
EmailDomainApi VerifyEmailDomain Post /api/v1/email-domains/{emailDomainId}/verify Verify an Email Domain
EventHookApi ActivateEventHook Post /api/v1/eventHooks/{eventHookId}/lifecycle/activate Activate an Event Hook
EventHookApi CreateEventHook Post /api/v1/eventHooks Create an Event Hook
EventHookApi DeactivateEventHook Post /api/v1/eventHooks/{eventHookId}/lifecycle/deactivate Deactivate an Event Hook
EventHookApi DeleteEventHook Delete /api/v1/eventHooks/{eventHookId} Delete an Event Hook
EventHookApi GetEventHook Get /api/v1/eventHooks/{eventHookId} Retrieve an Event Hook
EventHookApi ListEventHooks Get /api/v1/eventHooks List all Event Hooks
EventHookApi ReplaceEventHook Put /api/v1/eventHooks/{eventHookId} Replace an Event Hook
EventHookApi VerifyEventHook Post /api/v1/eventHooks/{eventHookId}/lifecycle/verify Verify an Event Hook
FeatureApi GetFeature Get /api/v1/features/{featureId} Retrieve a Feature
FeatureApi ListFeatureDependencies Get /api/v1/features/{featureId}/dependencies List all Dependencies
FeatureApi ListFeatureDependents Get /api/v1/features/{featureId}/dependents List all Dependents
FeatureApi ListFeatures Get /api/v1/features List all Features
FeatureApi UpdateFeatureLifecycle Post /api/v1/features/{featureId}/{lifecycle} Update a Feature Lifecycle
GroupApi ActivateGroupRule Post /api/v1/groups/rules/{ruleId}/lifecycle/activate Activate a Group Rule
GroupApi AssignGroupOwner Post /api/v1/groups/{groupId}/owners Assign a Group Owner
GroupApi AssignUserToGroup Put /api/v1/groups/{groupId}/users/{userId} Assign a User
GroupApi CreateGroup Post /api/v1/groups Create a Group
GroupApi CreateGroupRule Post /api/v1/groups/rules Create a Group Rule
GroupApi DeactivateGroupRule Post /api/v1/groups/rules/{ruleId}/lifecycle/deactivate Deactivate a Group Rule
GroupApi DeleteGroup Delete /api/v1/groups/{groupId} Delete a Group
GroupApi DeleteGroupOwner Delete /api/v1/groups/{groupId}/owners/{ownerId} Delete a Group Owner
GroupApi DeleteGroupRule Delete /api/v1/groups/rules/{ruleId} Delete a group Rule
GroupApi GetGroup Get /api/v1/groups/{groupId} Retrieve a Group
GroupApi GetGroupRule Get /api/v1/groups/rules/{ruleId} Retrieve a Group Rule
GroupApi ListAssignedApplicationsForGroup Get /api/v1/groups/{groupId}/apps List all Assigned Applications
GroupApi ListGroupOwners Get /api/v1/groups/{groupId}/owners List all Group Owners
GroupApi ListGroupRules Get /api/v1/groups/rules List all Group Rules
GroupApi ListGroupUsers Get /api/v1/groups/{groupId}/users List all Member Users
GroupApi ListGroups Get /api/v1/groups List all Groups
GroupApi ReplaceGroup Put /api/v1/groups/{groupId} Replace a Group
GroupApi ReplaceGroupRule Put /api/v1/groups/rules/{ruleId} Replace a Group Rule
GroupApi UnassignUserFromGroup Delete /api/v1/groups/{groupId}/users/{userId} Unassign a User
HookKeyApi CreateHookKey Post /api/v1/hook-keys Create a key
HookKeyApi DeleteHookKey Delete /api/v1/hook-keys/{hookKeyId} Delete a key
HookKeyApi GetHookKey Get /api/v1/hook-keys/{hookKeyId} Retrieve a key
HookKeyApi GetPublicKey Get /api/v1/hook-keys/public/{keyId} Retrieve a public key
HookKeyApi ListHookKeys Get /api/v1/hook-keys List all keys
HookKeyApi ReplaceHookKey Put /api/v1/hook-keys/{hookKeyId} Replace a key
IdentityProviderApi ActivateIdentityProvider Post /api/v1/idps/{idpId}/lifecycle/activate Activate an Identity Provider
IdentityProviderApi CloneIdentityProviderKey Post /api/v1/idps/{idpId}/credentials/keys/{keyId}/clone Clone a Signing Credential Key
IdentityProviderApi CreateIdentityProvider Post /api/v1/idps Create an Identity Provider
IdentityProviderApi CreateIdentityProviderKey Post /api/v1/idps/credentials/keys Create an X.509 Certificate Public Key
IdentityProviderApi DeactivateIdentityProvider Post /api/v1/idps/{idpId}/lifecycle/deactivate Deactivate an Identity Provider
IdentityProviderApi DeleteIdentityProvider Delete /api/v1/idps/{idpId} Delete an Identity Provider
IdentityProviderApi DeleteIdentityProviderKey Delete /api/v1/idps/credentials/keys/{keyId} Delete a Signing Credential Key
IdentityProviderApi GenerateCsrForIdentityProvider Post /api/v1/idps/{idpId}/credentials/csrs Generate a Certificate Signing Request
IdentityProviderApi GenerateIdentityProviderSigningKey Post /api/v1/idps/{idpId}/credentials/keys/generate Generate a new Signing Credential Key
IdentityProviderApi GetCsrForIdentityProvider Get /api/v1/idps/{idpId}/credentials/csrs/{csrId} Retrieve a Certificate Signing Request
IdentityProviderApi GetIdentityProvider Get /api/v1/idps/{idpId} Retrieve an Identity Provider
IdentityProviderApi GetIdentityProviderApplicationUser Get /api/v1/idps/{idpId}/users/{userId} Retrieve a User
IdentityProviderApi GetIdentityProviderKey Get /api/v1/idps/credentials/keys/{keyId} Retrieve an Credential Key
IdentityProviderApi GetIdentityProviderSigningKey Get /api/v1/idps/{idpId}/credentials/keys/{keyId} Retrieve a Signing Credential Key
IdentityProviderApi LinkUserToIdentityProvider Post /api/v1/idps/{idpId}/users/{userId} Link a User to a Social IdP
IdentityProviderApi ListCsrsForIdentityProvider Get /api/v1/idps/{idpId}/credentials/csrs List all Certificate Signing Requests
IdentityProviderApi ListIdentityProviderApplicationUsers Get /api/v1/idps/{idpId}/users List all Users
IdentityProviderApi ListIdentityProviderKeys Get /api/v1/idps/credentials/keys List all Credential Keys
IdentityProviderApi ListIdentityProviderSigningKeys Get /api/v1/idps/{idpId}/credentials/keys List all Signing Credential Keys
IdentityProviderApi ListIdentityProviders Get /api/v1/idps List all Identity Providers
IdentityProviderApi ListSocialAuthTokens Get /api/v1/idps/{idpId}/users/{userId}/credentials/tokens List all Tokens from a OIDC Identity Provider
IdentityProviderApi PublishCsrForIdentityProvider Post /api/v1/idps/{idpId}/credentials/csrs/{csrId}/lifecycle/publish Publish a Certificate Signing Request
IdentityProviderApi ReplaceIdentityProvider Put /api/v1/idps/{idpId} Replace an Identity Provider
IdentityProviderApi RevokeCsrForIdentityProvider Delete /api/v1/idps/{idpId}/credentials/csrs/{csrId} Revoke a Certificate Signing Request
IdentityProviderApi UnlinkUserFromIdentityProvider Delete /api/v1/idps/{idpId}/users/{userId} Unlink a User from IdP
IdentitySourceApi CreateIdentitySourceSession Post /api/v1/identity-sources/{identitySourceId}/sessions Create an Identity Source Session
IdentitySourceApi DeleteIdentitySourceSession Delete /api/v1/identity-sources/{identitySourceId}/sessions/{sessionId} Delete an Identity Source Session
IdentitySourceApi GetIdentitySourceSession Get /api/v1/identity-sources/{identitySourceId}/sessions/{sessionId} Retrieve an Identity Source Session
IdentitySourceApi ListIdentitySourceSessions Get /api/v1/identity-sources/{identitySourceId}/sessions List all Identity Source Sessions
IdentitySourceApi StartImportFromIdentitySource Post /api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/start-import Start the import from the Identity Source
IdentitySourceApi UploadIdentitySourceDataForDelete Post /api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-delete Upload the data to be deleted in Okta
IdentitySourceApi UploadIdentitySourceDataForUpsert Post /api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-upsert Upload the data to be upserted in Okta
InlineHookApi ActivateInlineHook Post /api/v1/inlineHooks/{inlineHookId}/lifecycle/activate Activate an Inline Hook
InlineHookApi CreateInlineHook Post /api/v1/inlineHooks Create an Inline Hook
InlineHookApi DeactivateInlineHook Post /api/v1/inlineHooks/{inlineHookId}/lifecycle/deactivate Deactivate an Inline Hook
InlineHookApi DeleteInlineHook Delete /api/v1/inlineHooks/{inlineHookId} Delete an Inline Hook
InlineHookApi ExecuteInlineHook Post /api/v1/inlineHooks/{inlineHookId}/execute Execute an Inline Hook
InlineHookApi GetInlineHook Get /api/v1/inlineHooks/{inlineHookId} Retrieve an Inline Hook
InlineHookApi ListInlineHooks Get /api/v1/inlineHooks List all Inline Hooks
InlineHookApi ReplaceInlineHook Put /api/v1/inlineHooks/{inlineHookId} Replace an Inline Hook
LinkedObjectApi CreateLinkedObjectDefinition Post /api/v1/meta/schemas/user/linkedObjects Create a Linked Object Definition
LinkedObjectApi DeleteLinkedObjectDefinition Delete /api/v1/meta/schemas/user/linkedObjects/{linkedObjectName} Delete a Linked Object Definition
LinkedObjectApi GetLinkedObjectDefinition Get /api/v1/meta/schemas/user/linkedObjects/{linkedObjectName} Retrieve a Linked Object Definition
LinkedObjectApi ListLinkedObjectDefinitions Get /api/v1/meta/schemas/user/linkedObjects List all Linked Object Definitions
LogStreamApi ActivateLogStream Post /api/v1/logStreams/{logStreamId}/lifecycle/activate Activate a Log Stream
LogStreamApi CreateLogStream Post /api/v1/logStreams Create a Log Stream
LogStreamApi DeactivateLogStream Post /api/v1/logStreams/{logStreamId}/lifecycle/deactivate Deactivate a Log Stream
LogStreamApi DeleteLogStream Delete /api/v1/logStreams/{logStreamId} Delete a Log Stream
LogStreamApi GetLogStream Get /api/v1/logStreams/{logStreamId} Retrieve a Log Stream
LogStreamApi ListLogStreams Get /api/v1/logStreams List all Log Streams
LogStreamApi ReplaceLogStream Put /api/v1/logStreams/{logStreamId} Replace a Log Stream
NetworkZoneApi ActivateNetworkZone Post /api/v1/zones/{zoneId}/lifecycle/activate Activate a Network Zone
NetworkZoneApi CreateNetworkZone Post /api/v1/zones Create a Network Zone
NetworkZoneApi DeactivateNetworkZone Post /api/v1/zones/{zoneId}/lifecycle/deactivate Deactivate a Network Zone
NetworkZoneApi DeleteNetworkZone Delete /api/v1/zones/{zoneId} Delete a Network Zone
NetworkZoneApi GetNetworkZone Get /api/v1/zones/{zoneId} Retrieve a Network Zone
NetworkZoneApi ListNetworkZones Get /api/v1/zones List all Network Zones
NetworkZoneApi ReplaceNetworkZone Put /api/v1/zones/{zoneId} Replace a Network Zone
OrgSettingApi BulkRemoveEmailAddressBounces Post /api/v1/org/email/bounces/remove-list Remove Emails from Email Provider Bounce List
OrgSettingApi ExtendOktaSupport Post /api/v1/org/privacy/oktaSupport/extend Extend Okta Support Access
OrgSettingApi GetOktaCommunicationSettings Get /api/v1/org/privacy/oktaCommunication Retrieve the Okta Communication Settings
OrgSettingApi GetOrgContactTypes Get /api/v1/org/contacts Retrieve the Org Contact Types
OrgSettingApi GetOrgContactUser Get /api/v1/org/contacts/{contactType} Retrieve the User of the Contact Type
OrgSettingApi GetOrgOktaSupportSettings Get /api/v1/org/privacy/oktaSupport Retrieve the Okta Support Settings
OrgSettingApi GetOrgPreferences Get /api/v1/org/preferences Retrieve the Org Preferences
OrgSettingApi GetOrgSettings Get /api/v1/org Retrieve the Org Settings
OrgSettingApi GetWellknownOrgMetadata Get /.well-known/okta-organization Retrieve the Well-Known Org Metadata
OrgSettingApi GrantOktaSupport Post /api/v1/org/privacy/oktaSupport/grant Grant Okta Support Access to your Org
OrgSettingApi OptInUsersToOktaCommunicationEmails Post /api/v1/org/privacy/oktaCommunication/optIn Opt in all Users to Okta Communication emails
OrgSettingApi OptOutUsersFromOktaCommunicationEmails Post /api/v1/org/privacy/oktaCommunication/optOut Opt out all Users from Okta Communication emails
OrgSettingApi ReplaceOrgContactUser Put /api/v1/org/contacts/{contactType} Replace the User of the Contact Type
OrgSettingApi ReplaceOrgSettings Put /api/v1/org Replace the Org Settings
OrgSettingApi RevokeOktaSupport Post /api/v1/org/privacy/oktaSupport/revoke Revoke Okta Support Access
OrgSettingApi UpdateOrgHideOktaUIFooter Post /api/v1/org/preferences/hideEndUserFooter Update the Preference to Hide the Okta Dashboard Footer
OrgSettingApi UpdateOrgSettings Post /api/v1/org Update the Org Settings
OrgSettingApi UpdateOrgShowOktaUIFooter Post /api/v1/org/preferences/showEndUserFooter Update the Preference to Show the Okta Dashboard Footer
OrgSettingApi UploadOrgLogo Post /api/v1/org/logo Upload the Org Logo
PolicyApi ActivatePolicy Post /api/v1/policies/{policyId}/lifecycle/activate Activate a Policy
PolicyApi ActivatePolicyRule Post /api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/activate Activate a Policy Rule
PolicyApi ClonePolicy Post /api/v1/policies/{policyId}/clone Clone an existing policy
PolicyApi CreatePolicy Post /api/v1/policies Create a Policy
PolicyApi CreatePolicyRule Post /api/v1/policies/{policyId}/rules Create a Policy Rule
PolicyApi DeactivatePolicy Post /api/v1/policies/{policyId}/lifecycle/deactivate Deactivate a Policy
PolicyApi DeactivatePolicyRule Post /api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate Deactivate a Policy Rule
PolicyApi DeletePolicy Delete /api/v1/policies/{policyId} Delete a Policy
PolicyApi DeletePolicyRule Delete /api/v1/policies/{policyId}/rules/{ruleId} Delete a Policy Rule
PolicyApi GetPolicy Get /api/v1/policies/{policyId} Retrieve a Policy
PolicyApi GetPolicyRule Get /api/v1/policies/{policyId}/rules/{ruleId} Retrieve a Policy Rule
PolicyApi ListPolicies Get /api/v1/policies List all Policies
PolicyApi ListPolicyRules Get /api/v1/policies/{policyId}/rules List all Policy Rules
PolicyApi ReplacePolicy Put /api/v1/policies/{policyId} Replace a Policy
PolicyApi ReplacePolicyRule Put /api/v1/policies/{policyId}/rules/{ruleId} Replace a Policy Rule
PrincipalRateLimitApi CreatePrincipalRateLimitEntity Post /api/v1/principal-rate-limits Create a Principal Rate Limit
PrincipalRateLimitApi GetPrincipalRateLimitEntity Get /api/v1/principal-rate-limits/{principalRateLimitId} Retrieve a Principal Rate Limit
PrincipalRateLimitApi ListPrincipalRateLimitEntities Get /api/v1/principal-rate-limits List all Principal Rate Limits
PrincipalRateLimitApi ReplacePrincipalRateLimitEntity Put /api/v1/principal-rate-limits/{principalRateLimitId} Replace a Principal Rate Limit
ProfileMappingApi GetProfileMapping Get /api/v1/mappings/{mappingId} Retrieve a Profile Mapping
ProfileMappingApi ListProfileMappings Get /api/v1/mappings List all Profile Mappings
ProfileMappingApi UpdateProfileMapping Post /api/v1/mappings/{mappingId} Update a Profile Mapping
PushProviderApi CreatePushProvider Post /api/v1/push-providers Create a Push Provider
PushProviderApi DeletePushProvider Delete /api/v1/push-providers/{pushProviderId} Delete a Push Provider
PushProviderApi GetPushProvider Get /api/v1/push-providers/{pushProviderId} Retrieve a Push Provider
PushProviderApi ListPushProviders Get /api/v1/push-providers List all Push Providers
PushProviderApi ReplacePushProvider Put /api/v1/push-providers/{pushProviderId} Replace a Push Provider
RateLimitSettingsApi GetRateLimitSettingsAdminNotifications Get /api/v1/rate-limit-settings/admin-notifications Retrieve the Rate Limit Admin Notification Settings
RateLimitSettingsApi GetRateLimitSettingsPerClient Get /api/v1/rate-limit-settings/per-client Retrieve the Per-Client Rate Limit Settings
RateLimitSettingsApi ReplaceRateLimitSettingsAdminNotifications Put /api/v1/rate-limit-settings/admin-notifications Replace the Rate Limit Admin Notification Settings
RateLimitSettingsApi ReplaceRateLimitSettingsPerClient Put /api/v1/rate-limit-settings/per-client Replace the Per-Client Rate Limit Settings
ResourceSetApi AddMembersToBinding Patch /api/v1/iam/resource-sets/{resourceSetId}/bindings/{roleIdOrLabel}/members Add more Members to a binding
ResourceSetApi AddResourceSetResource Patch /api/v1/iam/resource-sets/{resourceSetId}/resources Add more Resource to a resource set
ResourceSetApi CreateResourceSet Post /api/v1/iam/resource-sets Create a Resource Set
ResourceSetApi CreateResourceSetBinding Post /api/v1/iam/resource-sets/{resourceSetId}/bindings Create a Resource Set Binding
ResourceSetApi DeleteBinding Delete /api/v1/iam/resource-sets/{resourceSetId}/bindings/{roleIdOrLabel} Delete a Binding
ResourceSetApi DeleteResourceSet Delete /api/v1/iam/resource-sets/{resourceSetId} Delete a Resource Set
ResourceSetApi DeleteResourceSetResource Delete /api/v1/iam/resource-sets/{resourceSetId}/resources/{resourceId} Delete a Resource from a resource set
ResourceSetApi GetBinding Get /api/v1/iam/resource-sets/{resourceSetId}/bindings/{roleIdOrLabel} Retrieve a Binding
ResourceSetApi GetMemberOfBinding Get /api/v1/iam/resource-sets/{resourceSetId}/bindings/{roleIdOrLabel}/members/{memberId} Retrieve a Member of a binding
ResourceSetApi GetResourceSet Get /api/v1/iam/resource-sets/{resourceSetId} Retrieve a Resource Set
ResourceSetApi ListBindings Get /api/v1/iam/resource-sets/{resourceSetId}/bindings List all Bindings
ResourceSetApi ListMembersOfBinding Get /api/v1/iam/resource-sets/{resourceSetId}/bindings/{roleIdOrLabel}/members List all Members of a binding
ResourceSetApi ListResourceSetResources Get /api/v1/iam/resource-sets/{resourceSetId}/resources List all Resources of a resource set
ResourceSetApi ListResourceSets Get /api/v1/iam/resource-sets List all Resource Sets
ResourceSetApi ReplaceResourceSet Put /api/v1/iam/resource-sets/{resourceSetId} Replace a Resource Set
ResourceSetApi UnassignMemberFromBinding Delete /api/v1/iam/resource-sets/{resourceSetId}/bindings/{roleIdOrLabel}/members/{memberId} Unassign a Member from a binding
RiskEventApi SendRiskEvents Post /api/v1/risk/events/ip Send multiple Risk Events
RiskProviderApi CreateRiskProvider Post /api/v1/risk/providers Create a Risk Provider
RiskProviderApi DeleteRiskProvider Delete /api/v1/risk/providers/{riskProviderId} Delete a Risk Provider
RiskProviderApi GetRiskProvider Get /api/v1/risk/providers/{riskProviderId} Retrieve a Risk Provider
RiskProviderApi ListRiskProviders Get /api/v1/risk/providers List all Risk Providers
RiskProviderApi ReplaceRiskProvider Put /api/v1/risk/providers/{riskProviderId} Replace a Risk Provider
RoleApi CreateRole Post /api/v1/iam/roles Create a Role
RoleApi CreateRolePermission Post /api/v1/iam/roles/{roleIdOrLabel}/permissions/{permissionType} Create a Permission
RoleApi DeleteRole Delete /api/v1/iam/roles/{roleIdOrLabel} Delete a Role
RoleApi DeleteRolePermission Delete /api/v1/iam/roles/{roleIdOrLabel}/permissions/{permissionType} Delete a Permission
RoleApi GetRole Get /api/v1/iam/roles/{roleIdOrLabel} Retrieve a Role
RoleApi GetRolePermission Get /api/v1/iam/roles/{roleIdOrLabel}/permissions/{permissionType} Retrieve a Permission
RoleApi ListRolePermissions Get /api/v1/iam/roles/{roleIdOrLabel}/permissions List all Permissions
RoleApi ListRoles Get /api/v1/iam/roles List all Roles
RoleApi ReplaceRole Put /api/v1/iam/roles/{roleIdOrLabel} Replace a Role
RoleAssignmentApi AssignRoleToGroup Post /api/v1/groups/{groupId}/roles Assign a Role to a Group
RoleAssignmentApi AssignRoleToUser Post /api/v1/users/{userId}/roles Assign a Role to a User
RoleAssignmentApi GetGroupAssignedRole Get /api/v1/groups/{groupId}/roles/{roleId} Retrieve a Role assigned to Group
RoleAssignmentApi GetUserAssignedRole Get /api/v1/users/{userId}/roles/{roleId} Retrieve a Role assigned to a User
RoleAssignmentApi ListAssignedRolesForUser Get /api/v1/users/{userId}/roles List all Roles assigned to a User
RoleAssignmentApi ListGroupAssignedRoles Get /api/v1/groups/{groupId}/roles List all Assigned Roles of Group
RoleAssignmentApi UnassignRoleFromGroup Delete /api/v1/groups/{groupId}/roles/{roleId} Unassign a Role from a Group
RoleAssignmentApi UnassignRoleFromUser Delete /api/v1/users/{userId}/roles/{roleId} Unassign a Role from a User
RoleTargetApi AssignAllAppsAsTargetToRoleForUser Put /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps Assign all Apps as Target to Role
RoleTargetApi AssignAppInstanceTargetToAppAdminRoleForGroup Put /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId} Assign an Application Instance Target to Application Administrator Role
RoleTargetApi AssignAppInstanceTargetToAppAdminRoleForUser Put /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId} Assign an Application Instance Target to an Application Administrator Role
RoleTargetApi AssignAppTargetToAdminRoleForGroup Put /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName} Assign an Application Target to Administrator Role
RoleTargetApi AssignAppTargetToAdminRoleForUser Put /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName} Assign an Application Target to Administrator Role
RoleTargetApi AssignGroupTargetToGroupAdminRole Put /api/v1/groups/{groupId}/roles/{roleId}/targets/groups/{targetGroupId} Assign a Group Target to a Group Role
RoleTargetApi AssignGroupTargetToUserRole Put /api/v1/users/{userId}/roles/{roleId}/targets/groups/{groupId} Assign a Group Target to Role
RoleTargetApi ListApplicationTargetsForApplicationAdministratorRoleForGroup Get /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps List all Application Targets for an Application Administrator Role
RoleTargetApi ListApplicationTargetsForApplicationAdministratorRoleForUser Get /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps List all Application Targets for Application Administrator Role
RoleTargetApi ListGroupTargetsForGroupRole Get /api/v1/groups/{groupId}/roles/{roleId}/targets/groups List all Group Targets for a Group Role
RoleTargetApi ListGroupTargetsForRole Get /api/v1/users/{userId}/roles/{roleId}/targets/groups List all Group Targets for Role
RoleTargetApi UnassignAppInstanceTargetFromAdminRoleForUser Delete /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId} Unassign an Application Instance Target from an Application Administrator Role
RoleTargetApi UnassignAppInstanceTargetToAppAdminRoleForGroup Delete /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId} Unassign an Application Instance Target from an Application Administrator Role
RoleTargetApi UnassignAppTargetFromAppAdminRoleForUser Delete /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName} Unassign an Application Target from an Application Administrator Role
RoleTargetApi UnassignAppTargetToAdminRoleForGroup Delete /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName} Unassign an Application Target from Application Administrator Role
RoleTargetApi UnassignGroupTargetFromGroupAdminRole Delete /api/v1/groups/{groupId}/roles/{roleId}/targets/groups/{targetGroupId} Unassign a Group Target from a Group Role
RoleTargetApi UnassignGroupTargetFromUserAdminRole Delete /api/v1/users/{userId}/roles/{roleId}/targets/groups/{groupId} Unassign a Group Target from Role
SchemaApi GetApplicationLayout Get /api/v1/meta/layouts/apps/{appName} Retrieve the UI Layout for an Application
SchemaApi GetApplicationUserSchema Get /api/v1/meta/schemas/apps/{appInstanceId}/default Retrieve the default Application User Schema for an Application
SchemaApi GetGroupSchema Get /api/v1/meta/schemas/group/default Retrieve the default Group Schema
SchemaApi GetLogStreamSchema Get /api/v1/meta/schemas/logStream/{logStreamType} Retrieve the Log Stream Schema for the schema type
SchemaApi GetUserSchema Get /api/v1/meta/schemas/user/{schemaId} Retrieve a User Schema
SchemaApi ListLogStreamSchemas Get /api/v1/meta/schemas/logStream List the Log Stream Schemas
SchemaApi UpdateApplicationUserProfile Post /api/v1/meta/schemas/apps/{appInstanceId}/default Update the default Application User Schema for an Application
SchemaApi UpdateGroupSchema Post /api/v1/meta/schemas/group/default Update the default Group Schema
SchemaApi UpdateUserProfile Post /api/v1/meta/schemas/user/{schemaId} Update a User Schema
SessionApi CreateSession Post /api/v1/sessions Create a Session with Session Token
SessionApi GetSession Get /api/v1/sessions/{sessionId} Retrieve a Session
SessionApi RefreshSession Post /api/v1/sessions/{sessionId}/lifecycle/refresh Refresh a Session
SessionApi RevokeSession Delete /api/v1/sessions/{sessionId} Revoke a Session
SubscriptionApi ListRoleSubscriptions Get /api/v1/roles/{roleTypeOrRoleId}/subscriptions List all Subscriptions of a Custom Role
SubscriptionApi ListRoleSubscriptionsByNotificationType Get /api/v1/roles/{roleTypeOrRoleId}/subscriptions/{notificationType} List all Subscriptions of a Custom Role with a specific notification type
SubscriptionApi ListUserSubscriptions Get /api/v1/users/{userId}/subscriptions List all Subscriptions
SubscriptionApi ListUserSubscriptionsByNotificationType Get /api/v1/users/{userId}/subscriptions/{notificationType} List all Subscriptions by type
SubscriptionApi SubscribeRoleSubscriptionByNotificationType Post /api/v1/roles/{roleTypeOrRoleId}/subscriptions/{notificationType}/subscribe Subscribe a Custom Role to a specific notification type
SubscriptionApi SubscribeUserSubscriptionByNotificationType Post /api/v1/users/{userId}/subscriptions/{notificationType}/subscribe Subscribe to a specific notification type
SubscriptionApi UnsubscribeRoleSubscriptionByNotificationType Post /api/v1/roles/{roleTypeOrRoleId}/subscriptions/{notificationType}/unsubscribe Unsubscribe a Custom Role from a specific notification type
SubscriptionApi UnsubscribeUserSubscriptionByNotificationType Post /api/v1/users/{userId}/subscriptions/{notificationType}/unsubscribe Unsubscribe from a specific notification type
SystemLogApi ListLogEvents Get /api/v1/logs List all System Log Events
TemplateApi CreateSmsTemplate Post /api/v1/templates/sms Create an SMS Template
TemplateApi DeleteSmsTemplate Delete /api/v1/templates/sms/{templateId} Delete an SMS Template
TemplateApi GetSmsTemplate Get /api/v1/templates/sms/{templateId} Retrieve an SMS Template
TemplateApi ListSmsTemplates Get /api/v1/templates/sms List all SMS Templates
TemplateApi ReplaceSmsTemplate Put /api/v1/templates/sms/{templateId} Replace an SMS Template
TemplateApi UpdateSmsTemplate Post /api/v1/templates/sms/{templateId} Update an SMS Template
ThreatInsightApi GetCurrentConfiguration Get /api/v1/threats/configuration Retrieve the ThreatInsight Configuration
ThreatInsightApi UpdateConfiguration Post /api/v1/threats/configuration Update the ThreatInsight Configuration
TrustedOriginApi ActivateTrustedOrigin Post /api/v1/trustedOrigins/{trustedOriginId}/lifecycle/activate Activate a Trusted Origin
TrustedOriginApi CreateTrustedOrigin Post /api/v1/trustedOrigins Create a Trusted Origin
TrustedOriginApi DeactivateTrustedOrigin Post /api/v1/trustedOrigins/{trustedOriginId}/lifecycle/deactivate Deactivate a Trusted Origin
TrustedOriginApi DeleteTrustedOrigin Delete /api/v1/trustedOrigins/{trustedOriginId} Delete a Trusted Origin
TrustedOriginApi GetTrustedOrigin Get /api/v1/trustedOrigins/{trustedOriginId} Retrieve a Trusted Origin
TrustedOriginApi ListTrustedOrigins Get /api/v1/trustedOrigins List all Trusted Origins
TrustedOriginApi ReplaceTrustedOrigin Put /api/v1/trustedOrigins/{trustedOriginId} Replace a Trusted Origin
UserApi ActivateUser Post /api/v1/users/{userId}/lifecycle/activate Activate a User
UserApi ChangePassword Post /api/v1/users/{userId}/credentials/change_password Change Password
UserApi ChangeRecoveryQuestion Post /api/v1/users/{userId}/credentials/change_recovery_question Change Recovery Question
UserApi CreateUser Post /api/v1/users Create a User
UserApi DeactivateUser Post /api/v1/users/{userId}/lifecycle/deactivate Deactivate a User
UserApi DeleteLinkedObjectForUser Delete /api/v1/users/{userId}/linkedObjects/{relationshipName} Delete a Linked Object
UserApi DeleteUser Delete /api/v1/users/{userId} Delete a User
UserApi ExpirePassword Post /api/v1/users/{userId}/lifecycle/expire_password Expire Password
UserApi ExpirePasswordAndGetTemporaryPassword Post /api/v1/users/{userId}/lifecycle/expire_password_with_temp_password Expire Password and Set Temporary Password
UserApi ForgotPassword Post /api/v1/users/{userId}/credentials/forgot_password Initiate Forgot Password
UserApi ForgotPasswordSetNewPassword Post /api/v1/users/{userId}/credentials/forgot_password_recovery_question Reset Password with Recovery Question
UserApi GenerateResetPasswordToken Post /api/v1/users/{userId}/lifecycle/reset_password Generate a Reset Password Token
UserApi GetRefreshTokenForUserAndClient Get /api/v1/users/{userId}/clients/{clientId}/tokens/{tokenId} Retrieve a Refresh Token for a Client
UserApi GetUser Get /api/v1/users/{userId} Retrieve a User
UserApi GetUserGrant Get /api/v1/users/{userId}/grants/{grantId} Retrieve a User Grant
UserApi ListAppLinks Get /api/v1/users/{userId}/appLinks List all Assigned Application Links
UserApi ListGrantsForUserAndClient Get /api/v1/users/{userId}/clients/{clientId}/grants List all Grants for a Client
UserApi ListLinkedObjectsForUser Get /api/v1/users/{userId}/linkedObjects/{relationshipName} List all Linked Objects
UserApi ListRefreshTokensForUserAndClient Get /api/v1/users/{userId}/clients/{clientId}/tokens List all Refresh Tokens for a Client
UserApi ListUserBlocks Get /api/v1/users/{userId}/blocks List all User Blocks
UserApi ListUserClients Get /api/v1/users/{userId}/clients List all Clients
UserApi ListUserGrants Get /api/v1/users/{userId}/grants List all User Grants
UserApi ListUserGroups Get /api/v1/users/{userId}/groups List all Groups
UserApi ListUserIdentityProviders Get /api/v1/users/{userId}/idps List all Identity Providers
UserApi ListUsers Get /api/v1/users List all Users
UserApi ReactivateUser Post /api/v1/users/{userId}/lifecycle/reactivate Reactivate a User
UserApi ReplaceUser Put /api/v1/users/{userId} Replace a User
UserApi ResetFactors Post /api/v1/users/{userId}/lifecycle/reset_factors Reset all Factors
UserApi RevokeGrantsForUserAndClient Delete /api/v1/users/{userId}/clients/{clientId}/grants Revoke all Grants for a Client
UserApi RevokeTokenForUserAndClient Delete /api/v1/users/{userId}/clients/{clientId}/tokens/{tokenId} Revoke a Token for a Client
UserApi RevokeTokensForUserAndClient Delete /api/v1/users/{userId}/clients/{clientId}/tokens Revoke all Refresh Tokens for a Client
UserApi RevokeUserGrant Delete /api/v1/users/{userId}/grants/{grantId} Revoke a User Grant
UserApi RevokeUserGrants Delete /api/v1/users/{userId}/grants Revoke all User Grants
UserApi RevokeUserSessions Delete /api/v1/users/{userId}/sessions Revoke all User Sessions
UserApi SetLinkedObjectForUser Put /api/v1/users/{associatedUserId}/linkedObjects/{primaryRelationshipName}/{primaryUserId} Create a Linked Object for two User
UserApi SuspendUser Post /api/v1/users/{userId}/lifecycle/suspend Suspend a User
UserApi UnlockUser Post /api/v1/users/{userId}/lifecycle/unlock Unlock a User
UserApi UnsuspendUser Post /api/v1/users/{userId}/lifecycle/unsuspend Unsuspend a User
UserApi UpdateUser Post /api/v1/users/{userId} Update a User
UserFactorApi ActivateFactor Post /api/v1/users/{userId}/factors/{factorId}/lifecycle/activate Activate a Factor
UserFactorApi EnrollFactor Post /api/v1/users/{userId}/factors Enroll a Factor
UserFactorApi GetFactor Get /api/v1/users/{userId}/factors/{factorId} Retrieve a Factor
UserFactorApi GetFactorTransactionStatus Get /api/v1/users/{userId}/factors/{factorId}/transactions/{transactionId} Retrieve a Factor Transaction Status
UserFactorApi ListFactors Get /api/v1/users/{userId}/factors List all Factors
UserFactorApi ListSupportedFactors Get /api/v1/users/{userId}/factors/catalog List all Supported Factors
UserFactorApi ListSupportedSecurityQuestions Get /api/v1/users/{userId}/factors/questions List all Supported Security Questions
UserFactorApi UnenrollFactor Delete /api/v1/users/{userId}/factors/{factorId} Unenroll a Factor
UserFactorApi VerifyFactor Post /api/v1/users/{userId}/factors/{factorId}/verify Verify an MFA Factor
UserTypeApi CreateUserType Post /api/v1/meta/types/user Create a User Type
UserTypeApi DeleteUserType Delete /api/v1/meta/types/user/{typeId} Delete a User Type
UserTypeApi GetUserType Get /api/v1/meta/types/user/{typeId} Retrieve a User Type
UserTypeApi ListUserTypes Get /api/v1/meta/types/user List all User Types
UserTypeApi ReplaceUserType Put /api/v1/meta/types/user/{typeId} Replace a User Type
UserTypeApi UpdateUserType Post /api/v1/meta/types/user/{typeId} Update a User Type

Documentation For Models

Documentation For Authorization

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.

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.apiToken.manage: Allows the app to manage API Tokens in your Okta organization.
  • okta.apiToken.read: Allows the app to read API Tokens 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.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.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.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.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.
  • okta.roles.read: Allows the app to read administrative role assignments for users in your Okta organization.
  • 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.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.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.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

devex-public@okta.com

Documentation

Documentation is too large to display.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.