OpenIdConnectApplicationSettingsClient
{
"properties": {
"jwks": {
"$ref": "#/components/schemas/OpenIdConnectApplicationSettingsClientKeys"
},
"tos_uri": {
"type": "string"
},
"logo_uri": {
"type": "string"
},
"client_uri": {
"type": "string"
},
"policy_uri": {
"type": "string"
},
"grant_types": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OAuthGrantType"
}
},
"issuer_mode": {
"$ref": "#/components/schemas/OpenIdConnectApplicationIssuerMode"
},
"redirect_uris": {
"type": "array",
"items": {
"type": "string"
}
},
"refresh_token": {
"$ref": "#/components/schemas/OpenIdConnectApplicationSettingsRefreshToken"
},
"consent_method": {
"$ref": "#/components/schemas/OpenIdConnectApplicationConsentMethod"
},
"response_types": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OAuthResponseType"
}
},
"application_type": {
"$ref": "#/components/schemas/OpenIdConnectApplicationType"
},
"wildcard_redirect": {
"type": "string"
},
"initiate_login_uri": {
"type": "string"
},
"idp_initiated_login": {
"$ref": "#/components/schemas/OpenIdConnectApplicationIdpInitiatedLogin"
},
"post_logout_redirect_uris": {
"type": "array",
"items": {
"type": "string"
}
}
},
"x-okta-tags": [
"Application"
]
}
OpenIdConnectApplicationSettingsClientKeys
{
"properties": {
"keys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonWebKey"
}
}
},
"x-okta-tags": [
"Application"
]
}
OpenIdConnectApplicationSettingsRefreshToken
{
"type": "object",
"properties": {
"leeway": {
"type": "integer"
},
"rotation_type": {
"$ref": "#/components/schemas/OpenIdConnectRefreshTokenRotationType"
}
},
"x-okta-tags": [
"Application"
]
}
OpenIdConnectApplicationType
{
"enum": [
"web",
"native",
"browser",
"service"
],
"type": "string",
"x-okta-tags": [
"Application"
]
}
OpenIdConnectRefreshTokenRotationType
{
"enum": [
"rotate",
"static"
],
"type": "string",
"x-okta-tags": [
"Application"
]
}
Org2OrgApplication
{
"properties": {
"name": {
"default": "okta_org2org"
},
"settings": {
"$ref": "#/components/schemas/Org2OrgApplicationSettings"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/SamlApplication",
"x-okta-defined-as": {
"name": "okta_org2org"
}
}
Org2OrgApplicationSettings
{
"properties": {
"app": {
"$ref": "#/components/schemas/Org2OrgApplicationSettingsApp"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/SamlApplicationSettings"
}
Org2OrgApplicationSettingsApp
{
"properties": {
"acsUrl": {
"type": "string"
},
"baseUrl": {
"type": "string"
},
"audRestriction": {
"type": "string"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/ApplicationSettingsApplication"
}
OrgContactType
{
"enum": [
"BILLING",
"TECHNICAL"
],
"type": "string",
"x-okta-tags": [
"Org"
]
}
OrgContactTypeObj
{
"type": "object",
"properties": {
"_links": {
"additionalProperties": {
"type": "object"
}
},
"contactType": {
"$ref": "#/components/schemas/OrgContactType"
}
},
"x-okta-tags": [
"Org"
]
}
OrgContactUser
{
"type": "object",
"properties": {
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"userId": {
"type": "string"
}
},
"x-okta-tags": [
"Org"
],
"x-okta-operations": [
{
"alias": "updateContactUser",
"arguments": [
{
"src": "userId",
"dest": "userId"
}
],
"operationId": "updateOrgContactUser"
}
]
}
OrgListContactTypesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/OrgContactTypeObj"
}
}
OrgOktaCommunicationSetting
{
"type": "object",
"properties": {
"_links": {
"additionalProperties": {
"type": "object"
}
},
"optOutEmailUsers": {
"type": "boolean",
"readOnly": true
}
},
"x-okta-tags": [
"Org"
],
"x-okta-operations": [
{
"alias": "optInUsersToOktaCommunicationEmails",
"operationId": "optInUsersToOktaCommunicationEmails"
},
{
"alias": "optOutUsersFromOktaCommunicationEmails",
"operationId": "optOutUsersFromOktaCommunicationEmails"
}
]
}
OrgOktaSupportSetting
{
"enum": [
"DISABLED",
"ENABLED"
],
"type": "string",
"x-okta-tags": [
"Org"
]
}
OrgOktaSupportSettingsObj
{
"type": "object",
"properties": {
"_links": {
"additionalProperties": {
"type": "object"
}
},
"support": {
"$ref": "#/components/schemas/OrgOktaSupportSetting"
},
"expiration": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"x-okta-tags": [
"Org"
],
"x-okta-operations": [
{
"alias": "extendOktaSupport",
"operationId": "extendOktaSupport"
},
{
"alias": "grantOktaSupport",
"operationId": "grantOktaSupport"
},
{
"alias": "revokeOktaSupport",
"operationId": "revokeOktaSupport"
}
]
}
OrgPreferences
{
"type": "object",
"properties": {
"_links": {
"additionalProperties": {
"type": "object"
}
},
"showEndUserFooter": {
"type": "boolean",
"readOnly": true
}
},
"x-okta-tags": [
"Org"
],
"x-okta-operations": [
{
"alias": "hideEndUserFooter",
"operationId": "hideOktaUIFooter"
},
{
"alias": "showEndUserFooter",
"operationId": "showOktaUIFooter"
}
]
}
OrgSetting
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"_links": {
"additionalProperties": {
"type": "object"
}
},
"status": {
"type": "string",
"readOnly": true
},
"country": {
"type": "string"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"website": {
"type": "string"
},
"address1": {
"type": "string"
},
"address2": {
"type": "string"
},
"expiresAt": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"subdomain": {
"type": "string",
"readOnly": true
},
"postalCode": {
"type": "string"
},
"companyName": {
"type": "string"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"phoneNumber": {
"type": "string"
},
"supportPhoneNumber": {
"type": "string"
},
"endUserSupportHelpURL": {
"type": "string"
}
},
"x-okta-crud": [
{
"alias": "read",
"arguments": [
{
"dest": "orgSetting",
"self": true
}
],
"operationId": "getOrgSettings"
},
{
"alias": "update",
"arguments": [
{
"dest": "orgSetting",
"self": true
}
],
"operationId": "updateOrgSetting"
}
],
"x-okta-tags": [
"Org"
],
"x-okta-operations": [
{
"alias": "partialUpdate",
"arguments": [
{
"dest": "orgSetting",
"self": true
}
],
"operationId": "partialUpdateOrgSetting"
},
{
"alias": "getContactTypes",
"operationId": "getOrgContactTypes"
},
{
"alias": "getOrgContactUser",
"operationId": "getOrgContactUser"
},
{
"alias": "getSupportSettings",
"operationId": "getOrgOktaSupportSettings"
},
{
"alias": "communicationSettings",
"operationId": "getOktaCommunicationSettings"
},
{
"alias": "orgPreferences",
"operationId": "getOrgPreferences"
},
{
"alias": "showFooter",
"arguments": [
{
"dest": "orgSetting",
"self": true
}
],
"operationId": "showOktaUIFooter"
},
{
"alias": "hideFooter",
"arguments": [
{
"dest": "orgSetting",
"self": true
}
],
"operationId": "hideOktaUIFooter"
},
{
"alias": "updateOrgLogo",
"operationId": "updateOrgLogo"
}
]
}
PasswordCredential
{
"type": "object",
"properties": {
"hash": {
"$ref": "#/components/schemas/PasswordCredentialHash"
},
"hook": {
"$ref": "#/components/schemas/PasswordCredentialHook"
},
"value": {
"type": "string",
"format": "password"
}
},
"x-okta-tags": [
"User"
]
}
PasswordCredentialHash
{
"type": "object",
"properties": {
"salt": {
"type": "string"
},
"value": {
"type": "string"
},
"algorithm": {
"$ref": "#/components/schemas/PasswordCredentialHashAlgorithm"
},
"saltOrder": {
"type": "string"
},
"workFactor": {
"type": "integer"
}
},
"x-okta-tags": [
"User"
]
}
PasswordCredentialHashAlgorithm
{
"enum": [
"BCRYPT",
"SHA-512",
"SHA-256",
"SHA-1",
"MD5"
],
"type": "string",
"x-okta-tags": [
"User"
]
}
PasswordCredentialHook
{
"type": "object",
"properties": {
"type": {
"type": "string"
}
},
"x-okta-tags": [
"User"
]
}
PasswordDictionary
{
"type": "object",
"properties": {
"common": {
"$ref": "#/components/schemas/PasswordDictionaryCommon"
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordDictionaryCommon
{
"type": "object",
"properties": {
"exclude": {
"type": "boolean",
"default": false
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordExpirationPolicyRuleCondition
{
"type": "object",
"properties": {
"unit": {
"type": "string"
},
"number": {
"type": "integer"
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicy
{
"type": "object",
"properties": {
"settings": {
"$ref": "#/components/schemas/PasswordPolicySettings"
},
"conditions": {
"$ref": "#/components/schemas/PasswordPolicyConditions"
}
},
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/Policy"
}
PasswordPolicyAuthenticationProviderCondition
{
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"type": "string"
}
},
"provider": {
"enum": [
"ACTIVE_DIRECTORY",
"ANY",
"LDAP",
"OKTA"
],
"type": "string"
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicyConditions
{
"properties": {
"people": {
"$ref": "#/components/schemas/PolicyPeopleCondition"
},
"authProvider": {
"$ref": "#/components/schemas/PasswordPolicyAuthenticationProviderCondition"
}
},
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/PolicyRuleConditions"
}
PasswordPolicyDelegationSettings
{
"type": "object",
"properties": {
"options": {
"$ref": "#/components/schemas/PasswordPolicyDelegationSettingsOptions"
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicyDelegationSettingsOptions
{
"type": "object",
"properties": {
"skipUnlock": {
"type": "boolean"
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicyPasswordSettings
{
"type": "object",
"properties": {
"age": {
"$ref": "#/components/schemas/PasswordPolicyPasswordSettingsAge"
},
"lockout": {
"$ref": "#/components/schemas/PasswordPolicyPasswordSettingsLockout"
},
"complexity": {
"$ref": "#/components/schemas/PasswordPolicyPasswordSettingsComplexity"
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicyPasswordSettingsAge
{
"type": "object",
"properties": {
"maxAgeDays": {
"type": "integer",
"default": 0
},
"historyCount": {
"type": "integer",
"default": 0
},
"minAgeMinutes": {
"type": "integer",
"default": 0
},
"expireWarnDays": {
"type": "integer",
"default": 0
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicyPasswordSettingsComplexity
{
"type": "object",
"properties": {
"minLength": {
"type": "integer",
"default": 8
},
"minNumber": {
"type": "integer",
"default": 1
},
"minSymbol": {
"type": "integer",
"default": 1
},
"dictionary": {
"$ref": "#/components/schemas/PasswordDictionary"
},
"minLowerCase": {
"type": "integer",
"default": 1
},
"minUpperCase": {
"type": "integer",
"default": 1
},
"excludeUsername": {
"type": "boolean",
"default": true
},
"excludeAttributes": {
"type": "array",
"items": {
"type": "string"
},
"default": 1
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicyPasswordSettingsLockout
{
"type": "object",
"properties": {
"maxAttempts": {
"type": "integer"
},
"autoUnlockMinutes": {
"type": "integer"
},
"showLockoutFailures": {
"type": "boolean"
},
"userLockoutNotificationChannels": {
"type": "array",
"items": {
"type": "string"
}
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicyRecoveryEmail
{
"type": "object",
"properties": {
"status": {
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string",
"readOnly": true
},
"properties": {
"$ref": "#/components/schemas/PasswordPolicyRecoveryEmailProperties"
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicyRecoveryEmailProperties
{
"type": "object",
"properties": {
"recoveryToken": {
"$ref": "#/components/schemas/PasswordPolicyRecoveryEmailRecoveryToken"
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicyRecoveryEmailRecoveryToken
{
"type": "object",
"properties": {
"tokenLifetimeMinutes": {
"type": "integer",
"default": 10080
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicyRecoveryFactorSettings
{
"type": "object",
"properties": {
"status": {
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string",
"default": "INACTIVE"
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicyRecoveryFactors
{
"type": "object",
"properties": {
"okta_sms": {
"$ref": "#/components/schemas/PasswordPolicyRecoveryFactorSettings"
},
"okta_call": {
"$ref": "#/components/schemas/PasswordPolicyRecoveryFactorSettings"
},
"okta_email": {
"$ref": "#/components/schemas/PasswordPolicyRecoveryEmail"
},
"recovery_question": {
"$ref": "#/components/schemas/PasswordPolicyRecoveryQuestion"
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicyRecoveryQuestion
{
"type": "object",
"properties": {
"status": {
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string",
"readOnly": true
},
"properties": {
"$ref": "#/components/schemas/PasswordPolicyRecoveryQuestionProperties"
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicyRecoveryQuestionComplexity
{
"type": "object",
"properties": {
"minLength": {
"type": "integer",
"readOnly": true
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicyRecoveryQuestionProperties
{
"type": "object",
"properties": {
"complexity": {
"$ref": "#/components/schemas/PasswordPolicyRecoveryQuestionComplexity"
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicyRecoverySettings
{
"type": "object",
"properties": {
"factors": {
"$ref": "#/components/schemas/PasswordPolicyRecoveryFactors"
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicyRule
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"actions": {
"$ref": "#/components/schemas/PasswordPolicyRuleActions"
},
"conditions": {
"$ref": "#/components/schemas/PasswordPolicyRuleConditions"
}
},
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/PolicyRule"
}
PasswordPolicyRuleAction
{
"type": "object",
"properties": {
"access": {
"enum": [
"ALLOW",
"DENY"
],
"type": "string",
"readOnly": false
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordPolicyRuleActions
{
"properties": {
"passwordChange": {
"$ref": "#/components/schemas/PasswordPolicyRuleAction"
},
"selfServiceUnlock": {
"$ref": "#/components/schemas/PasswordPolicyRuleAction"
},
"selfServicePasswordReset": {
"$ref": "#/components/schemas/PasswordPolicyRuleAction"
}
},
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/PolicyRuleActions"
}
PasswordPolicyRuleConditions
{
"properties": {
"people": {
"$ref": "#/components/schemas/PolicyPeopleCondition"
},
"network": {
"$ref": "#/components/schemas/PolicyNetworkCondition"
}
},
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/PolicyRuleConditions"
}
PasswordPolicySettings
{
"type": "object",
"properties": {
"password": {
"$ref": "#/components/schemas/PasswordPolicyPasswordSettings"
},
"recovery": {
"$ref": "#/components/schemas/PasswordPolicyRecoverySettings"
},
"delegation": {
"$ref": "#/components/schemas/PasswordPolicyDelegationSettings"
}
},
"x-okta-tags": [
"Policy"
]
}
PasswordSettingObject
{
"type": "object",
"properties": {
"seed": {
"$ref": "#/components/schemas/SeedEnum"
},
"change": {
"$ref": "#/components/schemas/ChangeEnum"
},
"status": {
"$ref": "#/components/schemas/EnabledStatus"
}
},
"x-okta-tags": [
"Application"
]
}
PlatformConditionEvaluatorPlatform
{
"type": "object",
"properties": {
"os": {
"$ref": "#/components/schemas/PlatformConditionEvaluatorPlatformOperatingSystem"
},
"type": {
"enum": [
"DESKTOP",
"MOBILE",
"OTHER",
"ANY"
],
"type": "string"
}
},
"x-okta-tags": [
"Policy"
]
}
PlatformConditionEvaluatorPlatformOperatingSystem
{
"type": "object",
"properties": {
"type": {
"enum": [
"ANDROID",
"IOS",
"WINDOWS",
"OSX",
"OTHER",
"ANY"
],
"type": "string"
},
"version": {
"$ref": "#/components/schemas/PlatformConditionEvaluatorPlatformOperatingSystemVersion"
},
"expression": {
"type": "string"
}
},
"x-okta-tags": [
"Policy"
]
}