User Bans

Overview

The Ban Management is a community manager that controls over your players behavior in order to preserve a healthy community. As a community manager, you can ban a player for violating your policy by restricting them to access specific resources or the whole access to your resources. There are two ways to carry out the ban:

  • Global Ban restricts access to all of your resources by invalidating all the user’s session ID.
  • Specific Ban restricts access to specific resources by invalidating a specific session ID that affects specific resources. Note: These bans have an expiration time, once it expires all the bans directed to players will no longer be active. You can also configure the ban duration according to your need.

User Ban Management includes two main actions: banning a player from your game and lifting a ban from a player. Banning and unbanning players requires administrator access, and can be performed indirectly via API or directly from the Admin Portal.

Tutorials

Make sure you have authorized access before performing a request.

Banning a Player

Banning a Player Using the API Gateway

To ban a player use the Users: Ban a Single User - POST /iam/v3/admin/namespaces/{namespace}/users/{userId}/bans endpoint and follow these steps to make the request:

  1. Input the game’s namespace into the Namespace field.
  2. Input the User ID using UUID 4 format, without hyphens.
  3. Fill out the Request Body:
    • Input the Ban type.
    • Input a Comment containing any relevant information about how the ban will be carried out.
    • Input the date the ban will end in the End Date field.
    • Input Reason with the reason why the player is being banned.
    • Click Try it out!

Upon successful request, the ban will be enabled and the banned player will not be able to access the game.

Note: There are a couple other endpoints that can help you when you’re banning a player.The Bans: Get List of Ban Types - GET /iam/v3/admin/bans endpoint and Bans: Get List of Ban Reasons - GET /iam/v3/admin/bans/reasons endpoint can be used to retrieve the list of ban types and ban reasons, respectively.

Banning a Player Through the Admin Portal

  1. Go to the User menu and type the user ID of the player you want to ban.

user-ban-management

  1. Once you’re in the player’s dashboard, switch to the Bans tab.

user-ban-management

  1. Click the Add Ban button.

user-ban-management

  1. Input the required fields as seen below. Select the appropriate Ban Type and Reason from their respective dropdown lists, and add a comment with any relevant information regarding the ban. Then click Bans.

user-ban-management

  1. When you’re done, the new ban will appear in the Bans list.

user-ban-management

Getting a Player’s Ban History

Getting a Player’s Ban History Using the API Gateway

To retrieve a player's ban history use the Users: Get User’s Bans - GET /iam/v3/public/namespaces/{namespace}/users/{userId}/bans endpoint. Follow these steps to make the request:

  1. Input the game’s namespace into the Namespace field.
  2. Input the player’s User ID using UUID 4 format, without hyphens.

Upon successful requests, the player’s ban history will be retreived.

Getting a Player’s Ban History Through the Admin Portal

  1. Go to the User menu, and type the desired player’s user ID.

user-ban-management

  1. Once you’re in the user’s dashboard, switch to the Bans tab.

user-ban-management

  1. The player’s ban history will be visible.

user-ban-management

Enabling or Disabling a Player’s Ban

Enable or Disable a Player’s Ban Using the API Gateway

If you’ve previously banned a player, this ban can be disabled or re-enabled as needed. Use the Users: Enable or disable ban for a single user - PATCH /iam/v3/admin/namespaces/{namespace}/users/{userId}/bans/{banId} endpoint. Follow these steps to make the request:

  1. Input the game namespace into the Namespace field.
  2. Input the player’s user ID into the User ID field.
  3. Input the Ban ID using UUID version 4 formatting, without hyphens.
  4. Fill out the Request Body:
    • Set the Enabled parameter to true to enable the ban, or to false to disable the ban.

Enable or Disable a Player’s Ban Through the Admin Portal

  1. In the player’s Bans list you can find the ban that you want to enable or disable.

user-ban-management

  1. Click Enable or Disable on the ban listing to enable or disable the ban. After you click, a confirmation message will appear.

user-ban-management

  1. After you enable the ban, the player will be notified by email.

user-ban-management

What’s Next?

  • For more information about User Ban Management, you can access the API References.