...
Push Mode does not support Org Identity Sync via Job Shell or at Login. Technically, no errors will be thrown, but because Push Mode does not support calling out to the System of Record, no updates will be made.
Pull Mode
Pull Mode requires the System of Record to offer an API with a predictable interface to specific records. In other words, given a specific SOR ID the API must allow for the retrieval of a specific record.
Not yet implemented.
Poll Mode
Poll Mode consumes event-oriented messages, such as those that may be placed on a Message Queue or Bus. As distinct from Pull Mode, it is typically not possible for a specific record to be retrieved on demand, but only when the System of Record sends out an update.
Not yet implemented.
Endpoints and Actions
...
returnUrl is optional, and consists of a single string containing a URL. This URL is used as a Petition-Specific Redirect Target, if API Source is connected to a Pipeline that in turn is connected to an Enrollment Flow. Make sure the returnUrl is configured in the Enrollment Flow's Return URL Whitelist configuration.
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"sorAttributes": {
"names": [
{
"type": "official",
"given": "Pat",
"middle": "X",
"family": "Lee"
}
],
"affiliation": "faculty",
"organization": "School of Philosophy and Biopharmacology",
"department": "Department of Metaphysics",
"title": "Associate Professor of Metaphysical Microbiology",
"dateOfBirth": "1990-04-25",
"validFrom": "2019-09-01T00:00:00Z",
"validThrough": "2020-08-31T23:59:59Z",
"identifiers": [
{
"type": "national",
"identifier": "541-00-3732"
}
],
"emailAddresses": [
{
"type": "personal",
"address": "patxlee@email.nil",
"verified": true
}
],
"addresses": [
{
"type": "home",
"streetAddress": "3593 Red Maple Drive",
"locality": "Los Angeles",
"region": "CA",
"postalCode": "90046",
"country": "US"
}
],
"telephoneNumbers": [
{
"type": "home",
"number": "323-555-1208"
}
],
"urls": [
{
"type": "personal",
"url": "https://metaphysics.spb.ac.nil/plee"
}
]
},
"returnUrl": "https://registry.myvo.org/localapps/post-enrollment?regid=12345"
} |
...