Identity API - Getting Identity Information

This method provides user identity information.

GET /{tenant}/api/identity/v1/{id}

The request

Request parameters

Name Values Description Required
id The identityId of the identity Instructs The Identity Hub to return the identity information of the identity matching the provided identityId. The caller must be authorized to access the identity. No (defaults to authenticated identity)

Example request

GET /{tenant}/api/identity/v1/12487978 
Authorization: Bearer 57600
Host: www.theidentityhub.com
GET /{tenant}/api/identity/v1/12487978?access_token=57600

The response

If the method call is successfull, "The Identity Hub" returns the information about the identity in JSON format.

Response parameters

Name Values Description
displayName A string The display name of the identity.
emailAddress An email address The primary email address of the identity.
emailAddresses An array of email addresses Email addresses of the identity.
emailAddressVerified true or false Wether or not the primary email address has been verified to be accessible by the identity.
givenName A string The primary given name of the identity.
givenNames An array of strings. The given names of the identity.
identityId A string An unique identifier.
isEditable true or false Wether or not the identity can edit the information coming from the Account Providers.
largePictures An array of uri The uri of the large identity pictures.
localities An array of culture identifiers. The preferred identity cultures
locality A culture identifier The primary culture identifier.
mediumPictures An array of uri The uri of the medium identity pictures.
privatePersonalIdentifier A string An unique identifier.
smallPictures An array of uri The uri of the small identity pictures.
surname A string The primary surname of the identity.
surnames An array of strings. The surnames of the identity.
userName A string An unique identifier.

Example response

{
  "displayName": "John Doe",
  "emailAddress": "JohnDoe@mail.com",
  "emailAddresses": [
    "JohnDoe@mail.com",
    "JohnDoe@mailinator.com"
  ],
  "emailAddressVerified": true,
  "givenName": "John",
  "givenNames": [
    "John",
    "John Davis"
  ],
  "identityId": "45789465489797843004",
  "isEditable": true,
  "largePictures": [
    "https://fake.url/pic1.jpg",
    "https://fake2.url/pic17.png"
  ],
  "localities": [
    "en-US",
    "nl-BE"
  ],
  "locality": "en-US",
  "mediumPictures": [
    "https://fake.url/pic7m.jpg",
    "https://fake2.url/pic29m.png"
  ],
  "privatePersonalIdentifier": "8945645642133340",
  "smallPictures": [
    "https://fake.url/pic7aas.jpg",
    "https://fake2.url/picaa9s.png"
  ],
  "surname": "Doe",
  "surnames": [
    "Doe"    
  ],
  "userName": "07894564561379874"
}

Related sections

GET {tenant}/api/identity/v1
GET {tenant}/api/identity/v1/{id}
GET {tenant}/api/identity/v1/accounts
GET {tenant}/api/identity/v1/{id}/accounts
GET {tenant}/api/identity/v1/friends
GET {tenant}/api/identity/v1/{id}/friends
GET {tenant}/api/identity/v1/roles
GET {tenant}/api/identity/v1/{id}/roles
PUT {tenant}/api/identity/v1/