Authenticating Users

The examples below apply to versions 2.x.x. If you’re using version 3, use the SequenceEmbeddedWalletBP (Blueprints) and SequenceEmbeddedWallet (C++) classes instead.

Requirements

Make sure you have enabled your required login methods on Sequence Builder
Visit our Platform Requirements page for detailed information on setting up and ensuring that the authentication methods you choose are properly configured in your Unreal project.

Sign in users with any email, and they will receive a one-time password in their inbox. Listen for the Email Requires Code event.

Blueprint
C++

const TFunction<void()> OnApiSuccess = [] { };
const FFailureCallback OnApiFailure = [](const FSequenceError& Error) { };

USequenceSessions* Sessions = NewObject<USequenceSessions>();
Sessions->StartEmailLogin(Email, OnApiSuccess, OnApiFailure);

Sign in users with any email, and they will receive a one-time password in their inbox. Listen for the Email Requires Code event.

Blueprint
C++

const FString Code = "123456";

const TFunction<void()> OnApiSuccess = [] { };
const FFailureCallback OnApiFailure = [](const FSequenceError& Error) { };
const TFunction<void(FFederationSupportData)> OnApiFederationRequired = [this](const FFederationSupportData& FederationData) { };

USequenceSessions* Sessions = NewObject<USequenceSessions>();
Sessions->ConfirmEmailLoginWithCode(Code, OnApiSuccess, OnApiFailure, OnApiFederationRequired);

You can sign in users as guests. However, note that they will lose access to their wallet if they uninstall the app or sign out. Leverage our account federation feature to link the wallet to another email or social account to keep access.

Blueprint
C++

const TFunction<void()> OnApiSuccess = [] { };
const FFailureCallback OnApiFailure = [](const FSequenceError& Error) { };

USequenceSessions* Sessions = NewObject<USequenceSessions>();
Sessions->StartGuestSession(OnApiSuccess, OnApiFailure);

To initiate SSO-based authentication on desktop, you need to navigate to a browser to obtain the necessary id_token. On mobile, our SDK handles this process for you using integrated plugins. On desktop platforms, listen for the Sign in Web View Required event and open the returned Sign In URL. On mobile platforms, listen for the Id Token Received event. When you call the Sign In functions, listen for the Session Established event on the SequenceSessionsBP subsystem to know when the sign in request was successful. Listen for Session Creation Failure when something went wrong.

Get Google Id Token

Blueprint
C++

USequenceSessions* Sessions = NewObject<USequenceSessions>();
if (Sessions->IsBrowserRequired)
    const FString Url = this->Sessions->GetGoogleSignInUrl();
else
    Sessions->GetGoogleTokenId(this);

Get Apple Id Token

Blueprint
C++

USequenceSessions* Sessions = NewObject<USequenceSessions>();
if (Sessions->IsBrowserRequired)
    const FString Url = this->Sessions->GetAppleSignInUrl();
else
    Sessions->GetAppleTokenId(this);

Blueprint
C++

const FString IdToken = "ey1234";

const TFunction<void()> OnApiSuccess = []() { };
const FFailureCallback OnApiFailure = [](const FSequenceError& Error) { };
const TFunction<void(FFederationSupportData)> OnApiFederationRequired = [](const FFederationSupportData& FederationData) { };

USequenceSessions* Sessions = NewObject<USequenceSessions>();
Sessions->StartOidcSession(IdToken, OnApiSuccess, OnApiFailure, OnApiFederationRequired);

Blueprint
C++

const FString IdToken = "ey1234";

const TFunction<void()> OnApiSuccess = []() { };
const FFailureCallback OnApiFailure = [](const FSequenceError& Error) { };
const TFunction<void(FFederationSupportData)> OnApiFederationRequired = [](const FFederationSupportData& FederationData) { };

USequenceSessions* Sessions = NewObject<USequenceSessions>();
Sessions->StartOidcSession(IdToken, OnApiSuccess, OnApiFailure, OnApiFederationRequired);

Blueprint
C++

const FString IdToken = "ey1234";

