Class AuthenticationService

Service class for managing authentication related operations.

Hierarchy

ApiService
- AuthenticationService

Index

Methods

getAuthenticationDetails send2faChallenge submit2faAttempt getInstance

Methods

getAuthenticationDetails

getAuthenticationDetails(
brandIdentity: string,
parameters: AuthenticationDetailsParameters,
): AuthenticationDetails
Retrieves the authentication details, which include the url that is used to start the Authorization code flow.

This is the Authorization Endpoint, used as part of the Authorization Code Grant, with the PKCE extension. This endpoint allows clients to securely authenticate into the Paysafe infrastructure by generating an authorization code, which can then be exchanged for an access token. For an enhanced security all clients must use the PKCE extension with the SHA-256 code challenge method.

How Authorization Code Flow works
1. The partner application retrieves the URL for the Paysafe Authentication UI by using this method.
2. The partner application opens the URL in a preferred environment (e.g. browser).
3. The end-user is redirected to the login page (Paysafe Authentication UI).
4. After successful authentication, the end-user is redirected to the partner application with the authorization code as a query parameter.
5. The partner application should use the authorization code to exchange it for an access token.
6. The partner application should invoke Paysafe Web SDK authenticate method with the issued access token.
7. The access token can be used to access the protected resources of the Paysafe API.
Parameters
- brandIdentity: string
  The identity of the partner using the Embedded Wallet.
- parameters: AuthenticationDetailsParameters
  The query parameters for the authorize request.
Returns AuthenticationDetails
The authentication details object, which contains the necessary information for authorization.
Example
```
// Example usage:

const brandIdentity = 'brand-identity';
const parameters = {
  client_id: 'f4db4e70-23fc-49b5-9c16-8792afa45b12',
  code_challenge: 'fnA81erDlIx65spDQ881PwGJkabRAcb2Z1aMUrys721'
  code_challenge_method: CodeChallengeMethod.S256,
  digital_fingerprint: '19e0abfb-590a-4f1f-af9e-bdf48473a123',
  state: 'Utwe',
  reset_credentials_url: 'https://www.paysafe.com/reset-credentials'
  redirect_uri: 'http://www.partner.com/wallet/dashboard'
  locale: 'en-US'
  login_strategy: LoginStrategy.PIN
};

const authenticationDetails: AuthenticationDetails = authenticationService.getAuthenticationDetails(brandIdentity, parameters);
window.location.href = authenticationDetails.authenticationUrl;
```
- Defined in authentication/services/authentication.service.ts:110

send2faChallenge

send2faChallenge(
eventId: string,
request: ScaAuthenticationEventChallengeEmbeddedHybridRequest,
): Promise<ScaAuthenticationEventChallengeEmbeddedHybridResponse>
Sends a 2FA challenge via a secure communication mechanism as part of the ongoing Embedded or Hybrid SCA process.
Parameters
- eventId: string
  A distinct identifier for the SCA authentication event.
- request: ScaAuthenticationEventChallengeEmbeddedHybridRequest
  The SCA authentication event challenge request.
Returns Promise<ScaAuthenticationEventChallengeEmbeddedHybridResponse>
A Promise that resolves to the SCA authentication event challenge response.
Throws
If the HTTP request fails.
Example
```
// Example usage:
authenticationService.send2faChallenge(eventId, request)
 .then((response) => {
   console.log(response);
 })
 .catch((error) => {
   console.error(`Error sending 2FA challenge.`);
 });
```
- Defined in authentication/services/authentication.service.ts:146

submit2faAttempt

submit2faAttempt(
eventId: string,
request: ScaAuthenticationEventAttemptEmbeddedHybridRequest,
): Promise<ScaAuthenticationEventAttemptEmbeddedHybridResponse>
Submits an Embedded or Hybrid authentication attempt for a Two-Factor Authentication (2FA) event.
Parameters
- eventId: string
  A distinct identifier for the SCA authentication event.
- request: ScaAuthenticationEventAttemptEmbeddedHybridRequest
  The SCA authentication event attempt request.
Returns Promise<ScaAuthenticationEventAttemptEmbeddedHybridResponse>
A Promise that resolves to the SCA authentication event attempt response.
Throws
If the HTTP request fails.
Example
```
// Example usage:
authenticationService.submit2faAttempt(eventId, request)
 .then((response) => {
   console.log(response);
 })
 .catch((error) => {
   console.error(`Error submitting 2FA attempt.`);
 });
```
- Defined in authentication/services/authentication.service.ts:186

`Static`getInstance

getInstance(): AuthenticationService
Function
Retrieves the singleton instance of the AuthenticationService class.

Returns AuthenticationService
The singleton instance of the AuthenticationService class.
Static
Example
```
// Usage:
const authenticationService = AuthenticationService.getInstance();
```
- Defined in authentication/services/authentication.service.ts:56

Class AuthenticationService

Hierarchy

Index

Methods

Methods

getAuthenticationDetails

How Authorization Code Flow works

Parameters

Returns AuthenticationDetails

Example

send2faChallenge

Parameters

Returns Promise<ScaAuthenticationEventChallengeEmbeddedHybridResponse>

Throws

Example

submit2faAttempt

Parameters

Returns Promise<ScaAuthenticationEventAttemptEmbeddedHybridResponse>

Throws

Example

`Static`getInstance

Returns AuthenticationService

Static

Example

Settings

On This Page

Class AuthenticationService

Hierarchy

Index

Methods

Methods

getAuthenticationDetails

How Authorization Code Flow works

Parameters

Returns AuthenticationDetails

Example

send2faChallenge

Parameters

Returns Promise<ScaAuthenticationEventChallengeEmbeddedHybridResponse>

Throws

Example

submit2faAttempt

Parameters

Returns Promise<ScaAuthenticationEventAttemptEmbeddedHybridResponse>

Throws

Example

StaticgetInstance

Returns AuthenticationService

Static

Example

Settings

On This Page

`Static`getInstance