Skip to main content

AuthFlow

Additional and optional specification object to describe what an 'advanced' Auth flow would need to function.

  • A connector should be able to fully function with the configuration as described by the ConnectorSpecification in a 'basic' mode.

  • The 'advanced' mode provides easier UX for the user with UI improvements and automations. However, this requires further setup on the server side by instance or workspace admins beforehand. The trade-off is that the user does not have to provide as many technical inputs anymore and the auth process is faster and easier to complete.

  • type: object

auth_flow_type​

The type of auth to use

  • Required: No
  • type: string
  • enum: ["oauth2.0","oauth1.0"]

predicate_key​

JSON path to a field in the connectorSpecification that should exist for the advanced auth to be applicable.

  • Required: No
  • type: array

Examples:

- credentials
- auth_type

  • items:

    • type: string

predicate_value​

Value of the predicate_key fields for the advanced auth to be applicable.

  • Required: No
  • type: string

Examples:

Oauth

oauth_config_specification​

Was this page helpful?