Directus (flagbit) icon

Directus (flagbit)

Consume Directus API

Authentication → Start OAuth Flow

AI-generated

Overview

This node initiates the OAuth authentication flow for a specified OAuth provider. It is useful in scenarios where a user needs to authenticate via an external OAuth provider to gain access to a service or application. For example, it can be used to start the login process with providers like Google, Facebook, or any custom OAuth provider configured in the system.

Use Case Examples

  1. Starting OAuth login flow for Google to authenticate a user.
  2. Initiating OAuth flow for a custom provider to obtain access tokens.

Properties

Name Meaning
Provider Key of the activated OAuth provider used to start the OAuth flow, specifying which external service to authenticate with.
Additional Fields Optional additional parameters for the OAuth flow, such as redirect URL after successful login.

Output

JSON

  • authenticationDetails - Contains authentication details returned after successful OAuth flow completion or JSON response if no redirect is set.

Troubleshooting

  • Ensure the 'Provider' key matches a configured OAuth provider; otherwise, the flow will fail to start.
  • If the redirect URL is incorrect or not allowed by the OAuth provider, the authentication may fail or not redirect properly.
  • Missing or incorrect OAuth credentials for the provider can cause authentication errors.

Discussion