Auth0 flows API

openapi: 3.2.0
info:
  title: Auth0 Management Flows API
  description: Auth0 Management API v2.
  termsOfService: https://auth0.com/web-terms/
  contact:
    name: Auth0 Support
    url: https://support.auth0.com
  version: '2.0'
servers:
- url: https://{tenantDomain}/api/v2
  variables:
    tenantDomain:
      default: '{TENANT}.auth0.com'
      description: Auth0 Tenant Domain
security:
- bearerAuth: []
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:
    CreateFlowsVaultConnectionTelegramUninitialized:
      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/FlowsVaultConnectionAppIdTelegramEnum'
    CreateFlowsVaultConnectionHttpBasicAuth:
      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/FlowsVaultConnectionAppIdHttpEnum'
        setup:
          $ref: '#/components/schemas/FlowsVaultConnectionHttpBasicAuthSetup'
    FlowActionSalesforceCreateLeadParams:
      type: object
      additionalProperties: false
      required:
      - connection_id
      - last_name
      - company
      properties:
        connection_id:
          type: string
          maxLength: 30
          format: flows-vault-connections-id
        first_name:
          type: string
        last_name:
          type: string
          minLength: 1
        company:
          type: string
          minLength: 1
        email:
          type: string
        phone:
          type: string
        payload:
          $ref: '#/components/schemas/FlowActionSalesforceCreateLeadParamsPayload'
    FlowActionSlackPostMessageParams:
      type: object
      additionalProperties: false
      required:
      - connection_id
      properties:
        connection_id:
          type: string
          maxLength: 30
          format: flows-vault-connections-id
        text:
          type: string
        attachments:
          type: array
          items:
            $ref: '#/components/schemas/FlowActionSlackPostMessageParamsAttachment'
    FlowActionClearbitFindCompanyParams:
      type: object
      additionalProperties: false
      required:
      - connection_id
      - domain
      properties:
        connection_id:
          type: string
          maxLength: 30
          format: flows-vault-connections-id
        domain:
          type: string
    FlowActionSalesforceCreateLead:
      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:
          - SALESFORCE
        action:
          type: string
          enum:
          - CREATE_LEAD
        allow_failure:
          type: boolean
        mask_output:
          type: boolean
        params:
          $ref: '#/components/schemas/FlowActionSalesforceCreateLeadParams'
    CreateFlowsVaultConnectionMailjetApiKey:
      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/FlowsVaultConnectionAppIdMailjetEnum'
        setup:
          $ref: '#/components/schemas/FlowsVaultConnectioSetupMailjetApiKey'
    CreateFlowsVaultConnectionMailjet:
      type: object
      oneOf:
      - $ref: '#/components/schemas/CreateFlowsVaultConnectionMailjetApiKey'
      - $ref: '#/components/schemas/CreateFlowsVaultConnectionMailjetUninitialized'
    FlowActionAirtableListRecords:
      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:
          - AIRTABLE
        action:
          type: string
          enum:
          - LIST_RECORDS
        allow_failure:
          type: boolean
        mask_output:
          type: boolean
        params:
          $ref: '#/components/schemas/FlowActionAirtableListRecordsParams'
    FlowActionClearbitFindPersonParams:
      type: object
      additionalProperties: false
      required:
      - connection_id
      - email
      properties:
        connection_id:
          type: string
          maxLength: 30
          format: flows-vault-connections-id
        email:
          type: string
    FlowActionStripeFindCustomers:
      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:
          - STRIPE
        action:
          type: string
          enum:
          - FIND_CUSTOMERS
        allow_failure:
          type: boolean
        mask_output:
          type: boolean
        params:
          $ref: '#/components/schemas/FlowActionStripeFindCustomersParams'
    FlowActionHttpSendRequestParamsBasicAuth:
      type: object
      additionalProperties: false
      properties:
        username:
          type: string
          minLength: 1
        password:
          type: string
          minLength: 1
    FlowActionOtpVerifyCodeParams:
      type: object
      additionalProperties: false
      required:
      - reference
      - code
      properties:
        reference:
          type: string
          maxLength: 250
        code:
          $ref: '#/components/schemas/FlowActionOtpVerifyCodeParamsCode'
    FlowActionJsonCreateJsonParams:
      type: object
      additionalProperties: false
      required:
      - object
      properties:
        object:
          $ref: '#/components/schemas/FlowActionJsonCreateJsonParamsObject'
    FlowActionGoogleSheetsAddRow:
      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:
          - GOOGLE_SHEETS
        action:
          type: string
          enum:
          - ADD_ROW
        allow_failure:
          type: boolean
        mask_output:
          type: boolean
        params:
          $ref: '#/components/schemas/FlowActionGoogleSheetsAddRowParams'
    FlowActionClearbit:
      type: object
      oneOf:
      - $ref: '#/components/schemas/FlowActionClearbitFindPerson'
      - $ref: '#/components/schemas/FlowActionClearbitFindCompany'
    FlowActionAuth0SendRequestParamsCustomVars:
      type: object
      additionalProperties: true
    CreateFlowsVaultConnectionJwtUninitialized:
      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/FlowsVaultConnectionAppIdJwtEnum'
    FlowActionHttp:
      type: object
      oneOf:
      - $ref: '#/components/schemas/FlowActionHttpSendRequest'
    CreateFlowsVaultConnectionJwtJwt:
      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/FlowsVaultConnectionAppIdJwtEnum'
        setup:
          $ref: '#/components/schemas/FlowsVaultConnectioSetupJwt'
    FlowActionStripeAddTaxId:
      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:
          - STRIPE
        action:
          type: string
          enum:
          - ADD_TAX_ID
        allow_failure:
          type: boolean
        mask_output:
          type: boolean
        params:
          $ref: '#/components/schemas/FlowActionStripeAddTaxIdParams'
    FlowsVaultConnectioSetupOauthCode:
      type: object
      additionalProperties: true
      properties:
        type:
          $ref: '#/components/schemas/FlowsVaultConnectioSetupTypeOauthCodeEnum'
        code:
          type: string
    FlowActionBigqueryInsertRowsParamsData:
      type: object
      additionalProperties: true
      properties: {}
    FlowActionMailchimp:
      type: object
      oneOf:
      - $ref: '#/components/schemas/FlowActionMailchimpUpsertMember'
    FlowActionAuth0UpdateUser:
      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:
          - UPDATE_USER
        allow_failure:
          type: boolean
        mask_output:
          type: boolean
        params:
          $ref: '#/components/schemas/FlowActionAuth0UpdateUserParams'
    FlowActionAuth0SendEmailParamsFromEmail:
      type: string
      oneOf:
      - type: string
        format: email
      - type: string
        format: forms-expression
    FlowActionMailchimpUpsertMemberParamsMember:
      type: object
      additionalProperties: false
      required:
      - email_address
      - status_if_new
      properties:


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