identity.schema.json

{
  "meta:license": [
    "Copyright 2017 Adobe Systems Incorporated. All rights reserved.",
    "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license",
    "you may not use this file except in compliance with the License. You may obtain a copy",
    "of the License at https://creativecommons.org/licenses/by/4.0/"
  ],
  "$id": "https://ns.adobe.com/xdm/context/identity",
  "$schema": "http://json-schema.org/draft-06/schema#",
  "title": "Identity",
  "type": "object",
  "meta:extensible": true,
  "description":
    "Identity is used to clearly distinguish people that are interacting with digital experiences. Identity is established by an identity provider, which itself is referenced in the `namespace` attribute. Within each `namespace`, the identity is unique.",
  "definitions": {
    "identity": {
      "properties": {
        "xdm:id": {
          "title": "Identifier",
          "type": "string",
          "description": "Identity of the consumer in the related namespace."
        },
        "xdm:namespace": {
          "title": "Namespace",
          "$ref": "https://ns.adobe.com/xdm/context/namespace",
          "description":
            "The namespace associated with the `xid` attribute and matched up with the AAM data source integration code."
        },
        "xdm:xid": {
          "title": "Experience Identifier",
          "type": "string",
          "description":
            "When present, this value represents a cross-namespace identifier that is unique across all namespace-scoped identifiers in all namespaces."
        },
        "xdm:primary": {
          "title": "Primary",
          "type": "boolean",
          "default": false,
          "description":
            "Indicates this identity is the preferred identity. Is used as a hint to help systems better organize how identities are queried."
        }
      }
    }
  },
  "allOf": [
    {
      "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
    },
    {
      "$ref": "#/definitions/identity"
    }
  ],
  "meta:status": "stabilizing"
}