Add a new CO Person. A person must have an OrgIdentity before they can be added to a CO. Note that linking to an OrgIdentity and invitations are separate operations.
Method |
|
---|---|
URL |
|
Request Body |
HTTP Status | Response Body | Description |
---|---|---|
| NewObjectResponse with | CoPerson created |
| CoPerson Request not provided in POST body | |
| ErrorResponse with details in | An error in one or more provided fields |
| Authentication required | |
| The specified CO does not exist | |
| Unknown error |
Remove a CO Person. This method will also delete related data, such as CoPersonRoles, EmailAddresses, and Identifiers. A person must be removed from any COs (CoPerson records must be deleted) before the OrgIdentity record can be removed.
Method |
|
---|---|
URL |
|
Request Body |
HTTP Status | Response Body | Description |
---|---|---|
| CoPerson deleted | |
|
| |
| Authentication required | |
| The Person has one or more Person Role records and cannot be deleted | |
| The Person has a role in one or more COUs that the authenticated user does not control | |
|
| |
| Unknown error |
Edit an existing CO Person.
Method |
|
---|---|
URL |
|
Request Body |
HTTP Status | Response Body | Description |
---|---|---|
| CoPerson updated | |
| CoPerson Request not provided in POST body | |
| ErrorResponse with details in | An error in one or more provided fields |
| Authentication required | |
| The specified CO does not exist | |
|
| |
| Unknown error |
Search for existing CO Person records.
When too many records are found, a message may be returned rather than specific records.
This API call is currently intended only to support the People Picker user interface element. It does not currently support RESTful response codes. It may change across minor releases. It may be eventually be merged with the Match API. The Find API is available as of Registry v3.3.0. |
Method |
|
---|---|
URL |
|
Request Body |
where
A JSON array of objects, where each object contains a label
(human readable string) and value
(CO Person ID).
Attempt to match existing CO Person records.
Note that matching is not performed on search criteria of less than 3 characters, or for email addresses that are not syntactically valid.
This API call is likely to evolve to accept search criteria more flexibly. It may change across minor releases. It may eventually be removed in favor of the Find API. |
Method |
|
---|---|
URL |
|
Request Body |
mail
was added in Registry v3.3.0.
HTTP Status | Response Body | Description |
---|---|---|
| CoPerson returned (zero or more matches may be returned) | |
| Authentication required | |
|
| |
| Unknown error |
Retrieve all existing CO People.
Method |
|
---|---|
URL |
|
Request Body |
HTTP Status | Response Body | Description |
---|---|---|
| CoPerson returned | |
| Authentication required | |
| Unknown error |
Retrieve all existing CO People for the specified CO.
Method |
|
---|---|
URL |
|
Request Body |
HTTP Status | Response Body | Description |
---|---|---|
| CoPeople returned | |
| Authentication required | |
|
| |
| Unknown error |
Retrieve all existing CO People attached to the specified Email Address. Note the specified identifier must be attached to a CO Person, not an Org Identity. Available as of Registry v4.1.0.
Method |
|
---|---|
URL |
|
Request Body |
HTTP Status | Response Body | Description |
---|---|---|
| CoPeople returned | |
| Authentication required | |
|
| |
| Unknown error |
Retrieve all existing CO People attached to the specified identifier. Note the specified identifier must be attached to a CO Person, not an Org Identity.
Method |
|
---|---|
URL |
|
Request Body |
HTTP Status | Response Body | Description |
---|---|---|
| CoPeople returned | |
| Authentication required | |
|
| |
| Unknown error |
Retrieve an existing CO Person.
Method |
|
---|---|
URL |
|
Request Body |
HTTP Status | Response Body | Description |
---|---|---|
| CoPerson returned | |
| Authentication required | |
|
| |
| Unknown error |