OAuth

Signed-in user (OpenID Connect UserInfo)

Who the access token's user is. Send an OAuth access token (gm_oat_…) that was granted the openid and/or email scope; API keys and tokens without an identity scope are refused. sub is the stable user id. email and email_verified are returned with the email scope. Sign-in requires a verified email address, so email_verified is true for every account. The identity scopes grant no other access: a token with only openid and email is refused by every other endpoint.

post/oauth/userinfo

Request

  • Base URL: https://api.groundmail.dev
  • URL: https://api.groundmail.dev/oauth/userinfo
  • Auth: HTTP bearer

Response

Claims for the signed-in user

substring required

Stable user id

emailstring email

With the email scope

email_verifiedboolean

With the email scope

Example response

{
  "email_verified": true
}

Changes

No recorded changes to this operation across all 2 revisions of this API.