Class AuthenticationApi

AuthenticationApi - object-oriented interface

Export

AuthenticationApi

Hierarchy (view full)

generated.AuthenticationApi
- AuthenticationApi

Index

Constructors

Properties

axios basePath configuration

Methods

authorize exchangeToken getOrRefreshToken refreshToken

Constructors

constructor

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

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

authorize

authorize(redirectUri, clientId, options?): Promise<AxiosResponse<void, any>>
Parameters
- redirectUri: string
- clientId: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
AuthenticationApi
Inherited from AuthenticationApi.authorize
- Defined in src/generated/api.ts:4002

exchangeToken

exchangeToken(request, options?): 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?, options?): Promise<AxiosResponse<GetOrRefreshToken200Response, any>>
Parameters
- OptionalgetOrRefreshTokenRequest: GetOrRefreshTokenRequest
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetOrRefreshToken200Response, any>>
Throws
Memberof
AuthenticationApi
Inherited from AuthenticationApi.getOrRefreshToken
- Defined in src/generated/api.ts:4013

refreshToken

refreshToken(request, options?): 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