Class AuthenticationApi

AuthenticationApi - object-oriented interface

Hierarchy (View Summary)

BaseAPI
- AuthenticationApi
  - AuthenticationApi

Index

Constructors

Properties

axios basePath configuration

Methods

authorize getOrRefreshToken

Constructors

constructor

new AuthenticationApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): generated.AuthenticationApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns generated.AuthenticationApi
Inherited from BaseAPI.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
- Defined in src/generated/api.ts:944

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
- Defined in src/generated/api.ts:954