Theme switcher

Get the current user

Header Parameters

Authorizationstring

Keycloak access token (OAuth2). Replace [HOST] and [YOUR_REALM] with the values of your installation. OAuth2 flows: Implicit (authorization URL: https://[HOST]/realms/[YOUR_REALM]/protocol/openid-connect/auth)

Response

200
Object

The current user.

Response Attributes

loginTimestring

Time the user object was built for this request.

tenantIdstring

Keycloak realm, used as tenant id.

preferredUsernamestring

User's preferred username (e.g. email or UPN)

namestring

Display name.

emailstring

E-mail address (claims email, unique_name or upn).

givenNamestring

First name.

familyNamestring

Last name.

realmRolesarray

Keycloak realm roles from realm_access.roles

Show child attributes

clientRolesarray

Keycloak client roles from resource_access.{clientId}.roles

Show child attributes

groupsarray

Groups from the Keycloak groups claim. Used for task visibility and UI group checks.

Show child attributes

customClaimsobject

Custom claims configured in Keycloak protocol mappers

issuedAtstring

Issue time of the token.

expiresAtstring

Expiry time of the token.

tokenIdstring

Token id (jti claim).

eccTypestring

Object type.

401
Object

Missing, invalid or expired access token.

Response Attributes

successboolean

true for 2xx responses, false for errors.

httpStatusinteger

HTTP status code, same as the response status.

httpStatusReasonPhrasestring

HTTP reason phrase.

messageCodestring

Message code for application errors with a defined code (EccException), e.g. EAP0001.

messagestring

Message text. Localized for coded application errors, otherwise the technical exception message.

dataTypestring

Simple class name of the error or its data (errors only).

datastring

Payload. Type depends on the endpoint. For coded application errors the EccException.

403
Object

Not Allowed

Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?