Skip to content

Latest commit

 

History

History
153 lines (91 loc) · 4.06 KB

identity.schema.md

File metadata and controls

153 lines (91 loc) · 4.06 KB
Raw

Identity Schema

https://ns.adobe.com/xdm/context/identity

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.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stable No Forbidden Permitted datatypes/identity.schema.json

Schema Hierarchy

Identity Examples

{
  "xdm:id": "id123",
  "xdm:namespace": {
    "xdm:code": "AA12345"
  },
  "xdm:authenticatedState": "ambiguous"
}
{
  "xdm:id": "someone@example.com",
  "xdm:namespace": {
    "xdm:code": "Email"
  }
}

Identity Properties

Property Type Required Default Defined by
xdm:authenticatedState enum Optional "ambiguous" Identity item
xdm:id string Optional Identity item
xdm:namespace Namespace Optional Identity (this schema)
xdm:primary boolean Optional false Identity item
xdm:xid string Optional Identity (this schema)
* any Additional this schema allows additional properties

xdm:authenticatedState

The state this identity is authenticated as for this observed ExperienceEvent.

xdm:authenticatedState

  • is optional
  • type: enum
  • default: "ambiguous"
  • defined in Identity item

The value of this property must be equal to one of the known values below.

xdm:authenticatedState Known Values

Value Description
ambiguous Ambiguous
authenticated User identified by a login or similar action that was valid at the time of the event observation.
loggedOut User was identified by a login action at some point of time previously, but is not currently logged in.

xdm:id

Identifier

Identity of the consumer in the related namespace.

xdm:id

xdm:id Type

string

xdm:namespace

Namespace

The namespace associated with the xid attribute and matched up with the AAM data source integration code.

xdm:namespace

  • is optional
  • type: Namespace
  • defined in this schema

xdm:namespace Type

  • Namespace – https://ns.adobe.com/xdm/context/namespace

xdm:primary

Primary

Indicates this identity is the preferred identity. Is used as a hint to help systems better organize how identities are queried.

xdm:primary

  • is optional
  • type: boolean
  • default: false
  • defined in Identity item

xdm:primary Type

boolean

xdm:xid

Experience identifier

When present, experience identifier value represents a cross-namespace identifier that is unique across all namespace-scoped identifiers in all namespaces.

xdm:xid

  • is optional
  • type: string
  • defined in this schema

xdm:xid Type

string