Identity API - Getting Identity Accounts Information

This method provides information about the identity linked accounts. An indentity can have one or more linked accounts (Facebook, Microsoft Account, Google...).

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

The request

Request parameters

none

Example request

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

The response

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

Response parameters

Name Values Description
accountProviderId A string An unique identifier.
accounts An array of account information See below.
canAddAnotherAccount true or false Wether or not another account of this type can be linked to the identity.
isNonQueryable true or false Wether or not The Identity Hub can query the Account Provider for information outside of the sign-in process.
providerImageUrl An url The url of the image associated with the Account Provider.
signInUrl An url. The url that can be used to link another account of this type.

Accounts

Name Values Description
accountId A string An unique identifier.
accountPrivatePersonalIdentifier A string An unique identifier.
accountProfileUrl An url An url to the profile page of the account (e.g. Facebook page).
displayName A string The display name of this account.
emailAddress An email address The email address of the account.
pictureUrl An url. The url of the account picture (e.g. Microsoft Account picture).

Example response

            [
  {
    "accountProviderId": "78945641231231",
    "accounts": [
      {
        "accountId": "4564564564564",
        "accountPrivatePersonalIdentifier": "879465437987464",
        "accountProfileUrl": "https://www.accountprovider.com/profile/879465437987464",
        "displayName": "John Doe",
        "emailAddress": "jd@mail.com",
        "pictureUrl": "https://www.accountprovider.com/profile/pic/879465437987464.png"
      },
      {
        "accountId": "456784564312340",
        "accountPrivatePersonalIdentifier": "784136504654",
        "accountProfileUrl": "https://www.accountprovider.com/profile/7894564215456",
        "displayName": "John Doe Junior",
        "emailAddress": "jdoe@mail.com",
        "pictureUrl": "https://www.accountprovider.com/profile/pic/7894564215456.jpg"
      }
    ],
    "canAddAnotherAccount": true,
    "displayName": "Account Provider",
    "isNonQueryable": true,
    "providerImageUrl": "https://www.accountprovider.com/picture.jpg",
    "signInUrl": "https://www.theidentityhub.com/{tenant}/Profile/Home/LinkAccount/78945641231231"
  },
  {
    "accountProviderId": "895653157464654",
    "accounts": [
      {
        "accountId": "8956456451413",
        "accountPrivatePersonalIdentifier": "9897451231231",
        "accountProfileUrl": "https://www.accountprovider2.com/prof/89564135487",
        "displayName": "John Doe",
        "emailAddress": "jd@mail.com",
        "pictureUrl": "https://www.accountprovider2.com/prof/img/78456456487897.png"
      },
      {
        "accountId": "879843120505604",
        "accountPrivatePersonalIdentifier": "045407787564564",
        "accountProfileUrl": "https://www.accountprovider2.com/prof/4567890708708789",
        "displayName": "John Doe Junior",
        "emailAddress": "jdoe@mail.com",
        "pictureUrl": "https://www.accountprovider2.com/prof/img/078456405640564.jpg"
      }
    ],
    "canAddAnotherAccount": true,
    "displayName": "Account Provider",
    "isNonQueryable": true,
    "providerImageUrl": "https://www.accountprovider2.com/pic.jpg",
    "signInUrl": "https://www.theidentityhub.com/{tenant}/Profile/Home/LinkAccount/895653157464654"
  },
  }
]

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/