Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Page Properties
hiddentrue
idDONE

Product Version
Report Note
Assignee

Resources & Remarks

Modification History

2021 Summer
NameDateProduct VersionAction
Antje19 MAY 202102 MAR 20232023 SpringPage created.



As of Version

product version 2021 Summer | component version 2023 Spring

Request MethodGET
Response FormatJSON
Description


Excerpt

This request retrieves the user information of the current logged in user.

Per default, whoami requests the yuuvis® user-service which in turn requests the identity provider service (IPS) Keycloak. Beginning with version 2021 Autumn: If you need to request a different IPS, you can build a custom microservice that answers in the same way, and configure its endpoint in the application.yml file, or better in the api-web-prod.yml file as shown below.

Note: Keep in mind that a session cookie is created that may have to be ignored by your custom microservice.

Code Block
whoami:
  endpoint: http://whoamitest

Response HTTP status codes:

HTTP Status CodeMeaning
200 OKSuccessful.
401 UnauthorizedNot successful.


Request Example

https://<host>/api-web/api/usersidm/whoami

no request body

Response Example

200 OK

Code Block
languageyml
{
  "accountNonExpiredusername": true"string",
  "accountNonLockedid": true"string",
  "authoritiesforeignid": [
    "string"
  ],
  "credentialsNonExpiredtype": true"string",
  "domaintitle": "string",
  "email": "string",
  "enabledfirstname": true"string",
  "firstnamelastname": "string",
  "foreigniddomain": "string",
  "idtenant": "string",
  "lastnameauthorities": [
    "string"
  ],
  "substituteOf": [
    "string"
  ],
  "tenantaccountNonExpired": true,
  "stringaccountNonLocked": true,
  "titlecredentialsNonExpired": "string"true,
  "typeenabled": "string"true,
  "usernamedisplayName": "string"
}