How To: Call The Identity Hub API

With The Identity Hub REST API you can obtain information about an identity using The Identity Hub API REST API. Results are returned in JSON format.

Authentication

The Identity Hub REST API uses OAuth 2.0 Access Token to authenticate the caller.

Getting an Access Token

There are several ways to get an Access Token.

OAuth and OpenID Connect

You can use one of the available OAuth or OpenID Connect flows to get an Access Token. For more information see the specific topic.

Flow	More information
OAuth Implicit Grant	How To: Perform an OAuth 2.0 Implicit Grant
OAuth Code Grant	How To: Perform an OAuth Authorization Code Grant
OAuth Client Credentials Grant	How To: Perform OAuth Client Credentials Grant
OpenID Connect Implicit Grant	How To: Perform an OpenID Connect Implicit Grant
OpenID Connect Code Grant	How To: Perform an OpenID Connect Authorization Code Grant

WS-Federation and SAMLP

When your application uses the WS-Federation or SAMLP endpoint to authenticate users through The Identity Hub, the following claim is always returned and contains a valid Access Token:

http://schemas.u2uconsult.com/ws/2014/03/identity/claims/accesstoken

Calling an API method

There are two ways to call an API methods:

Passing the Access Token in the Authorization Header (recommended)

GET /{tenant}/api/identity/v1 
Authorization: Bearer puDWcq-4-xLwoG6y0DwZRA

Passing the Access Token as a query string parameter

Host: www.theidentityhub.com
GET /{tenant}/api/identity/v1?access_token=puDWcq-4-xLwoG6y0DwZRA