Delete a group
- 01 Jul 2021
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Delete a group
- Updated on 01 Jul 2021
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback!
Delete users
DELETE /groups/{externalId}
Header
| Name | Data Type | Description |
|---|---|---|
| Content-type: | application/json | for all requests |
| Authorization: | EAPI {token} | for all requests |
Request Parameters
Parameters indicated with a * are mandatory
| Parameter | Type | Description | max length |
|---|---|---|---|
| externalId* | String | The external ID of a user that needs to be fetched. The ExternalId will be known as "OrganisationID " in the Cirrus platform |
Sample successfull Response
{
"SuccessfullyRemoved": [
"NewGroup"
]
}
Sample unsuccessfull Response
{
"Success": false,
"Errors": "Group with ExternalId [NewGroup] is not found."
}
Responses
| Code | Description |
|---|---|
| 200 | Successful operation |
| 400 | Possible errors: Group with ExternalId [{externalId}] is not found Group or its children are used |
| 403 | Not allowed to use external API |
| 500 | Internal server error |
Was this article helpful?