Scopes and claims
Ask only for what you use. Players see each scope on the consent screen.
| Scope | Players see | Gives you |
|---|---|---|
openid | Know who you are on REAN | ID token with sub. |
profile | See your username, display name and avatar | preferred_username, name, picture; GET /v1/me. |
email | See your email address | email, email_verified. |
offline_access | Stay signed in without asking again | A refresh token. |
friends.read | See your REAN friends list | GET /v1/friends. |
presence.read | See your friends' online status and what they are playing | Presence in /v1/friends and /v1/presence. |
presence.write | Show what you are doing in this game to your friends | POST /v1/presence (rich presence). |
invites | Send game invites to your friends and receive theirs | /v1/invites, invite events. |
ID token and userinfo claims
| Claim | Scope | Description |
|---|---|---|
sub | openid | Permanent REAN player id (UUID). |
preferred_username | profile | REAN username. Can change. |
name | profile | Display name (falls back to the username). |
picture | profile | Avatar URL, when the player has one. |
email | Account email. Can change. | |
email_verified | Whether REAN has verified the email. | |
nonce | — | The nonce you sent (ID token only). |
auth_time | — | When the player signed in (ID token only). |
GET
https://api.reanstudios.com/api/oauth/userinfo{
"sub": "4f9c2b1e-7a3d-4c55-9e10-2f6b8a1d3c77",
"preferred_username": "nova",
"name": "Nova",
"picture": "https://…/avatar.png"
}