...
Connection HTTP Interface via http://www.example.org/api/connection/personaidentifier.
REST HTTP Interface via http://www.example.org/api/v2/personaidentifier.
Upsert HTTP Interface via http://www.example.org/api/v2/personaidentifier/upsert.
SCHEMA
Name | Description |
|---|---|
_id | The id of this identifier. |
organisation | The id of the organisation this identifier belongs to. |
persona | The id of the persona this identifier belongs to. |
ifi | A representation of the inverse functional identifier. |
EXAMPLE
| Code Block |
|---|
{
"_id" : "59c1219936229d4ce9634601",
"organisation" : "59c1219936229d4ce9634602",
"persona": "59c1219936229d4ce9634603",
"ifi": {
"key": "account",
"value": {
"homePage": "http://www.example.org",
"name": "example-user"
}
}
}
|
INVERSE FUNCTIONAL IDENTIFIER
According to the xAPI specification, an Inverse Functional Identifier (IFI) is “a value of an Agent or Identified Group that is guaranteed to only ever refer to that Agent or Identified Group”.
SCHEMA
Name | Description |
|---|---|
key | The type of IFI (account, mbox, mbox_sha1sum, or openid). |
value | The value of the IFI. |
ACCOUNT IFI
| Code Block |
|---|
{
"key": "account",
"value": {
"homePage": "http://www.example.org",
"name": "example-user"
}
}
|
MBOX IFI
| Code Block |
|---|
{
"key": "mbox",
"value": "mailto:user@example.org"
}
|
MBOX SHA1SUM IFI
| Code Block |
|---|
{
"key": "mbox_sha1sum",
"value": "cc1e39b02974c5d21e792d7febcaa6018bb6c574"
}
|
OPENID IFI
| Code Block |
|---|
{
"key": "openid",
"value": "http://www.example.org/example-user"
}
|
UPSERT HTTP INTERFACE
This interface creates or updates a persona identifier depending on whether the IFI already exists.
...