Contents x
- Developers
- Getting Started
- REST API Reference
- Using Cirrus REST API
- Users
- Hierarchies (Groups)
- Collections
- Assessments
- Scheduling
- Attempts
- Marking Settings
- Candidate Review Sessions
- Results
- Webhooks
- Change log
- Integrations
- LTI
- Single Sign-On
Remove users - assessment Sharing
Article summary
Did you find this summary helpful?
Thank you for your feedback
Add users - Sharing
DELETE /assessment/{externalId}/sharing
Header
Name | Data Type | Description |
---|---|---|
Content-type: | application/json | for all requests |
Authorization: | EAPI {token} | for all requests |
Body Parameters
Parameters indicated with a * are mandatory
Name | Data Type | Description |
---|---|---|
*[] | String) | UserName |
Sample Request URL
https://api.cirrusplatform.com/api/v1/integrations/assessment/ColExt1/sharing
Curl
Sample Request
["user1", "user2", "user3", "user4"]
JSON
Sample Response
{
"Content": {
"SuccessfullyRemoved": ["user1", "user4"],
"Errors": [{
"UserName": "user2",
"Error": "Assessment has not been shared with this user"
},
{
"UserName": "user3",
"Error": "Owner can not be deleted from assessment"
}]
},
"Success": true,
"Errors": null
}
JSON
Response codes
Code | Description |
---|---|
200 | Successful operation |
403 | Not allowed to use external API |
500 | Internal server error |
Was this article helpful?
Thank you for your feedback! Our team will get back to you
How can we improve this article?
Your feedback
Comment
Comment (Optional)
Character limit : 500
Please enter your comment
Email (Optional)
Email
Please enter a valid email