Class AccountApi

AccountApi - object-oriented interface export AccountApi

Hierarchy (view full)

BaseAPI
- AccountApi

Index

Constructors

Properties

axios basePath configuration

Methods

apiAccountDelete refreshAccessToken requestAuthLink requestOtp verifyOtp

Constructors

constructor

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

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

apiAccountDelete

apiAccountDelete(options?): Promise<AxiosResponse<void, any>>
The account block action is irreversible through the API. Users must contact support to unblock their accounts if this action was done in error. summary Disables a user's account by marking it as blocked in Auth0. The user ID is extracted from the JWT token provided in the Authorization header.
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
memberof AccountApi
- Defined in src/api/api.ts:13780

refreshAccessToken

refreshAccessToken(auth0RefreshTokenRequestDeet?, options?): Promise<AxiosResponse<TokenResponse, any>>
summary Refresh Auth Access Token
Parameters
- Optionalauth0RefreshTokenRequestDeet: Auth0RefreshTokenRequestDeet
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<TokenResponse, any>>
Throws
memberof AccountApi
- Defined in src/api/api.ts:13792

requestAuthLink

requestAuthLink(authLinkRequestDeet?, options?): Promise<AxiosResponse<AuthLinkResponse, any>>
summary Generate Authorized Link
Parameters
- OptionalauthLinkRequestDeet: AuthLinkRequestDeet
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<AuthLinkResponse, any>>
Throws
memberof AccountApi
- Defined in src/api/api.ts:13804

requestOtp

requestOtp(auth0OtpGenerateDeets?, options?): Promise<AxiosResponse<Auth0OtpGenerateResponse, any>>
summary Generate Auth OTP
Parameters
- Optionalauth0OtpGenerateDeets: Auth0OtpGenerateDeets
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<Auth0OtpGenerateResponse, any>>
Throws
memberof AccountApi
- Defined in src/api/api.ts:13816

verifyOtp

verifyOtp(auth0OtpVerifyDeets?, options?): Promise<AxiosResponse<TokenResponse, any>>
summary Verify Auth OTP
Parameters
- Optionalauth0OtpVerifyDeets: Auth0OtpVerifyDeets
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<TokenResponse, any>>
Throws
memberof AccountApi
- Defined in src/api/api.ts:13828