...
The Org Identity Source Backend is expected to return both a raw record (directly representing the backend datasource), and a formatted record. The formatted record is expected to represent an OrgIdentity, in typical Cake array format, along with its associated Models. The Backend may return the following supported attributes:
| Attribute | Multi-valued? | Required? | Notes |
|---|---|---|---|
| Address | Yes | No | See note  below. |
| EmailAddress | Yes | No | See note below. |
| Identifier | Yes | No | Does not automatically include the unique key (SORID). See note below. |
| Name | Yes | No | At least one Name must be returned, and exactly one Name must be flagged primary. See note below. |
| OrgIdentity.affiliation | No | No | Possible values may vary by CO; see CoExtendedType::definedTypes |
| OrgIdentity.title | No | No | |
| OrgIdentity.o | No | No | |
| OrgIdentity.ou | No | No | |
| OrgIdentity.valid_from | No | No | Must be in database format, eg via strftime("%F %T", ...) |
| OrgIdentity.valid_through | No | No | Must be in database format, eg via strftime("%F %T", ...) |
| TelephoneNumber | Yes | No | See note below. |
| Info |
|---|
For multi-valued attributes, only one attribute of a given type is currently supported. For example, there can only be one Possible types may vary by CO, see |
...
Example
| Code Block | ||
|---|---|---|
| ||
$myData = array(
'OrgIdentity' => array(
'title' => 'Researcher',
'o' => 'University of Impossible Equations',
'ou' => 'Department of Timey Wimey Stuff'
),
'Name' => array(
array(
'given' => 'Pat',
'family' => 'Lee',
'type' => 'official',
'primary_name' => true
)
),
// Note below here are multi-valued arrays
'Identifier' => array(
array(
'identifier' => 'plee@university.edu',
'type' => 'eppn',
'login' => true
)
),
'EmailAddress' => array(
array(
'mail' => 'plee@university.edu',
'type' => 'official',
'verified' => true
),
array(
'mail' => 'plee@socialemail.com',
'type' => 'personal',
'verified' => false
)
)
); |
...