object ProvisioningDeprovisionedCondition

{
  "type": "object",
  "properties": {
    "action": {
      "enum": [
        "NONE",
        "REACTIVATE"
      ],
      "type": "string"
    }
  },
  "x-okta-tags": [
    "IdentityProvider"
  ]
}

object ProvisioningGroups

{
  "type": "object",
  "properties": {
    "action": {
      "enum": [
        "NONE",
        "APPEND",
        "SYNC",
        "ASSIGN"
      ],
      "type": "string"
    },
    "filter": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "assignments": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sourceAttributeName": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "IdentityProvider"
  ]
}

object ProvisioningSuspendedCondition

{
  "type": "object",
  "properties": {
    "action": {
      "enum": [
        "NONE",
        "UNSUSPEND"
      ],
      "type": "string"
    }
  },
  "x-okta-tags": [
    "IdentityProvider"
  ]
}

object PushUserFactor

{
  "properties": {
    "profile": {
      "$ref": "#/components/schemas/PushUserFactorProfile"
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time"
    },
    "factorResult": {
      "$ref": "#/components/schemas/FactorResultType"
    }
  },
  "x-okta-tags": [
    "UserFactor"
  ],
  "x-okta-parent": "#/definitions/UserFactor"
}

object PushUserFactorProfile

{
  "properties": {
    "name": {
      "type": "string"
    },
    "version": {
      "type": "string"
    },
    "platform": {
      "type": "string"
    },
    "deviceType": {
      "type": "string"
    },
    "deviceToken": {
      "type": "string"
    },
    "credentialId": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "UserFactor"
  ]
}

object RecoveryQuestionCredential

{
  "type": "object",
  "properties": {
    "answer": {
      "type": "string"
    },
    "question": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "User"
  ]
}

string RequiredEnum

{
  "enum": [
    "ALWAYS",
    "HIGH_RISK_ONLY",
    "NEVER"
  ],
  "type": "string",
  "x-okta-tags": [
    "Authenticator"
  ]
}

object ResetPasswordToken

{
  "type": "object",
  "properties": {
    "resetPasswordUrl": {
      "type": "string",
      "readOnly": true
    }
  },
  "x-okta-tags": [
    "User"
  ]
}

object ResponseLinks

{
  "type": "object",
  "properties": {
    "_links": {
      "type": "object",
      "readOnly": true,
      "additionalProperties": {
        "type": "object"
      }
    }
  },
  "x-okta-tags": [
    "User"
  ]
}

object RiskPolicyRuleCondition

{
  "type": "object",
  "properties": {
    "behaviors": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "uniqueItems": true
    }
  },
  "x-okta-tags": [
    "Policy"
  ]
}

object RiskScorePolicyRuleCondition

{
  "type": "object",
  "properties": {
    "level": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "Policy"
  ]
}

object Role

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "type": {
      "$ref": "#/components/schemas/RoleType"
    },
    "label": {
      "type": "string",
      "readOnly": true
    },
    "_links": {
      "type": "object",
      "readOnly": true,
      "additionalProperties": {
        "type": "object"
      }
    },
    "status": {
      "$ref": "#/components/schemas/RoleStatus"
    },
    "created": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "_embedded": {
      "type": "object",
      "readOnly": true,
      "additionalProperties": {
        "type": "object"
      }
    },
    "description": {
      "type": "string"
    },
    "lastUpdated": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "assignmentType": {
      "$ref": "#/components/schemas/RoleAssignmentType"
    }
  },
  "x-okta-tags": [
    "User"
  ],
  "x-okta-operations": [
    {
      "alias": "addAdminGroupTarget",
      "arguments": [
        {
          "src": "id",
          "dest": "roleId"
        },
        {
          "dest": "groupId",
          "parentSrc": "id"
        }
      ],
      "operationId": "addGroupTargetToGroupAdministratorRoleForGroup"
    },
    {
      "alias": "addAppInstanceTargetToAdminRole",
      "arguments": [
        {
          "src": "id",
          "dest": "roleId"
        },
        {
          "dest": "groupId",
          "parentSrc": "id"
        }
      ],
      "operationId": "addApplicationInstanceTargetToAppAdminRoleGivenToGroup"
    },
    {
      "alias": "addAppTargetToAdminRole",
      "arguments": [
        {
          "src": "id",
          "dest": "roleId"
        },
        {
          "dest": "groupId",
          "parentSrc": "id"
        }
      ],
      "operationId": "addApplicationTargetToAdminRoleGivenToGroup"
    },
    {
      "alias": "addAllAppsAsTargetToRole",
      "arguments": [
        {
          "src": "id",
          "dest": "roleId"
        },
        {
          "dest": "userId",
          "parentSrc": "id"
        }
      ],
      "operationId": "addAllAppsAsTargetToRole"
    },
    {
      "alias": "addAppTargetToAppAdminRoleForUser",
      "arguments": [
        {
          "src": "id",
          "dest": "roleId"
        },
        {
          "dest": "userId",
          "parentSrc": "id"
        }
      ],
      "operationId": "addApplicationTargetToAppAdminRoleForUser"
    },
    {
      "alias": "addAppTargetToAdminRoleForUser",
      "arguments": [
        {
          "src": "id",
          "dest": "roleId"
        },
        {
          "dest": "userId",
          "parentSrc": "id"
        }
      ],
      "operationId": "addApplicationTargetToAdminRoleForUser"
    }
  ]
}

