Class Oauth2Api

Oauth2Api - object-oriented interface

export

Hierarchy

BaseAPI
- Oauth2Api

Index

Constructors

constructor

Methods

Constructors

constructor

new Oauth2Api(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): Oauth2Api

Inherited from BaseAPI.constructor
- Defined in base.ts:51
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns Oauth2Api

Methods

adminAcceptConsent

adminAcceptConsent(requestParameters: Oauth2ApiAdminAcceptConsentRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<AdminRedirectTo, any>>

- Defined in api.ts:10342
Accept Consent Challenge to login.

throws
{RequiredError}

memberof
Oauth2Api

Parameters
- requestParameters: Oauth2ApiAdminAcceptConsentRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<AdminRedirectTo, any>>

adminAcceptLogin

adminAcceptLogin(requestParameters: Oauth2ApiAdminAcceptLoginRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<AdminRedirectTo, any>>

- Defined in api.ts:10362
Accept Login Challenge with subject & login challenge

throws
{RequiredError}

memberof
Oauth2Api

Parameters
- requestParameters: Oauth2ApiAdminAcceptLoginRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<AdminRedirectTo, any>>

createToken

createToken(requestParameters: Oauth2ApiCreateTokenRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<OAuth2Token, any>>

- Defined in api.ts:10382
Create an OAuth2 access token. For details, see our Authentication guide.

throws
{RequiredError}

memberof
Oauth2Api

Parameters
- requestParameters: Oauth2ApiCreateTokenRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<OAuth2Token, any>>

revokeToken

revokeToken(requestParameters: Oauth2ApiRevokeTokenRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<void, any>>

- Defined in api.ts:10405
Revoke an OAuth2 access token.

throws
{RequiredError}

memberof
Oauth2Api

Parameters
- requestParameters: Oauth2ApiRevokeTokenRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<void, any>>