Loading ...

REST API: Update Permissions | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Permissions » REST API: Update Permissions
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 22

REST API: Update Permissions

0 
 /5
0 (0votes)
Open API Guide
PUT/api/permissions/access

Supports the synchronization and modification of update role permissions properties via the API.

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
EntityTypeStringYESQueryUnique identifier for a particular entity.REST API: System Entity Types 
RoleIDIntegerYESQueryUnique identifier for a particular role
PermissionsStringYESBodyPermission that you want to set for the specific role in JSON format.REST API: Permission Types 

Optional Parameters

ParameterTypeRequiredLocationDescription
EntityIDIntegerNOQueryEntity ID needs to be specified only where permissions are entity based. Entity types where permissions are entity based: Files Forums Forum Groups Tasks You will get default permissions for these entity types if you don't specify entity ID for above entity types
SpaceIDIntegerNOQuerySpecify space ID if permissions need to be set for a space

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Request URL

https://your-site.com/api/permissions/access?entitytype=3&roleid=3

Request Body

{
  "Create": true
}

Success Response

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

Error Response

{
  "IsError": true,
  "ResponseMessage": "Required parameter is missing or invalid.",
  "ResponseData": null
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestOne or more required fields are missing or invalid. (permissions, roleID, entityType)Verify the request payload against the required parameters.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenUser does not have sufficient permissions.Confirm the user has the required roles for this action.
404 Not FoundThe specified permission was not found.Verify the roleID is correct.
500 Server ErrorInternal failure.Retry later.

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