Skip to content

Latest commit

 

History

History
261 lines (145 loc) · 5.86 KB

descriptorIdentity.schema.md

File metadata and controls

261 lines (145 loc) · 5.86 KB

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 Stabilizing No Forbidden Permitted common/descriptors/identity/descriptorIdentity.schema.json

Schema Hierarchy

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

Identity Descriptor Examples

{
  "@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
}
{
  "@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"
}

Identity Descriptor Properties

Property Type Required Defined by
@id string Optional Schema Descriptor
@type const Optional Identity Descriptor (this schema)
xdm:isPrimary complex 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 string 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

@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: complex
  • defined in this schema

xdm:isPrimary Type

Unknown type ``.

{
  "title": "Is primary key or not",
  "description": "When present, only one field should be marked as the primary. Default is false.",
  "simpletype": "complex"
}

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

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

xdm:sourceProperty 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

xdm:sourceSchema Type

string

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

xdm:sourceVersion

Source Version

Major version being referenced.

xdm:sourceVersion

xdm:sourceVersion Type

number