Get permissions

Gets a list of all permissions

get

Query parameters

ResourceTypeIdstringOptional

Filter by resource type id.

CodestringOptional

Filter by code.

NamestringOptional

Filter by name.

TagsstringOptional

Filter by tags.

DescriptionstringOptional

Filter by description.

Typestring · enumOptional

Filter by type.

Possible values:

KeywordsstringOptional

Filter by keywords.

SortDataFieldstringOptional

The sort data field to sort. By default, the value is ID.

SortOrderstring · enumOptional

Specifies the sorting order type for a collection.

Possible values:

PageNumberinteger · int32Optional

The page number of the pagination. Default value is 0.

PageSizeinteger · int32Optional

The page size of the pagination. Default value is 200.

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/permissions

HTTPcURLJavaScriptPython

GET /api/v1/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": {
    "items": [
      {
        "id": "sApKpllz4sAplsmzha",
        "parentBrandId": "sApKpllz4sAplsmzha",
        "resourceTypeId": "sApKpllz4sAplsmzha",
        "guid": "73580cc5-36ec-499e-92b0-49e06eabbbf6",
        "code": "PERMISSION_CODE",
        "name": "Permission Name",
        "description": "Permission Description",
        "tags": "Permission Tags",
        "type": "Custom"
      }
    ],
    "totalItems": 1,
    "pageNumber": 0,
    "pageSize": 10
  },
  "errors": []
}