AuthenticationProvider
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/AuthenticationProviderType"
}
},
"x-okta-tags": [
"User"
]
}
AuthenticationProviderType
{
"enum": [
"ACTIVE_DIRECTORY",
"FEDERATION",
"LDAP",
"OKTA",
"SOCIAL",
"IMPORT"
],
"type": "string",
"x-okta-tags": [
"User"
]
}
Authenticator
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/AuthenticatorType"
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"status": {
"$ref": "#/components/schemas/AuthenticatorStatus"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"provider": {
"$ref": "#/components/schemas/AuthenticatorProvider"
},
"settings": {
"$ref": "#/components/schemas/AuthenticatorSettings"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"x-okta-crud": [
{
"alias": "read",
"arguments": [],
"operationId": "getAuthenticator"
},
{
"alias": "update",
"arguments": [
{
"src": "id",
"dest": "authenticatorId"
},
{
"dest": "authenticator",
"self": true
}
],
"operationId": "updateAuthenticator"
}
],
"x-okta-tags": [
"Authenticator"
],
"x-okta-operations": [
{
"alias": "activate",
"arguments": [
{
"src": "id",
"dest": "authenticatorId"
}
],
"operationId": "activateAuthenticator"
},
{
"alias": "deactivate",
"arguments": [
{
"src": "id",
"dest": "authenticatorId"
}
],
"operationId": "deactivateAuthenticator"
}
]
}
AuthenticatorListAllAvailableResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Authenticator"
}
}
AuthenticatorProvider
{
"properties": {
"type": {
"type": "string"
},
"configuration": {
"$ref": "#/components/schemas/AuthenticatorProviderConfiguration"
}
},
"x-okta-tags": [
"Authenticator"
]
}
AuthenticatorProviderConfiguration
{
"properties": {
"host": {
"type": "string"
},
"authPort": {
"type": "integer"
},
"hostName": {
"type": "string"
},
"secretKey": {
"type": "string"
},
"instanceId": {
"type": "string"
},
"sharedSecret": {
"type": "string"
},
"integrationKey": {
"type": "string"
},
"userNameTemplate": {
"$ref": "#/components/schemas/AuthenticatorProviderConfigurationUserNamePlate"
}
},
"x-okta-tags": [
"Authenticator"
]
}
AuthenticatorProviderConfigurationUserNamePlate
{
"properties": {
"template": {
"type": "string"
}
},
"x-okta-tags": [
"Authenticator"
]
}
AuthenticatorSettings
{
"type": "object",
"properties": {
"allowedFor": {
"$ref": "#/components/schemas/AllowedForEnum"
},
"compliance": {
"$ref": "#/components/schemas/Compliance"
},
"appInstanceId": {
"type": "string"
},
"channelBinding": {
"$ref": "#/components/schemas/ChannelBinding"
},
"userVerification": {
"$ref": "#/components/schemas/UserVerificationEnum"
},
"tokenLifetimeInMinutes": {
"type": "integer"
}
},
"x-okta-tags": [
"Authenticator"
]
}
AuthenticatorStatus
{
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string",
"x-okta-tags": [
"Authenticator"
]
}
AuthenticatorType
{
"enum": [
"app",
"password",
"security_question",
"phone",
"email",
"security_key",
"federated"
],
"type": "string",
"x-okta-tags": [
"Authenticator"
]
}
AuthorizationServer
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string"
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"issuer": {
"type": "string"
},
"status": {
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"default": {
"type": "boolean",
"readOnly": true
},
"audiences": {
"type": "array",
"items": {
"type": "string"
}
},
"issuerMode": {
"enum": [
"ORG_URL",
"CUSTOM_URL",
"DYNAMIC"
],
"type": "string"
},
"credentials": {
"$ref": "#/components/schemas/AuthorizationServerCredentials"
},
"description": {
"type": "string"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"x-okta-crud": [
{
"alias": "create",
"arguments": [
{
"dest": "authorizationServer",
"self": true
}
],
"operationId": "createAuthorizationServer"
},
{
"alias": "read",
"arguments": [],
"operationId": "getAuthorizationServer"
},
{
"alias": "update",
"arguments": [
{
"src": "id",
"dest": "authServerId"
},
{
"dest": "authorizationServer",
"self": true
}
],
"operationId": "updateAuthorizationServer"
},
{
"alias": "delete",
"arguments": [
{
"src": "id",
"dest": "authServerId"
},
{
"dest": "authorizationServer",
"self": true
}
],
"operationId": "deleteAuthorizationServer"
}
],
"x-okta-tags": [
"AuthorizationServer"
],
"x-okta-operations": [
{
"alias": "listOAuth2Claims",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "listOAuth2Claims"
},
{
"alias": "createOAuth2Claim",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "createOAuth2Claim"
},
{
"alias": "deleteOAuth2Claim",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "deleteOAuth2Claim"
},
{
"alias": "getOAuth2Claim",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "getOAuth2Claim"
},
{
"alias": "updateOAuth2Claim",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "updateOAuth2Claim"
},
{
"alias": "listOAuth2Clients",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "listOAuth2ClientsForAuthorizationServer"
},
{
"alias": "revokeRefreshTokensForClient",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "revokeRefreshTokensForAuthorizationServerAndClient"
},
{
"alias": "listRefreshTokensForClient",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "listRefreshTokensForAuthorizationServerAndClient"
},
{
"alias": "getRefreshTokenForClient",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "getRefreshTokenForAuthorizationServerAndClient"
},
{
"alias": "revokeRefreshTokenForClient",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "revokeRefreshTokenForAuthorizationServerAndClient"
},
{
"alias": "listKeys",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "listAuthorizationServerKeys"
},
{
"alias": "rotateKeys",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "rotateAuthorizationServerKeys"
},
{
"alias": "activate",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "activateAuthorizationServer"
},
{
"alias": "deactivate",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "deactivateAuthorizationServer"
},
{
"alias": "listPolicies",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "listAuthorizationServerPolicies"
},
{
"alias": "createPolicy",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "createAuthorizationServerPolicy"
},
{
"alias": "deletePolicy",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "deleteAuthorizationServerPolicy"
},
{
"alias": "getPolicy",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "getAuthorizationServerPolicy"
},
{
"alias": "updatePolicy",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "updateAuthorizationServerPolicy"
},
{
"alias": "listOAuth2Scopes",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "listOAuth2Scopes"
},
{
"alias": "createOAuth2Scope",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "createOAuth2Scope"
},
{
"alias": "deleteOAuth2Scope",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "deleteOAuth2Scope"
},
{
"alias": "getOAuth2Scope",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "getOAuth2Scope"
},
{
"alias": "updateOAuth2Scope",
"arguments": [
{
"src": "id",
"dest": "authServerId"
}
],
"operationId": "updateOAuth2Scope"
}
]
}
AuthorizationServerCredentials
{
"properties": {
"signing": {
"$ref": "#/components/schemas/AuthorizationServerCredentialsSigningConfig"
}
},
"x-okta-tags": [
"Application"
]
}
AuthorizationServerCredentialsRotationMode
{
"enum": [
"AUTO",
"MANUAL"
],
"type": "string",
"x-okta-tags": [
"AuthorizationServer"
]
}
AuthorizationServerCredentialsSigningConfig
{
"properties": {
"kid": {
"type": "string"
},
"use": {
"$ref": "#/components/schemas/AuthorizationServerCredentialsUse"
},
"lastRotated": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"nextRotation": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"rotationMode": {
"$ref": "#/components/schemas/AuthorizationServerCredentialsRotationMode"
}
},
"x-okta-tags": [
"AuthorizationServer"
]
}
AuthorizationServerCredentialsUse
{
"enum": [
"sig"
],
"type": "string",
"x-okta-tags": [
"AuthorizationServer"
]
}
AuthorizationServerEnumeratePolicyRulesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AuthorizationServerPolicyRule"
}
}
AuthorizationServerGetClaimsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/OAuth2Claim"
}
}
AuthorizationServerGetClientTokensResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/OAuth2RefreshToken"
}
}
AuthorizationServerGetPoliciesSuccessResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AuthorizationServerPolicy"
}
}
AuthorizationServerGetScopesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/OAuth2Scope"
}
}
AuthorizationServerListClientsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/OAuth2Client"
}
}
AuthorizationServerListCredentialsKeysResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonWebKey"
}
}
AuthorizationServerListServersResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AuthorizationServer"
}
}
AuthorizationServerPolicy
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/PolicyType"
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"status": {
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string"
},
"system": {
"type": "boolean"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"priority": {
"type": "integer"
},
"_embedded": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"conditions": {
"$ref": "#/components/schemas/PolicyRuleConditions"
},
"description": {
"type": "string"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"x-okta-crud": [
{
"alias": "read",
"arguments": [
{
"src": "id",
"dest": "policyId"
}
],
"operationId": "getAuthorizationServerPolicy"
},
{
"alias": "update",
"arguments": [
{
"src": "id",
"dest": "policyId"
},
{
"dest": "policy",
"self": true
}
],
"operationId": "updateAuthorizationServerPolicy"
},
{
"alias": "delete",
"arguments": [
{
"src": "id",
"dest": "policyId"
}
],
"operationId": "deleteAuthorizationServerPolicy"
}
],
"x-okta-tags": [
"AuthorizationServer"
],
"x-okta-operations": [
{
"alias": "listPolicyRules",
"arguments": [
{
"src": "id",
"dest": "policyId"
}
],
"operationId": "listAuthorizationServerPolicyRules"
},
{
"alias": "createPolicyRule",
"arguments": [
{
"src": "id",
"dest": "policyId"
}
],
"operationId": "createAuthorizationServerPolicyRule"
},
{
"alias": "getPolicyRule",
"arguments": [
{
"src": "id",
"dest": "policyId"
}
],
"operationId": "getAuthorizationServerPolicyRule"
},
{
"alias": "deletePolicyRule",
"arguments": [
{
"src": "id",
"dest": "policyId"
}
],
"operationId": "deleteAuthorizationServerPolicyRule"
},
{
"alias": "activate",
"arguments": [
{
"src": "id",
"dest": "policyId"
}
],
"operationId": "activateAuthorizationServerPolicy"
},
{
"alias": "deactivate",
"arguments": [
{
"src": "id",
"dest": "policyId"
}
],
"operationId": "deactivateAuthorizationServerPolicy"
}
]
}
AuthorizationServerPolicyRule
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string"
},
"type": {
"enum": [
"RESOURCE_ACCESS"
],
"type": "string"
},
"status": {
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string",
"default": "ACTIVE"
},
"system": {
"type": "boolean",
"default": false
},
"actions": {
"$ref": "#/components/schemas/AuthorizationServerPolicyRuleActions"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"priority": {
"type": "integer"
},
"conditions": {
"$ref": "#/components/schemas/AuthorizationServerPolicyRuleConditions"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"x-okta-crud": [
{
"alias": "update",
"arguments": [
{
"src": "id",
"dest": "ruleId"
},
{
"dest": "policyRule",
"self": true
},
{
"dest": "policyId",
"parentSrc": "id"
}
],
"operationId": "updateAuthorizationServerPolicyRule"
},
{
"alias": "delete",
"arguments": [
{
"src": "id",
"dest": "ruleId"
},
{
"dest": "policyId",
"parentSrc": "policyId"
}
],
"operationId": "deleteAuthorizationServerPolicyRule"
}
],
"x-okta-tags": [
"AuthorizationServerPolicy"
],
"x-okta-operations": [
{
"alias": "activate",
"arguments": [
{
"src": "id",
"dest": "ruleId"
},
{
"dest": "policyId",
"parentSrc": "policyId"
}
],
"operationId": "activateAuthorizationServerPolicyRule"
},
{
"alias": "deactivate",
"arguments": [
{
"src": "id",
"dest": "ruleId"
},
{
"dest": "policyId",
"parentSrc": "policyId"
}
],
"operationId": "deactivateAuthorizationServerPolicyRule"
}
]
}
AuthorizationServerPolicyRuleActions
{
"type": "object",
"properties": {
"token": {
"$ref": "#/components/schemas/TokenAuthorizationServerPolicyRuleAction"
}
},
"x-okta-tags": [
"AuthorizationServerPolicy"
]
}
AuthorizationServerPolicyRuleConditions
{
"type": "object",
"properties": {
"people": {
"$ref": "#/components/schemas/PolicyPeopleCondition"
},
"scopes": {
"$ref": "#/components/schemas/OAuth2ScopesMediationPolicyRuleCondition"
},
"clients": {
"$ref": "#/components/schemas/ClientPolicyCondition"
},
"grantTypes": {
"$ref": "#/components/schemas/GrantTypePolicyRuleCondition"
}
},
"x-okta-tags": [
"AuthorizationServerPolicy"
]
}
AuthorizationServerRotateKeyLifecycleResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonWebKey"
}
}
AutoLoginApplication
{
"properties": {
"settings": {
"$ref": "#/components/schemas/AutoLoginApplicationSettings"
},
"credentials": {
"$ref": "#/components/schemas/SchemeApplicationCredentials"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/Application"
}
AutoLoginApplicationSettings
{
"properties": {
"signOn": {
"$ref": "#/components/schemas/AutoLoginApplicationSettingsSignOn"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/ApplicationSettings"
}
AutoLoginApplicationSettingsSignOn
{
"properties": {
"loginUrl": {
"type": "string"
},
"redirectUrl": {
"type": "string"
}
},
"x-okta-tags": [
"Application"
]
}
BasicApplicationSettings
{
"properties": {
"app": {
"$ref": "#/components/schemas/BasicApplicationSettingsApplication"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/ApplicationSettings"
}
BasicApplicationSettingsApplication
{
"properties": {
"url": {
"type": "string"
},
"authURL": {
"type": "string"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/ApplicationSettingsApplication"
}
BasicAuthApplication
{
"properties": {
"name": {
"default": "template_basic_auth"
},
"settings": {
"$ref": "#/components/schemas/BasicApplicationSettings"
},
"credentials": {
"$ref": "#/components/schemas/SchemeApplicationCredentials"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/Application",
"x-okta-defined-as": {
"name": "template_basic_auth"
}
}
BeforeScheduledActionPolicyRuleCondition
{
"type": "object",
"properties": {
"duration": {
"$ref": "#/components/schemas/Duration"
},
"lifecycleAction": {
"$ref": "#/components/schemas/ScheduledUserLifecycleAction"
}
},
"x-okta-tags": [
"Policy"
]
}
BookmarkApplication
{
"properties": {
"name": {
"default": "bookmark"
},
"settings": {
"$ref": "#/components/schemas/BookmarkApplicationSettings"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/Application",
"x-okta-defined-as": {
"name": "bookmark"
}
}
BookmarkApplicationSettings
{
"properties": {
"app": {
"$ref": "#/components/schemas/BookmarkApplicationSettingsApplication"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/ApplicationSettings"
}
BookmarkApplicationSettingsApplication
{
"properties": {
"url": {
"type": "string"
},
"requestIntegration": {
"type": "boolean"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/ApplicationSettingsApplication"
}
Brand
{
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"removePoweredByOkta": {
"type": "boolean"
},
"customPrivacyPolicyUrl": {
"type": "string"
},
"agreeToCustomPrivacyPolicy": {
"type": "boolean"
}
},
"x-okta-crud": [
{
"alias": "read",
"arguments": [
{
"src": "id",
"dest": "brandId"
}
],
"operationId": "getBrand"
},
{
"alias": "update",
"arguments": [
{
"src": "id",
"dest": "brandId"
},
{
"dest": "brand",
"self": true
}
],
"operationId": "updateBrand"
}
],
"x-okta-tags": [
"Brand"
]
}
BrandGetAllBrandsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Brand"
}
}
BrandGetThemesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ThemeResponse"
}
}
BrandListEmailTemplateCustomizationsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailTemplateCustomization"
}
}
BrandListEmailTemplatesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailTemplate"
}
}
BrowserPluginApplication
{
"properties": {
"credentials": {
"$ref": "#/components/schemas/SchemeApplicationCredentials"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/Application",
"x-openapi-v3-discriminator": {
"mapping": {
"template_swa": "#/definitions/SwaApplication",
"template_swa3field": "#/definitions/SwaThreeFieldApplication"
},
"propertyName": "name"
}
}
CallUserFactor
{
"properties": {
"profile": {
"$ref": "#/components/schemas/CallUserFactorProfile"
}
},
"x-okta-tags": [
"UserFactor"
],
"x-okta-parent": "#/definitions/UserFactor"
}
CallUserFactorProfile
{
"properties": {
"phoneNumber": {
"type": "string"
},
"phoneExtension": {
"type": "string"
}
},
"x-okta-tags": [
"UserFactor"
]
}
CapabilitiesCreateObject
{
"type": "object",
"properties": {
"lifecycleCreate": {
"$ref": "#/components/schemas/LifecycleCreateSettingObject"
}
},
"x-okta-tags": [
"Application"
]
}
CapabilitiesObject
{
"type": "object",
"properties": {
"create": {
"$ref": "#/components/schemas/CapabilitiesCreateObject"
},
"update": {
"$ref": "#/components/schemas/CapabilitiesUpdateObject"
}
},
"x-okta-tags": [
"Application"
]
}
CapabilitiesUpdateObject
{
"type": "object",
"properties": {
"profile": {
"$ref": "#/components/schemas/ProfileSettingObject"
},
"password": {
"$ref": "#/components/schemas/PasswordSettingObject"
},
"lifecycleDeactivate": {
"$ref": "#/components/schemas/LifecycleDeactivateSettingObject"
}
},
"x-okta-tags": [
"Application"
]
}
CatalogApplication
{
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string"
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"status": {
"$ref": "#/components/schemas/CatalogApplicationStatus"
},
"website": {
"type": "string"
},
"category": {
"type": "string"
},
"features": {
"type": "array",
"items": {
"type": "string"
}
},
"description": {
"type": "string"
},
"displayName": {
"type": "string"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"signOnModes": {
"type": "array",
"items": {
"type": "string"
}
},
"verificationStatus": {
"type": "string"
}
},
"x-okta-tags": [
"Role"
]
}