Class OAuth2TokenResponse

Index

Constructors

Properties

accessToken expiresIn? refreshToken? scope? tokenType

Methods

getAccessToken getExpiresIn getRefreshToken getScope getTokenType setAccessToken setExpiresIn setRefreshToken setScope setTokenType toJSON toObject

Constructors

constructor

new OAuth2TokenResponse(
accessToken: string,
tokenType: string,
): OAuth2TokenResponse
Parameters
- accessToken: string
- tokenType: string
Returns OAuth2TokenResponse
- Defined in src/security/oauth2/responses.ts:105

Properties

`Protected`accessToken

accessToken: string

`Protected` `Optional`expiresIn

expiresIn?: number

in seconds

`Protected` `Optional`refreshToken

refreshToken?: string

`Protected` `Optional`scope

scope?: string

`Protected`tokenType

tokenType: string

Methods

getAccessToken

getAccessToken(): string
Returns string
- Defined in src/security/oauth2/responses.ts:114

getExpiresIn

getExpiresIn(): undefined | number
Returns undefined | number
number of seconds
- Defined in src/security/oauth2/responses.ts:136

getRefreshToken

getRefreshToken(): undefined | string
Returns undefined | string
- Defined in src/security/oauth2/responses.ts:144

getScope

getScope(): undefined | string
Returns undefined | string
- Defined in src/security/oauth2/responses.ts:152

getTokenType

getTokenType(): string
Returns string
- Defined in src/security/oauth2/responses.ts:122

setAccessToken

setAccessToken(value: string): OAuth2TokenResponse
Parameters
- value: string
Returns OAuth2TokenResponse
- Defined in src/security/oauth2/responses.ts:110

setExpiresIn

setExpiresIn(value?: number): OAuth2TokenResponse
Parameters
- Optionalvalue: number
  number of seconds
Returns OAuth2TokenResponse
- Defined in src/security/oauth2/responses.ts:129

setRefreshToken

setRefreshToken(value?: string): OAuth2TokenResponse
Parameters
- Optionalvalue: string
Returns OAuth2TokenResponse
- Defined in src/security/oauth2/responses.ts:140

setScope

setScope(value?: string): OAuth2TokenResponse
Parameters
- Optionalvalue: string
Returns OAuth2TokenResponse
- Defined in src/security/oauth2/responses.ts:148

setTokenType

setTokenType(value: string): OAuth2TokenResponse
Parameters
- value: string
Returns OAuth2TokenResponse
- Defined in src/security/oauth2/responses.ts:118

toJSON

toJSON(): {
    access_token: string;
    expires_in?: number;
    refresh_token?: string;
    scope?: string;
    token_type: string;
}
Returns {
    access_token: string;
    expires_in?: number;
    refresh_token?: string;
    scope?: string;
    token_type: string;
}
- Defined in src/security/oauth2/responses.ts:166

toObject

toObject(): {
    access_token: string;
    expires_in?: number;
    refresh_token?: string;
    scope?: string;
    token_type: string;
}
Returns {
    access_token: string;
    expires_in?: number;
    refresh_token?: string;
    scope?: string;
    token_type: string;
}
- Defined in src/security/oauth2/responses.ts:156