Class DefaultSudoUserClient

Interface encapsulating a library of functions for calling Sudo Platform identity service, handling federated sign in, managing keys and performing cryptographic operations.

Hierarchy

DefaultSudoUserClient

Implements

SudoUserClient

Constructors

constructor

new DefaultSudoUserClient(options?): DefaultSudoUserClient
Parameters
- Optional options: SudoUserOptions
Returns DefaultSudoUserClient
- Defined in src/user/user-client.ts:62

Accessors

sudoKeyManager

get sudoKeyManager(): SudoKeyManager
Getter to retrieve the SudoKeyManager

Returns SudoKeyManager
Implementation of SudoUserClient.sudoKeyManager
- Defined in src/user/user-client.ts:114

Methods

clearAuthenticationTokens

clearAuthenticationTokens(): Promise<void>
Clears cached authentication tokens.

Returns Promise<void>
Implementation of SudoUserClient.clearAuthenticationTokens
- Defined in src/user/user-client.ts:418

deregister

deregister(): Promise<void>
De-registers the user associated with this client. The user must be signed in.

Returns Promise<void>
Implementation of SudoUserClient.deregister
- Defined in src/user/user-client.ts:412

getAccessToken

getAccessToken(): Promise<undefined | string>
Returns the access token cached from the last sign-in.

Returns Promise<undefined | string>
access token.
Implementation of SudoUserClient.getAccessToken
- Defined in src/user/user-client.ts:152

getIdToken

getIdToken(): Promise<undefined | string>
Returns the ID token cached from the last sign-in.

Returns Promise<undefined | string>
ID token.
Implementation of SudoUserClient.getIdToken
- Defined in src/user/user-client.ts:148

getLatestAuthToken

getLatestAuthToken(): Promise<string>
Retrieves the latest ID token. This is to be used by the AWS AppSync client.

Returns Promise<string>
the latest ID token
Implementation of SudoUserClient.getLatestAuthToken
- Defined in src/user/user-client.ts:243

getRefreshToken

getRefreshToken(): Promise<undefined | string>
Returns the refresh token cached from the last sign-in.

Returns Promise<undefined | string>
refresh token.
Implementation of SudoUserClient.getRefreshToken
- Defined in src/user/user-client.ts:156

getRefreshTokenExpiry

getRefreshTokenExpiry(): Promise<undefined | Date>
Returns the refresh token expiry cached from the last sign-in.

Returns Promise<undefined | Date>
refresh token expiry.
Implementation of SudoUserClient.getRefreshTokenExpiry
- Defined in src/user/user-client.ts:165

getSubject

getSubject(): Promise<undefined | string>
Returns the subject of the user associated with this client. Note: This is an internal method used by other Sudo platform SDKs.

Returns Promise<undefined | string>
user subject.
Implementation of SudoUserClient.getSubject
- Defined in src/user/user-client.ts:195

getTokenExpiry

getTokenExpiry(): Promise<undefined | Date>
Returns the ID and access token expiry cached from the last sign-in.

Returns Promise<undefined | Date>
token expiry.
Implementation of SudoUserClient.getTokenExpiry
- Defined in src/user/user-client.ts:160

getUserClaim

getUserClaim(name): Promise<any>
Returns the specified claim associated with the user's identity.
Parameters
- name: string
  
  claim name.
Returns Promise<any>
Implementation of SudoUserClient.getUserClaim
- Defined in src/user/user-client.ts:189

getUserName

getUserName(): Promise<undefined | string>
Returns the user name associated with this client. The username maybe needed to contact the support team when diagnosing an issue related to a specific user.

Returns Promise<undefined | string>
user name.
Implementation of SudoUserClient.getUserName
- Defined in src/user/user-client.ts:176

globalSignOut

globalSignOut(): Promise<void>
Signs out the user from all devices.

Returns Promise<void>
Implementation of SudoUserClient.globalSignOut
- Defined in src/user/user-client.ts:295

isRegistered

isRegistered(): Promise<boolean>
Indicates whether or not this client is registered with Sudo Platform backend.

Returns Promise<boolean>
true if the client is registered.
Implementation of SudoUserClient.isRegistered
- Defined in src/user/user-client.ts:384

isSignedIn

isSignedIn(): Promise<boolean>
Indicates whether or not this client is signed in with Sudo Platform backend. The client is considered signed in if it cached valid ID, access and refresh tokens.

Returns Promise<boolean>
true if the client is signed in.
Implementation of SudoUserClient.isSignedIn
- Defined in src/user/user-client.ts:199

presentFederatedSignInUI

presentFederatedSignInUI(): void
Presents the sign in UI for federated sign in using an external identity provider.

Returns void
Implementation of SudoUserClient.presentFederatedSignInUI
- Defined in src/user/user-client.ts:118

presentSignOutUI

presentSignOutUI(): void
Presents the Cognito hosted UI signout endpoint. When the endpoint is invoked, the hosted web app's cookies will be invalidated, but the user is not logged out of Cognito.

Returns void
Implementation of SudoUserClient.presentSignOutUI
- Defined in src/user/user-client.ts:431

processFederatedSignInTokens

processFederatedSignInTokens(url): Promise<AuthenticationTokens>
Processes tokens from federated sign in returned to the specified URL. The tokens are passed to the web app via a redirect URL.
Parameters
- url: string
  
  callback URL containing the tokens.
Returns Promise<AuthenticationTokens>
Successful authentication result AuthenticationTokens.
Implementation of SudoUserClient.processFederatedSignInTokens
- Defined in src/user/user-client.ts:128

refreshTokens

