Class AuthLinksApi

AuthLinksApi - object-oriented interface

Export

Hierarchy

BaseAPI
- AuthLinksApi

Index

Constructors

Properties

axios basePath configuration

Methods

Constructors

constructor

new AuthLinksApi(configuration?, basePath?, axios?): AuthLinksApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns AuthLinksApi
Inherited from BaseAPI.constructor
- Defined in base.ts:56

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

createAuthLink

createAuthLink(requestParameters, options?): Promise<AxiosResponse<AuthLinkDto, any>>
Creates an Auth Link for a User.

Summary
Create an Auth Link

Throws

Memberof
AuthLinksApi
Parameters
- requestParameters: AuthLinksApiCreateAuthLinkRequest
  
  Request parameters.
- Optional options: RawAxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<AuthLinkDto, any>>
- Defined in api/auth-links-api.ts:167

Generated using TypeDoc