documentation

Patient Vault v3 API

User / Myself

/v2/user/myself endpoint reference.

URL: https://demo.1health.io/api/v2/user/myself

No description available in the API specification.

Endpoints

EndpointMethodDescription
/v2/user/myselfGETRetrieve the info of the logged in user.

GET/v2/user/myself

Retrieve the info of the logged in user.

Overview

No description available in the API specification.

Authorization

Bearer JWT required. See the authentication guide.

Responses

200 OK

Successful retrieval of the logged in user's information.

DTO: OneHealthUserDTO

{
  "id": 1001,
  "keycloakId": "example-value",
  "username": "example-value",
  "firstName": "example-value",
  "lastName": "example-value",
  "phoneNumber": "example-value",
  "email": "example-value",
  "enabled": true,
  "emailVerified": true,
  "isMta": true,
  "roles": [
    "example-value"
  ],
  "groups": [
    {}
  ],
  "timeZone": "example-value",
  "locale": "example-value",
  "preferredLanguage": "example-value",
  "birthDate": "2024-01-15",
  "possibleEnglishCommunication": true,
  "personId": 1001,
  "race": "example-value",
  "ethnicity": "example-value",
  "middleName": "example-value",
  "namePrefix": "example-value",
  "nameSuffix": "example-value",
  "otherNames": "example-value",
  "titles": "example-value",
  "cityOfBirth": "example-value",
  "biologicalGender": "example-value",
  "genderIdentity": "example-value",
  "hashCode": "example-value",
  "locations": [
    {}
  ],
  "receiveNotifications": true,
  "signature": {},
  "sexualOrientation": "example-value",
  "socialSecurityNumber": "example-value"
}
FieldTypeNullableDescription
idLongYes
keycloakIdStringYes
usernameStringYes
firstNameStringYes
lastNameStringYes
phoneNumberStringYes
emailStringYes
enabledBooleanYes
emailVerifiedBooleanYes
isMtaBooleanYes
rolesSetYes
groupsSetYes
timeZoneStringYes
localeStringYes
preferredLanguageStringYes
birthDateLocalDateYes
possibleEnglishCommunicationBooleanYes
personIdLongYes
raceStringYes
ethnicityStringYes
middleNameStringYes
namePrefixStringYes
nameSuffixStringYes
otherNamesStringYes
titlesStringYes
cityOfBirthStringYes
biologicalGenderStringYes
genderIdentityStringYes
hashCodeStringYes
locationsListYes
receiveNotificationsBooleanYes
signatureIdNameDTOYes
sexualOrientationStringYes
socialSecurityNumberStringYes

Example

curl -X GET "https://demo.1health.io/api/v2/user/myself" \
  -H "Authorization: Bearer $TOKEN"

Parent: https://agents.1health.io/public/demo/api/v2/agents.md · Site guide: https://agents.1health.io/public/demo/api/agents.md