Interface SudoUserClient

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

interface SudoUserClient {
    sudoKeyManager: SudoKeyManager;
    clearAuthenticationTokens(): Promise<void>;
    deregister(): Promise<void>;
    getAccessToken(): Promise<undefined | string>;
    getIdToken(): Promise<undefined | string>;
    getLatestAuthToken(): Promise<string>;
    getRefreshToken(): Promise<undefined | string>;
    getRefreshTokenExpiry(): Promise<undefined | Date>;
    getSubject(): Promise<undefined | string>;
    getTokenExpiry(): Promise<undefined | Date>;
    getUserClaim(name): Promise<any>;
    getUserName(): Promise<undefined | string>;
    globalSignOut(): Promise<void>;
    isRegistered(): Promise<boolean>;
    isSignedIn(): Promise<boolean>;
    presentFederatedSignInUI(): void;
    presentSignOutUI(): void;
    processFederatedSignInTokens(url): Promise<AuthenticationTokens>;
    refreshTokens(refreshToken): Promise<AuthenticationTokens>;
    registerWithAuthenticationProvider(authenticationProvider, registrationId?): Promise<string>;
    reset(): Promise<void>;
    resetUserData(): Promise<void>;
    setUserName(name): Promise<void>;
    signInWithAuthenticationProvider(authenticationProvider): Promise<AuthenticationTokens>;
    signInWithKey(): Promise<AuthenticationTokens>;
    signOut(): Promise<void>;
}

Implemented by

Properties

sudoKeyManager

Methods

clearAuthenticationTokens deregister getAccessToken getIdToken getLatestAuthToken getRefreshToken getRefreshTokenExpiry getSubject getTokenExpiry getUserClaim getUserName globalSignOut isRegistered isSignedIn presentFederatedSignInUI presentSignOutUI processFederatedSignInTokens refreshTokens registerWithAuthenticationProvider reset resetUserData setUserName signInWithAuthenticationProvider signInWithKey signOut

Properties

Readonly sudoKeyManager

sudoKeyManager: SudoKeyManager

Getter to retrieve the SudoKeyManager

Methods

clearAuthenticationTokens

  • clearAuthenticationTokens(): Promise<void>

  • Clears cached authentication tokens.

    Returns Promise<void>

deregister

  • deregister(): Promise<void>

  • De-registers the user associated with this client. The user must be signed in.

    Returns Promise<void>

getAccessToken

  • getAccessToken(): Promise<undefined | string>

  • Returns the access token cached from the last sign-in.

    Returns Promise<undefined | string>

    access token.

getIdToken

  • getIdToken(): Promise<undefined | string>

  • Returns the ID token cached from the last sign-in.

    Returns Promise<undefined | string>

    ID token.

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

getRefreshToken

  • getRefreshToken(): Promise<undefined | string>

  • Returns the refresh token cached from the last sign-in.

    Returns Promise<undefined | string>

    refresh token.

getRefreshTokenExpiry

  • getRefreshTokenExpiry(): Promise<undefined | Date>

  • Returns the refresh token expiry cached from the last sign-in.

    Returns Promise<undefined | Date>

    refresh token expiry.

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.

getTokenExpiry

  • getTokenExpiry(): Promise<undefined | Date>

  • Returns the ID and access token expiry cached from the last sign-in.

    Returns Promise<undefined | Date>

    token expiry.

getUserClaim

  • getUserClaim(name): Promise<any>

  • Returns the specified claim associated with the user's identity.

    Parameters

    • name: string

      claim name.

    Returns Promise<any>

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.

globalSignOut

  • globalSignOut(): Promise<void>

  • Signs out the user from all devices.

    Returns Promise<void>

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.

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.

presentFederatedSignInUI

  • presentFederatedSignInUI(): void

  • Presents the sign in UI for federated sign in using an external identity provider.

    Returns void

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

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.

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

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

reset

  • reset(): Promise<void>

  • Resets internal state and clears any cached data.

    Returns Promise<void>

resetUserData

  • resetUserData(): Promise<void>

  • Removes all data owned by the signed-in user in Sudo Platform Services without deregistering the user. Should only be used in tests.

    Returns Promise<void>

setUserName

  • setUserName(name): Promise<void>

  • Sets the user name associated with this client.

    Parameters

    • name: string

      user name.

    Returns Promise<void>

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.

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.

signOut

  • signOut(): Promise<void>

  • Signs out the user from this device.

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

sudoKeyManagerclearAuthenticationTokensderegistergetAccessTokengetIdTokengetLatestAuthTokengetRefreshTokengetRefreshTokenExpirygetSubjectgetTokenExpirygetUserClaimgetUserNameglobalSignOutisRegisteredisSignedInpresentFederatedSignInUIpresentSignOutUIprocessFederatedSignInTokensrefreshTokensregisterWithAuthenticationProviderresetresetUserDatasetUserNamesignInWithAuthenticationProvidersignInWithKeysignOut