Last Updated: 6/20/2022, 9:59:43 AM

# 3rd Party Login Integration

# Overview

AccelByte provides 3rd Party Login Integration and Single Sign-On (SSO), to enable players to log into your game or platform with a credential from a 3rd party. When a player uses 3rd party credentials to sign into your game or platform for the first time without first creating an account, a headless account (an account without an email address) will be created for that player. You can offer players the option to upgrade their headless account to a full account in your game or on your platform. Players need to provide an email address and date of birth to create full login credentials.

After players create a headed account, they can then link their accounts from other 3rd party platforms to it. This enables cross-progression, or the ability for players to access their game data and continue play from different platforms.

# Supported Platforms

Here’s a table showing the platforms we support, and the features they offer:

3rd Party Login In-App Purchases Entitlements Device ID Y N N Apple Y Y AWS Cognito Y N N Epic Online Services Y Y Y Facebook Y N N Google* Y Y N Microsoft Azure* Y N N Nintendo Y Y Y PlayStation 4 + 5 Y Y Y Stadia Y Y Y Steam Y Y Y Twitch Y Y Y Xbox Live Y Y Y OpenID Connect Y N N

Device ID*

Device ID can refer to a computer’s serial number, the IMEI of a mobile device, or some other unique identifier. Device ID can be used both for testing and as an easy way for players to log into mobile games without an account.

3rd Party Login

**3rd party login using Google and Microsoft Azure credentials is only for the Admin Portal. It’s intended to give teams that already have Microsoft accounts a quick way to access the Admin Portal without having to first have an account created for them.

# Prerequisites

Before implementing 3rd Party Login, make sure you’ve set up the following items:

# Permissions

Permissions are used to grant access to specific resources within our services. Make sure your account has the following permissions before you attempt to integrate 3rd Party Login in the Admin Portal. For a full list of permissions that impact identity access management, see the IAM tab of the permissions reference.

Usage Permission Tag Action
Add SSO Platform Credential ADMIN:NAMESPACE:{namespace}:PLATFORM:{platformId}:SSO Create
Add Third Party Platform Credential ADMIN:NAMESPACE:{namespace}:PLATFORM:{platformId}:CLIENT Create

Permissions work slightly differently depending on whether they are assigned to IAM Clients or Roles assigned to users. For more information, read the Authentication and Authorization documentation.

# Enabling Login with 3rd Party Platforms in the Admin Portal

Enabling 3rd party login consists of configuring login from your chosen platform in the Admin Portal, then using our SDK to retrieve the Auth token for that platform and log players in with their 3rd party credentials.

3rd party login can either be configured in a game namespace, or in the publisher namespace. When you configure login from a 3rd party platform within a game namespace, only that game will be accessible using the credentials from the configured platform.

