Class AuthenticationApi

AuthenticationApi - object-oriented interface

Hierarchy (View Summary)

generated.AuthenticationApi
- AuthenticationApi

Index

Constructors

Properties

axios basePath configuration

Methods

authorize exchangeToken getOrRefreshToken refreshToken

Constructors

constructor

new AuthenticationApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): AuthenticationApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns AuthenticationApi
Inherited from AuthenticationApi.constructor
- Defined in src/generated/base.ts:39

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

authorize

authorize(
    redirectUri: string,
    clientId: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- redirectUri: string
- clientId: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
Inherited from AuthenticationApi.authorize
- Defined in src/generated/api.ts:944

exchangeToken

exchangeToken(
request: Omit<ObtainToken, "grant_type">,
options?: AxiosRequestConfig<any>,
): Promise<AxiosResponse<TokenResponse, any, {}>>
Wrapper function of _AuthenticationApi.getOrRefreshToken for token exchange.
Parameters
- request: Omit<ObtainToken, "grant_type">
  ObtainToken but without grant_type field.
- Optionaloptions: AxiosRequestConfig<any>
  Axios request configuration.
Returns Promise<AxiosResponse<TokenResponse, any, {}>>
API response.
- Defined in src/client/auth.ts:20

getOrRefreshToken

getOrRefreshToken(
getOrRefreshTokenRequest?: GetOrRefreshTokenRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetOrRefreshToken200Response, any, {}>>
Parameters
- OptionalgetOrRefreshTokenRequest: GetOrRefreshTokenRequest
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetOrRefreshToken200Response, any, {}>>

Throws
Inherited from AuthenticationApi.getOrRefreshToken
- Defined in src/generated/api.ts:954

refreshToken

refreshToken(
request: Omit<RefreshToken, "grant_type">,
options?: AxiosRequestConfig<any>,
): Promise<AxiosResponse<TokenResponse, any, {}>>
Wrapper function of _AuthenticationApi.getOrRefreshToken for token refresh.
Parameters
- request: Omit<RefreshToken, "grant_type">
  RefreshToken but without grant_type field.
- Optionaloptions: AxiosRequestConfig<any>
  Axios request configuration.
Returns Promise<AxiosResponse<TokenResponse, any, {}>>
API response.
- Defined in src/client/auth.ts:46