Interface: InstallProviderOptions
Properties
authVersion?
optional authVersion: "v1" | "v2";
The default is "v2" (a.k.a. Granular Bot Permissions), different from "v1" (a.k.a. "Classic Apps"). More details here:
- https://medium.com/slack-developer-blog/more-precision-less-restrictions-a3550006f9c3
- https://api.slack.com/authentication/migration
Defined in
packages/oauth/src/install-provider-options.ts:78
authorizationUrl?
optional authorizationUrl: string;
The slack.com authorize URL
Defined in
packages/oauth/src/install-provider-options.ts:27
clientId
clientId: string;
Client ID, which can be found under the Basic Information section of your application on https://api.slack.com/apps
Defined in
packages/oauth/src/install-provider-options.ts:12
clientOptions?
optional clientOptions: Omit<WebClientOptions, "logLevel" | "logger">;
The customization options for WebClient
Defined in
packages/oauth/src/install-provider-options.ts:98
clientSecret
clientSecret: string;
Client Secret, which can be found under the Basic Information section of your application on https://api.slack.com/apps
Defined in
packages/oauth/src/install-provider-options.ts:17
directInstall?
optional directInstall: boolean;
The install path web page rendering will be skipped if true (default: false)
Defined in
packages/oauth/src/install-provider-options.ts:70
installUrlOptions?
optional installUrlOptions: InstallURLOptions;
The initialization options for the OAuth flow
Defined in
packages/oauth/src/install-provider-options.ts:83
installationStore?
optional installationStore: InstallationStore;
Manages installation data, which can be called by both the OAuth flow and authorize() in event handling
Defined in
packages/oauth/src/install-provider-options.ts:22
legacyStateVerification?
optional legacyStateVerification: boolean;
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.
Defined in
packages/oauth/src/install-provider-options.ts:50
logLevel?
optional logLevel: any;
@slack/logger logging level used in this class
Defined in
packages/oauth/src/install-provider-options.ts:93
logger?
optional logger: any;
@slack/logger logging used in this class
Defined in
packages/oauth/src/install-provider-options.ts:88
renderHtmlForInstallPath()?
optional renderHtmlForInstallPath: (url) => string;
The function for rendering the web page for the install path URL
Parameters
• url: string
Returns
string
Defined in
packages/oauth/src/install-provider-options.ts:65
stateCookieExpirationSeconds?
optional stateCookieExpirationSeconds: number;
The expiration time in seconds for the state parameter value stored via cookies
Defined in
packages/oauth/src/install-provider-options.ts:60
stateCookieName?
optional stateCookieName: string;
The cookie name used for setting state parameter value in cookies
Defined in
packages/oauth/src/install-provider-options.ts:55
stateSecret?
optional stateSecret: string;
The secret value used for generating the state parameter value
Defined in
packages/oauth/src/install-provider-options.ts:38
stateStore?
optional stateStore: StateStore;
Stores state issued to authorization server and verifies the value returned at redirection during OAuth flow to prevent CSRF
Defined in
packages/oauth/src/install-provider-options.ts:33
stateVerification?
optional stateVerification: boolean;
handleCallback() verifies the state parameter if true (default: true)