Follow the steps below to set up the Third-party Store configuration in the Admin Portal.

  1. First make sure you are in the namespace you want to configure. Go to the User Management section of the main menu and select Login Methods.

    3rd-party-integration

  2. On the Login Methods page, click the Add New button.

    3rd-party-integration

  3. On the Login Platform Configuration page, select the platform you want to configure.

    3rd-party-integration

  4. The Create Configuration form will appear. Fill in the required fields below:

    # Device ID

    3rd-party-integration

    • In the Redirect URL field, input the URL where the user will be directed once the account authorization is successful. The default URL is http://127.0.0.1.

    # Apple

    IMPORTANT

    Currently we only support 3rd party login integration for your website or web platform using these credentials. In-game login is not yet supported.

    3rd-party-integration

    • Input the Client ID that you set in the Apple Developer Portal for your game in the Client ID field.
    • Input the Client Secret that you set in the Apple Developer Portal for your game in the Secret field.
    • Input the URL where the user will be directed once the account authorization is successful in the Redirect URL field. The Redirect URL should direct the player back to your server after they successfully log in.
    • Input the Team ID that you set in the Apple Developer Portal for your game in the Team ID field.
    • Input the Key ID that you set in the Apple Developer Portal for your game in the Key ID field.

    # AWS Cognito

    3rd-party-integration

    • Input the User Pool ID that you created in the AWS Cognito console for your game in the User Pool ID field.
    • Input the desired AWS Cognito Region code in the Region field, e.g., us-west-1.

    # Epic Online Services

    3rd-party-integration

    • Input the App ID that you've set in the Epic Developer Portal for your game in the App ID field.
    • Input the Client ID that you set in the Epic Developer Portal for your game in the Client ID field.
    • Input the Client Secret that you set in the Epic Developer Portal for your game in the Secret field.
    • Input the URL where the user will be directed once the account authorization is successful in the Redirect URL field. The default URL for EOS is http://127.0.0.1.

    # Facebook

    IMPORTANT

    Currently we only support 3rd party login integration for your website or web platform using these credentials. In-game login is not yet supported.

    3rd-party-integration

    • Input the App ID that you set in the Facebook Developer Portal for your game in the App ID field.
    • Input the App ID that you set in the Facebook Developer Portal for your app in the Client ID field.
    • Input the Client Secret that you set in the Facebook Developer Portal for your game in the Secret field.
    • Input the URL where the user will be directed once the account authorization is successful in the Redirect URL field. The default URL for Facebook is {baseURL}/iam/v3/platforms/facebook/authenticate.

    NOTE

    To complete the setup, you’ll also have to configure the Redirect URL in the Facebook Developer Portal.

    # Google

    IMPORTANT

    Currently we only support 3rd party login integration for your website or web platform using these credentials. In-game login is not yet supported.

    3rd-party-integration

    • Input the Client ID from your Google OAuth Client Google Developer Console (opens new window) account in the Client ID field.
    • Input the Secret from your Google OAuth Client Google Developer Console account in the Secret field.
    • Input the URL where the user will be directed once the account authorization is successful in the Redirect URL field. The Redirect URL should direct the player back to your server after they successfully log in.

    # Microsoft Azure

    IMPORTANT

    In addition to the steps below, there are some tasks that must be performed in the Azure Portal to enable 3rd party login using Microsoft Azure. Please contact AccelByte if you need assistance.

    3rd-party-integration

    • Input the Entity ID from your Basic SAML Configuration in the App ID field.
    • Input the Reply URL from your Basic SAML Configuration in the ACS URL field.
    • Input the App Federation Metadata URL from the SAML Signing Certificate in the Federation Metadata URL field.

    # Nintendo

    3rd-party-integration

    • Input the Application ID for your application in the App ID field. You can find your Application ID in your product information in the Nintendo Developer Portal.
    • In the Redirect URL field, input http://127.0.0.1 for in-game login. Otherwise enter the desired destination on your website.

    # PSN Web Login

    3rd-party-integration

    • Input the Client ID for your game in the PlayStation App Server in the App ID field.

    • Input the Client ID for your game in the PlayStation App Server in the Client ID field.

    • Input the Client Secret for your game in the PlayStation App Server in the Secret field.

    • Select your environment type in the Environment field. You can choose from the below options:

      Environment
      Environment Purpose
      sp-int Development
      prod-qa QA
      np Live Environment
    • Input the URL where the user will be directed once the account authorization is successful in the Redirect URL field. For PS4, the default URL is orbis://games.

    # PS4 SDK Login

    3rd-party-integration

    • Input the Client ID for your game in the PlayStation App Server in the App ID field.

    • Input the Client Secret for your game in the PlayStation App Server in the Secret field.

    • Select your environment type in the Environment field. You can choose from the below options:

      Environment
      Environment Purpose
      sp-int Development
      prod-qa QA
      np Live Environment
    • Input the URL where the user will be directed once the account authorization is successful in the Redirect URL field. For PS4, the default URL is orbis://games.

    # PS5 SDK Login

    3rd-party-integration

    • Input the Client ID for your game in the PlayStation App Server in the App ID field.

    • Input the Client Secret for your game in the PlayStation App Server in the Secret field.

    • Select your environment type in the Environment field. You can choose from the below options:

      Environment
      Environment Purpose
      sp-int Development
      prod-qa QA
      np Live Environment
    • Input the URL where the user will be directed once the account authorization is successful in the Redirect URL field. For PS5, the default URL is orbis://games.

    # Stadia ID

    3rd-party-integration

    • Input your game’s Stadia Account ID in the Client ID field.
    • Input your game’s secret in the Secret field.
    • Input the URL where the user will be directed once the account authorization is successful in the Redirect URL field. For Stadia, the default URL is http://127.0.0.1.

    # Steam Web Login

    3rd-party-integration

    • Input your Publisher Web API Key in the Steam Web API Key field.
    • Input the URL where the user will be directed once the account authorization is successful in the Redirect URL field. The default URL for Steam is http://127.0.0.1.

    # Steam SDK Login

    3rd-party-integration

    • Input Steam’s App ID for your game in the App ID field. For testing purposes, you can also input 480 which is the ID for Steam’s test game.
    • Input your Publisher Web API Key in the Steam Web API Key field.
    • Input the URL where the user will be directed once the account authorization is successful in the Redirect URL field. For in-game login, use the default URL which is http://127.0.0.1.

    # Twitch

    3rd-party-integration

    • Input the Client ID in the Client ID field.
    • Input the Client Secret in the Secret field.
    • Input the URL where the user will be directed once the account authorization is successful in the Redirect URL field. The Redirect URL should direct the player back to your server after they successfully log in.

    # Xbox SDK Login

    3rd-party-integration

    # Xbox Web Login

    3rd-party-integration

    • Input the Client ID in the Client ID field.
    • Input the Client Secret in the Secret field.
    • Input the URL where the user will be directed once the account authorization is successful in the Redirect URL field. The Redirect URL should direct the player back to your server after they successfully log in.

    # OpenID Connect

    1. Fill the Platform Identity Provider form with the following information:

      3rd-party-integration

      • Input the third-party platform name in the Platform Name field.
      • Input the platform identity provider of your selected third-party platform in the Platform ID field .
      • Input the third-party JWKS in the JWKS URL field.
      • Input the authorization server's issuer identifier in the Issuer field. This identifier is an URL that uses the https scheme and has no query or fragment components.
      • Input your Client ID of your selected platform in the Client ID field.

      NOTE

      The way in which you obtain your Client ID will differ across providers. Please check your provider's documentation for more information.

      Once completed, click Next.

    2. Fill the Token Claims Mapping form with the following information:

      3rd-party-integration

      • Input the name of the ID Token Claim’s field that contains the user’s name in the Field Name in ID Token field.
      • Input the email of the ID Token Claim’s field that contains the user’s email in the Field Email in ID Token field.
      • Input the profile picture URL of the ID Token Claim’s field that contains the user’s profile picture URL in the Field Profile Picture URL in ID Token field

      TIP

      For more information on token claims, see OpenID’s documentation (opens new window) page.

      Once completed, click Create.

