Jump to: navigation, search

Query identity

Description

This method retrieves a given identity.

Request

Method GET
URL /identities/${identityId}
Parameters
Name   Value Mandatory Description
${identityId} string yes Identity identifier.
include_visits
  • true
  • false
no If true, the returned identity contains the reference list of associated visits.
include_visits_detail
  • true (if include_visits=true)
  • false
no If true, the returned identity contains the associated visit resources. You can only use this parameter if include_visits is set to true.
include_sessions
  • true
  • false
no If true, the returned identity contains the reference list of authentication sessions.
include_sessions_detail
  • true (if include_sessions=true)
  • false
no If true, the returned identity contains the associated sessions. You can only use this parameter if include_sessions is set to true.
include_pages
  • true
  • false
no If true, the returned identity contains the reference list of the associated pages.
include_pages_detail
  • true (if include_pages=true)
  • false
no If true, the returned identity contains the associated pages. You can only use this parameter if include_pages is set to true.
include_events
  • true
  • false
no If true, the returned identity contains the reference list of associated events.
include_events_detail
  • true (if include_events=true)
  • false
no If true,  the returned identity contains the associated events.
You can only use this parameter if include_events is set to true.

Response

The History REST API answers with HTTP codes for every request. The following table shows the correct response for a successful request. See HTTP Response Codes and Errors for further details on the possible codes that this request can return.

HTTP code 200
HTTP Title OK
Body  JSON Identity.

Example

The following request retrieves the identity resource with the pat.thompsom@genesyslab.com ID.

Request

http://127.0.0.1:9081/server/data/identities/pat.thompsom@genesyslab.com

Response

HTTP/1.1 200 OK
Date: Wed, 12 Dec 2012 15:17:09 GMT
Content-Type: application/json; charset=UTF-8
Date: Wed, 12 Dec 2012 15:17:09 GMT
Accept-Ranges: bytes
Server: Restlet-Framework/2.1.0
Content-Length: 477
[{"eventIds":null,"events":null,"pageIds":null,"pages":null,
"sessionIds":null,"sessions":null,"identityId":"pat.thompsom@genesyslab.com",
"name":null,"location":null,"entityInCS":null,"visitScope":"Authenticated",
"visitIds":null,"visits":null}]

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on November 6, 2015, at 12:00.