descriptorIdentity.schema.md

Identity Descriptor Schema

https://ns.adobe.com/xdm/common/descriptors/descriptorIdentity

Used to mark a field as an identity.

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

Schema Hierarchy

• Identity Descriptor https://ns.adobe.com/xdm/common/descriptors/descriptorIdentity
  • Schema Descriptor https://ns.adobe.com/xdm/common/descriptors/schemadescriptor

Identity Descriptor Examples

{
  "@type": "xdm:descriptorIdentity",
  "xdm:sourceSchema": "https://ns.adobe.com/xdm/context/profile",
  "xdm:sourceVersion": 1,
  "xdm:sourceProperty": "/orgUnitId",
  "xdm:namespace": "12345",
  "xdm:property": "xdm:id"
}

{
  "@type": "xdm:descriptorIdentity",
  "xdm:sourceSchema": "https://ns.adobe.com/xdm/context/profile",
  "xdm:sourceVersion": 1,
  "xdm:sourceProperty": "/orgUnitId",
  "xdm:namespace": "AAM",
  "xdm:property": "xdm:code",
  "xdm:isPrimary": true
}

Identity Descriptor Properties

Property	Type	Required	Defined by
@id	string	Optional	Schema Descriptor
@type	const	Optional	Identity Descriptor (this schema)
xdm:isPrimary	boolean	Optional	Identity Descriptor (this schema)
xdm:namespace	string	Optional	Identity Descriptor (this schema)
xdm:property	enum	Optional	Identity Descriptor (this schema)
xdm:sourceItem	complex	Optional	Schema Descriptor
xdm:sourceProperty	complex	Optional	Schema Descriptor
xdm:sourceSchema	string	Optional	Schema Descriptor
xdm:sourceVersion	number	Optional	Schema Descriptor
*	any	Additional	this schema allows additional properties

@id

Identifier

The unique identifier for the schema descriptor. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors'.

@id

• is optional
• type: string
• defined in Schema Descriptor

@id Type

string

• format: uri-reference – URI Reference (according to RFC3986)

@type

Type

@type

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

The value of this property must be equal to:

"xdm:descriptorIdentity"

xdm:isPrimary

Is primary key or not

When present, only one field should be marked as the primary. Default is false.

xdm:isPrimary

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

xdm:isPrimary Type

boolean

xdm:namespace

Namespace

Identity ID or Code.

xdm:namespace

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

xdm:namespace Type

string

xdm:property

Property

Property of the xdm:namespace field.

xdm:property

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

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

xdm:property Known Values

Value	Description
xdm:id
xdm:code

xdm:sourceItem

Source Item

When present, the selector used to match a specific item in the array pointed to by sourceProperty.

xdm:sourceItem

• is optional
• type: complex
• defined in Schema Descriptor

xdm:sourceItem Type

One of the following conditions need to be fulfilled.

Condition 1

Condition 2

Condition 3

Condition 4

xdm:sourceProperty

Source Property

When present, the property of the source schema to which this descriptor applies. This value is a JSON Pointer, applied to an instance of an object described by xdm:sourceSchema.

xdm:sourceProperty

• is optional
• type: complex
• defined in Schema Descriptor

xdm:sourceProperty Type

One of the following conditions need to be fulfilled.

Condition 1

string

Condition 2

Array type:

All items must be of the type: string

xdm:sourceSchema

Source Schema

The source schema this descriptor applies to. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors'

xdm:sourceSchema

• is optional
• type: string
• defined in Schema Descriptor

xdm:sourceSchema Type

string

• format: uri – Uniformous Resource Identifier (according to RFC3986)

xdm:sourceVersion

Source Version

Major version being referenced.

xdm:sourceVersion

• is optional
• type: number
• defined in Schema Descriptor

xdm:sourceVersion Type

number