# SSO Configurations

Single Sign-On (SSO) enables players to log in with a single credential to access several independent services. To enable SSO we use Discourse, which is an open-source discussion platform that can be used as a mailing list.

# Create a New Discourse Configuration

  1. Go to the Admin Portal, and click on the SSO Configurations menu.

    3rd-party-integration

  2. Click the Configure Now button to add a new configuration.

    3rd-party-integration

  3. The Add Discourse Configuration appears. Fill in the required information:

    3rd-party-integration

    • Input the URL to which players will be redirected in the SSO URL field.
    • Input the Secret Key from Discourse in the Secret Key field.
    • Input the API Key from Discourse in the API Key field
  4. When you’re done, click Submit.

  5. After creating the configuration, it will be accessible from the Discourse SSO Configuration panel on the SSO Configurations page.

    3rd-party-integration

# Registering a Google Domain in the Admin Portal

To enable SSO with Google credentials in the Admin Portal, you must first register the Google domain members of your institution will use to access the Admin Portal. You can also associate Roles and IAM Clients with a domain, allowing you to control what users under that domain can access. Multiple domains can be registered and configured independently.

NOTE

You can only register a Google domain from the publisher namespace.

  1. In the publisher namespace of the Admin Portal, click Login Methods. On the Login Platform Configuration page, click Google, scroll to the Domain section, and click the Register Domain button.

    3rd-party-integration

  2. The Register Domain form appears. Fill in the fields with the following information:

    • Enter the target Google domain in the Domain Name field.
    • Select any IAM Client you want users from that domain to be able to access from the Clients dropdown. You can choose more than one client.
    • Select the default role for users from that domain from the Default Role dropdown.

    3rd-party-integration

  3. When you’re done, click Save.

    3rd-party-integration

