Class BaseAuthApi

Hierarchy

BaseAuthApi

Index

Constructors

Methods

createUserRecovery createUserActionChallenge createUserLogin createUserLoginChallenge createUserRegistration createUserRegistrationChallenge signUserActionChallenge userLogout

Constructors

constructor

new BaseAuthApi(): BaseAuthApi
Returns BaseAuthApi

Methods

createUserRecovery

createUserRecovery(request, options): Promise<UserRegistrationResponse>
Completes Recovery by sending the signed recovery challenge, containing the new Credential identity created.
Parameters
- request: CreateUserRecoveryRequest
- options: DfnsBaseApiOptions
Returns Promise<UserRegistrationResponse>
- Defined in packages/sdk/baseAuthApi.ts:201

`Static` createUserActionChallenge

createUserActionChallenge(request, options): Promise<UserActionChallenge>
Creates a user action challenge
Parameters
- request: CreateUserActionChallengeRequest
- options: DfnsBaseApiOptions
Returns Promise<UserActionChallenge>
- Defined in packages/sdk/baseAuthApi.ts:91

`Static` createUserLogin

createUserLogin(request, options): Promise<UserLoginResponse>
Completes user login by sending the signed login challenge.
Parameters
- request: SignUserActionChallengeRequest
- options: DfnsBaseApiOptions
Returns Promise<UserLoginResponse>
- Defined in packages/sdk/baseAuthApi.ts:139

`Static` createUserLoginChallenge

createUserLoginChallenge(request, options): Promise<UserActionChallenge>
Initiates user login, by creating a challenge that will need to be signed by the user Credentials.
Parameters
- request: CreateUserLoginChallengeRequest
- options: DfnsBaseApiOptions
Returns Promise<UserActionChallenge>
- Defined in packages/sdk/baseAuthApi.ts:123

`Static` createUserRegistration

createUserRegistration(request, options): Promise<UserRegistrationResponse>
Completes Registration by sending the signed registration challenge, containing the new Credential identity created.
Parameters
- request: CreateUserRegistrationRequest
- options: DfnsBaseApiOptions
Returns Promise<UserRegistrationResponse>
- Defined in packages/sdk/baseAuthApi.ts:185

`Static` createUserRegistrationChallenge

createUserRegistrationChallenge(request, options): Promise<CreateRegistrationChallengeResponse>
Initiates Registration by creating a challenge that will need to be signed by a new set of Credentials.
Parameters
- request: CreateUserRegistrationChallengeRequest
- options: DfnsBaseApiOptions
Returns Promise<CreateRegistrationChallengeResponse>
- Defined in packages/sdk/baseAuthApi.ts:169

`Static` signUserActionChallenge

signUserActionChallenge(request, options): Promise<UserActionResponse>
Sign a user action challenge
Parameters
- request: SignUserActionChallengeRequest
- options: DfnsBaseApiOptions
Returns Promise<UserActionResponse>
- Defined in packages/sdk/baseAuthApi.ts:107

`Static` userLogout

userLogout(options): Promise<void>
Completes user logout by sending the user auth token.
Parameters
- options: DfnsBaseApiOptions
Returns Promise<void>
- Defined in packages/sdk/baseAuthApi.ts:154

Generated using TypeDoc