Skip to main content

Get user info

GET 
/users-srv/userinfo

This OIDC standard API returns user information based on the token in the header. Returned data depends on token scopes (from authorization endpoint) and accepted claims.

Scopes and Field Visibility​

The fields returned in the response are controlled by the scopes requested during authorization. Each scope maps to specific user fields:

ScopeReturns
openidBasic user identifier (sub)
profileProfile fields: given_name, family_name, name, picture, birthdate, locale, preferred_username
emailEmail-related fields: email, email_verified
phonePhone-related fields: mobile_number, mobile_number_verified
addressAddress information
identitiesAll linked identities (social providers, etc.)
groupsUser groups with roles and metadata
rolesUser roles (default roles from CIDAAS_USERS group)
consentsAccepted consents

Important: Only fields that are:

  1. Mapped to the requested scopes in Field Settings
  2. Enabled in Field Settings
  3. Not marked as Internal in Field Settings

will be included in the response.

Field Settings Impact​

Field settings configured in Field Settings control field visibility and behavior:

  • Enabled: Field must be enabled to be included in the response. Disabled fields are never returned.
  • Internal: Fields marked as internal are never returned in userinfo responses, even if the corresponding scope is requested. Internal fields are only accessible to administrators via admin APIs.
  • ReadOnly: ReadOnly fields are returned in the response (if scope is requested and field is enabled), but users cannot modify them via self-service update APIs. Admins can still update readonly fields.

Example: If a field is configured with enabled=true, internal=true, and mapped to scope profile, it will not be returned in the userinfo response, regardless of whether the profile scope is requested.

For more information, see Field Settings and Scope Management.

Request​

Responses​

The response is defined by the OIDC standard and contains a user Entity; Depends on the scopes requested in the token.