Accounts

Overview

Account management provides a wide range of usage for players and admin. As a player, this feature ensures that you will have full control of your own data like maintaining your account information, requesting a password reset, deactivating account and downloading all of your data from the system if needed. As an admin, you will have more control of your players data, for example you can see the users order history or their activity updates. In some cases, you may need to disable an account due to some violation of your terms and conditions.

Tutorials

Create a New User

Creating a new user can be done through either the API or through the Admin Portal.

Create a New User Using the API

Follow the steps below to create a new user to be assigned for an admin role.

  1. Use the Create User: POST /iam/v3/public/namespaces/{namespace}/users endpoint.
  2. Input the namespace you want the new user to be admin of in the Namespace field.
  3. Fill out the Request Body:
    • Input the Authentication Type (authType) with the appropriate authentication type, in this case, EMAILPASSWD.
    • Input the user’s country in the Country field, using ISO 3166-1 alpha 2 two letter format, e.g. US.
    • Input the user’s date of birth into the Date of Birth field, using YYYY-MM-DD format, e.g. 2019-04-29.
    • Input the user’s Display Name.
    • Input the user’s Email Address.
    • Input the user’s Password.

Create a New Admin User Through the Admin Portal

Follow these tutorials if the users haven’t listed in Admin Portal but, if you already have a user, you can Assign the User to an Admin Role.

  1. Go to the Users Management section in the Admin Portal and open the Users menu.

    User Account Management
  2. In the Users Management window, click the Create New button.

    User Account Management
  3. Input the required information into the form below.

    User Account Management

Assign a User to an Admin Role

Get Bulk Users from Email Addresses

You can retrieve multiple users at once, using their email addresses to retrieve information about the users such as their User IDs. You can then use these User IDs to assign the users to admin roles.

  1. Use the Get Bulk User By Email Address: POST - /iam​/v3​/admin​/namespaces​/{namespace}​/users​/search​/bulk endpoint

  2. Input the Namespace where the users belong.

  3. Fill out the Request Body.

    • List the users’ email addresses in the listEmailAddressRequest.
    {
    "listEmailAddress": [
    "a@example.com",
    "b@example.com",
    "c@example.com"
    ]
    }

Assign a User to an Admin Role Using the API

Follow the steps below to assign a user to an admin role.

  1. Use the Add User Role: POST /iam/v3/admin/namespaces/{namespace}/users/{userId}/roles/{roleId} endpoint.
  2. Input the publisher namespace in the Namespace field.
  3. Input the user’s ID in the User ID field.
  4. Input the appropriate Role ID, using UUID-4 formatting without hyphens.

Assign a User to an Admin Role Through the Admin Portal

You can assign a user to various roles such as Read-Only Publisher Admin or Super Admin for the Publisher by following the steps below.

  1. In the Admin Portal, go to the desired user and switch to the Roles tab. Then, click the Add Role button.

    User Account Management
  2. Open the Choose Roles dropdown menu and choose the desired role.

    User Account Management
  3. The new role will be added to the list of roles for the selected user. In this example, we’ve added Read-Only Admin.

    User Account Management

User Activity Log

User Activity Log enables you to see the history of any changes made by a user. A game admin can see the history of their own namespace, while a publisher admin will be able to see all of the histories in all namespaces.

Get a User’s Log in the Admin Portal

  1. In the Users list of the Admin Portal, select the desired User and click Logs. Then, input the date range you want to display.

    • This is what the Logs page looks like if you log in as a game admin. You will see a list of user logs and a timestamp of when they were created in the Date field.
    User Account Management
    • This is what the Logs page looks like if you logged in as a publisher admin. You will see a list of user logs, the Namespace where the logs were created, and a timestamp of when they were created.
    User Account Management
  2. In the Action column, click View to see the Event Log Details.

Get a User’s Log Using the API

You can retrieve a user’s log as either a game or publisher admin by following the steps below.

  1. Input the desired Namespace. Game admins can only input their game namespace, whereas publisher admins can input any namespace.
  2. Input the User ID field of the user whose history you want to retrieve.
  3. Input the pageSize field with the number of lines you want to display on a single page. The default value is 100.
  4. Input a startDate and endDate if you want to only display data from a specific time range. If left blank, all of the user’s log data will be returned.
  5. Input the offset to define which line you want the retrieved data to start on. This field is optional.
  6. Input the eventName if needed to narrow down the search by log type. For example, if you input user_login_info you will only see the user’s login history.

Upon successful request, the defined log data will be retrieved.

Account History

The account history feature allows you to see changes made to account data by users. The information available includes changes made to Display Name, Email Address, Password, and Date of Birth.

Get a User’s Edit History Through the Admin Portal

  1. In the User Management menu of the Admin Portal, go to the desired user and click View Account History to get their edit history.

    User Account Management
  2. Input the Start and End Date of the time period for which you want to retrieve the history. For example, here we input 2020-07-27 to 2020-08-04 to see the changes the user made to their Display Name within that time period.

    User Account Management

    You can also view the edit history for other fields, such as Email Address, Password, or Date of Birth.

    User Account Management

Get a User’s Edit History Using API

You can retrieve a user’s edit history by following the steps below:

  1. Use the Get a User Edit History Based on the Provided Type: GET - /event/v2/public/namespaces/{namespace}/users/{userId}/edithistory endpoint.
  2. Input the Namespace to which the user belongs.
  3. Input the User ID of the user whose history you want to see.
  4. Input the number of lines of data you want to display on a page in the Page Size field. You can leave this field blank
  5. Input the Start and the End Date of time period for which you want to see the history with the appropriate formate e.g. 2015-03-20T12:27:06Z. Or, leave these fields blank to retrieve the edit history for all time.
  6. Input the offset to define which line you want the retrieved data to start on. This field is optional.
  7. Input the Edit History field with the type of data you’d like to return. You can input one type of data from the list below to be returned, or leave this field blank to retrieve change data for all data types.
TypeDescription
emailDisplay the email edit history
passwordPassword edit history
displaynameDisplay Name edit history
dateofbirthDate of Birth edit history
countryCountry edit history
languageLanguage edit history

Upon successful request, the edit history for a user will be retrieved.

What’s Next?

  • For more information about User Account Management you can access the API references.