Scopes and claims

Ask only for what you use. Players see each scope on the consent screen.

ScopePlayers seeGives you
openidKnow who you are on REANID token with sub.
profileSee your username, display name and avatarpreferred_username, name, picture; GET /v1/me.
emailSee your email addressemail, email_verified.
offline_accessStay signed in without asking againA refresh token.
friends.readSee your REAN friends listGET /v1/friends.
presence.readSee your friends' online status and what they are playingPresence in /v1/friends and /v1/presence.
presence.writeShow what you are doing in this game to your friendsPOST /v1/presence (rich presence).
invitesSend game invites to your friends and receive theirs/v1/invites, invite events.

ID token and userinfo claims

ClaimScopeDescription
subopenidPermanent REAN player id (UUID).
preferred_usernameprofileREAN username. Can change.
nameprofileDisplay name (falls back to the username).
pictureprofileAvatar URL, when the player has one.
emailemailAccount email. Can change.
email_verifiedemailWhether REAN has verified the email.
nonce—The nonce you sent (ID token only).
auth_time—When the player signed in (ID token only).
GEThttps://api.reanstudios.com/api/oauth/userinfoscope openid
json
{
  "sub": "4f9c2b1e-7a3d-4c55-9e10-2f6b8a1d3c77",
  "preferred_username": "nova",
  "name": "Nova",
  "picture": "https://…/avatar.png"
}