const TFunction<void()> OnApiSuccess = []() { };
const FFailureCallback OnApiFailure = [](const FSequenceError& Error) { };
const TFunction<void(FFederationSupportData)> OnApiFederationRequired = [](const FFederationSupportData& FederationData) { };

USequenceSessions* Sessions = NewObject<USequenceSessions>();
Sessions->StartOidcSession(IdToken, OnApiSuccess, OnApiFailure, OnApiFederationRequired);

Start Session with OIDC Id Token

Use this method to start a session using a valid Id token from Google, Apple or Epic Games.

Blueprint
C++

const FString IdToken = "ey1234";

const TFunction<void()> OnApiSuccess = []() { };
const FFailureCallback OnApiFailure = [](const FSequenceError& Error) { };
const TFunction<void(FFederationSupportData)> OnApiFederationRequired = [](const FFederationSupportData& FederationData) { };

USequenceSessions* Sessions = NewObject<USequenceSessions>();
Sessions->StartOidcSession(IdToken, OnApiSuccess, OnApiFailure, OnApiFederationRequired);

PlayFab

You will need to include your PlayFab Title ID in the SequenceConfig.ini file during Configuration and configure PlayFab in the Builder.

PlayFab Registration

Blueprint
C++

const TFunction<void()> OnApiSuccess = [this, OnSuccess]() { };
const FFailureCallback OnApiFailure = [this, OnFailure](const FSequenceError& Error) { };
const TFunction<void (FFederationSupportData)> OnApiFederationRequired = [this](const FFederationSupportData& FederationData) { };

USequenceSessions* Sessions = NewObject<USequenceSessions>();
Sessions->PlayFabRegistration(UsernameIn, EmailIn, PasswordIn, OnApiSuccess, OnApiFailure, OnApiFederationRequired);

Blueprint
C++

const TFunction<void()> OnApiSuccess = [this, OnSuccess]() { };
const FFailureCallback OnApiFailure = [this, OnFailure](const FSequenceError& Error) { };
const TFunction<void (FFederationSupportData)> OnApiFederationRequired = [this](const FFederationSupportData& FederationData) { };

USequenceSessions* Sessions = NewObject<USequenceSessions>();
Sessions->PlayFabLogin(UsernameIn, PasswordIn, OnApiSuccess, OnApiFailure, OnApiFederationRequired);

PlayFab Authenticate with Session Ticket

Blueprint
C++

const TFunction<void()> OnApiSuccess = [this, OnSuccess]() { };
const FFailureCallback OnApiFailure = [this, OnFailure](const FSequenceError& Error) { };
const TFunction<void (FFederationSupportData)> OnApiFederationRequired = [this](const FFederationSupportData& FederationData) { };

USequenceSessions* Sessions = NewObject<USequenceSessions>();
Sessions->PlayFabAuthenticateWithSessionTicket(SessionTicket, OnApiSuccess, OnApiFailure, OnApiFederationRequired);

Account Federation

To link another account to your wallet, simply re-use the same authentication methods. The SDK will check if there’s an existing session stored and will automatically attempt to link that account.

Web SDKs

Game Engine SDKs

Mobile

Other SDKs

Requirements

Get Google Id Token

Get Apple Id Token

Start Session with OIDC Id Token

PlayFab

PlayFab Registration

PlayFab Authenticate with Session Ticket

Account Federation

​Requirements

​Start Email Login

​Confirm Email Login with Code

​Sign In as a Guest

​Social Sign In

​Get Google Id Token

​Get Apple Id Token

​Sign In with Google

​Sign In with Apple

​Sign In with Epic

​Start Session with OIDC Id Token

​PlayFab

​PlayFab Registration

​PlayFab Login

​PlayFab Authenticate with Session Ticket

​Account Federation

Requirements

Start Email Login

Confirm Email Login with Code

Sign In as a Guest

Social Sign In

Get Google Id Token

Get Apple Id Token

Sign In with Google

Sign In with Apple

Sign In with Epic

Start Session with OIDC Id Token

PlayFab

PlayFab Registration

PlayFab Login

PlayFab Authenticate with Session Ticket

Account Federation