List identity mappings
A mapping is a collection of all identities in a cluster, for a specified namespace.
Get an identity mapping for a single identity
Given an identity, retrieve all related identities from the same namespace as that represented by the identity in the request.
API format
GET https://platform-{REGION}.adobe.io/data/core/identity/mapping
Request
Option 1: Supply the identity as namespace (nsId, by ID) and ID value (id).
curl -X GET \
'https://platform-va7.adobe.io/data/core/identity/mapping?nsId=411&id=WTCpVgAAAFq14FMF' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Option 2: Supply the identity as namespace (ns, by name) and ID value (id).
curl -X GET \
'https://platform-va7.adobe.io/data/core/identity/mapping?ns=AMO&id=WTCpVgAAAFq14FMF' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Option 3: Supply the identity as XID (xid). For more on how to obtain an identity’s XID, see the section of this document covering getting the XID for an identity.
curl -X GET \
'https://platform-va7.adobe.io/data/core/identity/mapping?xid=CJsDEAMaEAHmCKwPCQYNvzxD9JGDHZ8' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Get identity mappings for multiple identities
Use the POST method as a batch equivalent of the GET method described above to retrieve mappings for multiple identities.
API format
POST https://platform.adobe.io/data/core/identity/mappings
Request body
Option 1: Supply a list of XIDs for which to retrieve mappings.
{
"xids": ["GYMBWaoXbMtZ1j4eAAACepuQGhs","b2NJK9a5X7x4LVE4rUqkMyM"],
"graph-type": "Private Graph"
}
Option 2: Supply a list of identities as composite IDs, where each names the ID value and namespace by namespace ID. This example demonstrates using this method while overwriting the default graph-type of “Private Graph”.
{
"compositeXids": [{
"nsid": 411,
"id": "WRbM7AAAAJ_PBZHl"
},
{
"nsid": 411,
"id": "WY-RNgAAArI4rGBo"
}
],
"graph-type": "None"
}
Request
Using XIDs
curl -X POST \
https://platform-va7.adobe.io/data/core/identity/mappings \
-H 'authorization: Bearer {ACCESS_TOKEN}' \
-H 'content-type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: 111111@AdobeOrg' \
-d '{
"xids": ["GesCQXX0CAESEE8wHpswUoLXXmrYy8KBTVgA"],
"targetNs": "0",
"graph-type": "Private Graph"
}' | json_pp
Using UIDs
curl -X POST \
https://platform-va7.adobe.io/data/core/identity/mappings \
-H 'authorization: Bearer {ACCESS_TOKEN}' \
-H 'content-type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: 111111@AdobeOrg' \
-d '{
"compositeXids": [{
"nsid": 411,
"id": "WRbM7AAAAJ_PBZHl"
},
{
"nsid": 411,
"id": "WY-RNgAAArI4rGBo"
}
],
"targetNs": "0",
"graph-type": "Private Graph"
}' | json_pp
If no related identities were found with the provided input, an HTTP 204 response code is returned with no content.
Response
{
"version": 1,
"mappings": [{
"xid": "CAESEPl1uYyma1kMDWxx7dhbwGo",
"mapping": [{
"xid": "81218968060697815473313992060878182012",
"lastAssociationTime": "1493310475047"
}],
"compositeXid": {
"nsid": 411,
"id": "WY-RNgAAArI4rGBo"
},
"mapping": [{
"compositeXid": {
"nsid": 411,
"id": "WY-RNchvdsTSJS"
},
"lastAssociationTime": "1493310475047"
}],
"regions": [{
"regionId": "10",
"lastAssociationTime": "1493310475047"
}]
}],
"unprocessedXids": ["cb0665db616f49758713252d8a335c1e"],
"unprocessedNids": [{
"nsid": 411,
"id": "WY-RNgAAArI4rGBo"
}]
}
lastAssociationTime: The timestamp when the input identity was last associated with this identity.regions: Provides theregionIdandlastAssociationTimefor where the identity was seen.
Next steps
Proceed to the next tutorial to list available namespaces.