Select the tab
ESET Connect – Table of Contents

GET List permissions

Relative path: /v2/permissions

List all possible permissions.

Query parameters

Name

Type

Description

pageSize

integer

Limit for pagination purposes.

If unspecified or 0, the default value is 50. The maximum value is 1000; values above 1000 will be coerced to 1000.

Info: For more information, refer to Paginating Requests in APIs

or Design Patterns: Pagination

pageToken

string

Page token of the current page.

If not given or "", the first page is returned.

Info: For more information, refer to Paginating Requests in APIs

or Design Patterns: Pagination

Responses

Display Schema instead of an Example or vice-versa

Code

Description

Example

Schema

200

Successful response.

 
{
  "permissions": [
    {
      "name": "string"
    }
  ],
  "nextPageToken": "string"
}
 
{
  "$ref": "v2ListPermissionsResponse",
  "permissions": [
    {
      "$ref": "v2Permission",
      "description": "Permission specifies the allowed actions that can be performed.",
      "name": {
        "type": "string",
        "description": "Permission name. It is a unique ID of the permission. It must be a URL-safe identifier. It must consist only of alphanumeric characters (a-z, A-Z, 0-9), dashes (-), and underscores (_). Spaces and special characters are not allowed. Info: For EPC, the display name is formed by concatenating strings for functionality and possible actions (Read, Write, Use) in the format functionality.action, separated by the symbol '.' Example: Rogue Detection Sensor Database Reset.Read"
      }
    }
  ],
  "nextPageToken": {
    "type": "string",
    "description": "Page token of the next page. Empty or '' for the last page. Info: For more information, refer to Paginating Requests in APIs or Design Patterns: Pagination"
  }
}

202

Response took too long; request cached. Response can be retrieved later using the response-id header.

 
null
 
[]

400

One of the errors: 1. Bad or missing authorization. 2. Validation error. Invalid argument provided.

 
null
 
[]

401

Token has expired or is invalid.

 
null
 
[]

403

Access denied. Check permissions.

 
null
 
[]

404

Requested resource not found.

 
null
 
[]

429

Rate limit reached. Try again later.

 
null
 
[]

500

Internal server failure. Try again later.

 
null
 
[]

502

Internal server failure. Try again later.

 
null
 
[]

503

Environment under maintenance. Try again later.

 
null
 
[]

504

Action took too long; timeout reached

 
null
 
[]