Note that the REST API does not cause administrator groups to be created when a COU is created. When adding a COU, you may wish to add the corresponding admin:COU group as well.
Add
Add a new Cou.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status |
Response Body |
Description |
|---|---|---|
|
NewObjectResponse with |
Cou added |
|
|
Cou 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 |
|
|
A COU already exists with the specified name in the specified CO |
|
|
Parent COU can not be a descendant of the child |
|
|
Parent/child COU not member of same CO |
|
|
Unknown error |
Delete
Remove a Cou.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status |
Response Body |
Description |
|---|---|---|
|
|
Cou deleted |
|
|
|
|
|
Authentication required |
|
|
One or more CO Person Roles are members of this COU, and so the COU cannot be removed |
|
|
Can not be deleted if children will be orphaned |
|
|
|
|
|
Unknown error |
Edit
Edit an existing Cou.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status |
Response Body |
Description |
|---|---|---|
|
|
Cou updated |
|
|
Cou 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 |
|
|
A COU already exists with the specified name in the specified CO |
|
|
Parent COU can not be a descendant of the child |
|
|
Parent/child COU not member of same CO |
|
|
|
|
|
Unknown error |
View (all)
Retrieve all existing Cous.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status |
Response Body |
Description |
|---|---|---|
|
Cou returned |
|
|
|
Authentication required |
|
|
Unknown error |
View (per CO)
Retrieve Cou attached to a CO.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status |
Response Body |
Description |
|---|---|---|
|
Cou returned |
|
|
|
Authentication required |
|
|
|
|
|
Unknown error |
View (one)
Retrieve an existing Cou.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status |
Response Body |
Description |
|---|---|---|
|
Cou 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_cous data model definition
- CoOrgIdentityLink API