Security Credentials

Credentials allow you to configure permissive role types for Players within the game. You can configure each Credential to control which requests and responses are authorized for use when connecting to the GameSparks API platform:

Managing Credentials

To create and edit Credentials, go to Configurator > Credentials. Existing Credentials are listed:

You can use the following options (highlighted above):

Understanding Credential Settings

There are two main ways in which you can configure Credentials for your game:

You can also configure Credentials for:

Selecting Credential Types

When you create or edit a custom Credential there are three key settings you can use to determine the type of Credential and ensure the Credential suits your purposes:

There are certain rules applied to the combination of Credential types:

Important! You cannot alter the type settings for a System Credential!

Enabling Credential Requests

When you create or edit a Credential, there are four tabs for different requests categories, which you can use to control the requests allowed for the Credential:

Enabling COPPA Compliance

If you enable a Credential as COPPA compliant:

Selecting REST Policy

Select to allow or forbid the Credential to accept REST Service Requests:

{
  "@class": ".AccountDetailsRequest",
  "playerId": "5849655e16c047eb048bc585",
  "authToken": "a321c1ea-e48d-45ea-8370-6161eb1e84db",
  "requestId": "12897"
}

REST Service Requests? For more detail on Service Requests made through the REST API, see here.

System Credentials

On all games there are five default System credentials:

There are a few important things to note about System credentials:

Editing System Credentials

To edit a System Credential:

1. Click the edit icon. The Edit Credential page appears:

2. Use the REST Policy drop-down to select whether or not you want this Credential to allow REST requests:

3. Switch COPPA Compliant to ON, if you want the Credential to impose COPPA compliance.

4. If you don't want to configure the requests that the Credential allows, don't select the Configure request types check box:

5. If you want to configure which requests you want to allow for this Credential, select the Configure request types check box. The four Requests tabs are shown:

Important! If you simply select the Configure request types check box and do not change any of the default settings on any of the four request tabs and perform a save, this will save the current default request settings for the Credential. However, if a new request type is added to the platform, that Credential will NOT automatically inherit the default setting for that new request - you'll have to edit the Credential and explicitly select for the setting you want.

6. Click to Save and Close your editing changes.

Creating and Editing Custom Credentials

To create and edit a custom Credential:

1. Click Add. The Add Credential page appears:

2. Complete the mandatory fields for the Credential:

3. Use the toggle buttons to enable the type of Credential you want - Player, Listener, or Callback. In this example, we have selected for a Player Credential. When you select Player:

In this example, we've selected for a Player/Listener custom Credential.

4. Use the REST Policy drop-down to select whether or not you want your custom Credential to allow REST requests:

5. Switch COPPA Compliant to ON, if you want the Credential to impose COPPA compliance.

6. If you don't want to configure the requests that the Credential allows, don't select the Configure request types check box:

7. If you want to configure which requests you want to allow for this Credential, select the Configure request types check box. The four Requests tabs are shown:

Important! If you simply select the Configure request types check box and do not change any of the default settings on any of the four request tabs and perform a save, this will save the current default request settings for the Credential. However, if a new request type is added to the platform, that Credential will NOT automatically inherit the default setting for that new request - you'll have to edit the Credential and explicitly select for the setting you want.

8. Click to Save and Close your new Credential.

Resetting Credential Secret

To reset a Credential's secret:

1. Under Credentials, click the reset icon for the Credential whose secret you want to reset:

A Reset Secret confirmation dialog appears:

2. Click OK to continue with the Credential secret reset. The confirmation dialog closes and you'll see that the Credential's secret has been updated:


Callback Example! For an example of when you might want to create a Callback Credential and use it, see the How to Use Custom Callback Urls tutorial.


This product includes GeoLite data created by MaxMind, available from http://www.maxmind.com.

Did this page help you? Please enter your feedback below. For questions about using this part of the platform, please contact support here