string CatalogApplicationStatus

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

string ChangeEnum

{
  "enum": [
    "KEEP_EXISTING",
    "CHANGE"
  ],
  "type": "string",
  "x-okta-tags": [
    "Application"
  ]
}

object ChangePasswordRequest

{
  "type": "object",
  "properties": {
    "newPassword": {
      "$ref": "#/components/schemas/PasswordCredential"
    },
    "oldPassword": {
      "$ref": "#/components/schemas/PasswordCredential"
    }
  },
  "x-okta-tags": [
    "User"
  ]
}

object ChannelBinding

{
  "type": "object",
  "properties": {
    "style": {
      "type": "string"
    },
    "required": {
      "$ref": "#/components/schemas/RequiredEnum"
    }
  },
  "x-okta-tags": [
    "Authenticator"
  ]
}

object ClientPolicyCondition

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

object ClientSecret

{
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "_links": {
      "type": "object",
      "readOnly": true,
      "additionalProperties": {
        "type": "object"
      }
    },
    "status": {
      "enum": [
        "ACTIVE",
        "INACTIVE"
      ],
      "type": "string"
    },
    "created": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "lastUpdated": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "secret_hash": {
      "type": "string"
    },
    "client_secret": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}

object ClientSecretMetadata

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

object Compliance

{
  "type": "object",
  "properties": {
    "fips": {
      "$ref": "#/components/schemas/FipsEnum"
    }
  },
  "x-okta-tags": [
    "Authenticator"
  ]
}

object ContextPolicyRuleCondition

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

object CreateSessionRequest

{
  "type": "object",
  "properties": {
    "sessionToken": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "Session"
  ]
}

object CreateUserRequest

{
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/UserType"
    },
    "profile": {
      "$ref": "#/components/schemas/UserProfile"
    },
    "groupIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "credentials": {
      "$ref": "#/components/schemas/UserCredentials"
    }
  },
  "x-okta-tags": [
    "User"
  ]
}

object Csr

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "csr": {
      "type": "string",
      "readOnly": true
    },
    "kty": {
      "type": "string",
      "readOnly": true
    },
    "created": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}

object CsrMetadata

{
  "properties": {
    "subject": {
      "$ref": "#/components/schemas/CsrMetadataSubject"
    },
    "subjectAltNames": {
      "$ref": "#/components/schemas/CsrMetadataSubjectAltNames"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}

object CsrMetadataSubject

{
  "properties": {
    "commonName": {
      "type": "string"
    },
    "countryName": {
      "type": "string"
    },
    "localityName": {
      "type": "string"
    },
    "organizationName": {
      "type": "string"
    },
    "stateOrProvinceName": {
      "type": "string"
    },
    "organizationalUnitName": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "Application"
  ]
}

object CsrMetadataSubjectAltNames

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

object CustomHotpUserFactor

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

object CustomHotpUserFactorProfile

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

object DNSRecord

{
  "properties": {
    "fqdn": {
      "type": "string"
    },
    "values": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "expiration": {
      "type": "string"
    },
    "recordType": {
      "$ref": "#/components/schemas/DNSRecordType"
    }
  },
  "x-okta-tags": [
    "Domain"
  ]
}

string DNSRecordType

{
  "enum": [
    "TXT",
    "CNAME"
  ],
  "type": "string",
  "x-okta-tags": [
    "Domain"
  ]
}

object DeviceAccessPolicyRuleCondition

{
  "properties": {
    "managed": {
      "type": "boolean"
    },
    "registered": {
      "type": "boolean"
    }
  },
  "x-okta-tags": [
    "Policy"
  ],
  "x-okta-parent": "#/definitions/DevicePolicyRuleCondition"
}

object DevicePolicyRuleCondition

{
  "type": "object",
  "properties": {
    "rooted": {
      "type": "boolean"
    },
    "migrated": {
      "type": "boolean"
    },
    "platform": {
      "$ref": "#/components/schemas/DevicePolicyRuleConditionPlatform"
    },
    "trustLevel": {
      "enum": [
        "ANY",
        "TRUSTED"
      ],
      "type": "string"
    }
  },
  "x-okta-tags": [
    "Policy"
  ]
}

object DevicePolicyRuleConditionPlatform

{
  "type": "object",
  "properties": {
    "types": {
      "type": "array",
      "items": {
        "enum": [
          "IOS",
          "ANDROID",
          "OSX",
          "WINDOWS"
        ],
        "type": "string"
      }
    },
    "supportedMDMFrameworks": {
      "type": "array",
      "items": {
        "enum": [
          "AFW",
          "SAFE",
          "NATIVE"
        ],
        "type": "string"
      }
    }
  },
  "x-okta-tags": [
    "Policy"
  ]
}

object Domain

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "domain": {
      "type": "string"
    },
    "dnsRecords": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DNSRecord"
      }
    },
    "validationStatus": {
      "$ref": "#/components/schemas/DomainValidationStatus"
    },
    "publicCertificate": {
      "$ref": "#/components/schemas/DomainCertificateMetadata"
    },
    "certificateSourceType": {
      "$ref": "#/components/schemas/DomainCertificateSourceType"
    }
  },
  "x-okta-tags": [
    "Domain"
  ]
}

