Skip to main content

Interface: OAuthAccessArguments

Defined in: packages/web-api/src/types/request/oauth.ts:4

Extends​

  • OAuthCredentials

Properties​

client_id​

client_id: string;

Defined in: packages/web-api/src/types/request/common.ts:138

Description​

Issued when you created your application.

Inherited from​

OAuthCredentials.client_id

client_secret​

client_secret: string;

Defined in: packages/web-api/src/types/request/common.ts:140

Description​

Issued when you created your application.

Inherited from​

OAuthCredentials.client_secret

code?​

optional code: string;

Defined in: packages/web-api/src/types/request/common.ts:142

Description​

The code parameter returned via the OAuth callback.

Inherited from​

OAuthCredentials.code

redirect_uri?​

optional redirect_uri: string;

Defined in: packages/web-api/src/types/request/common.ts:147

Description​

While optional, it is required if your app passed it as a parameter to the OpenID/OAuth flow's first step and must match the originally submitted URI.

Inherited from​

OAuthCredentials.redirect_uri

single_channel?​

optional single_channel: boolean;

Defined in: packages/web-api/src/types/request/oauth.ts:6

Description​

Request the user to add your app only to a single channel. Only valid with a legacy workspace app. Defaults to false.