Auth0 flows API

The flows API from Auth0 — 6 operation(s) for flows.

OpenAPI Specification

auth0-flows-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  title: Auth0 Authentication actions flows 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: flows
paths:
  /flows:
    get:
      summary: Get Flows
      tags:
      - flows
      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: hydration param
        style: form
        explode: true
        schema:
          type: array
          items:
            $ref: '#/components/schemas/ListFlowsRequestParametersHydrateEnum'
      - name: synchronous
        in: query
        description: flag to filter by sync/async flows
        schema:
          type: boolean
      responses:
        '200':
          description: Flows successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListFlowsResponseContent'
        '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:flows.'
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: get_flows
      x-release-lifecycle: GA
      x-operation-name: list
      x-operation-request-parameters-name: ListFlowsRequestParameters
      x-operation-group: flows
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:flows
    post:
      summary: Create a Flow
      tags:
      - flows
      requestBody:
        x-release-lifecycle: GA
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFlowRequestContent'
              x-release-lifecycle: GA
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateFlowRequestContent'
              x-release-lifecycle: GA
      responses:
        '201':
          description: Flow successfully created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateFlowResponseContent'
                x-release-lifecycle: GA
              x-release-lifecycle: GA
        '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:flows.'
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: post_flows
      x-release-lifecycle: GA
      x-operation-name: create
      x-operation-group: flows
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - create:flows
  /flows/vault/connections:
    get:
      summary: Get Flows Vault Connection List
      tags:
      - flows
      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
      responses:
        '200':
          description: Vault connections successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListFlowsVaultConnectionsResponseContent'
        '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:flows_vault_connections.'
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: get_flows_vault_connections
      x-release-lifecycle: GA
      x-operation-name: list
      x-operation-request-parameters-name: ListFlowsVaultConnectionsRequestParameters
      x-operation-group:
      - flows
      - vault
      - connections
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:flows_vault_connections
    post:
      summary: Create a Flows Vault Connection
      tags:
      - flows
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFlowsVaultConnectionRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateFlowsVaultConnectionRequestContent'
      responses:
        '201':
          description: Connection successfully created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateFlowsVaultConnectionResponseContent'
        '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:flows_vault_connections.'
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: post_flows_vault_connections
      x-release-lifecycle: GA
      x-operation-name: create
      x-operation-group:
      - flows
      - vault
      - connections
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - create:flows_vault_connections
  /flows/vault/connections/{id}:
    get:
      summary: Get a Flows Vault Connection
      tags:
      - flows
      parameters:
      - name: id
        in: path
        description: Flows Vault connection ID
        required: true
        schema:
          type: string
          maxLength: 30
      responses:
        '200':
          description: Flow vault connection successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetFlowsVaultConnectionResponseContent'
        '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:flows_vault_connections.'
        '404':
          description: The Flow vault connection does not exist.
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: get_flows_vault_connections_by_id
      x-release-lifecycle: GA
      x-operation-name: get
      x-operation-request-parameters-name: GetFlowsVaultConnectionRequestParameters
      x-operation-group:
      - flows
      - vault
      - connections
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:flows_vault_connections
    delete:
      summary: Delete a Flows Vault Connection
      tags:
      - flows
      parameters:
      - name: id
        in: path
        description: Vault connection id
        required: true
        schema:
          type: string
          maxLength: 30
      responses:
        '204':
          description: Connection 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:flows_vault_connections.'
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: delete_flows_vault_connections_by_id
      x-release-lifecycle: GA
      x-operation-name: delete
      x-operation-group:
      - flows
      - vault
      - connections
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - delete:flows_vault_connections
    patch:
      summary: Update a Flows Vault Connection
      tags:
      - flows
      parameters:
      - name: id
        in: path
        description: Flows Vault connection ID
        required: true
        schema:
          type: string
          maxLength: 30
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFlowsVaultConnectionRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateFlowsVaultConnectionRequestContent'
      responses:
        '200':
          description: Flow vault connection successfully updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateFlowsVaultConnectionResponseContent'
        '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: update:flows_vault_connections.'
        '404':
          description: The Flow vault connection does not exist.
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: patch_flows_vault_connections_by_id
      x-release-lifecycle: GA
      x-operation-name: update
      x-operation-group:
      - flows
      - vault
      - connections
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - update:flows_vault_connections
  /flows/{flow_id}/executions:
    get:
      summary: Get Flow Executions
      tags:
      - flows
      parameters:
      - name: flow_id
        in: path
        description: Flow id
        required: true
        schema:
          type: string
          maxLength: 30
      - name: page
        in: query
        description: Page index of the results to return. First page is 0.
        schema:
          type: integer
          minimum: 0
      - 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: from
        in: query
        description: Optional Id from which to start selection.
        schema:
          type: string
      - name: take
        in: query
        description: Number of results per page. Defaults to 50.
        schema:
          type: integer
          minimum: 1
          maximum: 100
      responses:
        '200':
          description: Flow executions successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetFlowsExecutionsResponseContent'
        '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:flows_executions.'
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: get_flows_executions
      x-release-lifecycle: GA
      x-operation-name: list
      x-operation-request-parameters-name: ListFlowExecutionsRequestParameters
      x-operation-group:
      - flows
      - executions
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:flows_executions
  /flows/{flow_id}/executions/{execution_id}:
    get:
      summary: Get a Flow Execution
      tags:
      - flows
      parameters:
      - name: flow_id
        in: path
        description: Flow id
        required: true
        schema:
          type: string
          maxLength: 30
      - name: execution_id
        in: path
        description: Flow execution id
        required: true
        schema:
          type: string
          maxLength: 30
      - name: hydrate
        in: query
        description: Hydration param
        style: form
        explode: true
        schema:
          type: array
          items:
            $ref: '#/components/schemas/GetFlowExecutionRequestParametersHydrateEnum'
      responses:
        '200':
          description: Flow execution successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetFlowExecutionResponseContent'
        '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:flows_executions.'
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: get_flows_executions_by_execution_id
      x-release-lifecycle: GA
      x-operation-name: get
      x-operation-request-parameters-name: GetFlowExecutionRequestParameters
      x-operation-group:
      - flows
      - executions
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:flows_executions
    delete:
      summary: Delete a Flow Execution
      tags:
      - flows
      parameters:
      - name: flow_id
        in: path
        description: Flows id
        required: true
        schema:
          type: string
          maxLength: 30
      - name: execution_id
        in: path
        description: Flow execution identifier
        required: true
        schema:
          type: string
          maxLength: 30
      responses:
        '204':
          description: Flow execution 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:flows_executions.'
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: delete_flows_executions_by_execution_id
      x-release-lifecycle: GA
      x-operation-name: delete
      x-operation-group:
      - flows
      - executions
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - delete:flows_executions
  /flows/{id}:
    get:
      summary: Get a Flow
      tags:
      - flows
      parameters:
      - name: id
        in: path
        description: Flow identifier
        required: true
        schema:
          type: string
          maxLength: 30
      - name: hydrate
        in: query
        description: hydration param
        style: form
        explode: true
        schema:
          type: array
          items:
            $ref: '#/components/schemas/GetFlowRequestParametersHydrateEnum'
      responses:
        '200':
          description: Flow successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetFlowResponseContent'
                x-release-lifecycle: GA
              x-release-lifecycle: GA
        '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:flows.'
        '404':
          description: The flow does not exist.
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: get_flows_by_id
      x-release-lifecycle: GA
      x-operation-name: get
      x-operation-request-parameters-name: GetFlowRequestParameters
      x-operation-group: flows
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:flows
    delete:
      summary: Delete a Flow
      tags:
      - flows
      parameters:
      - name: id
        in: path
        description: Flow id
        required: true
        schema:
          type: string
          maxLength: 30
      responses:
        '204':
          description: Flow 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:flows.'
        '404':
          description: The flow does not exist.
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: delete_flows_by_id
      x-release-lifecycle: GA
      x-operation-name: delete
      x-operation-group: flows
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - delete:flows
    patch:
      summary: Update a Flow
      tags:
      - flows
      parameters:
      - name: id
        in: path
        description: Flow identifier
        required: true
        schema:
          type: string
          maxLength: 30
      requestBody:
        x-release-lifecycle: GA
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFlowRequestContent'
              x-release-lifecycle: GA
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateFlowRequestContent'
              x-release-lifecycle: GA
      responses:
        '200':
          description: Flow successfully updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateFlowResponseContent'
                x-release-lifecycle: GA
              x-release-lifecycle: GA
        '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:flows.'
        '404':
          description: The flow does not exist.
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: patch_flows_by_id
      x-release-lifecycle: GA
      x-operation-name: update
      x-operation-group: flows
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - update:flows
components:
  schemas:
    CreateFlowsVaultConnectionStripeUninitialized:
      type: object
      additionalProperties: false
      required:
      - name
      - app_id
      properties:
        name:
          type: string
          description: Flows Vault Connection name.
          minLength: 1
          maxLength: 150
        app_id:
          $ref: '#/components/schemas/FlowsVaultConnectionAppIdStripeEnum'
    CreateFlowsVaultConnectionSalesforce:
      type: object
      oneOf:
      - $ref: '#/components/schemas/CreateFlowsVaultConnectionSalesforceOauthCode'
      - $ref: '#/components/schemas/CreateFlowsVaultConnectionSalesforceUninitialized'
    FlowActionJsonParseJson:
      type: object
      additionalProperties: false
      required:
      - id
      - type
      - action
      - params
      properties:
        id:
          type: string
          format: forms-custom-identifier
        alias:
          type: string
          maxLength: 100
        type:
          type: string
          enum:
          - JSON
        action:
          type: string
          enum:
          - PARSE_JSON
        allow_failure:
          type: boolean
        mask_output:
          type: boolean
        params:
          $ref: '#/components/schemas/FlowActionJsonParseJsonParams'
    FlowActionMailchimpUpsertMemberParamsMember:
      type: object
      additionalProperties: false
      required:
      - email_address
      - status_if_new
      properties:
        email_address:
          type: string
        status_if_new:
          type: string
        merge_fields:
          $ref: '#/components/schemas/FlowActionMailchimpUpsertMemberParamsMemberMergeFields'
    FlowActionActivecampaignListContacts:
      type: object
      additionalProperties: false
      required:
      - id
      - type
      - action
      - params
      properties:
        id:
          type: string
          format: forms-custom-identifier
        alias:
          type: string
          maxLength: 100
        type:
          type: string
          enum:
          - ACTIVECAMPAIGN
        action:
          type: string
          enum:
          - LIST_CONTACTS
        allow_failure:
          type: boolean
        mask_output:
          type: boolean
        params:
          $ref: '#/components/schemas/FlowActionActivecampaignListContactsParams'
    FlowActionAuth0:
      type: object
      oneOf:
      - $ref: '#/components/schemas/FlowActionAuth0CreateUser'
      - $ref: '#/components/schemas/FlowActionAuth0GetUser'
      - $ref: '#/components/schemas/FlowActionAuth0UpdateUser'
      - $ref: '#/components/schemas/FlowActionAuth0SendRequest'
      - $ref: '#/components/schemas/FlowActionAuth0SendEmail'
      - $ref: '#/components/schemas/FlowActionAuth0SendSms'
      - $ref: '#/components/schemas/FlowActionAuth0MakeCall'
    FlowsVaultConnectioSetupTypeBearerEnum:
      type: string
      enum:
      - BEARER
    CreateFlowsVaultConnectionAirtableUninitialized:
      type: object
      additionalProperties: false
      required:
      - name
      - app_id
      properties:
        name:
          type: string
          description: Flows Vault Connection name.
          minLength: 1
          maxLength: 150
        app_id:
          $ref: '#/components/schemas/FlowsVaultConnectionAppIdAirtableEnum'
    FlowActionClearbitFindPersonParams:
      type: object
      additionalProperties: false
      required:
      - connection_id
      - email
      properties:
        connection_id:
          type: string
          maxLength: 30
          format: flows-vault-connections-id
        email:
          type: string
    FlowActionAuth0SendSms:
      type: object
      additionalProperties: false
      required:
      - id
      - type
      - action
      - params
      properties:
        id:
          type: string
          format: forms-custom-identifier
        alias:
          type: string
          maxLength: 100
        type:
          type: string
          enum:
          - AUTH0
        action:
          type: string
          enum:
          - SEND_SMS
        allow_failure:
          type: boolean
        mask_output:
          type: boolean
        params:
          $ref: '#/components/schemas/FlowActionAuth0SendSmsParams'
    CreateFlowsVaultConnectionBigqueryUninitialized:
      type: object
      additionalProperties: false
      required:
      - name
      - app_id
      properties:
        name:
          type: string
          description: Flows Vault Connection name.
          minLength: 1
          maxLength: 150
        app_id:
          $ref: '#/components/schemas/FlowsVaultConnectionAppIdBigqueryEnum'
    FlowActionAirtableCreateRecordParams:
      type: object
      additionalProperties: false
      required:
      - connection_id
      - base_id
      - table_name
      properties:
        connection_id:
          type: string
          maxLength: 30
          format: flows-vault-connections-id
        base_id:
          type: string
        table_name:
          type: string
        fields:
          $ref: '#/components/schemas/FlowActionAirtableCreateRecordParamsFields'
    FlowActionSlackPostMessageParamsAttachment:
      type: object
      additionalProperties: false
      properties:
        color:
          type: string
          enum:
          - GOOD
          - WARNING
          - DANGER
        pretext:
          type: string
        text:
          type: string
        fields:
          type: array
          items:
            $ref: '#/components/schemas/FlowActionSlackPostMessageParamsAttachmentField'
    UpdateFlowsVaultConnectionResponseContent:
      type: object
      additionalProperties: false
      required:
      - id
      - app_id
      - name
      - ready
      - created_at
      - updated_at
      - fingerprint
      properties:
        id:
          type: string
          description: Flows Vault Connection identifier.
          maxLength: 30
          format: flows-vault-connections-id
        app_id:
          type: string
          description: Flows Vault Connection app identifier.
          minLength: 1
          maxLength: 55
        environment:
          type: string
          description: Flows Vault Connection environment.
          minLength: 1
          maxLength: 55
        name:
          type: string
          description: Flows Vault Connection name.
          minLength: 1
          maxLength: 150
        account_name:
          type: string
          description: Flows Vault Connection custom account name.
          minLength: 1
          maxLength: 150
        ready:
          type: boolean
          description: Whether the Flows Vault Connection is configured.
        created_at:
          type: string
          description: The ISO 8601 formatted date when this Flows Vault Connection was created.
          format: date-time
        updated_at:
          type: string
          description: The ISO 8601 formatted date when this Flows Vault Connection was updated.
          format: date-time
        refreshed_at:
          type: string
          description: The ISO 8601 formatted date when this Flows Vault Connection was refreshed.
          format: date-time
        fingerprint:
          type: string
          minLength: 1
    FlowActionTwilioSendSms:
      type: object
      additionalProperties: false
      required:
      - id
      - type
      - action
      - params
      properties:
        id:
          type: string
          format: forms-custom-identifier
        alias:
          type: string
          maxLength: 100
        type:
          type: string
          enum:
          - TWILIO
        action:
          type: string
          enum:
          - SEND_SMS
        allow_failure:
          type: boolean
        mask_output:
          type: boolean
        params:
          $ref: '#/components/schemas/FlowActionTwilioSendSmsParams'
    CreateFlowsVaultConnectionDocusignUninitialized:
      type: object
      additionalProperties: false
      required:
      - name
      - app_id
      properties:
        name:
          type: string
          description: Flows Vault Connection name.
          minLength: 1
          maxLength: 150
        app_id:
          $ref: '#/components/schemas/FlowsVaultConnectionAppIdDocusignEnum'
    CreateFlowsVaultConnectionZapier:
      type: object
      oneOf:
      - $ref: '#/components/schemas/CreateFlowsVaultConnectionZapierWebhook'
      - $ref: '#/components/schemas/CreateFlowsVaultConnectionZapierUninitialized'
    FlowActionOtpVerifyCodeParamsCode:
      oneOf:
      - type: integer
        minimum: 0
        maximum: 9999999999
      - type: string
        maxLength: 250
    CreateFlowsVaultConnectionAuth0OauthApp:
      type: object
      additionalProperties: false
      required:
      - name
      - app_id
      - setup
      properties:
        name:
          type: string
          description: Flows Vault Connection name.
          minLength: 1
          maxLength: 150
        app_id:
          $ref: '#/components/schemas/FlowsVaultConnectionAppIdAuth0Enum'
        setup:
          $ref: '#/components/schemas/FlowsVaultConnectioSetupOauthApp'
    FlowActionMailchimpUpsertMemberParamsMemberMergeFields:
      type: object
      additionalProperties: true
      properties: {}
    FlowActionJwtDecodeJwtParams:
      type: object
      additionalProperties: false
      required:
      - token
      properties:
        token:
          type: string
          maxLength: 10000
    FlowsVaultConnectioSetupToken:
      type: object
      additionalProperties: false
      required:
      - type
      - token
      properties:
        type:
          $ref: '#/components/schemas/FlowsVaultConnectioSetupTypeTokenEnum'
        token:
          type: string
    FlowActionPipedriveAddDealParams:
      type: object
      additionalProperties: false
      required:
      - connection_id
      - title
      properties:
        connection_id:
          type: string
          maxLength: 30
          format: flows-vault-connections-id
    

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