Skip to main content

@slack/oauth / InstallProviderOptions

Interface: InstallProviderOptions

Defined in: packages/oauth/src/install-provider-options.ts:8

Properties​

authorizationUrl?​

optional authorizationUrl?: string;

Defined in: packages/oauth/src/install-provider-options.ts:27

The slack.com authorize URL

authVersion?​

optional authVersion?: "v1" | "v2";

Defined in: packages/oauth/src/install-provider-options.ts:78

The default is "v2" (a.k.a. Granular Bot Permissions), different from "v1" (a.k.a. "Classic Apps"). More details here:

clientId​

clientId: string;

Defined in: packages/oauth/src/install-provider-options.ts:12

Client ID, which can be found under the Basic Information section of your application on https://api.slack.com/apps

clientOptions?​

optional clientOptions?: Omit<WebClientOptions, "logLevel" | "logger">;

Defined in: packages/oauth/src/install-provider-options.ts:98

The customization options for WebClient

clientSecret​

clientSecret: string;

Defined in: packages/oauth/src/install-provider-options.ts:17

Client Secret, which can be found under the Basic Information section of your application on https://api.slack.com/apps

directInstall?​

optional directInstall?: boolean;

Defined in: packages/oauth/src/install-provider-options.ts:70

The install path web page rendering will be skipped if true (default: false)

installationStore?​

optional installationStore?: InstallationStore;

Defined in: packages/oauth/src/install-provider-options.ts:22

Manages installation data, which can be called by both the OAuth flow and authorize() in event handling

installUrlOptions?​

optional installUrlOptions?: InstallURLOptions;

Defined in: packages/oauth/src/install-provider-options.ts:83

The initialization options for the OAuth flow

legacyStateVerification?​

optional legacyStateVerification?: boolean;

Defined in: packages/oauth/src/install-provider-options.ts:50

handleCallback() skips checking browser cookies if true (default: false) Enabling this option is not recommended. This is supposed to be used only for backward-compatibility with v2.4 and olders.

logger?​

optional logger?: Logger;

Defined in: packages/oauth/src/install-provider-options.ts:88

@slack/logger logging used in this class

logLevel?​

optional logLevel?: LogLevel;

Defined in: packages/oauth/src/install-provider-options.ts:93

@slack/logger logging level used in this class

renderHtmlForInstallPath?​

optional renderHtmlForInstallPath?: (url) => string;

Defined in: packages/oauth/src/install-provider-options.ts:65

The function for rendering the web page for the install path URL

Parameters​

url​

string

Returns​

string

stateCookieExpirationSeconds?​

optional stateCookieExpirationSeconds?: number;

Defined in: packages/oauth/src/install-provider-options.ts:60

The expiration time in seconds for the state parameter value stored via cookies

stateCookieName?​

optional stateCookieName?: string;

Defined in: packages/oauth/src/install-provider-options.ts:55

The cookie name used for setting state parameter value in cookies

stateSecret?​

optional stateSecret?: string;

Defined in: packages/oauth/src/install-provider-options.ts:38

The secret value used for generating the state parameter value

stateStore?​

optional stateStore?: StateStore;

Defined in: packages/oauth/src/install-provider-options.ts:33

Stores state issued to authorization server and verifies the value returned at redirection during OAuth flow to prevent CSRF

stateVerification?​

optional stateVerification?: boolean;

Defined in: packages/oauth/src/install-provider-options.ts:43

handleCallback() verifies the state parameter if true (default: true)