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 follow these steps:

  1. Use the Users: Ban a Single User - POST /iam/v3/admin/namespaces/{namespace}/users/{userId}/bans endpoint

  2. Input the publisher namespace into the Namespace field.

  3. Input the User ID using UUID 4 format, without hyphens.

  4. Fill out the Request Body:

    • Input the Ban type. Here is the list of available ban types.

      Ban TypeRemarks
      CHAT_SENDBan players from sending messages.
      CHAT_ALLBan players from all chat related activities.
      VOICE_SENDBan players from sending voice messages.
      VOICE_ALLBan players from all voice chat related activities.
      COMMUNITYBan players from the community for a specific reason related to harassment, posting hateful content, etc.
      TRADE_INITIATEBan players from initiating trades.
      TRADE_ALLBan players from all trading activities.
      ORDER_AND_PAYMENTBan players from placing orders and making payments from the store.
      MARKETPLACE_LISTBan players from seeing what items are listed in the marketplace.
      MARKETPLACE_ALLBan players from all marketplace related activities.
      LOGINBan players from logging in.
    • 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. Here is the list of available ban reasons.

      ReasonRemarks
      VIOLENCEBan players for posting violent content.
      HARASSMENTBan players for harassing other players.
      HATEFUL_CONDUCTBan players for acting hateful towards other players.
      OFFENSIVE_USERNAMEBan players for having an offensive username.
      IMPERSONATIONBan players for impersonating other players.
      MALICIOUS_CONTENTBan players for posting malicious content such as spam, scams, etc.
      SEXUALLY_SUGGESTIVEBan players for posting sexually explicit or suggestive content.
      SEXUAL_VIOLENCEBan players for acting sexually violent or exploiting other players.
      EXTREME_VIOLENCEBan players for extreme violence such as gore and other obscene content.
      UNDERAGE_USERBan players for being underage.
      CHEATINGBan players for cheating.
      TOS_VIOLATIONBan players for Terms of Service violations.

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.

Banning a Player Through the Admin Portal

  1. In the Admin Portal, go to the User menu and type the Email or Display Name of the player you want to ban.

    user-ban-management

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

    user-ban-management

  3. Click the Add Ban button.

    user-ban-management

  4. 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. In the example below, we ban a player from sending voice messages for two days because of harassment.

    user-ban-management

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

    user-ban-management

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

    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, follow these steps to make the request:

  1. Use the Users: Get User’s Bans - GET /iam/v3/public/namespaces/{namespace}/users/{userId}/bans endpoint.
  2. Input the publisher namespace into the Namespace field.
  3. 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. In the Admin Portal, go to the User menu, and type the desired player’s user ID.

    user-ban-management

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

    user-ban-management

  3. 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. Follow these steps to make the request.

  1. Use the Users: Enable or disable ban for a single user - PATCH /iam/v3/admin/namespaces/{namespace}/users/{userId}/bans/{banId} endpoint.
  2. Input the game namespace into the Namespace field.
  3. Input the player’s user ID into the User ID field.
  4. Input the Ban ID using UUID version 4 formatting, without hyphens.
  5. 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

  2. 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

  3. After you disable the ban, the player will be able to send voice chat.

What’s Next?

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