Class RegistrationApi

RegistrationApi - object-oriented interface

export
class: RegistrationApi
extends: {BaseAPI}

Hierarchy

BaseAPI
- RegistrationApi

Index

Constructors

constructor

Methods

Constructors

constructor

new RegistrationApi(configuration?: Configuration, basePath?: string, fetch?: FetchAPI): RegistrationApi

Inherited from BaseAPI.constructor
- Defined in api.ts:58
Parameters
- Optional configuration: Configuration
- Default value basePath: string = BASE_PATH
- Default value fetch: FetchAPI = portableFetch
Returns RegistrationApi

Methods

deleteRegistration

deleteRegistration(options?: any): Promise<Response>

- Defined in api.ts:3629
api.resource.registration.deleteRegistration.description

summary

Delete the user context for the current token.

throws

{RequiredError}

memberof

RegistrationApi

Parameters
- Optional options: any
Returns Promise<Response>

getJsonWebKey

getJsonWebKey(options?: any): Promise<JwkJwkPublicKey>

- Defined in api.ts:3640
A valid API public key will be returned in JWK format to be used to encrypt registration data. Only needed with extended encryption.

summary

Request API JWK public key

throws

{RequiredError}

memberof

RegistrationApi

Parameters
- Optional options: any
Returns Promise<JwkJwkPublicKey>

getRegistrationPublicKey

getRegistrationPublicKey(options?: any): Promise<RegistrationPublicKey>

- Defined in api.ts:3651
A valid API public key will be returned to be used to encrypt registration data. Only needed with extended encryption.

summary

Request API public key

throws

{RequiredError}

memberof

RegistrationApi

Parameters
- Optional options: any
Returns Promise<RegistrationPublicKey>

register

register(options?: any): Promise<RegistrationResponse>

- Defined in api.ts:3662
Registers a user with AHOI

summary

User registration

throws

{RequiredError}

memberof

RegistrationApi

Parameters
- Optional options: any
Returns Promise<RegistrationResponse>