Players

Every environment has its own player table. A player in test and a player in production are different players, even when the same person is behind both.

The Players service is always on: sessions and anything else that names a player need it.

Identities

A player is known by one or more identities. An identity is a provider and a subject: who vouches for the player, and what that provider calls them.

Provider Subject Who signs the player in
server Your own id for the player, any string up to 200 characters Your game server, with a server key
eos The player's Epic Online Services product user id The game client, with an EOS id token
steam The player's Steam id64 Recorded by an EOS sign-in through Steam (Steam names)

The first time a provider and subject are seen in an environment, a player is made for them. After that, the same pair always finds the same player.

A player does not need a GreenMind account, and nothing here assumes one. The console shows whether a player has one linked.

Signing in from your server

Use the server provider when you have your own account system, your own sign-in, or a platform whose identity your server already checks (Steam, a console network, a device id). Your server decides who the player is; the platform takes its word.

curl -X POST https://api.greenmindmedia.com/api/platform/v1/auth/server \
  -H "Authorization: Bearer $GM_SERVER_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "subject": "account-1234", "displayName": "Ada" }'
Field Required Rules
subject yes 1 to 200 characters. Your id for the player
displayName no 1 to 40 characters after trimming. When given, it replaces the player's current name

The answer is the player's tokens (see Authentication), with 201 when the sign-in made the player and 200 when it found them. Pass the tokens to the player's game client over your own connection to it.

A new player past what your org's plan allows in the environment is refused with quota-exceeded; players already there keep signing in.

Choose a subject that never changes and means nothing to anyone else: an account id, not an email address or a username the player can change. A new subject is a new player.

Because a server key can sign in any subject, it can act as any of your players. Keep it on your servers.

Signing in with EOS

If your game uses Epic Online Services, the client can sign in without your server.

1. Enable EOS for the environment. In the console, open the environment and go to Connections, Player sign-in, switch EOS on, and enter your EOS client id (the client your game signs in to EOS with). Optionally enter a deployment id: a token from any other deployment is then refused. Do this for each environment that should accept EOS.

2. Sign in from the client. After the player has signed in to EOS Connect, take the id token for their product user (EOS_Connect_CopyIdToken in the EOS SDK) and send it with the environment's app key:

curl -X POST https://api.greenmindmedia.com/api/platform/v1/auth/eos \
  -H "Content-Type: application/json" \
  -d '{ "appKey": "skyforge_test", "idToken": "eyJraWQiOi..." }'
const response = await fetch('https://api.greenmindmedia.com/api/platform/v1/auth/eos', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({ appKey: 'skyforge_test', idToken }),
})
const tokens = await response.json()

The id token is checked against Epic's published signing keys and your client id. The answer is the player's tokens, 201 when the sign-in made the player.

Refusal Why
provider-disabled EOS is not switched on for that environment
unauthorized The id token is invalid, expired, for another client, or for another deployment
quota-exceeded A new player, past what your org's plan allows in the environment

A player signed in with EOS starts with no display name. Set one with PATCH /players/me from the client or PATCH /players/:playerId from your server.

Display names

A display name is what other players see, for example in a lobby. It is 1 to 40 characters after trimming, and it passes through a word filter for names: words the filter does not allow are starred out rather than refused, and the filtered name is what is stored.

A player can change their own name with PATCH /players/me. Your server can change any player's name with PATCH /players/:playerId, or by sending displayName when it signs them in.

A player may have no display name (null). Where a name is needed and there is none, such as a lobby seat, the platform uses their Steam name if your project names players by Steam (below), and Player otherwise.

Steam names

When a player signs in with EOS through Steam, the platform records their Steam account as a steam identity. Your project can name such a player by their Steam persona name until they choose a name of their own, so nobody sits in a lobby as Player.

The setting is the project's, for every environment, on the Steam section of the project page in the console. Whoever administers the project can change it:

  1. Get a Steam Web API key for your studio's Steam account at steamcommunity.com/dev/apikey. It is the ordinary Web API key, not the publisher key your store credentials hold.
  2. On the project page, choose Add a Steam key, enter the key, and leave Steam display names on.

Steam is asked once, as you save, whether it takes the key: a key it refuses is not saved, and neither is any key while Steam cannot be asked. The key is then sealed and never shown again, not even to you; to change it, enter another. Leave the field empty when you change only the switch.

With the setting on, the platform reads a player's Steam name beside each sign-in through Steam, with your key, at most once a day per player, and without holding the sign-in up. Steam allows each key so many calls a day, which is why it is your key and not GreenMind's. The name is used where the player has no display name of their own; a name they set always comes first.

Switch it off, or remove the key, and no Steam name is read for your players any more, and the names already read are forgotten at once, in every environment.

Reading players

Everything about one player is under /players/:playerId: me with the player's own token, and their id with a server key. A player's token naming any id, even its own, is refused with forbidden.

Route Credential Returns
GET /players/me Player The signed-in player
GET /players/:playerId Server One player of the key's environment

A player is returned as:

{
  "id": "0199a7c3-0b2d-7e11-8c55-5f0e3d9a4b21",
  "displayName": "Ada",
  "linked": false,
  "createdAt": "2026-09-29T12:00:00.000Z"
}

linked says the player is under a GreenMind account somebody has signed in to. Only GreenMind's own games put players under accounts, so for your players it is always false. A sign-in and a refresh answer the player in the same shape.

Asking for a player of another environment answers not-found, as for a player who does not exist.

In the console, the environment's Players page lists players newest first, and finds them by display name, by player id, or by an identity's exact subject. It also shows each player's identities and when they were last seen (last signed in or refreshed).

Patreon supporters

Your org can connect its Patreon campaign on its Patreon page in the console (an admin of the org does it, signed in to Patreon as the campaign's owner, once one of the org's projects is approved). Your players link their Patreon account to their GreenMind account on greenmindmedia.com, once for every game they play. From then on GET /players/me/patreon tells a game whether the player supports your campaign, and your server asks the same for any player of the environment with GET /players/:playerId/patreon.

A supporter is somebody Patreon says is entitled today to at least one of your campaign's paid tiers. Patreon tells us of a change within seconds, and every member of your campaign is checked again each night; the page's Check now runs that check at once. The answer names the tiers they are entitled to, and whether they let other people see a supporter badge.

Nothing here identifies a person outside Patreon's own ids: we never ask Patreon for a supporter's name, email address or what they pay.

Deleting a player

When a player asks you to delete their data, your server calls DELETE /players/:playerId with its server key, which answers 204. Their display name is removed, and so are their identities, so the same id signing in again becomes a new player; so are their saves, tours, game state and what they hold from purchases. Every token they hold stops working.

To end a player's sessions without deleting anything, sign them out everywhere: see Authentication.

Exporting what the platform holds about a player is not yet available in the console or the API. Send such a request to GreenMind with the player's id and environment, as the Data Processing Addendum describes.