Users

Get User Info

Changed on

Retrieves user-info for the currently authenticated user.

get/api/user/v1/user-info

Request

  • The document declares no server URL.
  • Auth
    OpenID Connect (http://localhost:6999/realms/agate/.well-known/openid-configuration, scopes: agridata.ch.Agridata_Einwilliger, agridata.ch.Agridata_Datenbezueger, agridata.ch.Agridata_Admin, agridata.ch.Agridata_Support, agridata.ch.Agridata_Datenanbieter)

Response

OK

userIdstring uuid
agateLoginIdstring

AgateLoginId of the user.

ktIdPstring

KtIdP of the user. Only set for data producers

uidstring

UID of the user. Only set for data consumers.

givenNamestring

User's first name.

familyNamestring

User's last name.

emailstring

Email address of the user

phoneNumberstring

Landline number of the user

mobileNumberstring

Mobile number of the user

addressStreetstring

Street name and house number of the user's residence.

addressLocalitystring

Locality (city or town) of the user's residence.

addressPostalCodestring

Postal code of the user's residence.

addressCountrystring

Country of residence

lastLoginDatestring date-time
rolesAtLastLoginstring[]

Roles of the user at the last login

lastAcceptedAgbDatestring date-time
lastAcceptedAgbRevisionIdstring uuid
enforceAgbAcceptanceFromstring date-time

Example response

{
  "agateLoginId": "1234567",
  "ktIdP": "ZH123456",
  "uid": "CHE123456789",
  "givenName": "Anna",
  "familyName": "Muster",
  "email": "anna.muster@example.com",
  "phoneNumber": "+41331234567",
  "mobileNumber": "+41791234567",
  "addressStreet": "Bahnhofstrasse 10",
  "addressLocality": "Zürich",
  "addressPostalCode": "8001",
  "addressCountry": "CH",
  "lastLoginDate": "2022-03-10T12:15:50",
  "userPreferences": {
    "mainMenuOpened": true,
    "activeUid": "CHE123456789",
    "dismissedMigratedIds": [
      "a5b1d2e3-4f6a-2b7c-6d0e-9f1a3b5c7d9e"
    ],
    "hasSeenConsentRequestTourIntro": true
  },
  "lastAcceptedAgbDate": "2022-03-10T12:15:50",
  "enforceAgbAcceptanceFrom": "2022-03-10T12:15:50"
}

Changes

  • 75957f6bdc66Revision changes
    • warning

      added the new EXPORT_CAPACITY_EXHAUSTED enum value to the response property for the response status

    • warning

      added the new EXPORT_CAPACITY_EXHAUSTED enum value to the response property for the response status

    • warning

      added the new EXPORT_LIMIT_EXCEEDED enum value to the response property for the response status

    • warning

      added the new EXPORT_LIMIT_EXCEEDED enum value to the response property for the response status

  • 1aa7b6ad5bccRevision changes
    • warning

      added the new UID_CLAIM_MISSING enum value to the response property for the response status

    • warning

      added the new UID_CLAIM_MISSING enum value to the response property for the response status