Get a permission

Get a permission

get

Path parameters

idstringRequired

The id of the permission.

Header parameters

Brand-URLstringRequired

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

Example: YOUR_BRAND_URL

Auth-KeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

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

429

The user has exceeded the rate limit.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/permissions/{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": "sApKpllz4sAplsmzha",
    "resourceTypeId": "sApKpllz4sAplsmzha",
    "guid": "f09cac3c-51de-4f66-972f-816eb58ab1bc",
    "code": "PERMISSION_CODE",
    "name": "Permission Name",
    "description": "Permission Description",
    "tags": "Permission Tags",
    "type": "Custom"
  },
  "errors": []
}