Loading ...

REST API: Check Permissions | Axero Documentation

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

REST API: Check Permissions

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

Get permissions JSON object from database. List of supported entities: Articles, Blogs, CMS Pages, Wikis, Files, Videos, Ideas, Photos, Events, Forums, Cases.

Request

Request Header

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

Required Parameters

ParameterTypeRequiredLocationDescription
EntityTypeStringYESQueryFor what REST API: System Entity Types  you want to fetch permissions
PermissionsCsvStringYESQueryCSV of the REST API: Permission Types that you want to check for the current user. For example: CREATE, UPDATE, DELETE Here, you will get a response if the current user has CREATE, UPDATE, DELETE permissions for given entity type.
ContentTypeIDIntegerNOQueryContent type ID for checking type-specific permissions

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 fetched for a space
UserIDIntegerNOQuerySpecify User ID when you want to fetch permissions of the specified user. (Only Site Administrators are allowed, and Space Administrators are also allowed when SpaceID > 0)
RoleIDIntegerNOQuerySpecify Role ID when you want to fetch permissions for the specified Role. (Only Site Administrators are allowed, and Space Administrators are also allowed when SpaceID > 0)

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/permissions/access?EntityType=3&PermissionsCsv=create,update,delete

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": {
    "Create": true,
    "Update": true,
    "Delete": false
  }
}

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. (entityType, permissionsCsv)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.
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