string RoleAssignmentType

{
  "enum": [
    "GROUP",
    "USER"
  ],
  "type": "string",
  "x-okta-tags": [
    "Role"
  ]
}

string RoleStatus

{
  "enum": [
    "ACTIVE",
    "INACTIVE"
  ],
  "type": "string",
  "x-okta-tags": [
    "User"
  ]
}

string RoleType

{
  "enum": [
    "SUPER_ADMIN",
    "ORG_ADMIN",
    "APP_ADMIN",
    "USER_ADMIN",
    "HELP_DESK_ADMIN",
    "READ_ONLY_ADMIN",
    "MOBILE_ADMIN",
    "API_ACCESS_MANAGEMENT_ADMIN",
    "REPORT_ADMIN",
    "GROUP_MEMBERSHIP_ADMIN",
    "CUSTOM"
  ],
  "type": "string",
  "x-okta-tags": [
    "Role"
  ]
}

object SamlApplication

{
  "properties": {
    "settings": {
      "$ref": "#/components/schemas/SamlApplicationSettings"
    }
  },
  "x-okta-tags": [
    "Application"
  ],
  "x-okta-parent": "#/definitions/Application",
  "x-openapi-v3-discriminator": {
    "mapping": {
      "okta_org2org": "#/definitions/Org2OrgApplication"
    },
    "propertyName": "name"
  }
}

object SamlApplicationSettings

{
  "properties": {
    "signOn": {
      "$ref": "#/components/schemas/SamlApplicationSettingsSignOn"
    }
  },
  "x-okta-tags": [
    "Application"
  ],
  "x-okta-parent": "#/definitions/ApplicationSettings"
}

object SamlApplicationSettingsSignOn

{
  "properties": {
    "slo": {
      "$ref": "#/components/schemas/SingleLogout"
    },
    "audience": {
      "type": "string"
    },
    "spIssuer": {
      "type": "string"
    },
    "idpIssuer": {
      "type": "string"
    },
    "recipient": {
      "type": "string"
    },
    "ssoAcsUrl": {
      "type": "string"
    },
    "destination": {
      "type": "string"
    },
    "inlineHooks": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SignOnInlineHook"
      }
    },
    "acsEndpoints": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AcsEndpoint"
      }
    },
    "spCertificate": {
      "$ref": "#/components/schemas/SpCertificate"
    },
    "responseSigned": {
      "type": "boolean"
    },
    "assertionSigned": {
      "type": "boolean"
    },
    "digestAlgorithm": {
      "type": "string"
    },
    "honorForceAuthn": {
      "type": "boolean"
    },
    "audienceOverride": {
      "type": "string"
    },
    "defaultRelayState": {
      "type": "string"
    },
    "recipientOverride": {
      "type": "string"
    },
    "requestCompressed": {
      "type": "boolean"
    },
    "ssoAcsUrlOverride": {
      "type": "string"
    },
    "signatureAlgorithm": {
      "type": "string"
    },
    "attributeStatements": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SamlAttributeStatement"
      }
    },
    "destinationOverride": {
      "type": "string"
    },
    "subjectNameIdFormat": {
      "type": "string"
    },
    "authnContextClassRef": {
      "type": "string"
    },
    "subjectNameIdTemplate": {
      "type": "string"
    },
    "samlSignedRequestEnabled": {
      "type": "boolean"
    },
    "allowMultipleAcsEndpoints": {
      "type": "boolean"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}

