identityitem.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/identityitem",
  "$schema": "http://json-schema.org/draft-06/schema#",
  "title": "Identity item",
  "type": "object",
  "meta:extensible": true,
  "description": "An end user identity item, to be included in an instance of `context/identitymap`.",
  "definitions": {
    "identityitem": {
      "properties": {
        "xdm:id": {
          "title": "Identifier",
          "type": "string",
          "description": "Identity of the consumer in the related namespace.",
          "meta:titleId": "identityitem##xdm:id##title##58961",
          "meta:descriptionId": "identityitem##xdm:id##description##34021"
        },
        "xdm:authenticatedState": {
          "description": "The state this identity is authenticated as for this observed ExperienceEvent.",
          "type": "string",
          "default": "ambiguous",
          "enum": ["ambiguous", "authenticated", "loggedOut"],
          "meta:enum": {
            "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."
          },
          "meta:descriptionId": "identityitem##xdm:authenticatedState##description##59181"
        },
        "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.",
          "meta:titleId": "identityitem##xdm:primary##title##78581",
          "meta:descriptionId": "identityitem##xdm:primary##description##13971"
        }
      }
    }
  },
  "allOf": [
    {
      "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
    },
    {
      "$ref": "#/definitions/identityitem"
    }
  ],
  "meta:status": "stable",
  "meta:createdDate": "2020-08-10",
  "meta:titleId": "identityitem##title##14281",
  "meta:descriptionId": "identityitem##description##85411"
}