Skip to main content

Interface: OpenIDConnectTokenArguments

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

Extends​

  • OAuthCredentials.OAuthGrantRefresh

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

grant_type?​

optional grant_type: "authorization_code" | "refresh_token";

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

Description​

The grant_type param as described in the OAuth spec.

Inherited from​

OAuthGrantRefresh.grant_type

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

refresh_token?​

optional refresh_token: string;

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

Description​

The refresh_token param as described in the OAuth spec.

Inherited from​

OAuthGrantRefresh.refresh_token