Delete Role

1 min

DELETE

https://api.upstartcommerce.com/v1/user/auth/role/{roleId}

This endpoint provides the ability to delete a role. A role cannot be deleted in the following cases:

It is a system role (e.g., has a system flag set to true).
There are active users that have this role assigned to them. In this case, an administrator must update all relevant users and make sure no one uses the role.

Required permissions:

user.role.delete

Authorized system roles:

system.admin
user.mgmt

x-upstart-tenantstringTenant identifier associated with the site this call is for.

x-upstart-sitestringUnique identifier for the site.

200This response indicates the the role was deleted.

400The request contained information that the server was unable to process. Appropriate errors are provided in the response body.

401The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.

403<p>An update to this resource requires the if-match and if-unmodified-since headers to be sent in order to process the request.</p>

404The requested resource was not found in the NoChannel system.

409The request conflicts with the current state of the resource.

500Internal server error. The server encountered an unexpected condition that prevented it from fulfilling the request.

curl --request DELETE \
     --url https://api.upstartcommerce.com/v1/user/auth/role/{roleId} \
     --header 'accept: application/json' \
     --header 'x-upstart-tenant: string'