object DomainCertificate

{
  "properties": {
    "type": {
      "$ref": "#/components/schemas/DomainCertificateType"
    },
    "privateKey": {
      "type": "string"
    },
    "certificate": {
      "type": "string"
    },
    "certificateChain": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "Domain"
  ],
  "x-okta-operations": [
    {
      "alias": "createCertificate",
      "arguments": [
        {
          "dest": "certificate",
          "self": true
        }
      ],
      "operationId": "createCertificate"
    }
  ]
}

object DomainCertificateMetadata

{
  "properties": {
    "subject": {
      "type": "string"
    },
    "expiration": {
      "type": "string"
    },
    "fingerprint": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "Domain"
  ]
}

string DomainCertificateSourceType

{
  "enum": [
    "MANUAL",
    "OKTA_MANAGED"
  ],
  "type": "string",
  "x-okta-tags": [
    "Domain"
  ]
}

string DomainCertificateType

{
  "enum": [
    "PEM"
  ],
  "type": "string",
  "x-okta-tags": [
    "Domain"
  ]
}

object DomainListResponse

{
  "properties": {
    "domains": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Domain"
      }
    }
  },
  "x-okta-tags": [
    "Domain"
  ]
}

string DomainValidationStatus

{
  "enum": [
    "NOT_STARTED",
    "IN_PROGRESS",
    "VERIFIED",
    "FAILED_TO_VERIFY",
    "DOMAIN_TAKEN",
    "COMPLETED"
  ],
  "type": "string",
  "x-okta-tags": [
    "Domain"
  ]
}

object Duration

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

object EmailTemplate

{
  "properties": {
    "name": {
      "type": "string",
      "readOnly": true
    },
    "_links": {
      "type": "object",
      "readOnly": true,
      "additionalProperties": {
        "type": "object"
      }
    }
  },
  "x-okta-crud": [
    {
      "alias": "read",
      "operationId": "getEmailTemplate"
    }
  ],
  "x-okta-tags": [
    "Brands"
  ],
  "x-okta-operations": [
    {
      "alias": "getEmailTemplate",
      "operationId": "getEmailTemplate"
    },
    {
      "alias": "deleteEmailTemplateCustomizations",
      "operationId": "deleteEmailTemplateCustomizations"
    },
    {
      "alias": "listEmailTemplateCustomizations",
      "operationId": "listEmailTemplateCustomizations"
    },
    {
      "alias": "createEmailTemplateCustomization",
      "operationId": "createEmailTemplateCustomization"
    },
    {
      "alias": "deleteEmailTemplateCustomization",
      "operationId": "deleteEmailTemplateCustomization"
    },
    {
      "alias": "getEmailTemplateCustomization",
      "operationId": "getEmailTemplateCustomization"
    },
    {
      "alias": "updateEmailTemplateCustomization",
      "operationId": "updateEmailTemplateCustomization"
    },
    {
      "alias": "getEmailTemplateCustomizationPreview",
      "operationId": "getEmailTemplateCustomizationPreview"
    },
    {
      "alias": "getEmailTemplateDefaultContent",
      "operationId": "getEmailTemplateDefaultContent"
    },
    {
      "alias": "getEmailTemplateDefaultContentPreview",
      "operationId": "getEmailTemplateDefaultContentPreview"
    },
    {
      "alias": "sendTestEmail",
      "operationId": "sendTestEmail"
    }
  ]
}

object EmailTemplateContent

{
  "properties": {
    "body": {
      "type": "string"
    },
    "_links": {
      "type": "object",
      "readOnly": true,
      "additionalProperties": {
        "type": "object"
      }
    },
    "subject": {
      "type": "string"
    },
    "fromName": {
      "type": "string"
    },
    "fromAddress": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "Brands"
  ]
}

object EmailTemplateCustomization

{
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "body": {
      "type": "string"
    },
    "_links": {
      "type": "object",
      "readOnly": true,
      "additionalProperties": {
        "type": "object"
      }
    },
    "created": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "subject": {
      "type": "string"
    },
    "language": {
      "type": "string",
      "description": "unique under each email template"
    },
    "isDefault": {
      "type": "boolean"
    },
    "lastUpdated": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    }
  },
  "x-okta-tags": [
    "Brands"
  ]
}

object EmailTemplateCustomizationRequest

{
  "properties": {
    "body": {
      "type": "string"
    },
    "subject": {
      "type": "string"
    },
    "language": {
      "type": "string",
      "description": "unique under each email template"
    },
    "isDefault": {
      "type": "boolean"
    }
  },
  "x-okta-tags": [
    "Brands"
  ]
}

