oidc

Changed on

Fetches the current UserInfo claims for the authorized user. This is the same fields returned by a id_token returns during authorization.

The claims returned depend on the granted scopes: profile claims (name, given_name, family_name) are only returned when the profile scope is granted, and email claims (email, email_verified) are only returned when the email scope is granted. The openid scope is always required.

get/v1/oidc/userinfo

Request

  • Base URL: https://api.canva.com/auth
  • URL: https://api.canva.com/auth/v1/oidc/userinfo
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://www.canva.com/api/oauth/authorize, token URL https://api.canva.com/rest/v1/oauth/token, scopes: openid, profile, email)
    • OAuth 2 (authorization code, authorization URL https://www.canva.com/api/oauth/authorize, token URL https://api.canva.com/rest/v1/oauth/token, scopes: openid, profile)
    • OAuth 2 (authorization code, authorization URL https://www.canva.com/api/oauth/authorize, token URL https://api.canva.com/rest/v1/oauth/token, scopes: openid, email)

Response

OK

substring required

Identifier for the End-User at the Issuer.

namestring

End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.

given_namestring

Given name(s) or first name(s) of the End-User. Note that in some cultures, people can have multiple given names; all can be present, with the names being separated by space characters.

family_namestring

Surname(s) or last name(s) of the End-User. Note that in some cultures, people can have multiple family names or no family name; all can be present, with the names being separated by space characters.

emailstring email

End-User's preferred e-mail address. Its value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax. The RP MUST NOT rely upon this value being unique, as discussed in Section 5.7.

email_verifiedboolean

True if the End-User's e-mail address has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this e-mail address was controlled by the End-User at the time the verification was performed. The means by which an e-mail address is verified is context specific, and dependent upon the trust framework or contractual agreements within which the parties are operating.

Example response

{
  "sub": "UAAAAAAAAA",
  "name": "Alice Person",
  "given_name": "Alice",
  "family_name": "Person",
  "email": "alice.person@example.com",
  "email_verified": true
}

Changes