We’ve migrated our documentation to a new site, which means some URLs have changed.
Audience

/profile/user/external/link/list

Retrieves a list of mappings for a given customer prefix and (optionally) customer-defined identifier.

The user must be authenticated and have read permissions to a sitegroup with the customer prefix registered.

Request

The request object has the following fields:

Name

Type

Required

Description

type

String

Yes

The customer-specific identifier type as registered with Cxense, i.e. a

customer prefix

.

id

String

No

The customer-defined identifier for the user.

Response

The response object has the following fields:

Name

Type

Description

identities

Array of IdentityMappings

All identity mappings matching the request

IdentityMapping object

Name

Type

Description

type

String

The type of identifier - equal to the type parameter from the request.

id

String

The customer-defined identifier for the user.

cxid

String

The Cxense-specific user identifier, either an internal cross-site user id returned from an API such as

/traffic/data

, or a site-specific id obtained from cX.getUserId() function call from cx.js.

Examples

Bash
python cx.py /profile/user/external/link/list '{"type":"alm", "id":"asdfaf3qf34f31"}'
{
 "identities":[
 {
 "id":"asdfaf3qf34f31",
 "cxid":"1234123",
 "type":"alm"
 },
 {
 "id":"asdfaf3qf34f31",
 "cxid":"23412341234",
 "type":"alm"
 }
 ]
}
Bash
python cx.py /profile/user/external/link/list '{"type":"alm"}'
{ 
 "identities":[
 { 
 "id":"asdfaf3qf34f31", 
 "cxid":"1234123", 
 "type":"alm" 
 }, 
 { 
 "id":"asdfaf3qf34f31", 
 "cxid":"23412341234", 
 "type":"alm" 
 },
 { 
 "id":"abababab", 
 "cxid":"89181828", 
 "type":"alm" 
 }
 ]
}

Last updated: