...
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.
| Info |
|---|
The Index API is available as of Registry v4.1.0. |
| Note |
|---|
The Core APIs do not support Extended Attributes, which are deprecated. AdHoc Attributes should be used instead. Alternately, the REST API v1 can be used to manage Extended Attributes. |
...
| Request Method | GET |
|---|---|
| URL |
where
|
Index API Endpoint
| Request Method | GET |
|---|---|
| URL |
where
|
Message Format
The response is a JSON document as described by this JSON Schema.
...
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.