You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

About the Write API

This API is used to send SOR information to the Identity Registry.

XXX: Add links to core schema

Methods

SOR Person Role Added

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

Request Using Separate Person-Level and Role-Level Attributes

In this example, hrms is the SOR, X12345 is the SORID, and R98765 and R98766 are SOR Role IDs.

Response

Response

Description

201 Created

Request successfully processed

400 Bad Request

There was a problem with the data submitted

403 Forbidden

Client is attempting to post outside of its authority (eg: to the wrong SOR path)

409 Conflict

There is already a person or role with the specified identifer

The Identity Registry may return a Reference Identifier if identity match is not called separately.

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

Request Using Person-Level Attributes Expressed As Role-Level Attributes

In this example, the SOR is capable of representing Person-Level Attributes, but the Identity Registry is not.

Request Using Only Role-Level Attributes

In this example, the Identity Registry is capable of representing Person-Level Attributes, but the SOR is not.

SOR Person Role Deleted

SOR Person Role Updated

Example of SORPersonRoleAdded with Person-level attributes expressed as Role-level attributes:

{
[

Unknown macro: { SORID}

,

Unknown macro: { SORID}

]
}
Example of SORPersonRoleAdded without Person-level attributes:

{
[

Unknown macro: { ReconciledPersonID}

,

Unknown macro: { ReconciledPersonID}

]
}

  • No labels