Add
Add a new CO Org Identity Link. A person must have an Org Identity and a CO Person record before they can be linked. Note that invitations are a separate operation.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
---|---|---|
| NewObjectResponse with | CoOrgIdentityLink created |
|
| CoOrgIdentityLink Request not provided in POST body |
| ErrorResponse with details in | An error in one or more provided fields |
|
| Authentication required |
|
| The specified CO Person does not exist |
|
| The specified Org Identity is already a member of this CO |
|
| The specified Org Identity does not exist |
|
| Unknown error |
Delete
Remove a CO Org Identity Link.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
---|---|---|
|
| CoOrgIdentityLink deleted |
|
|
|
|
| Authentication required |
|
|
|
|
| Unknown error |
Edit
Edit an existing CO Identity Link.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
---|---|---|
|
| CoOrgIdentityLink updated |
|
| CoOrgIdentityLink Request not provided in POST body |
| ErrorResponse with details in | An error in one or more provided fields |
|
| Authentication required |
|
| The specified CO Person Role does not exist |
|
| The specified Org Identity is already a member of this CO |
|
| The specified Org Identity does not exist |
|
|
|
|
| Unknown error |
View (all)
Retrieve all existing CO Identity Links.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
---|---|---|
| CoOrgIdentityLinks returned | |
|
| Authentication required |
|
| Unknown error |
View (by identity)
Retrieve all existing CO Identity Links for a CO Person or an Org Identity.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
---|---|---|
| CoOrgIdentityLinks returned | |
|
| Authentication required |
404 CO Person Unknown | copersonid not found | |
404 Org Identity Unknown | orgidentityid not found | |
|
| Unknown error |
View (one)
Retrieve an existing CO Identity Link.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
---|---|---|
| CoOrgIdentityLink returned | |
|
| Authentication required |
|
|
|
|
| Unknown error |
Notes
- Response format requested is ignored where response is only via HTTP status, but must still be provided.
See Also
- cm_co_org_identity_links data model definition
- CoInvite API
- CoPerson API
- OrgIdentity API