Standard Attributes
Standard attributes are those "data points" defined by the PRIVO system for use. These are common data points that most Partners would use, want to consume or require during a given registration for example. Standard attribute configurations reside at the base level within the PRIVO system and are shared between all Partners. A given Partner has the ability to determine how the attribute is presented by renaming the attribute for their use. For example, a Partner may have the need to define "Display Name" as "Screen Name" instead. Standard attribute configurations allow for such a modification without affecting how another Partner would utilize the same given attribute.
Standard Attributes:
Property | Identifier | Description | Restrictions/Format |
---|---|---|---|
First Name | firstName | Represents the User | No spaces, numbers or special characters allowed |
Middle Initial | middleInitial | User's middle initial | No numbers, maximum of 4 characters. Periods allowed |
Last Name | lastName | User's given name | No numbers or special characters allowed |
Last Initial | lastInitial | First initial of User's Last Name | Rarely used. No numbers or special characters, maximum of 1 charcter. |
Birth Date | birthDate_YYYYMMDD | Represents age of the User | Must follow format YYYYMMDD |
Email Address | User's email address | Must be proper email with @ and .xx(x) | |
Parental Email Address | parentEmail | Email address of Parent when registering a child | Must be proper email with @ and .xx(x) |
Gender | gender | Sex of the User | Dependent on API may be enumerated as 1,2 OR given as Male, Female |
Mobile Phone | mobilePhone | User's cell phone number | 7 to 10 numbers, no hyphens |
Home Phone Number | address.homePhoneNumber | User's home phone number | 7 to 10 numbers, no hyphens |
Street Address | address.streetAddress1 | User's street number and name | Open field |
Apartment/Suite | address.streetAddress2 | User's suite or apartment number | Open field |
City | address.city | User's city | Open field |
State/Province | address.stateProvince | User's state or province | 2 letters for US, oopen for INTL. |
Region | address.region | User's region | INTL. only. Open field |
Postal Code | address.postalCode | User's postal code | 5 digits for US, open for INTL. |
Country | address.country | User's country | 2 letters e.g. US |
Display Name | displayName | Name that displays in a service | Unique to the given service. Can be used for login to given service |
Username | userName | Username used for authentication | Unique to the entire system |