Skip to content

Latest commit

 

History

History
96 lines (58 loc) · 2.65 KB

identityitem.schema.md

File metadata and controls

96 lines (58 loc) · 2.65 KB
Raw

Identity item Schema

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

An end user identity item, to be included in an instance of context/identitymap.

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

Schema Hierarchy

  • Identity item https://ns.adobe.com/xdm/context/identityitem

Identity item Example

{
  "xdm:id": "id123",
  "xdm:authenticatedState": "ambiguous"
}

Identity item Properties

Property Type Required Default Defined by
xdm:authenticatedState enum Optional "ambiguous" Identity item (this schema)
xdm:id string Optional Identity item (this schema)
xdm:primary boolean Optional false Identity item (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 this schema

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

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

xdm:id Type

string

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 this schema

xdm:primary Type

boolean