LogRequest
{
"type": "object",
"properties": {
"ipChain": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogIpAddress"
},
"readOnly": true
}
},
"x-okta-tags": [
"Log"
]
}
LogSecurityContext
{
"type": "object",
"properties": {
"isp": {
"type": "string",
"readOnly": true
},
"asOrg": {
"type": "string",
"readOnly": true
},
"domain": {
"type": "string",
"readOnly": true
},
"isProxy": {
"type": "boolean",
"readOnly": true
},
"asNumber": {
"type": "integer",
"readOnly": true
}
},
"x-okta-tags": [
"Log"
]
}
LogSeverity
{
"enum": [
"DEBUG",
"INFO",
"WARN",
"ERROR"
],
"type": "string",
"x-okta-tags": [
"Log"
]
}
LogTarget
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"type": {
"type": "string",
"readOnly": true
},
"alternateId": {
"type": "string",
"readOnly": true
},
"detailEntry": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"displayName": {
"type": "string",
"readOnly": true
}
},
"x-okta-tags": [
"Log"
]
}
LogTransaction
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"type": {
"type": "string",
"readOnly": true
},
"detail": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
}
},
"x-okta-tags": [
"Log"
]
}
LogUserAgent
{
"type": "object",
"properties": {
"os": {
"type": "string",
"readOnly": true
},
"browser": {
"type": "string",
"readOnly": true
},
"rawUserAgent": {
"type": "string",
"readOnly": true
}
},
"x-okta-tags": [
"Log"
]
}
MDMEnrollmentPolicyRuleCondition
{
"type": "object",
"properties": {
"enrollment": {
"enum": [
"OMM",
"ANY_OR_NONE"
],
"type": "string"
},
"blockNonSafeAndroid": {
"type": "boolean"
}
},
"x-okta-tags": [
"Policy"
]
}
MultifactorEnrollmentPolicy
{
"allOf": [
{
"$ref": "#/components/schemas/Policy"
},
{
"type": "object",
"properties": {
"settings": {
"$ref": "#/components/schemas/MultifactorEnrollmentPolicySettings"
},
"conditions": {
"$ref": "#/components/schemas/PolicyRuleConditions"
}
}
}
],
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/Policy"
}
MultifactorEnrollmentPolicyAuthenticatorSettings
{
"type": "object",
"properties": {
"key": {
"$ref": "#/components/schemas/MultifactorEnrollmentPolicyAuthenticatorType"
},
"enroll": {
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/MultifactorEnrollmentPolicyAuthenticatorStatus"
}
}
},
"constraints": {
"type": "object",
"minimum": 0,
"properties": {
"aaguidGroups": {
"type": "array",
"items": {
"type": "string",
"uniqueItems": true
}
}
},
"x-okta-lifecycle": {
"features": [
"WEBAUTHN_MDS_CATALOG_BASED_AAGUID_ALLOWLIST"
]
}
}
},
"x-okta-tags": [
"Policy"
]
}
MultifactorEnrollmentPolicyAuthenticatorStatus
{
"enum": [
"NOT_ALLOWED",
"OPTIONAL",
"REQUIRED"
],
"type": "string",
"x-okta-tags": [
"Policy"
]
}
MultifactorEnrollmentPolicyAuthenticatorType
{
"enum": [
"custom_app",
"custom_otp",
"duo",
"external_idp",
"google_otp",
"okta_email",
"okta_password",
"okta_verify",
"onprem_mfa",
"phone_number",
"rsa_token",
"security_question",
"symantec_vip",
"webauthn",
"yubikey_token"
],
"type": "string",
"x-okta-tags": [
"Policy"
]
}
MultifactorEnrollmentPolicySettings
{
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/MultifactorEnrollmentPolicySettingsType"
},
"authenticators": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MultifactorEnrollmentPolicyAuthenticatorSettings"
}
}
},
"x-okta-tags": [
"Policy"
]
}
MultifactorEnrollmentPolicySettingsType
{
"enum": [
"AUTHENTICATORS"
],
"type": "string",
"x-okta-tags": [
"Policy"
]
}
NetworkZone
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"asns": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/NetworkZoneType"
},
"usage": {
"$ref": "#/components/schemas/NetworkZoneUsage"
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"status": {
"$ref": "#/components/schemas/NetworkZoneStatus"
},
"system": {
"type": "boolean"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"proxies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NetworkZoneAddress"
}
},
"gateways": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NetworkZoneAddress"
}
},
"locations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NetworkZoneLocation"
}
},
"proxyType": {
"type": "string"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"x-okta-crud": [
{
"alias": "read",
"arguments": [
{
"src": "id",
"dest": "zoneId"
}
],
"operationId": "getNetworkZone"
},
{
"alias": "update",
"arguments": [
{
"src": "id",
"dest": "zoneId"
},
{
"dest": "zone",
"self": true
}
],
"operationId": "updateNetworkZone"
},
{
"alias": "delete",
"arguments": [
{
"src": "id",
"dest": "zoneId"
}
],
"operationId": "deleteNetworkZone"
}
],
"x-okta-tags": [
"NetworkZone"
],
"x-okta-operations": [
{
"alias": "activate",
"arguments": [
{
"src": "id",
"dest": "zoneId"
}
],
"operationId": "activateNetworkZone"
},
{
"alias": "deactivate",
"arguments": [
{
"src": "id",
"dest": "zoneId"
}
],
"operationId": "deactivateNetworkZone"
}
]
}
NetworkZoneAddress
{
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/NetworkZoneAddressType"
},
"value": {
"type": "string"
}
},
"x-okta-tags": [
"NetworkZone"
]
}
NetworkZoneAddressType
{
"enum": [
"CIDR",
"RANGE"
],
"type": "string",
"x-okta-tags": [
"NetworkZone"
]
}
NetworkZoneListZonesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/NetworkZone"
}
}
NetworkZoneLocation
{
"type": "object",
"properties": {
"region": {
"type": "string"
},
"country": {
"type": "string"
}
},
"x-okta-tags": [
"NetworkZone"
]
}
NetworkZoneStatus
{
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string",
"x-okta-tags": [
"NetworkZone"
]
}
NetworkZoneType
{
"enum": [
"IP",
"DYNAMIC"
],
"type": "string",
"x-okta-tags": [
"NetworkZone"
]
}
NetworkZoneUsage
{
"enum": [
"POLICY",
"BLOCKLIST"
],
"type": "string",
"x-okta-tags": [
"NetworkZone"
]
}
NotificationType
{
"enum": [
"CONNECTOR_AGENT",
"USER_LOCKED_OUT",
"APP_IMPORT",
"LDAP_AGENT",
"AD_AGENT",
"OKTA_ANNOUNCEMENT",
"OKTA_ISSUE",
"OKTA_UPDATE",
"IWA_AGENT",
"USER_DEPROVISION",
"REPORT_SUSPICIOUS_ACTIVITY",
"RATELIMIT_NOTIFICATION"
],
"type": "string",
"x-okta-tags": [
"Subscription"
]
}
OAuth2Actor
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"type": {
"type": "string"
}
},
"x-okta-tags": [
"Application"
]
}
OAuth2Claim
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"status": {
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string"
},
"system": {
"type": "boolean"
},
"claimType": {
"enum": [
"IDENTITY",
"RESOURCE"
],
"type": "string"
},
"valueType": {
"enum": [
"EXPRESSION",
"GROUPS",
"SYSTEM"
],
"type": "string"
},
"conditions": {
"$ref": "#/components/schemas/OAuth2ClaimConditions"
},
"group_filter_type": {
"enum": [
"STARTS_WITH",
"EQUALS",
"CONTAINS",
"REGEX"
],
"type": "string"
},
"alwaysIncludeInToken": {
"type": "boolean"
}
},
"x-okta-tags": [
"Application"
]
}
OAuth2ClaimConditions
{
"type": "object",
"properties": {
"scopes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"x-okta-tags": [
"Application"
]
}
OAuth2Client
{
"type": "object",
"properties": {
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"logo_uri": {
"type": "string",
"readOnly": true
},
"client_id": {
"type": "string",
"readOnly": true
},
"client_uri": {
"type": "string",
"readOnly": true
},
"client_name": {
"type": "string",
"readOnly": true
}
},
"x-okta-tags": [
"Application"
]
}
OAuth2RefreshToken
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"issuer": {
"type": "string"
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"enum": [
"ACTIVE",
"REVOKED"
],
"type": "string"
},
"userId": {
"type": "string"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"clientId": {
"type": "string"
},
"_embedded": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"createdBy": {
"$ref": "#/components/schemas/OAuth2Actor"
},
"expiresAt": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"x-okta-tags": [
"Application"
]
}
OAuth2Scope
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string"
},
"system": {
"type": "boolean"
},
"consent": {
"enum": [
"REQUIRED",
"IMPLICIT",
"ADMIN"
],
"type": "string"
},
"default": {
"type": "boolean"
},
"description": {
"type": "string"
},
"displayName": {
"type": "string"
},
"metadataPublish": {
"enum": [
"ALL_CLIENTS",
"NO_CLIENTS"
],
"type": "string"
}
},
"x-okta-tags": [
"Application"
]
}
OAuth2ScopeConsentGrant
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"issuer": {
"type": "string"
},
"source": {
"$ref": "#/components/schemas/OAuth2ScopeConsentGrantSource"
},
"status": {
"$ref": "#/components/schemas/OAuth2ScopeConsentGrantStatus"
},
"userId": {
"type": "string"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"scopeId": {
"type": "string"
},
"clientId": {
"type": "string"
},
"_embedded": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"createdBy": {
"$ref": "#/components/schemas/OAuth2Actor"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"x-okta-tags": [
"Application"
]
}
OAuth2ScopeConsentGrantSource
{
"enum": [
"END_USER",
"ADMIN"
],
"type": "string",
"x-okta-tags": [
"Application"
]
}
OAuth2ScopeConsentGrantStatus
{
"enum": [
"ACTIVE",
"REVOKED"
],
"type": "string",
"x-okta-tags": [
"Application"
]
}
OAuth2ScopesMediationPolicyRuleCondition
{
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"type": "string"
}
}
},
"x-okta-tags": [
"Application"
]
}
OAuth2Token
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"issuer": {
"type": "string"
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"enum": [
"ACTIVE",
"REVOKED"
],
"type": "string"
},
"userId": {
"type": "string"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"clientId": {
"type": "string"
},
"_embedded": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"expiresAt": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"x-okta-tags": [
"Application"
]
}
OAuthApplicationCredentials
{
"properties": {
"oauthClient": {
"$ref": "#/components/schemas/ApplicationCredentialsOAuthClient"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/ApplicationCredentials"
}
OAuthAuthorizationPolicy
{
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/Policy"
}
OAuthEndpointAuthenticationMethod
{
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"client_secret_jwt",
"private_key_jwt"
],
"type": "string",
"x-okta-tags": [
"Application"
]
}
OAuthGrantType
{
"enum": [
"authorization_code",
"implicit",
"password",
"refresh_token",
"client_credentials",
"saml2_bearer",
"device_code",
"token_exchange",
"interaction_code"
],
"type": "string",
"x-okta-tags": [
"Application"
]
}
OAuthResponseType
{
"enum": [
"code",
"token",
"id_token"
],
"type": "string",
"x-okta-tags": [
"Application"
]
}
OktaSignOnPolicy
{
"type": "object",
"properties": {
"conditions": {
"$ref": "#/components/schemas/OktaSignOnPolicyConditions"
}
},
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/Policy"
}
OktaSignOnPolicyConditions
{
"properties": {
"people": {
"$ref": "#/components/schemas/PolicyPeopleCondition"
}
},
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/PolicyRuleConditions"
}
OktaSignOnPolicyRule
{
"properties": {
"name": {
"type": "string"
},
"actions": {
"$ref": "#/components/schemas/OktaSignOnPolicyRuleActions"
},
"conditions": {
"$ref": "#/components/schemas/OktaSignOnPolicyRuleConditions"
}
},
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/PolicyRule"
}
OktaSignOnPolicyRuleActions
{
"properties": {
"signon": {
"$ref": "#/components/schemas/OktaSignOnPolicyRuleSignonActions"
}
},
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/PolicyRuleActions"
}
OktaSignOnPolicyRuleConditions
{
"properties": {
"people": {
"$ref": "#/components/schemas/PolicyPeopleCondition"
},
"network": {
"$ref": "#/components/schemas/PolicyNetworkCondition"
},
"authContext": {
"$ref": "#/components/schemas/PolicyRuleAuthContextCondition"
}
},
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/PolicyRuleConditions"
}
OktaSignOnPolicyRuleSignonActions
{
"type": "object",
"properties": {
"access": {
"enum": [
"ALLOW",
"DENY"
],
"type": "string"
},
"session": {
"$ref": "#/components/schemas/OktaSignOnPolicyRuleSignonSessionActions"
},
"requireFactor": {
"type": "boolean",
"default": false
},
"factorLifetime": {
"type": "integer"
},
"factorPromptMode": {
"enum": [
"ALWAYS",
"DEVICE",
"SESSION"
],
"type": "string"
},
"rememberDeviceByDefault": {
"type": "boolean",
"default": false
}
},
"x-okta-tags": [
"Policy"
]
}
OktaSignOnPolicyRuleSignonSessionActions
{
"type": "object",
"properties": {
"usePersistentCookie": {
"type": "boolean",
"default": false
},
"maxSessionIdleMinutes": {
"type": "integer",
"default": 120
},
"maxSessionLifetimeMinutes": {
"type": "integer",
"default": 0
}
},
"x-okta-tags": [
"Policy"
]
}
OpenIdConnectApplication
{
"properties": {
"name": {
"default": "oidc_client"
},
"settings": {
"$ref": "#/components/schemas/OpenIdConnectApplicationSettings"
},
"credentials": {
"$ref": "#/components/schemas/OAuthApplicationCredentials"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/Application",
"x-okta-defined-as": {
"name": "oidc_client"
}
}
OpenIdConnectApplicationConsentMethod
{
"enum": [
"REQUIRED",
"TRUSTED"
],
"type": "string",
"x-okta-tags": [
"Application"
]
}
OpenIdConnectApplicationIdpInitiatedLogin
{
"type": "object",
"properties": {
"mode": {
"type": "string"
},
"default_scope": {
"type": "array",
"items": {
"type": "string"
}
}
},
"x-okta-tags": [
"Application"
]
}
OpenIdConnectApplicationIssuerMode
{
"enum": [
"CUSTOM_URL",
"ORG_URL",
"DYNAMIC"
],
"type": "string",
"x-okta-tags": [
"Application"
]
}
OpenIdConnectApplicationSettings
{
"properties": {
"oauthClient": {
"$ref": "#/components/schemas/OpenIdConnectApplicationSettingsClient"
}
},
"x-okta-tags": [
"Application"
],
"x-okta-parent": "#/definitions/ApplicationSettings"
}