Basic

Basic#

The simplest way to authenticate with the AcceleratXR backend is using Basic authentication via the /auth/password REST API endpoint or via one of the Login() functions in CoreSDK. This endpoint supports authentication using an account’s stored password, api key or device.

The below example shows how to authenticate using this method using a user’s unique name and password:

 1CoreSDK->LoginPassword(_XPLATSTR("username"), _XPLATSTR("password"))
 2    .then([](pplx::task<void> task)
 3{
 4   try
 5   {
 6        // Force the exception to be re-thrown if an error occurred.
 7        task.get();
 8   }
 9   catch (const xbe::sdk::Exception& e)
10   {
11       // Handle error here
12   }
13});

A successful authentication request will return a valid access token and cookie, or return without an error when using the SDK. Access tokens are typically valid for one hour before they must be refreshed.

Multi-factor Challenge#

For users that have enabled multi-factor authentication on their account they may be prompted to enter a time-based one-time password (TOTP) code to retrieve the final access token. The system notifies the user of this requirement by returning a CHALLENGE token after the initial request succeeds. The user then must follow up the initial request with a call to the /auth/totp endpoint or by using the CoreSDK.LoginTotp() function in the SDK.

When calling the the TOTP endpoint the challenge token must be provided in addition to the TOTP code as generated by the user’s registered authenticator app or device:

 1CoreSDK->SetTotpChallengeCallback(CoreSDK->CreateTask([]()
 2{
 3    utility::string_t code;
 4    // TODO Prompt user to enter TOTP code
 5    return code;
 6}));
 7
 8CoreSDK->LoginPassword(_XPLATSTR("username"), _XPLATSTR("password"))
 9    .then([](pplx::task<void> task)
10{
11    try
12    {
13        // Force the exception to be re-thrown if an error occurred.
14        task.get();
15    }
16    catch (const xbe::sdk::Exception& e)
17    {
18        // Handle error here
19    }
20});