Note |
---|
This document is based on an early draft by Benn Oshrin (internet2.edu) |
There are no required attributes from the perspective of the Core Schema. It is up to a given protocol or implementation to determine what attributes are required, and how such status is conveyed between participants.
...
Code Block |
---|
{ "identifiers":[ { "type":"enterprise", "value":"E12345678", }, { "type":"network", "value":"jqs123" } ] } |
Attribute
...
Data Types
- binary
- boolean
- country: ISO 3166-1 two letter country code
- date: YYYY-MM-DD format (ISO 8601)
- dateTerm: A datestamp used to indicate intervals such as a semester, trimester, or quarter. The general format is YYYY-L#, where L is one of H (half year), T (third), or Q (quarter), and # is the sequential number. eg: 2015-H2 designates the second semester of the 2015 academic year (and so might physically be in the year 2016).
- dateTime: YYYY-MM-DDTHH:MM:SSZ
Attribute Release Policies are encoded in metadata, as described below. The following policies are defined:
public
: The attribute and value may be used without restriction.internal
: The attribute and value are to be used for official institutional purposes only, and may not be redistributed without permission.private
: The attribute and value may not be used for any purpose without permission.
Attribute Data Types
- binary
- boolean
- country: ISO 3166-1 two letter country code
- date: YYYY-MM-DD format (ISO 8601)
- dateTerm: A datestamp used to indicate intervals such as a semester, trimester, or quarter. The general format is YYYY-L#, where L is one of H (half year), T (third), or Q (quarter), and # is the sequential number. eg: 2015-H2 designates the second semester of the 2015 academic year (and so might physically be in the year 2016).
- dateTime: YYYY-MM-DDTHH:MM:SSZ format (ISO 8601)
- integer
- locale: LL_CC format (ISO 639-1 two letter language code, an underscore, ISO 3166-1 two letter country code)
- region: ISO 3166-2 subdivision code, not including country prefix (eg:
BC
notCA-BC
) - string: Strings are case-preserving but not case-sensitive
- extensibleVocabulary: The Core Schema vocabulary should be supported when described values are relevant, however implementations may add to the vocabulary. How supported values are conveyed between participants is outside of the scope of this document. Extended vocabulary must begin with
x-
.
Case Sensitivity
All attribute names and other elements specified here are case sensitive. eg: official
and OFFICIAL
are not the same.
Metadata
Any complex attribute (Person, Person Role, Address, Identifier, etc) may optionally have the following meta attributes:
...
- integer
- locale: LL_CC format (ISO 639-1 two letter language code, an underscore, ISO 3166-1 two letter country code)
- region: ISO 3166-2 subdivision code, not including country prefix (eg:
BC
notCA-BC
) - string: Strings are case-preserving but not case-sensitive
- extensibleVocabulary: The Core Schema vocabulary should be supported when described values are relevant, however implementations may add to the vocabulary. How supported values are conveyed between participants is outside of the scope of this document. Extended vocabulary must begin with
x-
.
Case Sensitivity
All attribute names and other elements specified here are case sensitive. eg: official
and OFFICIAL
are not the same.
...
Person Core Attributes
Attribute | Data Type | Definition | Multi-Valued? (Parent Attribute) |
---|---|---|---|
| Yes ( | ||
| country | Country from a postal address | One per parent object |
| string | Address rendered as a single string, possibly with embedded newlines ( | One per parent object |
| string | Locality information from a postal address (city, etc) | One per parent object |
| locale | The language encoding of the address | One per parent object |
| string | Postal code from a postal address | One per parent object |
| region | Region information from a postal address (state, province, etc) | One per parent object |
| string | Room information from a postal address | One per parent object |
Changing to | string (multi-line) | Street/site information from a postal address (street name, house number, etc) | One per parent object |
| extensibleVocabulary:
| The type of the address | One per parent object |
| boolean | True if the address has been verified | One per parent object |
| country | Country of citizenship of the person | Yes ( |
| date | The date of birth of the person | No |
| Yes ( | ||
| string | The email address | One per parent object |
| extensibleVocabulary:
| The type of the email address | One per parent object |
| boolean | True if the address has been verified | One per parent object |
| extensibleVocabulary:
| The ethnicity of the person (US Census) | Yes ( |
| extensibleVocabulary:
| The gender of the person | No |
| Yes ( | ||
| string | The identifier | One per parent object |
identifier/authority | string | The system or authority that assigns and manges this identifier | One per parent object |
| extensibleVocabulary:
| The type of the identifier
| One per parent object |
| Yes ( | ||
| date | Date of birth, as confirmed on document | One per parent object |
| string | Name of agency issuing the confirmation document | One per parent object |
| extensibleVocabulary:
| Type of document used to confirm identity
| One per parent object |
| string | Full name, as confirmed on document | One per parent object |
| extensibleVocabulary:
| Status of the identity proofing | One per parent object |
| dateTime | Time document was confirmed | One per parent object |
| string | Address, as confirmed on document | One per parent object |
| Yes ( | ||
| string | The component of the person's name excluding the given, middle, and honorific components | One per parent object |
| string | The person's name, suitably formatted for display | One per parent object |
| string | The component of the person's name excluding the middle, family, and honorific components | One per parent object |
| locale | The language encoding of the person's name | One per parent object |
| string | The component of the person's name excluding the given, family, and honorific components | One per parent object |
| string | The honorific prefix of the person's name, such as "Dr" or "Ms" | One per parent object |
| string | The honorific suffix of the person's name, such as "Jr" or "III" | One per parent object |
| extensibleVocabulary:
| The type of the name
| One per parent object |
| Yes ( | ||
| binary | Encoding of a photo of the person | One per parent object |
| extensibleVocabulary:
| The encoding used for the photo | One per parent object |
| extensibleVocabulary:
| The type of the photo (not the encoding)
| One per parent object |
| string | The primary affiliation for the person, as defined by the institution (values same as for Person Role affiliation attribute, below) | No |
| string | The primary campus location for the person, as defined by the institution | No |
| Parent attribute for Role attributes, described below | Yes | |
| Yes ( | ||
| string | Telephone number for the person, preferably in + notation | One per parent object |
| extensibleVocabulary:
| The type of the telephone number | One per parent object |
| boolean | True if the telephone number has been verified | One per parent object |
| boolean | True if this record represents a test entry | No |
| Yes ( | ||
| string | URL for the person | One per parent object |
| extensibleVocabulary:
| The type of the telephone number | One per parent object |
| extensibleVocabulary:
| Visa status of the person | No |
...