Get permissions granted by role

Retrieve detailed list (name, description, resource server) of permissions granted by a specified user role.

Get permissions granted by role.

get

Path parameters

roleIdstringRequired

The id of the role to list granted permissions.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

The API result model with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Required

This is the message to be displayed to the user.

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

403

The user's access was denied.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

get

/api/v1/roles/{roleId}/permissions

HTTPcURLJavaScriptPython

GET /api/v1/roles/{roleId}/permissions HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": [
    {
      "id": "sApKpllz4sAplsmzha",
      "parentBrandId": "sApKpllz4sAplsmzha",
      "resourceTypeId": "sApKpllz4sAplsmzha",
      "guid": "767803d7-d86a-45c3-a01b-781e64e10d1d",
      "code": "PERMISSION_CODE",
      "name": "Permission Name",
      "description": "Permission Description",
      "tags": "Permission Tags",
      "type": "Custom"
    }
  ],
  "errors": []
}