IdentityProviderGetSocialAuthTokensResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/SocialAuthToken"
}
}
IdentityProviderGetUserResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/IdentityProviderApplicationUser"
}
}
IdentityProviderListCsrsForCertificateSigningRequestsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Csr"
}
}
IdentityProviderListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/IdentityProvider"
}
}
IdentityProviderListSigningKeyCredentialsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonWebKey"
}
}
IdentityProviderPolicy
{
"type": "object",
"properties": {
"subject": {
"$ref": "#/components/schemas/PolicySubject"
},
"accountLink": {
"$ref": "#/components/schemas/PolicyAccountLink"
},
"maxClockSkew": {
"type": "integer"
},
"provisioning": {
"$ref": "#/components/schemas/Provisioning"
}
},
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/Policy"
}
IdentityProviderPolicyRuleCondition
{
"type": "object",
"properties": {
"idpIds": {
"type": "array",
"items": {
"type": "string"
}
},
"provider": {
"enum": [
"ANY",
"OKTA",
"SPECIFIC_IDP"
],
"type": "string"
}
},
"x-okta-tags": [
"Policy"
]
}
IdpPolicyRuleAction
{
"type": "object",
"properties": {
"providers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IdpPolicyRuleActionProvider"
}
}
},
"x-okta-tags": [
"Policy"
]
}
IdpPolicyRuleActionProvider
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"type": {
"type": "string"
}
},
"x-okta-tags": [
"Policy"
]
}
IframeEmbedScopeAllowedApps
{
"enum": [
"OKTA_ENDUSER"
],
"type": "string",
"x-okta-tags": [
"Role"
]
}
ImageUploadResponse
{
"properties": {
"url": {
"type": "string",
"readOnly": true
}
},
"x-okta-tags": [
"Brand"
]
}
InactivityPolicyRuleCondition
{
"type": "object",
"properties": {
"unit": {
"type": "string"
},
"number": {
"type": "integer"
}
},
"x-okta-tags": [
"Policy"
]
}
InlineHook
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/InlineHookType"
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"status": {
"$ref": "#/components/schemas/InlineHookStatus"
},
"channel": {
"$ref": "#/components/schemas/InlineHookChannel"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"version": {
"type": "string"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"x-okta-crud": [
{
"alias": "create",
"arguments": [
{
"dest": "inlineHook",
"self": true
}
],
"operationId": "createInlineHook"
},
{
"alias": "read",
"arguments": [],
"operationId": "getInlineHook"
},
{
"alias": "update",
"arguments": [
{
"src": "id",
"dest": "inlineHookId"
},
{
"dest": "inlineHook",
"self": true
}
],
"operationId": "updateInlineHook"
},
{
"alias": "delete",
"arguments": [
{
"src": "id",
"dest": "inlineHookId"
}
],
"operationId": "deleteInlineHook"
}
],
"x-okta-tags": [
"InlineHook"
],
"x-okta-operations": [
{
"alias": "activate",
"arguments": [
{
"src": "id",
"dest": "inlineHookId"
}
],
"operationId": "activateInlineHook"
},
{
"alias": "deactivate",
"arguments": [
{
"src": "id",
"dest": "inlineHookId"
}
],
"operationId": "deactivateInlineHook"
},
{
"alias": "execute",
"arguments": [
{
"src": "id",
"dest": "inlineHookId"
}
],
"operationId": "executeInlineHook"
}
]
}
InlineHookChannel
{
"type": "object",
"properties": {
"type": {
"enum": [
"HTTP"
],
"type": "string",
"readOnly": false
},
"config": {
"$ref": "#/components/schemas/InlineHookChannelConfig"
},
"version": {
"type": "string",
"readOnly": false
}
},
"x-okta-tags": [
"InlineHook"
]
}
InlineHookChannelConfig
{
"type": "object",
"properties": {
"uri": {
"type": "string"
},
"method": {
"type": "string"
},
"headers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InlineHookChannelConfigHeaders"
}
},
"authScheme": {
"$ref": "#/components/schemas/InlineHookChannelConfigAuthScheme"
}
},
"x-okta-tags": [
"InlineHook"
]
}
InlineHookChannelConfigAuthScheme
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
}
},
"x-okta-tags": [
"InlineHook"
]
}
InlineHookChannelConfigHeaders
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"x-okta-tags": [
"InlineHook"
]
}
InlineHookGetSuccessResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InlineHook"
}
}
InlineHookPayload
{
"type": "object",
"x-okta-tags": [
"InlineHook"
],
"x-okta-extensible": true
}
InlineHookResponse
{
"type": "object",
"properties": {
"commands": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InlineHookResponseCommands"
}
}
},
"x-okta-tags": [
"InlineHook"
]
}
InlineHookResponseCommandValue
{
"properties": {
"op": {
"type": "string"
},
"path": {
"type": "string"
},
"value": {
"type": "string"
}
},
"x-okta-tags": [
"InlineHook"
]
}
InlineHookResponseCommands
{
"properties": {
"type": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InlineHookResponseCommandValue"
}
}
},
"x-okta-tags": [
"InlineHook"
]
}
InlineHookStatus
{
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string",
"x-okta-tags": [
"InlineHook"
]
}
InlineHookType
{
"enum": [
"com.okta.oauth2.tokens.transform",
"com.okta.import.transform",
"com.okta.saml.tokens.transform",
"com.okta.user.pre-registration",
"com.okta.user.credential.password.import"
],
"type": "string",
"x-okta-tags": [
"InlineHook"
]
}
IonField
{
"type": "object",
"properties": {
"form": {
"$ref": "#/components/schemas/IonForm"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"secret": {
"type": "boolean"
},
"mutable": {
"type": "boolean"
},
"visible": {
"type": "boolean"
},
"required": {
"type": "boolean"
}
},
"x-okta-tags": [
"Ion"
]
}
IonForm
{
"type": "object",
"properties": {
"rel": {
"type": "array",
"items": {
"type": "string"
}
},
"href": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IonField"
},
"readOnly": true
},
"method": {
"type": "string"
},
"accepts": {
"type": "string"
},
"refresh": {
"type": "integer"
},
"produces": {
"type": "string"
},
"relatesTo": {
"type": "array",
"items": {
"type": "string"
}
}
},
"x-okta-tags": [
"Ion"
]
}
JsonWebKey
{
"type": "object",
"properties": {
"e": {
"type": "string",
"readOnly": false
},
"n": {
"type": "string",
"readOnly": false
},
"alg": {
"type": "string",
"readOnly": false
},
"kid": {
"type": "string",
"readOnly": false
},
"kty": {
"type": "string",
"readOnly": false
},
"use": {
"type": "string",
"readOnly": false
},
"x5c": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": false
},
"x5t": {
"type": "string",
"readOnly": false
},
"x5u": {
"type": "string",
"readOnly": false
},
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"status": {
"type": "string",
"readOnly": false
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": false
},
"key_ops": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": false
},
"x5t#S256": {
"type": "string",
"readOnly": false
},
"expiresAt": {
"type": "string",
"format": "date-time",
"readOnly": false
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"readOnly": false
}
},
"x-okta-tags": [
"Application"
]
}
JwkUse
{
"properties": {
"use": {
"enum": [
"sig"
],
"type": "string"
}
},
"x-okta-tags": [
"Application"
]
}
KnowledgeConstraint
{
"x-okta-tags": [
"Policy"
],
"x-okta-parent": "#/definitions/AccessPolicyConstraint"
}
LifecycleCreateSettingObject
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/EnabledStatus"
}
},
"x-okta-tags": [
"Application"
]
}
LifecycleDeactivateSettingObject
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/EnabledStatus"
}
},
"x-okta-tags": [
"Application"
]
}
LifecycleExpirationPolicyRuleCondition
{
"type": "object",
"properties": {
"unit": {
"type": "string"
},
"number": {
"type": "integer"
},
"lifecycleStatus": {
"type": "string"
}
},
"x-okta-tags": [
"Policy"
]
}
LinkedObject
{
"type": "object",
"properties": {
"_links": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"primary": {
"$ref": "#/components/schemas/LinkedObjectDetails"
},
"associated": {
"$ref": "#/components/schemas/LinkedObjectDetails"
}
},
"x-okta-crud": [
{
"alias": "create",
"arguments": [
{
"dest": "linkedObjectDefinition",
"self": true
}
],
"operationId": "addLinkedObjectDefinition"
},
{
"alias": "read",
"arguments": [],
"operationId": "getLinkedObjectDefinition"
},
{
"alias": "delete",
"arguments": [
{
"dest": "linkedObjectName",
"self": true
}
],
"operationId": "deleteLinkedObjectDefinition"
}
],
"x-okta-tags": [
"LinkedObject"
]
}
LinkedObjectDetails
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/LinkedObjectDetailsType"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
}
},
"x-okta-tags": [
"LinkedObject"
]
}
LinkedObjectDetailsType
{
"enum": [
"USER"
],
"type": "string",
"x-okta-tags": [
"LinkedObject"
]
}
LinkedObjectGetUserLinkedObjectsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/LinkedObject"
}
}
LogActor
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"type": {
"type": "string",
"readOnly": true
},
"detail": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
},
"alternateId": {
"type": "string",
"readOnly": true
},
"displayName": {
"type": "string",
"readOnly": true
}
},
"x-okta-tags": [
"Log"
]
}
LogAuthenticationContext
{
"type": "object",
"properties": {
"issuer": {
"$ref": "#/components/schemas/LogIssuer"
},
"interface": {
"type": "string",
"readOnly": true
},
"credentialType": {
"$ref": "#/components/schemas/LogCredentialType"
},
"externalSessionId": {
"type": "string",
"readOnly": true
},
"authenticationStep": {
"type": "integer",
"readOnly": true
},
"credentialProvider": {
"$ref": "#/components/schemas/LogCredentialProvider"
},
"authenticationProvider": {
"$ref": "#/components/schemas/LogAuthenticationProvider"
}
},
"x-okta-tags": [
"Log"
]
}
LogAuthenticationProvider
{
"enum": [
"OKTA_AUTHENTICATION_PROVIDER",
"ACTIVE_DIRECTORY",
"LDAP",
"FEDERATION",
"SOCIAL",
"FACTOR_PROVIDER"
],
"type": "string",
"x-okta-tags": [
"Log"
]
}
LogClient
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"zone": {
"type": "string",
"readOnly": true
},
"device": {
"type": "string",
"readOnly": true
},
"ipAddress": {
"type": "string",
"readOnly": true
},
"userAgent": {
"$ref": "#/components/schemas/LogUserAgent"
},
"geographicalContext": {
"$ref": "#/components/schemas/LogGeographicalContext"
}
},
"x-okta-tags": [
"Log"
]
}
LogCredentialProvider
{
"enum": [
"OKTA_AUTHENTICATION_PROVIDER",
"OKTA_CREDENTIAL_PROVIDER",
"RSA",
"SYMANTEC",
"GOOGLE",
"DUO",
"YUBIKEY",
"APPLE"
],
"type": "string",
"x-okta-tags": [
"Log"
]
}
LogCredentialType
{
"enum": [
"OTP",
"SMS",
"PASSWORD",
"ASSERTION",
"IWA",
"EMAIL",
"OAUTH2",
"JWT"
],
"type": "string",
"x-okta-tags": [
"Log"
]
}
LogDebugContext
{
"type": "object",
"properties": {
"debugData": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"type": "object"
}
}
},
"x-okta-tags": [
"Log"
]
}
LogEvent
{
"type": "object",
"properties": {
"uuid": {
"type": "string",
"readOnly": true
},
"actor": {
"$ref": "#/components/schemas/LogActor"
},
"client": {
"$ref": "#/components/schemas/LogClient"
},
"target": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogTarget"
},
"readOnly": true
},
"outcome": {
"$ref": "#/components/schemas/LogOutcome"
},
"request": {
"$ref": "#/components/schemas/LogRequest"
},
"version": {
"type": "string",
"readOnly": true
},
"severity": {
"$ref": "#/components/schemas/LogSeverity"
},
"eventType": {
"type": "string",
"readOnly": true
},
"published": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"transaction": {
"$ref": "#/components/schemas/LogTransaction"
},
"debugContext": {
"$ref": "#/components/schemas/LogDebugContext"
},
"displayMessage": {
"type": "string",
"readOnly": true
},
"legacyEventType": {
"type": "string",
"readOnly": true
},
"securityContext": {
"$ref": "#/components/schemas/LogSecurityContext"
},
"authenticationContext": {
"$ref": "#/components/schemas/LogAuthenticationContext"
}
},
"x-okta-tags": [
"Log"
]
}
LogGeographicalContext
{
"type": "object",
"properties": {
"city": {
"type": "string",
"readOnly": true
},
"state": {
"type": "string",
"readOnly": true
},
"country": {
"type": "string",
"readOnly": true
},
"postalCode": {
"type": "string",
"readOnly": true
},
"geolocation": {
"$ref": "#/components/schemas/LogGeolocation"
}
},
"x-okta-tags": [
"Log"
]
}
LogGeolocation
{
"type": "object",
"properties": {
"lat": {
"type": "number",
"format": "double",
"readOnly": true
},
"lon": {
"type": "number",
"format": "double",
"readOnly": true
}
},
"x-okta-tags": [
"Log"
]
}
LogGetListEventsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/LogEvent"
}
}
LogIpAddress
{
"type": "object",
"properties": {
"ip": {
"type": "string",
"readOnly": true
},
"source": {
"type": "string",
"readOnly": true
},
"version": {
"type": "string",
"readOnly": true
},
"geographicalContext": {
"$ref": "#/components/schemas/LogGeographicalContext"
}
},
"x-okta-tags": [
"Log"
]
}
LogIssuer
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"type": {
"type": "string",
"readOnly": true
}
},
"x-okta-tags": [
"Log"
]
}
LogOutcome
{
"type": "object",
"properties": {
"reason": {
"type": "string",
"readOnly": true
},
"result": {
"type": "string",
"readOnly": true
}
},
"x-okta-tags": [
"Log"
]
}