Page History

...

CO Person Read API

The CO Person Read API creates is a collection of two APIs that create a consolidated view of most attributes associated with a CO Person, including

• CoGroupMember
• CoPersonRole
  • Address
  • AdHocAttribute
  • TelephoneNumber
• EmailAddress
• Identifier
• Name
• OrgIdentity
  • Address
  • EmailAddress
  • Identifier
  • Name
  • TelephoneNumber
  • Url
• Url
• Authenticators
• Clusters

The data returned by the Index API can be configured via the Response Type configuration:

• Full Profile: All available attributes (defined above) are returned.
• Identifier Only: Only the Identifier of the configured type is returned. The full record may be obtained using the Read API.

Read API Endpoint

Index API Endpoint

Message Format

The response is a JSON document as described by this JSON Schema.

Identifier via Query Parameter

As of Registry v4.1.0, identifiers may be provided to the read API via query parameters. Effectively, all read requests will be treated as Index operations, though when an identifier is provided at most one record will be returned.

GET https://$SERVER/registry/api/co/<coid>/core/v1/people?identifier=<foo>

CO Person Write API

The CO Person Write API is a collection of three APIs allow creation, updating, and deletion of CO Person records.

...

.

The Create and Update APIs accept the same attributes as returned by the Read API. Note that most metadata returned by the Read API is not permitted (and will be ignored) in the Write API. The exception is the sub-element id, which when present is used to indicated the update of an existing sub-element (such as an EmailAddress) rather than the creation of a new one.

The behavior of the Delete API can be configured via the Core API configuration. If Expunge on Delete is enabled, a Delete action will be treated as if the record were Expunged via the UI. Otherwise, all CoPersonRoles and the CoPerson record itself will be set to Deleted status.

Create API Endpoint

Delete API Endpoint

Update API Endpoint

Message Format

For the Create and Update APIs, the request is sent with Content-Type of application/json with a body containing a JSON document as described by this JSON Schema. An empty body or document is not valid for Create or Update. There is no request body for the Delete API.

The Create request will include the newly assigned Identifier of the configured type in the response body.

Identifier via Query Parameter

As of Registry v4.1.0, identifiers may be provided to the write API via query parameters.

PUT https://$SERVER/registry/api/co/<coid>/core/v1/people?identifier=<foo>
DELETE https://$SERVER/registry/api/co/<coid>/core/v1/people?identifier=<foo>

Department Read API

The Department Read API is a collection of two APIs that create a consolidated view of most attributes associated with a Department. The Department Read API is available as of Registry v4.3.0.

Supported attributes include:

• Address
• AdHocAttribute
• EmailAddress
• Identifier
• TelephoneNumber
• Url

The data returned by the Index API can be configured via the Response Type configuration:

• Full Profile: All available attributes (defined above) are returned.
• Identifier Only: Only the Identifier of the configured type is returned. The full record may be obtained using the Read API.

Read API Endpoint

Index API Endpoint

Message Format

The response is a JSON document as described by this JSON Schema.

Department Write API

The Department Write API is a collection of three APIs allow creation, updating, and deletion of Department records. The Department Write API is available as of Registry v4.3.0.

The Create and Update APIs accept the same attributes as returned by the Read API. Note that most metadata returned by the Read API is not permitted (and will be ignored) in the Write API. The exception is the sub-element id, which when present is used to indicated the update of an existing sub-element (such as an EmailAddress) rather than the creation of a new one.

Create API Endpoint

Delete API Endpoint

Update API Endpoint

Message Format

For the Create and Update APIs, the request is sent with Content-Type of application/json with a body containing a JSON document as described by this JSON Schema. An empty body or document is not valid for Create or Update. There is no request body for the Delete API.

The Create request will include the newly assigned Identifier of the configured type in the response body.

Match Callback API

The Match Callback API implements the COmanage Match Endpoint Notification Protocol in order to automate the reprocessing of records following a Match resolution. For more information, see Integrating With ID Match.

Organization Read API

The Organization Read API is a collection of two APIs that create a consolidated view of most attributes associated with an Organization. The Organization Read API is available as of Registry v4.3.0.

Supported attributes include:

• Address
• AdHocAttribute
• EmailAddress
• Identifier
• TelephoneNumber
• Url

The data returned by the Index API can be configured via the Response Type configuration:

• Full Profile: All available attributes (defined above) are returned.
• Identifier Only: Only the Identifier of the configured type is returned. The full record may be obtained using the Read API.

Read API Endpoint

Index API Endpoint

Message Format

The response is a JSON document as described by this JSON Schema.

Organization Write API

The Organization Write API is a collection of three APIs allow creation, updating, and deletion of Organization records. The Organization Write API is available as of Registry v4.3.0

...

.

The Create and Update APIs accept the same attributes as returned by the Read API. Note that most metadata returned by the Read API is not permitted (and will be ignored) in the Write API. The exception is the sub-element id, which when present is used to indicated the update of an existing sub-element (such as an EmailAddress) rather than the creation of a new one.

Create API Endpoint

Delete API Endpoint

Update API Endpoint

Message Format

For the Create and Update APIs, the request is sent with Content-Type of application/json with a body containing a JSON document as described by this JSON Schema. An empty body or document is not valid for Create or Update. There is no request body for the Delete API.

The Create request will include the newly assigned Identifier of the configured type in the response body.

Petition Read API

The Petition Read API creates a consolidated view of most attributes associated with a CO Petition. The Petition Read API is available as of Registry v4.3.0.

Supported attributes include:

• ApproverCoPerson
• CoEnrollmentFlow
• Cou
• EnrolleeCoPerson
• SponsorCoPerson
• CoInvite
• VettingRequest

Read API Endpoint

Index API Endpoint

Message Format

The response is a JSON document as described by this JSON Schema.

Implementation Notes

Anchor
CoreAPI-PaginationLimits CoreAPI-PaginationLimits

Pagination Limits

As of Registry v4.2.0, the maximum value for the limit parameter for index requests is 1000. Prior to Registry v4.2.0, the maximum value was 100.