Manage third-party account closures
Introduction
The GDPR-compliant Account Closure Configuration feature in AccelByte Gaming Services (AGS) allows the removal of player data linked to third-party accounts when they are closed from linked platforms. When players closes their account on a linked third-party platform (i.e., Playstation, Steam, Xbox), this feature removes all player data associated with that their-party account from AGS. This prevents any dependence or connection between the AGS account and the now-closed third-party account.
This guide walks you through the following:
- View and access account closure configuration
- Set up account closure configurations for Playstation, Steam, and Xbox
- View account closure history
You can do these tasks in the AGS Admin Portal or with the AGS CLI. To follow the AGS CLI steps, you have installed the AGS CLI and signed in with an account that has READ and UPDATE on ADMIN:NAMESPACE:{namespace}:GDPR:CONFIGURATION, and READ on ADMIN:NAMESPACE:{namespace}:USER to view the closure history. See Install and sign in. The examples use a Bash shell.
The Account Closure Configuration feature is only available in publisher and studio namespaces. It cannot be accessed from game namespaces.
View and access account closure configurations
- Admin Portal
- AGS CLI
- In the AGS Admin Portal, go to your publisher or studio namespace.
- On the sidebar, go to Foundations > 3rd Party Integraitons > Account Closure. The Account Closure page appears, showing a list of any existing platform configurations.
-
List the platforms that have an account closure configuration. Replace
<YourNamespace>with your publisher or studio namespace:ags gdpr platform-closure list-clients --namespace <YourNamespace> -
To see one platform's configuration, set
--platformtopsn,steamnetwork, orxbox:ags gdpr platform-closure get-client --namespace <YourNamespace> --platform psn
Set up account closure configurations
To set up account closure configurations for Playstation, Steam, and Xbox, follow these steps:
Playstation
First, prepare the client ID and secret for the Playstation platform. Then, follow these steps in your publisher or studio namespace:
- Admin Portal
- AGS CLI
- Go to Foundations > 3rd Party Integraitons > Account Closure. The Account Closure page appears.
- On the Account Closure page, click the Add Platform button and select Playstation.
- On the Add Platform form, fill in the platform name, client ID, and client secret for the Playstation platform.
- Click Add to save the configuration.
-
Create a JSON file with the platform's credentials. Any file name works. This example uses
psn-closure.json:{
"clientId": "<PlaystationClientId>",
"secret": "<PlaystationClientSecret>"
} -
Save the configuration. Replace
<YourNamespace>with your publisher or studio namespace:ags gdpr platform-closure update-client --namespace <YourNamespace> --platform psn --json @psn-closure.json -
Delete
psn-closure.json. It contains your credentials.
Steam
First, prepare a valid Steam Web API Key. The partner-only Publisher Web API is used for the Steam configuration. For more information, refer to Steam's official documentation. Then, follow these steps in your publisher or studio namespace:
- Admin Portal
- AGS CLI
- Go to Foundations > 3rd Party Integraitons > Account Closure. The Account Closure page appears.
- On the Account Closure page, click the Add Platform button and select Steam.
- On the Add Platform form, fill in the platform name and Steam Web API Key.
- Click Add to save the configuration.
-
Create a JSON file with the platform's credentials. Any file name works. This example uses
steam-closure.json:{
"publisherKey": "<SteamWebApiKey>"
} -
Save the configuration. Replace
<YourNamespace>with your publisher or studio namespace:ags gdpr platform-closure update-client --namespace <YourNamespace> --platform steamnetwork --json @steam-closure.json -
Delete
steam-closure.json. It contains your credentials.
Xbox
First, prepare a valid Xbox Business Partner Certificate file (.pfx). Then, follow these steps in your publisher or studio namespace:
- Admin Portal
- AGS CLI
- Go to Foundations > 3rd Party Integraitons > Account Closure. The Account Closure page appears.
- On the Account Closure page, click the Add Platform button and select Xbox.
- On the Add Platform form, provide the following:
- Platform name
- Sandbox ID: To use the live environment, type in RETAIL in the Sandbox ID field
- Business Partner Certificate: You can get a Business Partner Certificate from the Microsoft Partner Platform (.pfx file).
- Certificate Password
- Click Add to save the configuration.
-
Create a JSON file with the platform's credentials. Any file name works. This example uses
xbox-closure.json:{
"sandboxId": "RETAIL",
"bpCertFileName": "<CertificateFile>.pfx",
"bpCert": "<Base64Certificate>",
"password": "<CertificatePassword>"
}sandboxId:RETAILfor the live environment, or your sandbox ID.bpCertFileName: the file name of your Business Partner Certificate.bpCert: the contents of your Business Partner Certificate file, Base64-encoded on a single line. The Admin Portal encodes the file for you. With the AGS CLI, encode it withbase64 -w 0 <CertificateFile>.pfxon Linux orbase64 -i <CertificateFile>.pfxon macOS.password: the certificate password.
-
Save the configuration. Replace
<YourNamespace>with your publisher or studio namespace:ags gdpr platform-closure update-client --namespace <YourNamespace> --platform xbox --json @xbox-closure.json -
Delete
xbox-closure.json. It contains your credentials.
View account closure history
- Admin Portal
- AGS CLI
- In the AGS Admin Portal, go to your publisher or studio namespace.
- On the sidebar, go to Foundations > Legal & Privacy > 3rd Party Account Closure. The 3rd Party Account Closure page appears, showing a list of account closures with their closure date, platform user ID, platform, last linked Publisher User ID, and other additional information.
-
List the account closures. Replace
<YourNamespace>with your publisher or studio namespace:ags gdpr platform-closure get-history --namespace <YourNamespace>To filter the list, add
--platformwith the platform, or--user-idwith a user ID.