Sign in
Users

Get User Info

Retrieves user-info for the currently authenticated user.

get/api/user/v1/user-info

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

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"
}

Changes

Changed in 17 of the 56 revisions of this API.1916

  • afc89996cbbc2See the full diff
    • ○

      added the optional property lastAcceptedAgbDate to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property lastAcceptedAgbRevisionId to the response with the 200 status

      response-optional-property-added

  • 73b93bab6c7b2See the full diff
    • ●

      removed the optional property lastAcceptedAgbDate from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property lastAcceptedAgbRevisionId from the response with the 200 status

      response-optional-property-removed

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 4f907e1764812See the full diff
    • ○

      added the optional property lastAcceptedAgbDate to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property lastAcceptedAgbRevisionId to the response with the 200 status

      response-optional-property-added

  • a3a5891898921See the full diff
    • ○

      added the optional property mobileNumber to the response with the 200 status

      response-optional-property-added

  • d1729646b7662See the full diff
    • ●

      added the new DATA_PROVIDER_ERROR enum value to the type response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new DATA_PROVIDER_ERROR enum value to the type response property for the response status 500

      response-property-enum-value-added

  • a598446f80932See the full diff
    • ○

      removed the DATA_PROVIDER_ERROR enum value from the type response property for the response status 404

      response-property-enum-value-removed

    • ○

      removed the DATA_PROVIDER_ERROR enum value from the type response property for the response status 500

      response-property-enum-value-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 7cee7b14bf6f2See the full diff
    • ●

      added the new DATA_PROVIDER_ERROR enum value to the type response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new DATA_PROVIDER_ERROR enum value to the type response property for the response status 500

      response-property-enum-value-added

  • 5b038eea902d8See the full diff
    • ●

      added the new OTP_EXPIRED enum value to the type response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new OTP_EXPIRED enum value to the type response property for the response status 500

      response-property-enum-value-added

    • ●

      added the new OTP_INVALID enum value to the type response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new OTP_INVALID enum value to the type response property for the response status 500

      response-property-enum-value-added

    • ●

      added the new OTP_LOCKED enum value to the type response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new OTP_LOCKED enum value to the type response property for the response status 500

      response-property-enum-value-added

    • ●

      added the new OTP_RESEND_COOLDOWN enum value to the type response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new OTP_RESEND_COOLDOWN enum value to the type response property for the response status 500

      response-property-enum-value-added

  • 0734563de56e1See the full diff
    • ○

      added the optional property userId to the response with the 200 status

      response-optional-property-added

  • 8042d371f70e1See the full diff
    • ○

      added the optional property userPreferences/hasSeenConsentRequestTourIntro to the response with the 200 status

      response-optional-property-added