Auth0 forms API

openapi: 3.0.0
info:
  title: Auth0 Authentication actions forms API
  description: Auth0 Authentication API. Endpoints for authentication and authorization using OpenID Connect, OAuth 2.0, SAML, WS-Federation, and Passwordless flows.
  version: 1.0.0
servers:
- url: '{auth0_domain}'
  description: The Authentication API is served over HTTPS.
  variables:
    auth0_domain:
      description: Auth0 domain
      default: https://demo.us.auth0.com
tags:
- name: forms
paths:
  /forms:
    get:
      summary: Get Forms
      tags:
      - forms
      parameters:
      - name: page
        in: query
        description: Page index of the results to return. First page is 0.
        schema:
          type: integer
          minimum: 0
          maximum: 1000
      - name: per_page
        in: query
        description: Number of results per page. Defaults to 50.
        schema:
          type: integer
          minimum: 1
          maximum: 100
      - name: include_totals
        in: query
        description: Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).
        schema:
          type: boolean
      - name: hydrate
        in: query
        description: Query parameter to hydrate the response with additional data
        style: form
        explode: true
        schema:
          type: array
          items:
            $ref: '#/components/schemas/FormsRequestParametersHydrateEnum'
      responses:
        '200':
          description: Forms successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListFormsResponseContent'
        '400':
          description: Invalid request query string. The message will vary depending on the cause.
          x-description-1: Invalid query string paging options. The message will vary depending on the cause
        '401':
          description: Invalid token.
          x-description-1: Invalid signature received for JSON Web Token validation.
          x-description-2: Client is not global.
        '403':
          description: 'Insufficient scope; expected any of: read:forms.'
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: get_forms
      x-release-lifecycle: GA
      x-operation-name: list
      x-operation-request-parameters-name: ListFormsRequestParameters
      x-operation-group: forms
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:forms
    post:
      summary: Create a Form
      tags:
      - forms
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFormRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateFormRequestContent'
      responses:
        '201':
          description: Form successfully created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateFormResponseContent'
        '400':
          description: Invalid request query string. The message will vary depending on the cause.
        '401':
          description: Invalid token.
          x-description-1: Invalid signature received for JSON Web Token validation.
          x-description-2: Client is not global.
        '403':
          description: 'Insufficient scope; expected any of: create:forms.'
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: create_form
      x-release-lifecycle: GA
      x-operation-name: create
      x-operation-group: forms
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - create:forms
  /forms/{id}:
    get:
      summary: Get a Form
      tags:
      - forms
      parameters:
      - name: id
        in: path
        description: The ID of the form to retrieve.
        required: true
        schema:
          type: string
          maxLength: 30
      - name: hydrate
        in: query
        description: Query parameter to hydrate the response with additional data
        style: form
        explode: true
        schema:
          type: array
          items:
            $ref: '#/components/schemas/FormsRequestParametersHydrateEnum'
      responses:
        '200':
          description: Form successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetFormResponseContent'
        '400':
          description: Invalid request query string. The message will vary depending on the cause.
        '401':
          description: Invalid token.
          x-description-1: Invalid signature received for JSON Web Token validation.
          x-description-2: Client is not global.
        '403':
          description: 'Insufficient scope; expected any of: read:forms.'
        '404':
          description: The form does not exist.
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: get_form
      x-release-lifecycle: GA
      x-operation-name: get
      x-operation-request-parameters-name: GetFormRequestParameters
      x-operation-group: forms
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:forms
    delete:
      summary: Delete a Form
      tags:
      - forms
      parameters:
      - name: id
        in: path
        description: The ID of the form to delete.
        required: true
        schema:
          type: string
          maxLength: 30
      responses:
        '204':
          description: Form successfully deleted.
        '400':
          description: Invalid request body. The message will vary depending on the cause.
          x-description-1: Invalid request query string. The message will vary depending on the cause.
        '401':
          description: Invalid token.
          x-description-1: Invalid signature received for JSON Web Token validation.
          x-description-2: Client is not global.
        '403':
          description: 'Insufficient scope; expected any of: delete:forms.'
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: delete_form
      x-release-lifecycle: GA
      x-operation-name: delete
      x-operation-group: forms
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - delete:forms
    patch:
      summary: Update a Form
      tags:
      - forms
      parameters:
      - name: id
        in: path
        description: The ID of the form to update.
        required: true
        schema:
          type: string
          maxLength: 30
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFormRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateFormRequestContent'
      responses:
        '200':
          description: Form successfully updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateFormResponseContent'
        '401':
          description: Invalid token.
          x-description-1: Invalid signature received for JSON Web Token validation.
          x-description-2: Client is not global.
        '403':
          description: 'Insufficient scope; expected any of: update:forms.'
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: patch_form
      x-release-lifecycle: GA
      x-operation-name: update
      x-operation-group: forms
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - update:forms
components:
  schemas:
    FormsRequestParametersHydrateEnum:
      type: string
      maxLength: 50
      enum:
      - flow_count
      - links
    FormFieldSocialConfig:
      type: object
      additionalProperties: false
      properties: {}
    FormFieldTypeSocialConst:
      type: string
      enum:
      - SOCIAL
    FormFieldDateConfig:
      type: object
      additionalProperties: false
      properties:
        format:
          $ref: '#/components/schemas/FormFieldDateConfigFormatEnum'
        default_value:
          type: string
    FormEndingNodeRedirection:
      type: object
      additionalProperties: false
      required:
      - target
      properties:
        delay:
          type: integer
          minimum: 0
          maximum: 10
        target:
          type: string
          minLength: 1
          maxLength: 1024
    FormNodeTypeFlowConst:
      type: string
      enum:
      - FLOW
    ListFormsResponseContent:
      oneOf:
      - type: array
        items:
          $ref: '#/components/schemas/FormSummary'
      - $ref: '#/components/schemas/ListFormsOffsetPaginatedResponseContent'
    FormFieldEmail:
      type: object
      additionalProperties: false
      required:
      - id
      - category
      - type
      properties:
        id:
          type: string
          format: forms-custom-identifier
        category:
          $ref: '#/components/schemas/FormComponentCategoryFieldConst'
        type:
          $ref: '#/components/schemas/FormFieldTypeEmailConst'
        config:
          $ref: '#/components/schemas/FormFieldEmailConfig'
        label:
          type: string
          minLength: 1
        hint:
          type: string
          minLength: 1
          maxLength: 500
        required:
          type: boolean
        sensitive:
          type: boolean
    FormFieldPaymentConfigCredentials:
      type: object
      additionalProperties: false
      required:
      - public_key
      - private_key
      properties:
        public_key:
          type: string
          minLength: 1
          maxLength: 250
        private_key:
          type: string
          minLength: 1
          maxLength: 250
    FormWidgetTypeAuth0VerifiableCredentialsConst:
      type: string
      enum:
      - AUTH0_VERIFIABLE_CREDENTIALS
    FormFieldUrlConfig:
      type: object
      additionalProperties: false
      properties:
        default_value:
          type: string
          minLength: 1
        placeholder:
          type: string
          minLength: 1
          maxLength: 500
    FormBlockRichTextConfig:
      type: object
      additionalProperties: false
      properties:
        content:
          type: string
          maxLength: 10000
    FormFieldFileConfigCategoryEnum:
      type: string
      enum:
      - AUDIO
      - VIDEO
      - IMAGE
      - DOCUMENT
      - ARCHIVE
    FormFieldPaymentConfigChargeOneOffOneOff:
      type: object
      additionalProperties: true
      required:
      - amount
      - currency
      properties:
        amount:
          $ref: '#/components/schemas/FormFieldPaymentConfigChargeOneOffOneOffAmount'
        currency:
          $ref: '#/components/schemas/FormFieldPaymentConfigChargeOneOffCurrencyEnum'
    FormFieldText:
      type: object
      additionalProperties: false
      required:
      - id
      - category
      - type
      properties:
        id:
          type: string
          format: forms-custom-identifier
        category:
          $ref: '#/components/schemas/FormComponentCategoryFieldConst'
        type:
          $ref: '#/components/schemas/FormFieldTypeTextConst'
        config:
          $ref: '#/components/schemas/FormFieldTextConfig'
        label:
          type: string
          minLength: 1
        hint:
          type: string
          minLength: 1
          maxLength: 500
        required:
          type: boolean
        sensitive:
          type: boolean
    FormFieldLegalConfig:
      type: object
      additionalProperties: false
      properties:
        text:
          type: string
          minLength: 1
          maxLength: 10000
    FormEndingNodeResumeFlowTrueConst:
      type: boolean
      enum:
      - true
    FormFieldChoice:
      type: object
      additionalProperties: false
      required:
      - id
      - category
      - type
      properties:
        id:
          type: string
          format: forms-custom-identifier
        category:
          $ref: '#/components/schemas/FormComponentCategoryFieldConst'
        type:
          $ref: '#/components/schemas/FormFieldTypeChoiceConst'
        config:
          $ref: '#/components/schemas/FormFieldChoiceConfig'
        label:
          type: string
          minLength: 1
        hint:
          type: string
          minLength: 1
          maxLength: 500
        required:
          type: boolean
        sensitive:
          type: boolean
    FormStartNodeNullable:
      oneOf:
      - $ref: '#/components/schemas/FormStartNode'
      - type: 'null'
    FormFieldTelConfigStrings:
      type: object
      additionalProperties: false
      properties:
        filter_placeholder:
          type: string
          minLength: 1
    FormFieldTypeNumberConst:
      type: string
      enum:
      - NUMBER
    FormFieldTypeFileConst:
      type: string
      enum:
      - FILE
    FormBlockTypeImageConst:
      type: string
      enum:
      - IMAGE
    FormComponentCategoryBlockConst:
      type: string
      enum:
      - BLOCK
    FormFieldEmailConfig:
      type: object
      additionalProperties: false
      properties:
        default_value:
          type: string
          minLength: 1
        placeholder:
          type: string
          minLength: 1
          maxLength: 500
    FormStep:
      type: object
      additionalProperties: false
      required:
      - id
      - type
      properties:
        id:
          type: string
          format: forms-custom-identifier
        type:
          $ref: '#/components/schemas/FormNodeTypeStepConst'
        coordinates:
          $ref: '#/components/schemas/FormNodeCoordinates'
        alias:
          type: string
          minLength: 1
          maxLength: 150
        config:
          $ref: '#/components/schemas/FormStepConfig'
    FormStyle:
      type: object
      additionalProperties: false
      properties:
        css:
          type: string
          minLength: 1
          maxLength: 5000
    FormBlockResendButtonConfig:
      type: object
      additionalProperties: false
      required:
      - active_text
      - button_text
      - waiting_text
      - flow_id
      properties:
        active_text:
          type: string
          minLength: 1
          maxLength: 255
        button_text:
          type: string
          minLength: 1
          maxLength: 255
        waiting_text:
          type: string
          minLength: 1
          maxLength: 255
        text_alignment:
          $ref: '#/components/schemas/FormBlockResendButtonConfigTextAlignmentEnum'
        flow_id:
          type: string
          maxLength: 30
          format: flow-id
        max_attempts:
          type: number
          minimum: 1
          maximum: 10
        waiting_time:
          type: number
          minimum: 1
          maximum: 60
    FormFieldDateConfigFormatEnum:
      type: string
      enum:
      - DATE
      - TIME
    FormWidgetRecaptchaConfig:
      type: object
      additionalProperties: false
      required:
      - site_key
      - secret_key
      properties:
        site_key:
          type: string
          minLength: 1
        secret_key:
          type: string
          minLength: 1
    FormWidgetRecaptcha:
      type: object
      additionalProperties: false
      required:
      - id
      - category
      - type
      - config
      properties:
        id:
          type: string
          format: forms-custom-identifier
        category:
          $ref: '#/components/schemas/FormComponentCategoryWidgetConst'
        type:
          $ref: '#/components/schemas/FormWidgetTypeRecaptchaConst'
        config:
          $ref: '#/components/schemas/FormWidgetRecaptchaConfig'
        label:
          type: string
          minLength: 1
        hint:
          type: string
          minLength: 1
          maxLength: 500
        required:
          type: boolean
        sensitive:
          type: boolean
    FormFieldTypeLegalConst:
      type: string
      enum:
      - LEGAL
    FormBlockTypeRichTextConst:
      type: string
      enum:
      - RICH_TEXT
    FormStepComponentList:
      type: array
      items:
        $ref: '#/components/schemas/FormComponent'
    FormWidgetAuth0VerifiableCredentials:
      type: object
      additionalProperties: false
      required:
      - id
      - category
      - type
      - config
      properties:
        id:
          type: string
          format: forms-custom-identifier
        category:
          $ref: '#/components/schemas/FormComponentCategoryWidgetConst'
        type:
          $ref: '#/components/schemas/FormWidgetTypeAuth0VerifiableCredentialsConst'
        config:
          $ref: '#/components/schemas/FormWidgetAuth0VerifiableCredentialsConfig'
        label:
          type: string
          minLength: 1
        hint:
          type: string
          minLength: 1
          maxLength: 500
        required:
          type: boolean
        sensitive:
          type: boolean
    FormFieldTypeTelConst:
      type: string
      enum:
      - TEL
    FormFieldCustom:
      type: object
      additionalProperties: false
      required:
      - id
      - category
      - type
      - config
      properties:
        id:
          type: string
          format: forms-custom-identifier
        category:
          $ref: '#/components/schemas/FormComponentCategoryFieldConst'
        type:
          $ref: '#/components/schemas/FormFieldTypeCustomConst'
        config:
          $ref: '#/components/schemas/FormFieldCustomConfig'
        label:
          type: string
          minLength: 1
        hint:
          type: string
          minLength: 1
          maxLength: 500
        required:
          type: boolean
        sensitive:
          type: boolean
    FormBlockJumpButtonConfig:
      type: object
      additionalProperties: false
      required:
      - text
      - next_node
      properties:
        text:
          type: string
          maxLength: 150
        next_node:
          $ref: '#/components/schemas/FormNodePointer'
        style:
          $ref: '#/components/schemas/FormBlockJumpButtonConfigStyle'
    FormFieldLegal:
      type: object
      additionalProperties: false
      required:
      - id
      - category
      - type
      properties:
        id:
          type: string
          format: forms-custom-identifier
        category:
          $ref: '#/components/schemas/FormComponentCategoryFieldConst'
        type:
          $ref: '#/components/schemas/FormFieldTypeLegalConst'
        config:
          $ref: '#/components/schemas/FormFieldLegalConfig'
        label:
          type: string
          minLength: 1
        hint:
          type: string
          minLength: 1
          maxLength: 500
        required:
          type: boolean
        sensitive:
          type: boolean
    FormComponent:
      type: object
      oneOf:
      - $ref: '#/components/schemas/FormBlock'
      - $ref: '#/components/schemas/FormWidget'
      - $ref: '#/components/schemas/FormField'
    FormFieldTypeCustomConst:
      type: string
      enum:
      - CUSTOM
    FormFieldCardsConfig:
      type: object
      additionalProperties: false
      properties:
        hide_labels:
          type: boolean
        multiple:
          type: boolean
        options:
          type: array
          minItems: 0
          items:
            $ref: '#/components/schemas/FormFieldCardsConfigOption'
        default_value: {}
    FormWidgetTypeGMapsAddressConst:
      type: string
      enum:
      - GMAPS_ADDRESS
    FormBlockTypeDividerConst:
      type: string
      enum:
      - DIVIDER
    FormBlockHtmlConfig:
      type: object
      additionalProperties: false
      properties:
        content:
          type: string
          maxLength: 10000
    FormFieldTypeTextConst:
      type: string
      enum:
      - TEXT
    GetFormResponseContent:
      type: object
      additionalProperties: false
      required:
      - id
      - name
      - created_at
      - updated_at
      properties:
        id:
          type: string
          maxLength: 30
          format: form-id
        name:
          type: string
          minLength: 1
          maxLength: 150
        messages:
          $ref: '#/components/schemas/FormMessages'
        languages:
          $ref: '#/components/schemas/FormLanguages'
        translations:
          $ref: '#/components/schemas/FormTranslations'
        nodes:
          $ref: '#/components/schemas/FormNodeList'
        start:
          $ref: '#/components/schemas/FormStartNode'
        ending:
          $ref: '#/components/schemas/FormEndingNode'
        style:
          $ref: '#/components/schemas/FormStyle'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        embedded_at:
          type: string
          format: date
        submitted_at:
          type: string
          format: date
    FormWidgetGMapsAddressConfig:
      type: object
      additionalProperties: false
      required:
      - api_key
      properties:
        api_key:
          type: string
          minLength: 1
    FormRouterConfig:
      type: object
      additionalProperties: false
      properties:
        rules:
          type: array
          minItems: 0
          items:
            $ref: '#/components/schemas/FormRouterRule'
        fallback:
          $ref: '#/components/schemas/FormNodePointer'
    FormNodeTypeStepConst:
      type: string
      enum:
      - STEP
    FormNodeListNullable:
      oneOf:
      - $ref: '#/components/schemas/FormNodeList'
      - type: 'null'
    FormLanguages:
      type: object
      additionalProperties: false
      properties:
        primary:
          type: string
          minLength: 1
          maxLength: 55
        default:
          type: string
          minLength: 1
          maxLength: 55
    FormFieldTypeBooleanConst:
      type: string
      enum:
      - BOOLEAN
    FormRouter:
      type: object
      additionalProperties: false
      required:
      - id
      - type
      properties:
        id:
          type: string
          format: forms-custom-identifier
        type:
          $ref: '#/components/schemas/FormNodeTypeRouterConst'
        coordinates:
          $ref: '#/components/schemas/FormNodeCoordinates'
        alias:
          type: string
          minLength: 1
          maxLength: 150
        config:
          $ref: '#/components/schemas/FormRouterConfig'
    FormTranslations:
      type: object
      additionalProperties:
        type: object
        additionalProperties: true
    FormFieldTel:
      type: object
      additionalProperties: false
      required:
      - id
      - category
      - type
      properties:
        id:
          type: string
          format: forms-custom-identifier
        category:
          $ref: '#/components/schemas/FormComponentCategoryFieldConst'
        type:
          $ref: '#/components/schemas/FormFieldTypeTelConst'
        config:
          $ref: '#/components/schemas/FormFieldTelConfig'
        label:
          type: string
          minLength: 1
        hint:
          type: string
          minLength: 1
          maxLength: 500
        required:
          type: boolean
        sensitive:
          type: boolean
    FormStepConfig:
      type: object
      additionalProperties: false
      properties:
        components:
          $ref: '#/components/schemas/FormStepComponentList'
        next_node:
          $ref: '#/components/schemas/FormNodePointer'
    FormFieldTypePaymentConst:
      type: string
      enum:
      - PAYMENT
    FormFieldCardsConfigOption:
      type: object
      additionalProperties: false
      required:
      - value
      - label
      - image_url
      properties:
        value:
          type: string
          minLength: 1
        label:
          type: string
          minLength: 1
        image_url:
          type: string
          format: forms-url-https
    FormFieldPaymentConfigCharge:
      type: object
      oneOf:
      - $ref: '#/components/schemas/FormFieldPaymentConfigChargeOneOff'
      - type: object
        additionalProperties: false
        required:
        - type
        - subscription
        properties:
          type:
            $ref: '#/components/schemas/FormFieldPaymentConfigChargeTypeSubscriptionConst'
          subscription:
            $ref: '#/components/schemas/FormFieldPaymentConfigSubscription'
    FormFieldCustomConfigParams:
      type: object
      additionalProperties:
        type: string
    FormFieldTypeDropdownConst:
      type: string
      enum:
      - DROPDOWN
    FormFieldChoiceConfigAllowOtherEnabledTrueEnum:
      type: boolean
      enum:
      - true
    FormRouterRule:
      type: object
      additionalProperties: false
      required:
      - id
      - condition
      properties:
        id:
          type: string
          format: forms-custom-identifier
        alias:
          type: string
          minLength: 1
          maxLength: 150
        condition: {}
        next_node:
          $ref: '#/components/schemas/FormNodePointer'
    FormFieldTypeCardsConst:
      type: string
      enum:
      - CARDS
    FormFieldTextConfig:
      type: object
      allOf:
      - type: object
        additionalProperties: true
      - type: object
        additionalProperties: true
      - type: object
        additionalProperties: true
      additionalProperties: false
      properties:
        multiline:
          type: boolean
        default_value:
          type: string
          minLength: 1
        placeholder:
          type: string
          minLength: 1
          maxLength: 500
        min_length:
          type: integer
          minimum: 1
        max_length:
          type: integer
          minimum: 1
    FormStyleNullable:
      oneOf:
      - $ref: '#/components/schemas/FormStyle'
      - type: 'null'
    FormFieldPaymentConfigFields:
      type: object
      additionalProperties: false
      properties:
        card_number:
          $ref: '#/components/schemas/FormFieldPaymentConfigFieldProperties'
        expiration_date:
          $ref: '#/components/schemas/FormFieldPaymentConfigFieldProperties'
        security_code:
          $ref: '#/components/schemas/FormFieldPaymentConfigFieldProperties'
        trustmarks:
          type: boolean
    FormBlockImageConfig:
      type: object
      additionalProperties: false
      required:
      - src
      properties:
        src:
          type: string
          maxLength: 500
        position:
          $ref: '#/components/schemas/FormBlockImageConfigPositionEnum'
        height:
          type: number
          minimum: 1
          maximum: 500
    FormMessagesCustom:
      type: object
      additionalProperties:
        type: string
        minLength: 1
        maxLength: 255
    ListFormsOffsetPaginatedResponseContent:
      type: object
      additionalProperties: false
      properties:
        start:
          type: number
        limit:
          type: number
        total:
          type: number
        forms:
          type: array
          items:
            $ref: '#/components/schemas/FormSummary'
    FormComponentCategoryWidgetConst:
      type: string
      enum:
      - WIDGET
    FormFieldCards:
      type: object
      additionalProperties: false
      required:
      - id
      - category
      - type
      properties:
        id:
          type: string
          format: forms-custom-identifier
        category:
          $ref: '#/components/schemas/FormComponentCategoryFieldConst'
        type:
          $ref: '#/components/schemas/FormFieldTypeCardsConst'
        config:
          $ref: '#/components/schemas/FormFieldCardsConfig'
        label:
          type: string
          minLength: 1
        hint:
          type: string
          minLength: 1
          maxLength: 500
        required:
          type: boolean
        sensitive:
          type: boolean
    FormFieldBoolean:
      type: object
      additionalProperties: false
      required:
      - id
      - category
      - type
      - config
      properties:
        id:
          type: string
          format: forms-custom-identifier
        category:
          $ref: '#/components/schemas/FormComponentCategoryFieldConst'
        type:
          $ref: '#/components/schemas/FormFieldTypeBooleanConst'
        config:
          $ref: '#/components/schemas/FormFieldBooleanConfig'
        label:
          type: string
          minLength: 1
        hint:
          type: string
          minLength: 1
          maxLength: 500
        required:
          type: boolean
        sensitive:
          type: boolean
    FormFieldPaymentConfigProviderEnum:
      type: string
      enum:
      - STRIPE
    FormNodePointer:
      oneOf:
      - type: string
        format: forms-custom-identifier
      - $ref: '#/components/schemas/FormEndingNodeId'
    FormFieldPaymentConfigSubscription:
      type: object
      additionalProperties: true
    FormMessagesNullable:
      oneOf:
      - $ref: '#/components/schemas/FormMessages'
      - type: 'null'
    FormTranslationsNullable:
      oneOf:
      - $ref: '#/components/schemas/FormTranslations'
      - type: 'null'
    FormFieldFileConfigStorage:
      type: object
      additionalProperties: true
      required:
      - type
      properties:
        type:
          $ref: '#/components/schemas/FormFieldFileConfigStorageTypeEnum'
    FormFieldChoiceConfig:
      type: object
      additionalProperties: false
      properties:
        multiple:
          type: boolean
        options:
          type: array
          minItems: 0
          items:
            $ref: '#/components/schemas/FormFieldChoiceConfigOption'
        allow_other:
          $ref: '#/components/schemas/FormFieldChoiceConfigAllowOther'
        default_value: {}
    FormWidgetAuth0VerifiableCredentialsConfig:
      type: object
      additionalProperties: false
      required:
      - url
      - alternate_text
      - access_token
      - verification_id
      properties:
        url:
          type: string
          maxLength: 2000
        size:
          type: number
          minimum: 1
          maximum: 500
        alternate_text:
          type: string
          minLength: 1
          maxLength: 255
        access_token:
          type: string
          minLength: 1
          maxLength: 5000
        verification_id:
          type: string
          minLength: 1
          maxLength: 255
        max_wait:
          type: number
          minimum: 60
          maximum: 600
    FormBlockNextButtonConfig:
      type: object
      additionalProperties: false
      required:
      - text
      properties:
        text:
          type: string
          maxLength: 150
    FormBlockPreviousButton:
      type: object
      additionalProperties: false
      required:
      - id
      - category
      - type
      - config
      properties:
        id:
          type: string
          format: forms-custom-identifier
        category:
          $ref: '#/components/schemas/FormComponentCategoryBlockConst'
        type:
          $ref: '#/components/schemas/FormBlockTypePreviousButtonConst'
        config:
          $ref: '#/components/schemas/FormBlockPreviousButtonConfig'
    FormFieldTypeDateConst:
      type: string
      enum:
      - DATE
    FormEndingNodeAfterSubmit:
      type: object
      additionalProperties: false
      properties:
        flow_id:
          type: string
          maxLength: 30
          format: flow-id
    CreateFormResponseContent:
      type: object
      additionalProperties: false
      required:
      - id
      - name
      - created_at
      - updated_at
      properties:
        id:
          type: string
          maxLength: 30
          format: form-id
        name:
          type: string
          minLength: 1
          maxLength: 150
        messages:
          $ref: '#/components/schemas/FormMessages'
        languages:
          $ref: '#/components/schemas/FormLanguages'
        translations:
          $

# --- truncated at 32 KB (57 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/auth0/refs/heads/main/openapi/auth0-forms-api-openapi.yml