Loading ...

REST API: Delete All Space Roles of User | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Spaces » REST API: Space Roles » REST API: Delete All Space Roles of User
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 28

REST API: Delete All Space Roles of User

0 
 /5
0 (0votes)
Open API Guide
DELETE/api/users/{UserID}/spaces/{SpaceID}/roles

Remove every role a user holds in a space. ResponseData is true when roles were removed and false when the user held none. The user stays a member of the space, and Get User Space Roles then lists only the space's Guest role for them.

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens.

Required Parameters

ParameterTypeRequiredLocationDescription
UserIDIntegerYESPathUnique ID of the user
SpaceIDIntegerYESPathUnique ID of the space

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/users/26/spaces/11/roles

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": true
}

Error Response

{
  "Message": "The request is invalid."
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestUserID or SpaceID in the path is not an integer.Send numeric IDs in the path.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenThe caller is not a site administrator and does not have the Manage Role permission in the space. The same status answers when the user is an administrator of the space, whose roles only a site administrator can remove.Confirm the user has the required roles for this action.
500 Server ErrorInternal failure.Retry later.
200 with ResponseData falseUserID or SpaceID is 0, or the roles could not be removed.Check both IDs.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages