User Information
Retrieve user information for 3-legged OAuth users in the practice.
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Endpoints
- Primary
For 3-legged OAuth users only, implements the Open ID Connect /userinfo protocol.
GET
/v1/{practiceid}/userinfo
The OpenID Connect UserInfo Claim
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
Output Parameters
Expand all
birthdate
string
The birthdate (YYYY-MM-DD or YYYY) of the user.
email
string
The email address of the user.
email_verified
string
family_name
string
The last name of the user.
gender
string
The gender of the user.
given_name
string
The first name of the user.
middle_name
string
The middle name or initial of the user.
name
string
The full name.
nickname
string
The nickname of the user.
phone_number
string
The preferred phone number for the user.
picture
string
For some users (e.g. patients), we support an API to the patient's picture.
preferred_username
string
Shorthand for the username. May not be unique.
providerid
string
If the user is a provider, this is their provider ID.
sub
string
The identifier for this user. Because we support multiple authentication sources, this is typically source:username (e.g. "athenanet:jsmith32")
updated_at
string
The number of seconds since the epoch when this user's info was last updated.
Example Code