object EmailTemplateTestRequest

{
  "properties": {
    "customizationId": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "Brands"
  ]
}

string EmailTemplateTouchPointVariant

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

object EmailUserFactor

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

object EmailUserFactorProfile

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

string EnabledStatus

{
  "enum": [
    "ENABLED",
    "DISABLED"
  ],
  "type": "string",
  "x-okta-tags": [
    "Common"
  ]
}

string EndUserDashboardTouchPointVariant

{
  "enum": [
    "OKTA_DEFAULT",
    "WHITE_LOGO_BACKGROUND",
    "FULL_THEME",
    "LOGO_ON_FULL_WHITE_BACKGROUND"
  ],
  "type": "string",
  "x-okta-tags": [
    "Brand"
  ]
}

string ErrorPageTouchPointVariant

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

object EventHook

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "name": {
      "type": "string"
    },
    "_links": {
      "type": "object",
      "readOnly": true,
      "additionalProperties": {
        "type": "object"
      }
    },
    "events": {
      "$ref": "#/components/schemas/EventSubscriptions"
    },
    "status": {
      "enum": [
        "ACTIVE",
        "INACTIVE"
      ],
      "type": "string"
    },
    "channel": {
      "$ref": "#/components/schemas/EventHookChannel"
    },
    "created": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "createdBy": {
      "type": "string"
    },
    "lastUpdated": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "verificationStatus": {
      "enum": [
        "UNVERIFIED",
        "VERIFIED"
      ],
      "type": "string"
    }
  },
  "x-okta-crud": [
    {
      "alias": "create",
      "arguments": [
        {
          "dest": "eventHook",
          "self": true
        }
      ],
      "operationId": "createEventHook"
    },
    {
      "alias": "read",
      "arguments": [],
      "operationId": "getEventHook"
    },
    {
      "alias": "update",
      "arguments": [
        {
          "src": "id",
          "dest": "eventHookId"
        },
        {
          "dest": "eventHook",
          "self": true
        }
      ],
      "operationId": "updateEventHook"
    },
    {
      "alias": "delete",
      "arguments": [
        {
          "src": "id",
          "dest": "eventHookId"
        }
      ],
      "operationId": "deleteEventHook"
    }
  ],
  "x-okta-tags": [
    "EventHook"
  ],
  "x-okta-operations": [
    {
      "alias": "activate",
      "arguments": [
        {
          "src": "id",
          "dest": "eventHookId"
        }
      ],
      "operationId": "activateEventHook"
    },
    {
      "alias": "deactivate",
      "arguments": [
        {
          "src": "id",
          "dest": "eventHookId"
        }
      ],
      "operationId": "deactivateEventHook"
    },
    {
      "alias": "verify",
      "arguments": [
        {
          "src": "id",
          "dest": "eventHookId"
        }
      ],
      "operationId": "verifyEventHook"
    }
  ]
}

object EventHookChannel

{
  "type": "object",
  "properties": {
    "type": {
      "enum": [
        "HTTP"
      ],
      "type": "string",
      "readOnly": false
    },
    "config": {
      "$ref": "#/components/schemas/EventHookChannelConfig"
    },
    "version": {
      "type": "string",
      "readOnly": false
    }
  },
  "x-okta-tags": [
    "EventHook"
  ]
}

object EventHookChannelConfig

{
  "type": "object",
  "properties": {
    "uri": {
      "type": "string"
    },
    "headers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EventHookChannelConfigHeader"
      }
    },
    "authScheme": {
      "$ref": "#/components/schemas/EventHookChannelConfigAuthScheme"
    }
  },
  "x-okta-tags": [
    "EventHook"
  ]
}

object EventHookChannelConfigAuthScheme

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "type": {
      "$ref": "#/components/schemas/EventHookChannelConfigAuthSchemeType"
    },
    "value": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "EventHook"
  ]
}

string EventHookChannelConfigAuthSchemeType

{
  "enum": [
    "HEADER"
  ],
  "type": "string",
  "x-okta-tags": [
    "EventHook"
  ]
}

object EventHookChannelConfigHeader

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "EventHook"
  ]
}

array EventHookListSuccessEventsResponse

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

object EventSubscriptions

{
  "type": "object",
  "properties": {
    "type": {
      "enum": [
        "EVENT_TYPE",
        "FLOW_EVENT"
      ],
      "type": "string"
    },
    "items": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "x-okta-tags": [
    "EventHook"
  ],
  "discriminator": {
    "propertyName": "type"
  }
}

string FactorProvider

{
  "enum": [
    "OKTA",
    "RSA",
    "FIDO",
    "GOOGLE",
    "SYMANTEC",
    "DUO",
    "YUBICO",
    "CUSTOM",
    "APPLE"
  ],
  "type": "string",
  "x-okta-tags": [
    "UserFactor"
  ]
}