...
HTTP Status | Response Body | Description | |
|---|---|---|---|
| NewObjectResponse with | CoGroup added | |
|
| CoGroup 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 group already exists with the specified name in the specified CO | ||
| A group may not be created with the specified name (currently, the prefix 'admin:' is reserved)* | ||
|
| Unknown error |
*This applies only to non-admin users. However, all API operations are currently admin-level.
...
Method |
| |
|---|---|---|
URL |
| |
Request Body |
Response Format
HTTP Status | Response Body | Description | |
|---|---|---|---|
| CoGroup deleted | ||
|
| ||
|
| Authentication required | |
403 Forbidden | CoGroup cannot be deleted | ||
|
| ||
|
| Unknown error |
...
Edit
Edit an existing CoGroup.
...
HTTP Status | Response Body | Description | |
|---|---|---|---|
| CoGroup updated | ||
| CoGroup 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 group already exists with the specified name in the specified CO | ||
| A group may not be created with the specified name (currently, the prefix 'admin:' is reserved)* | ||
|
|
| |
| Unknown error |
*This applies only to non-admin users. However, all API operations are currently admin-level.
...
Reconcile (all)
Reconcile all membership groups.
Request Format
Method |
|
|---|---|
URL |
|
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| All CoGroup memberships reconciled | |
| Authentication required | |
| The specified CO does not exist | |
| Unknown error |
...
Reconcile (one)
Reconcile memberships for a CoGroup.
Request Format
Method |
|
|---|---|
URL |
|
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| CoGroup memberships reconciled | |
| Authentication required | |
| Unknown error |
...
View (all)
Retrieve all existing CoGroups.
Request Format
Method |
| |
|---|---|---|
URL |
| |
Request Body |
Response Format
HTTP Status | Response Body | Description | |
|---|---|---|---|
| CoGroup returned | ||
|
| Authentication required | |
|
| Unknown error |
...
View (per CO)
Retrieve CoGroups attached to a CO.
Request Format
Method |
| |
|---|---|---|
URL |
| |
Request Body |
Response Format
HTTP Status | Response Body | Description | |
|---|---|---|---|
| CoGroup returned | ||
|
| Authentication required | |
|
| ||
| Unknown error |
...
View (per CO Person)
Retrieve Groups attached to a CO Person.
Request Format
Method |
| |
|---|---|---|
URL |
| |
Request Body |
Response Format
HTTP Status | Response Body | Description | |
|---|---|---|---|
| CoGroups returned | ||
|
| The requested CO Person was found, but has no groups attached | |
|
| Authentication required | |
|
| ||
|
| Unknown error |
...
View (one)
Retrieve an existing CoGroup.
Request Format
Method |
| |
|---|---|---|
URL |
| |
Request Body |
|
Response Format
HTTP Status | Response Body | Description | |
|---|---|---|---|
| CoGroup returned | ||
|
| Authentication required | |
|
| ||
| Unknown error |
...
Notes
- Response format requested is ignored where response is only via HTTP status, but must still be provided.
...