This method provides information about the friends of the identities. The friends of the identity are other identities this identity is friend with through one or more linked accounts. For example friends on Facebook, Google....
| Name | Values | Description | Required |
|---|---|---|---|
| id | The identityId of the identity | Instructs The Identity Hub to return the friends of the identity matching the provided identityId. The caller must be authorized to access the identity. | No (defaults to authenticated identity) |
| offset | A page number | Instructs The Identity Hub to skip a number of pages of results. The page size equals the 'limit' parameter. | No (default 0) |
| limit | A number | The maximum number of results to return. Is also the page size. | No (default 500) |
GET /{tenant}/api/identity/v1/1457897987/friends?offset=2&limit=200
Authorization: Bearer 57600
Host: www.theidentityhub.comGET /{tenant}/api/identity/v1/1457897987/friends?access_token=57600&offset=2&limit=200If the method call is successfull, "The Identity Hub" returns the information about the friends of the identity in JSON format.
| Name | Values | Description |
|---|---|---|
| displayName | A string | The display name of the identity's friend. |
| identityId | A string | An unique identifier. |
| largePictures | An array of uri | The uri of the large pictures of the identity's friend. |
| mediumPictures | An array of uri | The uri of the medium pictures of the identity's friend. |
| smallPictures | An array of uri | The uri of the small pictures of the identity's friend. |
{
"displayName": "Jane Doe",
"identityId": "45784564567897",
"largePictures": [
"https://fake.url/pic45645.jpg",
"https://fake2.url/pic14447.png"
],
"mediumPictures": [
"https://fake.url/pic547m.jpg",
"https://fake2.url/pic25459m.png"
],
"smallPictures": [
"https://fake.url/pic7adddas.jpg"
],
}