Skip to content

JSON Structure of an HID user account

Chris Ruppel edited this page Oct 1, 2021 · 6 revisions

Below is the structure of an HID user account, as it is provided by the API when you request a specific user via authenticated request to /account.json during OpenID Connect operations.

{
  // HID internal ID of a user (same as sub)
  "id": "58e493063f0e0d00beec0b82",

  // OIDC standard claim. Use this attribute to uniquely identify an HID user.
  "sub": "58e493063f0e0d00beec0b82",

  // OIDC standard claim
  "email": "john@doe.com",
  // OIDC standard claim
  "email_verified": "true",

  // OIDC standard claim
  "name": "John Doe",

  // OIDC required property.
  "iss": "https://auth.humanitarian.id"
}

For a list of OpenID Connect standard claims: https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims