eedm.persons-credentials.v11.0.persons-credentials.json Maven / Gradle / Ivy

Go to download
{
  "title" : "Persons Credentials",
  "description" : "A subset of person's data, including only their credentials.",
  "type" : "object",
  "properties" : {
    "id" : {
      "title" : "ID",
      "description" : "A global identifier of a person.",
      "type" : "string",
      "format" : "guid",
      "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
    },
    "credentials" : {
      "title" : "Credential",
      "description" : "Information that identifies a user to a system such as a network or computer.",
      "type" : "array",
      "items" : {
        "type" : "object",
        "properties" : {
          "type" : {
            "title" : "Type",
            "description" : "The type of credential, such as \"Person ID\" or \"System ID\".",
            "enum" : [ "ssn", "sin", "bannerId", "colleaguePersonId", "elevateId", "bannerSourcedId", "bannerUserName", "bannerUdcId", "colleagueUserName" ],
            "type" : "string"
          },
          "value" : {
            "title" : "Value",
            "description" : "The current value of the credential.",
            "type" : "string",
            "minLength" : 1
          },
          "startOn" : {
            "title" : "Start Date",
            "description" : "The date when the credential starts being valid.",
            "oneOf" : [ {
              "type" : "string",
              "format" : "date-time",
              "pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?$"
            }, {
              "type" : "string",
              "maxLength" : 0
            } ]
          },
          "endOn" : {
            "title" : "End Date",
            "description" : "The date when the credential stops being valid.",
            "oneOf" : [ {
              "type" : "string",
              "format" : "date-time",
              "pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?$"
            }, {
              "type" : "string",
              "maxLength" : 0
            } ]
          }
        },
        "additionalProperties" : false,
        "required" : [ "type", "value" ]
      }
    },
    "metadata" : {
      "$ref" : "resource:/eedm/metadata.json"
    }
  },
  "required" : [ "id" ],
  "additionalProperties" : false,
  "links" : [ {
    "rel" : "filter",
    "encType" : "application/x-www-form-urlencoded",
    "method" : "GET",
    "href" : "/persons-credentials?filter={\"credentials\":[{\"type\":$type,\"value\":$value}]}",
    "title" : "Credentials",
    "description" : "Filter based on value and type in credentials",
    "schema" : {
      "type" : "object",
      "properties" : {
        "credentials" : {
          "type" : "array",
          "items" : {
            "type" : "object",
            "properties" : {
              "type" : {
                "enum" : [ "ssn", "sin", "bannerId", "colleaguePersonId", "elevateId", "bannerSourcedId", "bannerUserName", "bannerUdcId", "colleagueUserName" ],
                "type" : "string"
              },
              "value" : {
                "type" : "string"
              }
            },
            "additionalProperties" : false,
            "required" : [ "type", "value" ]
          }
        }
      }
    },
    "targetSchema" : {
      "$ref" : "persons-credentials.json#"
    }
  } ]
}