Get a role

Get a role by the role id.

get

Path parameters

idstringRequired

The id of the role.

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

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

404

The role was not found in the system.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/roles/{id} 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": null,
    "guid": "f165de52-269c-4296-9a0a-a63bfbfb4d2d",
    "code": "EXAMPLE",
    "name": "Example",
    "description": "Description",
    "tags": "#Example",
    "type": "Custom",
    "permissions": [
      "Resource.Action"
    ]
  },
  "errors": []
}