1. Docs
  2. API Reference
  3. OIDC UserInfo endpoint

OIDC UserInfo endpoint

GET/oauth/userinfo

OIDC UserInfo endpoint (GET /oauth/userinfo). Requires a valid identity access token (IdentityJwtGuard) and returns the standard OIDC claims for the authenticated subject: sub, email, email_verified, given_name, family_name, and name. Returns 401 for an invalid token and 403 when the bearer is not an identity principal.

Responses

application/json

  • substring*
  • emailstring*
  • email_verifiedboolean*
  • given_namestring*
  • family_namestring*
  • namestring*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

OAuthUserInfoResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/oauth/userinfo"
Response
{
  "sub": "string",
  "email": "string",
  "email_verified": false,
  "given_name": "string",
  "family_name": "string",
  "name": "string"
}
 Related endpoints Was this page helpful?

Tell us how we can improve this guide.

Canopy