object SamlAttributeStatement

{
  "properties": {
    "name": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "values": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "namespace": {
      "type": "string"
    },
    "filterType": {
      "type": "string"
    },
    "filterValue": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}

object ScheduledUserLifecycleAction

{
  "type": "object",
  "properties": {
    "status": {
      "enum": [
        "ACTIVE",
        "INACTIVE",
        "PENDING",
        "DELETED",
        "EXPIRED_PASSWORD",
        "ACTIVATING",
        "SUSPENDED",
        "DELETING"
      ],
      "type": "string"
    }
  },
  "x-okta-tags": [
    "Policy"
  ]
}

object SchemeApplicationCredentials

{
  "properties": {
    "scheme": {
      "$ref": "#/components/schemas/ApplicationCredentialsScheme"
    },
    "signing": {
      "$ref": "#/components/schemas/ApplicationCredentialsSigning"
    },
    "password": {
      "$ref": "#/components/schemas/PasswordCredential"
    },
    "userName": {
      "type": "string"
    },
    "revealPassword": {
      "type": "boolean"
    }
  },
  "x-okta-tags": [
    "Application"
  ],
  "x-okta-parent": "#/definitions/ApplicationCredentials"
}

object Scope

{
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/ScopeType"
    },
    "stringValue": {
      "type": "string"
    },
    "allowedOktaApps": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/IframeEmbedScopeAllowedApps"
      }
    }
  },
  "x-okta-tags": [
    "Role"
  ]
}

string ScopeType

{
  "enum": [
    "CORS",
    "REDIRECT",
    "IFRAME_EMBED"
  ],
  "type": "string",
  "x-okta-tags": [
    "Role"
  ]
}

object SecurePasswordStoreApplication

{
  "properties": {
    "name": {
      "default": "template_sps"
    },
    "settings": {
      "$ref": "#/components/schemas/SecurePasswordStoreApplicationSettings"
    },
    "credentials": {
      "$ref": "#/components/schemas/SchemeApplicationCredentials"
    }
  },
  "x-okta-tags": [
    "Application"
  ],
  "x-okta-parent": "#/definitions/Application",
  "x-okta-defined-as": {
    "name": "template_sps"
  }
}

object SecurePasswordStoreApplicationSettings

{
  "properties": {
    "app": {
      "$ref": "#/components/schemas/SecurePasswordStoreApplicationSettingsApplication"
    }
  },
  "x-okta-tags": [
    "Application"
  ],
  "x-okta-parent": "#/definitions/ApplicationSettings"
}

object SecurePasswordStoreApplicationSettingsApplication

{
  "properties": {
    "url": {
      "type": "string"
    },
    "passwordField": {
      "type": "string"
    },
    "usernameField": {
      "type": "string"
    },
    "optionalField1": {
      "type": "string"
    },
    "optionalField2": {
      "type": "string"
    },
    "optionalField3": {
      "type": "string"
    },
    "optionalField1Value": {
      "type": "string"
    },
    "optionalField2Value": {
      "type": "string"
    },
    "optionalField3Value": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "Application"
  ],
  "x-okta-parent": "#/definitions/ApplicationSettingsApplication"
}

object SecurityQuestion

{
  "properties": {
    "answer": {
      "type": "string"
    },
    "question": {
      "type": "string"
    },
    "questionText": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "UserFactor"
  ]
}

object SecurityQuestionUserFactor

{
  "properties": {
    "profile": {
      "$ref": "#/components/schemas/SecurityQuestionUserFactorProfile"
    }
  },
  "x-okta-tags": [
    "UserFactor"
  ],
  "x-okta-parent": "#/definitions/UserFactor"
}

