Date: Fri, 29 Mar 2024 10:47:16 +0000 (UTC) Message-ID: <940480838.7857.1711709236482@ip-10-10-7-29.ec2.internal> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_7856_1133977617.1711709236481" ------=_Part_7856_1133977617.1711709236481 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
Add a new CO Person. A person must have an OrgIdentity before they can b= e 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 |
|
|
E=
rrorResponse with details in |
An error in one or more provided fields = td> |
|
Authentication required |
|
|
The specified CO does not exist |
|
|
Unknown error |
Remove a CO Person. This method will also delete related data, such as <= a href=3D"/display/COmanage/CoPersonRole+API">CoPersonRoles, EmailAddresses, and Identifiers. A person must be removed fr= om 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 record= s and cannot be deleted |
|
|
The Person has a role in one or more COUs tha= t 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 |
|
|
E=
rrorResponse with details in |
An error in one or more provided fields = td> |
|
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 s= pecific records.
Provisional API
This API call is currently intended only to support the People Picker us= er interface element. It does not currently support RESTful response codes.= It may change across minor releases. It may be eventually be merged with t= he 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 ch= aracters, or for email addresses that are not syntactically valid.
Provisional API
This API call is likely to evolve to accept search criteria more flexibl= y. It may change across minor releases. It may eventually be removed in fav= or 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 b= e 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. No= te the specified identifier must be attached to a CO Person, not an Org Ide= ntity.
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 |