List all identities in a cluster
Identities that are related in an identity graph, regardless of namespace, are considered to be part of the same “cluster” in that identity graph. The options below provide the means to access all cluster members.
Get associated identities for a single identity
Retrieve all cluster members for a single identity.
You can use the optional graph-type
parameter to indicate the identity graph to get the cluster from. Options are:
- None - Perform no identity stitching.
- Private Graph - Perform identity stitching based on your private identity graph. If no
graph-type
is provided, this is the default.
API format
GET https://platform-{REGION}.adobe.io/data/core/identity/cluster/members?{PARAMETERS}
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/cluster/members?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/cluster/members?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/cluster/members?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 associated identities for multiple identities
Use POST
as a batch equivalent of the GET
method described above to return the identities in the clusters of multiple identities.
API format
POST https://platform-{REGION}.adobe.io/data/core/identity/clusters/members
Request
The following request demonstrates supplying a list of XIDs for which to retrieve cluster members.
Stub request
Usage of x-uis-cst-ctx: stub
header will return a stubbed response. This is a temporary solution to facilitate early integration development progress, while services are being completed. This will be deprecated when no longer needed.
curl -X POST \
https://platform-va7.adobe.io/data/core/identity/clusters/members \
-H 'authorization: Bearer {ACCESS_TOKEN}' \
-H 'content-type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-uis-cst-ctx: stub' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '{
"xids": ["GYMBWaoXbMtZ1j4eAAACepuQGhs","b2NJK9a5X7x4LVE4rUqkMyM"]
}'
Call using XIDs
curl -X POST \
https://platform-va7.adobe.io/data/core/identity/clusters/members \
-H 'authorization: Bearer {ACCESS_TOKEN}' \
-H 'content-type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '{
"xids": ["GYMBWaoXbMtZ1j4eAAACepuQGhs","b2NJK9a5X7x4LVE4rUqkMyM"],
"graph-type": "Private Graph"
}' | json_pp
Call using UIDs
curl -X POST \
https://platform-va7.adobe.io/data/core/identity/clusters/members \
-H 'authorization: Bearer {ACCESS_TOKEN}' \
-H 'content-type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '{
"compositeXids": [{
"nsid": 411,
"id": "WRbM7AAAAJ_PBZHl"
},
{
"nsid": 411,
"id": "WY-RNgAAArI4rGBo"
}
],
"graph-type": "Private Graph"
}' | json_pp
Response
‘Stubbed’ response
{
"version": 1,
"clusters": [{
"xid": "GZsBQnHQaGtL46ZKSvO9bNRE1DcUyQA",
"compositeXid": {
"nsid": 411,
"id": "WRbM7AAAAJ_PBZHl"
},
"members": ["e8138f65-d3d3-4485-a7e1-6712e047349d", "21312343536983537571245438594"],
"members": [{
"nsid": 0,
"id": "27064814400205787570627663430729680462"
},
{
"nsid": 411,
"id": "86826386186182763871263871263876128612"
}
]
},
{
"xid": "CJsDEAMaEAHmCKwPCQYNvzxD9JGDHZ8",
"compositeXid": {
"nsid": 411,
"id": "WRbM7AAAAJ_PBZHl"
},
"members": [],
"members": []
}
],
"unprocessedXids": ["cb0665db616f49758713252d8a335c1e"],
"unprocessedNids": [{
"nsid": 411,
"id": "WY-RNgAAArI4rGBo"
}]
}
Full response
{
"unprocessedXids": [],
"unprocessedNids": [],
"version": "1.0.0",
"clusters": [{
"xid": "411|WRbM7AAAAJ_PBZHl",
"members": [
"411|WRbM7AAAAJ_PBZHl",
"0|47713142741924778930324734610798294416"
],
"compositeXid": {
"nsid": 411,
"id": "WRbM7AAAAJ_PBZHl"
},
"members": [{
"nsid": 411,
"id": "WRbM7AAAAJ_PBZHl"
},
{
"nsid": 0,
"id": "47713142741924778930324734610798294416"
}
]
},
{
"xid": "411|WY-RNgAAArI4rGBo",
"compositeXid": {
"nsid": 411,
"id": "WY-RNgAAArI4rGBo"
},
"members": [
"411|WY-RNgAAArI4rGBo",
"411|WY-RNgAAArI4rGGy"
],
"members": [{
"nsid": 411,
"id": "WY-RNgAAArI4rGBo"
},
{
"nsid": 411,
"id": "WY-RNgAAArI4rGGy"
}
]
}
]
}
Next steps
Proceed to the next tutorial to list the cluster history of an identity