This API deletes a Service role.
This is the authentication key required for requests.
Enable "Delete Roles" in the Management API permissions, and include it in the request header when sending the request.
If the X-MICROCMS-API-KEY is exposed, third parties may be able to manipulate your Content without authorization. Please handle it with care. For details, see API Key (API Authentication and Permission Management).
Specify the ID of the Role to delete.
You can find the Role ID in the id field of the response from the API for retrieving the list of Roles.
No request body needs to be specified.
If the role is deleted successfully, a 200 response is returned.
For status codes returned in case of an error, see "Error Responses."
If the role is deleted successfully, the following response is returned.
{"id":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}The ID of the deleted role.
The main errors returned by this API are as follows.
Status Code | Condition |
|---|---|
| When a role ID that is not in UUID format is specified (including UUIDs containing uppercase letters) |
| When the Administrator role is specified |
| When a request is made for an environment created using the Multiple Environments feature |
| When a role that does not exist in the Service is specified |
| When a role assigned to one or more Members (including invited Members) is specified |
For other errors, see Management API Error Responses.
The following roles cannot be deleted:
Requests to environments created using the Multiple Environments feature are not supported.