object SecurityQuestionUserFactorProfile

{
  "properties": {
    "answer": {
      "type": "string"
    },
    "question": {
      "type": "string"
    },
    "questionText": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "UserFactor"
  ]
}

string SeedEnum

{
  "enum": [
    "OKTA",
    "RANDOM"
  ],
  "type": "string",
  "x-okta-tags": [
    "Application"
  ]
}

object Session

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "amr": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SessionAuthenticationMethod"
      },
      "readOnly": true
    },
    "idp": {
      "$ref": "#/components/schemas/SessionIdentityProvider"
    },
    "login": {
      "type": "string",
      "readOnly": true
    },
    "_links": {
      "type": "object",
      "readOnly": true,
      "additionalProperties": {
        "type": "object"
      }
    },
    "status": {
      "$ref": "#/components/schemas/SessionStatus"
    },
    "userId": {
      "type": "string",
      "readOnly": true
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "lastFactorVerification": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "lastPasswordVerification": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    }
  },
  "x-okta-crud": [
    {
      "alias": "read",
      "arguments": [
        {
          "src": "id",
          "dest": "sessionId"
        }
      ],
      "operationId": "getSession"
    },
    {
      "alias": "delete",
      "arguments": [
        {
          "src": "id",
          "dest": "sessionId"
        }
      ],
      "operationId": "endSession"
    }
  ],
  "x-okta-tags": [
    "Session"
  ],
  "x-okta-operations": [
    {
      "alias": "refresh",
      "arguments": [
        {
          "src": "id",
          "dest": "sessionId"
        }
      ],
      "operationId": "refreshSession"
    }
  ]
}

string SessionAuthenticationMethod

{
  "enum": [
    "pwd",
    "swk",
    "hwk",
    "otp",
    "sms",
    "tel",
    "geo",
    "fpt",
    "kba",
    "mfa",
    "mca",
    "sc"
  ],
  "type": "string",
  "x-okta-tags": [
    "Session"
  ]
}

object SessionIdentityProvider

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "type": {
      "$ref": "#/components/schemas/SessionIdentityProviderType"
    }
  },
  "x-okta-tags": [
    "Session"
  ]
}

string SessionIdentityProviderType

{
  "enum": [
    "ACTIVE_DIRECTORY",
    "LDAP",
    "OKTA",
    "FEDERATION",
    "SOCIAL"
  ],
  "type": "string",
  "x-okta-tags": [
    "Session"
  ]
}

string SessionStatus

{
  "enum": [
    "ACTIVE",
    "MFA_ENROLL",
    "MFA_REQUIRED"
  ],
  "type": "string",
  "x-okta-tags": [
    "Session"
  ]
}

string SignInPageTouchPointVariant

{
  "enum": [
    "OKTA_DEFAULT",
    "BACKGROUND_SECONDARY_COLOR",
    "BACKGROUND_IMAGE"
  ],
  "type": "string",
  "x-okta-tags": [
    "Brand"
  ]
}

object SignOnInlineHook

{
  "properties": {
    "id": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}

object SingleLogout

{
  "properties": {
    "issuer": {
      "type": "string"
    },
    "enabled": {
      "type": "boolean"
    },
    "logoutUrl": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}

object SmsTemplate

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "name": {
      "type": "string"
    },
    "type": {
      "$ref": "#/components/schemas/SmsTemplateType"
    },
    "created": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "template": {
      "type": "string"
    },
    "lastUpdated": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "translations": {
      "$ref": "#/components/schemas/SmsTemplateTranslations"
    }
  },
  "x-okta-crud": [
    {
      "alias": "create",
      "arguments": [
        {
          "dest": "smsTemplate",
          "self": true
        }
      ],
      "operationId": "createSmsTemplate"
    },
    {
      "alias": "read",
      "arguments": [],
      "operationId": "getSmsTemplate"
    },
    {
      "alias": "update",
      "arguments": [
        {
          "src": "id",
          "dest": "templateId"
        },
        {
          "dest": "smsTemplate",
          "self": true
        }
      ],
      "operationId": "updateSmsTemplate"
    },
    {
      "alias": "delete",
      "arguments": [
        {
          "src": "id",
          "dest": "templateId"
        }
      ],
      "operationId": "deleteSmsTemplate"
    }
  ],
  "x-okta-tags": [
    "Template"
  ],
  "x-okta-operations": [
    {
      "alias": "partialUpdate",
      "arguments": [
        {
          "src": "id",
          "dest": "templateId"
        },
        {
          "dest": "smsTemplate",
          "self": true
        }
      ],
      "operationId": "partialUpdateSmsTemplate"
    }
  ]
}

