Auth

Encrypted credentials

'encryptedCredentials'

required

The authentication type.

string

required

The name of the credentials. I.e. Twitter account, OpenAI account, Stripe keys, etc.

z.ZodObject<any>

required

The schema of the data that needs to be stored. See Options for more information.Example:

option.object({
  apiKey: option.string.meta({ layout: {
    isRequired: true,
    label: "API key",
    withVariableButton: false,
  } }),
});

OAuth

'oauth'

required

The authentication type for OAuth 2.0 flow.

string

required

The name of the credentials. I.e. Gmail account, Google Drive, GitHub account, etc.

string

required

The authorization URL for the OAuth provider where users will be redirected to authenticate.

string

required

The token endpoint URL where the authorization code will be exchanged for access tokens.

string[]

required

An array of OAuth scopes that define the permissions your application is requesting.

object

An object defining the default environment variable names for the OAuth client credentials.

Show Properties

string

required

The environment variable name for the OAuth client ID.

string

required

The environment variable name for the OAuth client secret.

object

Additional parameters to include in the authorization request.

Example:

const gmailScopes = [
  "https://www.googleapis.com/auth/gmail.send",
  "https://www.googleapis.com/auth/gmail.labels",
  "https://www.googleapis.com/auth/userinfo.profile",
  "https://www.googleapis.com/auth/userinfo.email",
] as const;

export const auth = createAuth({
  type: "oauth",
  name: "Gmail account",
  authUrl: "https://accounts.google.com/o/oauth2/v2/auth",
  tokenUrl: "https://oauth2.googleapis.com/token",
  scopes: gmailScopes,
  defaultClientEnvKeys: {
    id: "GMAIL_CLIENT_ID",
    secret: "GMAIL_CLIENT_SECRET",
  },
  extraAuthParams: {
    access_type: "offline",
    prompt: "consent",
  },
});

Get started

Guides

The Forge

Encrypted credentials

OAuth

​Encrypted credentials

​OAuth

Encrypted credentials

OAuth