Class OAuthResource

OAuth 2.0 flow for obtaining player consent.

Typical flow:

authorize — start an authorization, get a URL to redirect the player to.
Player approves on the Vairified site and is redirected back to your redirectUri with a code query parameter.
exchangeToken — swap the code for access and refresh tokens plus the player's external ID.
Store the refresh token and call refresh when the access token expires.
revoke — disconnect a player from your app.

Index

Methods

authorize exchangeToken refresh revoke availableScopes

Methods

authorize

authorize(
    options: {
        redirectUri: string;
        scopes?: readonly OAuthScope[];
        state?: string;
    },
): Promise<AuthorizationResponse>
Start an OAuth authorization flow.
Parameters
- options: { redirectUri: string; scopes?: readonly OAuthScope[]; state?: string }
Returns Promise<AuthorizationResponse>
Throws
OAuthError with errorCode: 'invalid_scope' if a requested scope is not in the accepted list.
- Defined in src/resources/oauth.ts:49

exchangeToken

exchangeToken(
options: { code: string; redirectUri: string },
): Promise<TokenResponse>
Exchange an authorization code for access and refresh tokens.
Parameters
- options: { code: string; redirectUri: string }
Returns Promise<TokenResponse>
- Defined in src/resources/oauth.ts:83

refresh

refresh(refreshToken: string): Promise<TokenResponse>
Refresh an expired access token using a refresh token.
Parameters
- refreshToken: string
Returns Promise<TokenResponse>
- Defined in src/resources/oauth.ts:93

revoke

revoke(playerId: string): Promise<Record<string, unknown>>
Revoke a player's OAuth connection to your app.
Parameters
- playerId: string
Returns Promise<Record<string, unknown>>
- Defined in src/resources/oauth.ts:103

availableScopes

availableScopes(): Promise<readonly { name: string; description: string }[]>
Return the list of OAuth scopes the server currently supports.

Returns Promise<readonly { name: string; description: string }[]>
- Defined in src/resources/oauth.ts:113