object SmsTemplateTranslations

{
  "type": "object",
  "x-okta-tags": [
    "Template"
  ],
  "x-okta-extensible": true
}

string SmsTemplateType

{
  "enum": [
    "SMS_VERIFY_CODE"
  ],
  "type": "string",
  "x-okta-tags": [
    "Template"
  ]
}

object SmsUserFactor

{
  "properties": {
    "profile": {
      "$ref": "#/components/schemas/SmsUserFactorProfile"
    }
  },
  "x-okta-tags": [
    "UserFactor"
  ],
  "x-okta-parent": "#/definitions/UserFactor"
}

object SmsUserFactorProfile

{
  "properties": {
    "phoneNumber": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "UserFactor"
  ]
}

object SocialAuthToken

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "token": {
      "type": "string"
    },
    "scopes": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "tokenType": {
      "type": "string"
    },
    "tokenAuthScheme": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "IdentityProvider"
  ]
}

object SpCertificate

{
  "properties": {
    "x5c": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "readOnly": false
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}

object Subscription

{
  "type": "object",
  "properties": {
    "_links": {
      "type": "object",
      "readOnly": true,
      "additionalProperties": {
        "type": "object"
      }
    },
    "status": {
      "$ref": "#/components/schemas/SubscriptionStatus"
    },
    "channels": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "notificationType": {
      "$ref": "#/components/schemas/NotificationType"
    }
  },
  "x-okta-tags": [
    "Role"
  ],
  "x-okta-operations": [
    {
      "alias": "listRoleSubscriptions",
      "operationId": "listRoleSubscriptions"
    },
    {
      "alias": "getRoleSubscriptionByNotificationType",
      "operationId": "getRoleSubscriptionByNotificationType"
    },
    {
      "alias": "getUserSubscriptionByNotificationType",
      "operationId": "getUserSubscriptionByNotificationType"
    },
    {
      "alias": "listUserSubscriptions",
      "operationId": "listUserSubscriptions"
    },
    {
      "alias": "subscribeUserSubscriptionByNotificationType",
      "operationId": "subscribeUserSubscriptionByNotificationType"
    },
    {
      "alias": "unsubscribeRoleSubscriptionByNotificationType",
      "operationId": "unsubscribeRoleSubscriptionByNotificationType"
    },
    {
      "alias": "subscribeRoleSubscriptionByNotificationType",
      "operationId": "subscribeRoleSubscriptionByNotificationType"
    },
    {
      "alias": "unsubscribeUserSubscriptionByNotificationType",
      "operationId": "unsubscribeUserSubscriptionByNotificationType"
    }
  ]
}

array SubscriptionListRoleSubscriptionsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Subscription"
  }
}

string SubscriptionStatus

{
  "enum": [
    "subscribed",
    "unsubscribed"
  ],
  "type": "string",
  "x-okta-tags": [
    "Role"
  ]
}

object SwaApplication

{
  "properties": {
    "name": {
      "default": "template_swa"
    },
    "settings": {
      "$ref": "#/components/schemas/SwaApplicationSettings"
    }
  },
  "x-okta-tags": [
    "Application"
  ],
  "x-okta-parent": "#/definitions/BrowserPluginApplication",
  "x-okta-defined-as": {
    "name": "template_swa"
  }
}

object SwaApplicationSettings

{
  "properties": {
    "app": {
      "$ref": "#/components/schemas/SwaApplicationSettingsApplication"
    }
  },
  "x-okta-tags": [
    "Application"
  ],
  "x-okta-parent": "#/definitions/ApplicationSettings"
}