Find the provider of interest in the list response

Using OAuth Integrations

Integrating with a third-party software via OAuth is typically used to perform actions on behalf of the user. It involves having the user log in using their own credentials, specifying the scopes that they want to provide, and then afterwards, API requests can be made on their behalf.

Important: Avoid reaching for an OAuth integration if your intent is to act as yourself rather than as your user.

The Assistant OAuth CLI

You are provided with the assistant oauth CLI for performing all necessary oauth-related actions.

Important: When in doubt how a command works or how to do something, read the references at the bottom. Never guess at how the CLI works. Read references and use the --help flag for any command you're about to run.

Viewing Available OAuth Providers

Vellum assistants can natively integrate with any application that supports OAuth 2.0. Many OAuth providers come pre-configured and ready to use. You can view them by running:

assistant oauth providers list

You can also search for specific providers. Here's an example that searches for the "google" provider:

assistant oauth providers list --provider-key google

Managed vs Your-Own Mode

All providers support "your-own" mode and some support "managed" mode.

Default: Managed Mode

"managed" mode relies on a first-class integration with the Vellum Platform. Managed mode is typically easier to set up and get going, often only requiring the user to log in with no additional configuration needed before they can begin using the integration. Managed mode is the recommended method for most users, especially those that are less technical or newer to their Vellum assistant.

When a task needs a managed OAuth connection, present it in chat with ui_show using surface_type: "oauth_connect" instead of sending the user to Settings or trying to open the OAuth flow from shell. See Connecting Accounts for the exact surface shape.

Note that using managed mode:

• Requires an account with the Vellum Platform
• May result in billable usage