refreshTokens(refreshToken): Promise<AuthenticationTokens>
Refresh the access and ID tokens using the refresh token.
Parameters
- refreshToken: string
  
  refresh token used to refresh the access and ID tokens.
Returns Promise<AuthenticationTokens>
Successful authentication result AuthenticationTokens containing refreshed tokens
Implementation of SudoUserClient.refreshTokens
- Defined in src/user/user-client.ts:223

registerWithAuthenticationProvider

registerWithAuthenticationProvider(authenticationProvider, registrationId?): Promise<string>
Registers this client against the backend with an external authentication provider. The caller must implement AuthenticationProvider protocol to return the appropriate authentication token required to authorize the registration request.
Parameters
- authenticationProvider: AuthenticationProvider
  
  authentication provider that provides the authentication token.
- Optional registrationId: string
  
  registration ID to uniquely identify this registration request.
Returns Promise<string>
user ID of the newly created user
Implementation of SudoUserClient.registerWithAuthenticationProvider
- Defined in src/user/user-client.ts:303

reset

reset(): void
Resets internal state and clears any cached data.

Returns void
Implementation of SudoUserClient.reset
- Defined in src/user/user-client.ts:435

resetUserData

resetUserData(): Promise<void>
Removes all data owned by the signed-in user in Sudo Platform Services without deregistering the user

Returns Promise<void>
Implementation of SudoUserClient.resetUserData
- Defined in src/user/user-client.ts:441

setAuthUI

setAuthUI(authUI): void
Provide a custom auth UI. This is mainly used for unit testing (optional).
Parameters
- authUI: AuthUI
Returns void
- Defined in src/user/user-client.ts:542

setAuthenticationStore

setAuthenticationStore(authenticationStore): void
Provide a custom authentication store. This is mainly used for unit testing (optional).
Parameters
- authenticationStore: AuthenticationStore
Returns void
- Defined in src/user/user-client.ts:565

setIdentityProvider

setIdentityProvider(identityProvider): void
Provide a custom identity provider. This is mainly used for unit testing (optional).
Parameters
- identityProvider: IdentityProvider
Returns void
- Defined in src/user/user-client.ts:549

setLaunchUriFn

setLaunchUriFn(launchUriFn): void
Provide a custom function to open the sign in url. This is mainly used for unit testing (optional).
Parameters
- launchUriFn: ((url) => void)
  - - (url): void
    - Parameters
      
      url: string
      
      Returns void
Returns void
- Defined in src/user/user-client.ts:557

setUserName

setUserName(name): Promise<void>
Sets the user name associated with this client.
Parameters
- name: string
  
  user name.
Returns Promise<void>
Implementation of SudoUserClient.setUserName
- Defined in src/user/user-client.ts:184

signInWithAuthenticationProvider

signInWithAuthenticationProvider(authenticationProvider): Promise<AuthenticationTokens>
Sign into the backend using an external authentication provider. Caller must implement AuthenticationProvider interface to return the appropriate authentication token associated with the external identity registered with registerWithAuthenticationProvider.
Parameters
- authenticationProvider: AuthenticationProvider
  
  authentication provider that provides the authentication token.
Returns Promise<AuthenticationTokens>
authentication tokens associated with the successful sign in.
Implementation of SudoUserClient.signInWithAuthenticationProvider
- Defined in src/user/user-client.ts:358

signInWithKey

signInWithKey(): Promise<AuthenticationTokens>
Sign into the backend using a private key. The client must have created a private/public key pair via the registerWithAuthenticationProvider method.

Returns Promise<AuthenticationTokens>
authentication tokens associated with the successful sign in.
Implementation of SudoUserClient.signInWithKey
- Defined in src/user/user-client.ts:393

signOut

signOut(): Promise<void>
Signs out the user from this device.

Returns Promise<void>
Implementation of SudoUserClient.signOut
- Defined in src/user/user-client.ts:277

Class DefaultSudoUserClient

Hierarchy

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Optional options: SudoUserOptions

Returns DefaultSudoUserClient

Accessors

sudoKeyManager

Returns SudoKeyManager

Methods

clearAuthenticationTokens

Returns Promise<void>

deregister

Returns Promise<void>

getAccessToken

Returns Promise<undefined | string>

getIdToken

Returns Promise<undefined | string>

getLatestAuthToken

Returns Promise<string>

getRefreshToken

Returns Promise<undefined | string>

getRefreshTokenExpiry

Returns Promise<undefined | Date>

getSubject

Returns Promise<undefined | string>

getTokenExpiry

Returns Promise<undefined | Date>

getUserClaim

Parameters

name: string

Returns Promise<any>

getUserName

Returns Promise<undefined | string>

globalSignOut

Returns Promise<void>

isRegistered

Returns Promise<boolean>

isSignedIn

Returns Promise<boolean>

presentFederatedSignInUI

Returns void

presentSignOutUI

Returns void

processFederatedSignInTokens

Parameters

url: string

Returns Promise<AuthenticationTokens>

refreshTokens

Parameters

refreshToken: string

Returns Promise<AuthenticationTokens>

registerWithAuthenticationProvider

Parameters

authenticationProvider: AuthenticationProvider

Optional registrationId: string

Returns Promise<string>

reset

Returns void

resetUserData

Returns Promise<void>

setAuthUI

Parameters

authUI: AuthUI

Returns void

setAuthenticationStore

Parameters

authenticationStore: AuthenticationStore

Returns void

setIdentityProvider

Parameters

identityProvider: IdentityProvider

Returns void

setLaunchUriFn

`Optional` options: SudoUserOptions

`Optional` registrationId: string