Loading ...

REST API: Assign Space Role | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Spaces » REST API: Space Roles » REST API: Assign Space Role
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 45

REST API: Assign Space Role

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

Assign a space role to an existing space user

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens
Content-TypeYESapplication/jsonMust be set to application/json

Required Parameters

ParameterTypeRequiredLocationDescription
UserIDIntegerYESPathUnique identifier for a particular user
SpaceIDIntegerYESPathUnique identifier for a particular space
RoleIDIntegerYESBodyID of the role to assign, sent as a JSON string in the request body (for example "123"). Several IDs separated by commas or pipes ("12,15") replace the user's space roles with that set; the last space administrator cannot be removed from the Administrator role.

Optional Parameters

ParameterTypeRequiredLocationDescription
IsRoleListBooleanNOQuerySet to true to treat a single RoleID as the user's complete set of space roles, removing every other space role. Default: false.

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Request URL

https://your-site.com/api/users/156/spaces/2/roles

Request Body

"123"

Success Response

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

Error Response

HTTP 500 with an empty body

Error Handling

Status CodeLikely CauseNext Action
500 Server ErrorA required parameter is missing. The endpoint fails with an empty body instead of reporting the missing value.Verify the request against the required parameters before treating the 500 as a server fault.
401 UnauthorizedMissing or invalid Bearer tokenCheck token validity. Learn how to create Bearer tokens →
403 ForbiddenUser does not have sufficient permissionsConfirm the user has the required roles for this action
200 with IsErrorThe role list is empty, or the change would remove the space's last administrator; ResponseMessage says which.Send at least one role and keep one Administrator in the space.

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