Access
Connect cross-platform accounts & identity management
User Accounts allow people to access your platform. This includes not only your players, but also everyone at your organization who has access to the Admin Portal.
There are two types of users: Admin and non-Admin. Admin users are allowed to access the Admin Portal, so this includes your colleagues at your organization. Non-Admin users, on the other hand, cannot access the Admin Portal. Non-Admin users are players. Player accounts can be managed by Admin users in the Admin Portal.
Permissions are used to grant access to specific resources within our services. Here are some of the basic permissions you’ll need to work with accounts, but there are many other aspects of account management. For a full list of permissions that impact account management, see the IAM tab of the permissions reference
Usage | Resource | Action |
---|---|---|
Find/Update/Delete a User | NAMESPACE:{namespace}:USER | Read/Update/Delete |
Invite a Player/Admin User | ADMIN:NAMESPACE:{namespace}:USER:INVITE | CREATE |
Get User by ID | NAMESPACE:{namespace}:USER:{userId} | Read |
Get User’s Information | NAMESPACE:{namespace}:USER:{userId}:INFORMATION | Read |
Reset User’s Password | ADMIN:NAMESPACE:{namespace}:USER:PASSWORD | Update |
Get User’s Login Histories | ADMIN:NAMESPACE:{namespace}:USER:{userId}:HISTORY:LOGIN | Read |
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.
With AccelByte Cloud’s IAM Input Validation service, you can customize how players register and log into your game. IAM input validation allows you to set the parameters of your players’ usernames, display names, passwords, and the emails used to sign up to your games.
When your players first set up an account, they will choose their username. Follow the steps below to learn how to customize username parameters for your game namespace.
In your desired game namespace, click on Platform Configurations in the top right-hand corner, and select IAM Input Validation.
On the IAM Input Validation page, you can select between Username, Display Name, Password, or Email Address. Select Username and fill in the following required Validation fields:
The Localization Description section is used to inform your players of your username requirements. Your namespace’s default language will appear automatically.
When you are finished, click Save at the bottom of the page to save and activate your configuration.
When your players first set up an account, they will choose their display name. Follow the steps below to learn how to customize display name parameters for your game namespace.
In your desired game namespace, click on Platform Configurations in the top right-hand corner, and select IAM Input Validation.
On the IAM Input Validation page, select or scroll down to Display Name and fill in the following required Validation fields:
NOTE
If Allow Unicode Character is set to Inactive, players who make accounts via 3rd parties and have a Unicode character in their 3rd party display name will receive an error. To avoid this, set Allow Unicode Character to Active.
The Localization Description section is used to inform your players of your display name requirements. Your namespace’s default language will appear automatically.
When you are finished, click Save at the bottom of the page to save and activate your configuration.
When your players first set up an account, they will choose their password. Follow the steps below to learn how to customize password parameters for your game namespace.
In your desired game namespace, click on Platform Configurations in the top right-hand corner, and select IAM Input Validation.
On the IAM Input Validation page, select or scroll down to Password and fill in the following required Validation fields:
The Localization Description section is used to inform your players of your display name requirements. Your namespace’s default language will appear automatically.
When you are finished, click Save at the bottom of the page to save and activate your configuration.
When your players first set up an account, they need to choose an email to associate with their account. Follow the steps below to learn how to customize the emails you allow to be used in your game.
In your desired game namespace, click on Platform Configurations in the top right-hand corner, and select IAM Input Validation.
On the IAM Input Validation page, select or scroll down to Email Address and fill in the following required Validation fields:
In the Banned Words section, you can add words, phrases, character combinations, or domains that you want to reject from being able to create an account with your game. This can be used to bulk deny email addresses from known fake domains or using other criteria.
The Localization Description section is used to inform your players of your display name requirements. Your namespace’s default language will appear automatically.
When you are finished, click Save at the bottom of the page to save and activate your configuration.
In the desired namespace of the Admin Portal, expand the Users Management section and click Users.
Select the search filter from the dropdown menu in the Search User panel that corresponds to the user’s account information that you have on hand.
Then, type the user’s credential into the text box and press Enter to search. The search results will appear.
If you choose to search for a player using a 3rd Party Platform credential, two new dropdown menus will appear. From the first dropdown menu, select the 3rd party platform your player comes from, just as Steam or Epic Games. In the second dropdown menu select either Platform Display Name or Platform User ID, depending on which credential you have.
You can also quickly invite your colleagues to create player accounts from the Admin Portal. This can be useful for play testing purposes. To invite your team to create player accounts for your game, follow the steps below:
In the desired namespace of the Admin Portal, expand the Users Management section and click Users.
Click the Invite User button in the top-right corner of the page.
The Invite User form appears. Input the users’ email address that you want to invite. You can invite more than one user at once by pressing Enter, Tab, or Comma on your keyboard to separate each email address.
When you’re finished, click the Invite button. Invitations will be sent to the email addresses you provided.
IMPORTANT
The invitation email is only valid for 60 minutes. If the invited user does not complete account registration within 60 minutes of receiving the email, you’ll need to send them a new invitation.
You can also quickly invite your colleagues or community managers from your game to the Admin Portal. To do so, follow the steps below:
In the Admin Portal, open the Platform Configurations menu in the top-right corner of the page and click Admins.
On the Admin page, click the Invite Admin button.
The Invite Admin form appears. Fill in the fields with the following information:
In the Assigner Email field, enter the email address for each person that you wish to give admin access to. You can invite more than one user at once by pressing Enter, Tab, or Comma on your keyboard to separate each email address.
In the Roles field, choose the roles that you want the new admins to have.
NOTE
You can also add other roles to the user later by following the steps in the Roles documentation.
The Namespace field appears after you select your roles. In the Namespace field, select the checkbox next to each namespace you want the new admins to have access to.
NOTE
The Namespace field won’t appear if you chose a global role in the previous step, because global roles can access all namespaces.
When you’re finished, click the Invite button. Invitations will be sent to the email addresses you provided.
IMPORTANT
The invitation email is only valid for 60 minutes. If the invited admin user does not complete account registration within 60 minutes of receiving the email, you’ll need to send them a new invitation.
You can follow the procedure below to change any user’s email address, including your own:
In the Admin Portal, expand the Users Management section and click Users.
Select the search filter from the dropdown menu in the Search User panel that corresponds to the player’s account information that you have on hand. Then type that information in the text box and press Enter to search.
TIP
Fuzzy search is allowed here, so you can find the player you’re looking for by typing just the first few characters of the player’s credential that you have.
The results of your search will appear. Browse the list to find the account you’re looking for and click View in the Action column of the account listing to open it.
The User Overview will appear, giving you a quick look at the user’s account data. Click Change under the user’s email address to change it.
To change a user’s email address, first you’ll need to verify your identity. In the Change User’s Email confirmation box that appears, click the Send Verification Code button to send a verification code to the email address with which you’re logged into the Admin Portal.
The Change User’s Email confirmation box changes to show two forms. Enter the verification code that was sent to your email address in the Verify your identity field, and enter a new email address for the user in the Set new email address for the user field. Once you’re done, click the Confirm button.
You’ll be redirected back to the User Overview page. The user will be sent a verification message to their old email address.
After the user confirms the update, their email address will be changed automatically.
The User Event Log shows you the history of any changes or actions made by a user, such as when a user logged into the portal or downloaded their personal data. You will only be able to see events from namespaces for which you have permission to view users’ login histories.
In the desired namespace of the Admin Portal, expand the Users Management section and click Users.
Select the search filter from the dropdown menu in the Search User panel that corresponds to the player’s account information that you have on hand. Then type that information in the text box and press Enter to search.
TIP
Fuzzy search is allowed here, so you can find the player you’re looking for by typing just the first few characters of the player’s credential that you have.
The results of your search will appear. Browse the list to find the account you’re looking for and click View in the Action column of the account listing to open it.
The User Overview will appear, giving you a quick look at the user’s account data. Click the Log tab.
On the Logs tab, you will see a list of user logs, the namespace they belong to, and the time each log was created. You can sort the logs by creation time and or namespace to help you find a particular log.
To open a log, click View in that log’s Action column.
The Event Log Details window appears. Here you can see the log’s contents.
The account history feature allows you to see changes made to account data by users. The information available includes changes made to a user’s Display Name, Email Address, Password, or Date of Birth.
In the desired namespace of the Admin Portal, expand the Users Management section and click Users.
Search for the user whose edit history you want to view.
The results of your search will appear. Browse the list to find the account you’re looking for and click View in the Action column of the account listing to open it.
The User Overview will appear, giving you a quick look at the user’s account data. Click View Account History to get their edit history.
You can choose to see the history based on the Display Name, Email Address, or Password. Select the desired field name from the list on the left side of the Account History page.
Input the Start and End Date of the time period for which you want to retrieve the history.
NOTE
See our Cloud Season Pass (opens new window) documentation to find out how to advance a user’s experience in the Admin Portal.
On the Season Pass Details section of the User page, click View History beside the Total Exp.
The Exp Acquisition History page will appear. Here, you can view the advancement history of the selected user.
Use the following procedure to link third party accounts.
Every player who registers to AccelByte Cloud is given a user publisher unique identifier regardless of how they registered. Headless accounts are also given user publisher unique identifiers in case they later want to upgrade to a full AccelByte account.
There are several ways of linking an AccelByte account with a 3rd-party account.
Players can link a 3rd-party account through the AccelByte Cloud Portal with either a new or existing AccelByte account.
Accounts can also be linked if a player requests a manual link after they have logged in. This method will still follow the standard login flow and will check whether the 3rd-party account in question is already linked to another AccelByte account. The linking request will be rejected if the 3rd-party account is already linked to an existing AccelByte account as we do not allow force linking.
Players can link a 3rd-party account through your game directly. This can be done with a new or existing AccelByte account, or through a headless account (created automatically when a player links their 3rd-party account).
For new or existing accounts, the linking flow is the same as Web linking above. The flow for headless accounts is as follows:
Clients can customize how the in-game login flow operates; you can force the player to upgrade their headless account to an AccelByte account when they link their 3rd-party account, or you can allow players to play without upgrading.
NOTE
Due to progression and 3rd-party regulations, players are unable to link more than one 3rd-party account from a specific 3rd-party, i.e., a player can only link one Steam account to their AccelByte account. This rule is true even if players unlink their previous Steam account before attempting to link a new one.
Use the following procedure to link 3rd-party accounts.
In the Admin Portal, select Users under the Users Management section.
Search for the player whose account you want to link.
Once you have found the desired account, select View in the Action column of the account listing to open it.
The User Overview page will appear with an overview of the player’s account data. Select the Linked Accounts tab.
On the Linked Accounts tab, click the Link an Account button.
The Link an Account popup will appear. Fill in the following information:
Once completed, click Link.
A confirmation message will appear. Check the information you have entered is correct and click Confirm to proceed.
The new linked account will be added to the Linked Accounts list.
In the Admin Portal, select Users under the Users Management section.
Search for the player whose account you want to unlink.
Once you have found the desired account, select View in the Action column of the account listing to open it.
The User Overview page will appear with an overview of the player’s account data. Select the Linked Accounts tab.
On the Linked Accounts tab, select the 3rd-party account you want to unlink and click Unlink under the Action column.
A Delete Item popup will appear. Click Unlink to proceed.
The selected 3rd-party account will be removed from the list.
This function allows your players to register for an account in your game.
This function allows a player to verify their account registration, which they must do before they can log into their account.
This function upgrades a headless account by linking the headless account with the email address and password.
This function shows how players can log into your game using a verified account.
Getting user data retrieves all of the personal data for the player that’s logged in.
You can retrieve public player data by submitting user IDs for the desired players using the following function. Public player data includes the AvatarUrl of a player’s avatar, their DisplayName, and their UserId.
Before using the Event Log service from the SDK, you will need to initialize your server-side SDK to ensure that you are authorized and able to perform create, read, update, and delete actions.
Before using the Event Log service from the Golang SDK, you will need to initialize the SDK by following the steps below:
Once completed, you can use the Golang SDK to create, read, update, or delete the Event Log (opens new window) from your serverless app.
Before using the Event Log service from the Python SDK, you will need to initialize the SDK by following the steps below:
Once completed, you can use the Python SDK to create, read, update, or delete the Event Log (opens new window) from your serverless app.
Before using the Event Log service, you will need to set some permissions. Use the following .NET namespaces:
using AccelByte.Sdk.Api.Eventlog.Model;
using AccelByte.Sdk.Api.Eventlog.Operation;
using AccelByte.Sdk.Api.Eventlog.Wrapper;
Before using the Event Log service, you will need to set some. Initialize the EventV2 wrapper from the Event Log service using the following code:
EventV2 wEvent = new EventV2(sdk);
Once completed, you can use the SDK to create, read, update, or delete event logs.
Use the following function to retrieve a list of events (opens new window):
Use the following function to retrieve a specific user's events (opens new window).
Before using the IAM service from the SDK you need to initialize your server-side SDK to make you authorized and able to perform any action from create, read, update, and delete.
To start using the IAM service from the Golang SDK, you need to initialize the SDK by making sure that you’ve done the following requirements.
On a successful initialization, you can use the Golang SDK to create, read, update and delete User (opens new window) from your serverless app.
Before using the IAM service, you will need to set some permissions. Use the following .NET namespaces:
using AccelByte.Sdk.Api.Iam.Model;
using AccelByte.Sdk.Api.Iam.Operation;
using AccelByte.Sdk.Api.Iam.Wrapper;
Before using the IAM service, you will need to set some. Initialize the UsersV4 wrapper from the IAM service using the following code:
UsersV4 wIamUserV4 = new UsersV4(sdk);
Once completed, you can use the SDK to create, read, update, or delete players.
To create a user (opens new window), use the following function.
If you need to create multiple user at once for testing purposes, you could create a loop statement based on the Create a User code as seen in the following snippet.
To delete a user (opens new window), use the following function.
If you need to delete multiple user at once for testing purposes, you could create a loop statement based on the Delete a User code as seen in the following snippet.
To get a user by their user ID (opens new window), use the following function.
To update user’s information (opens new window), use the following function.