Internet2 is investigating a security incident involving a compromise to a confluence server that affected https://spaces.at.internet2.edu on April 10, 2019, which was successfully mitigated on April 12, 2019. If you did not receive an email from us, it’s unlikely that any of the content you submitted to the Internet2 Spaces Wiki needs to be re-entered. We apologize for any inconvenience this may have caused. Should you have any questions or require further assistance, please email collaboration-support@internet2.edu.
Child pages
  • TIER API: Basic Person Management Operations
Skip to end of metadata
Go to start of metadata

TBD: Create Swagger Specification for These Operations

System of Record (SOR) Person Role Added

It is up to the Identity Registry to determine how to map the provided attributes to its internal data model.

In these examples, hrms is the SOR, X12345 is the SORID, and R98765 and R98766 are SOR Role IDs. (warning) The SOR Role ID must be unique for the SOR Person, but need not be unique across all SOR Roles.

Request Using Separate Person-Level and Role-Level Attributes
PUT .../v1/SorPerson/hrms:X12345

{
  "sorAttribute":
  {
    "names":[
      {
        "type":"official",
        "given":"Pat",
        "family":"Lee"
      }
    ],
    "dateOfBirth":"1983-03-18"
  }
}

PUT /v1/SorPerson/hrms:X12345/Role/id:R98765

{
  "sorAttributes":
  {
    "title":"Professor of Phrenology"
    "percentTime":"50%"
  }
}

PUT /v1/SorPerson/hrms:X12345/Role/id:R98766

{
  "sorAttributes":
  {
    "title":"Administrative Assistant"
    "percentTime":"20%"
  }
}
Response

Response

Description

201 Created

Request successfully processed

400 Bad Request

There was a problem with the data submitted

401 Unauthorized

Authentication required

403 Forbidden

Client is attempting to operate outside of its authority (eg: to the wrong SOR path); Optional – server may return 401 Unauthorized instead

500 Other Error

Unknown error

The Identity Registry may return a Reference Identifier URL if identity match is not called separately. (The other ID Match responses may apply, as well.)

201 Created

{
  "referenceId":"https://.../SorPeople/reference:542c6076-31f1-47f7-8d47-0e0dd7366293"
}

Additional attributes, such as identifiers, may also be returned, or may be returned instead.

201 Created

{
  "referenceId":"M225127891",
  "identifiers":[
    {
      "identifier":"pl53",
      "type":"network"
    }
  ],
  "emailAddresses":[
    {
      "address":"pat.lee@university.edu",
      "type":"official"
    }
  ]
}