# Enabling Login with 3rd Party Platform Credentials Using the SDK

For a player to log into your game or platform with 3rd party credentials, the game needs to pass the Auth token from the 3rd party platform whose credentials the player is using to the publisher platform.

# Retrieve the Authentication Token Using the SDK

# Device ID

The Device ID Auth token is whatever is retrieved by either Unity or Unreal Engine. To retrieve the Device ID Auth token, use the following function:

# AWS

For Unity, you can get the Auth token by using the AWS SDK for .NET. For Unreal Engine you can use the AWS C++ SDK. Here is an example of how to get an AWS Cognito Auth token:

You can also get an Auth token by making a HTTP Request, as seen in the example below.

For more details about setting up platform authentication, refer to the AWS documentation.

# Epic Online Service (EOS)

For Unity, you can get the Auth token for EOS by using the EOS SDK. For Unreal Engine you can use the EOS C# SDK. Here are the functions to retrieve the EOS Auth token:

# Nintendo

You can enable login with Nintendo credentials by using the Unreal Engine OSS. For now, only Unreal Engine is supported.

Unreal Engine (with OSS)

Prerequisites:

  • You must have the Nintendo Dev Kit for deployment.
  • You must have downloaded and set up Nintendo Online Subsystem into your Unreal Engine environment.

Configuration steps:

3rd-party-integration

  1. In BaseSwitchEngine.ini under Engine/Platforms/Switch/Config, set StartupAccountMode to Required
  2. You can now call Nintendo login using the OSS by with IOnlineSubsystem::Get()->GetIdentityInterface()->Login().

# Netflix

Use the following function to retrieve the Netflix GamerAccessToken:

# PS4

IMPORTANT

This configuration can only be used for PS4 games, not PS4 Cross-Gen games. For PS4 Cross-Gen games, use PS5 as the platform.

For Unity, you can get the Auth code by using NpToolkit. For Unreal Engine, you can use OnlineSubsystemPS4 which is already included in Unreal Engine.

# PS5

For PS5, you can get the Auth code by using the function below. For now, only Unreal Engine is supported.

# Stadia

For Stadia, you can get the Auth code by requesting a user's JWT token, or you can use the Stadia Platform Support package. For now, only Unity is supported.

# Steam

To get the Steam Auth ticket in Unity, use the tickets obtained from Steamworks.NET. For Unreal Engine, use the ticket obtained from Steamworks.

# Twitch

For Twitch, you can get the Authentication token by using the function below:

# Xbox

For Xbox, you can get the Auth token by using the function below:

  • In addition to distributing your game on 3rd party platforms, you can build your own platform with our Player Portal services.
  • Learn more about managing accounts in the User Accounts documentation.
  • In addition to login, AccelByte also offers Entitlement and In-App Purchase integration with several platforms.