Skip to main content

Interface: OAuthV2AccessArguments

Extends

  • OAuthCredentials.OAuthGrantRefresh

Properties

client_id

client_id: string;

Description

Issued when you created your application.

Inherited from

OAuthCredentials.client_id

Defined in

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


client_secret

client_secret: string;

Description

Issued when you created your application.

Inherited from

OAuthCredentials.client_secret

Defined in

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


code?

optional code: string;

Description

The code parameter returned via the OAuth callback.

Inherited from

OAuthCredentials.code

Defined in

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


grant_type?

optional grant_type: "authorization_code" | "refresh_token";

Description

The grant_type param as described in the OAuth spec.

Inherited from

OAuthGrantRefresh.grant_type

Defined in

packages/web-api/src/types/request/common.ts:152


redirect_uri?

optional redirect_uri: string;

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

Defined in

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


refresh_token?

optional refresh_token: string;

Description

The refresh_token param as described in the OAuth spec.

Inherited from

OAuthGrantRefresh.refresh_token

Defined in

packages/web-api/src/types/request/common.ts:154