Permissions

Get all valid permissions

Request

Definition

GET /api/v1/permissions

Headers

• Authorization required

  Authentication token with privileges to view the resource.

  Bearer {token}

Response

Status codes

Status code	Message
200	"List of permissions"
403	"Forbidden"

Body

Attributes

• data.permissions.id integer

  Permission ID.

• data.permissions.name string

  Permission name.

• data.permissions.description string

  Permission description.

• data.permissions.needs_service boolean

  Indicates whether the permission should be associated with one or more Domain Group.

Example

{
"data": {
    "permissions": [
    {
        "description": "User can visualize and ignore alerts. He can also explore related HTTP transactions.",
        "id": 0,
        "name": "Explore alerts",
        "needs_service": true
    },
    {
        "description": "User can visualize, create, modify and delete rules, either as Application and Source.",
        "id": 1,
        "name": "Handle rules",
        "needs_service": true
    },
    {
        "description": "User can load Applications Rules to a Web Application Firewall",
        "id": 2,
        "name": "Load application rules",
        "needs_service": false
    },
    {
        "description": "User can load Source Rules to a Firewall",
        "id": 3,
        "name": "Load source rules",
        "needs_service": false
    },
    {
        "description": "User can explore HTTP transactions",
        "id": 4,
        "name": "Explore transactions",
        "needs_service": true
    },
    {
        "description": "User can visualize, create and delete hosts and services.",
        "id": 5,
        "name": "Handle assets",
        "needs_service": false
    },
    {
        "description": "User can visualize, add, modify and delete traffic sources.",
        "id": 6,
        "name": "Handle traffic sources",
        "needs_service": false
    },
    {
        "description": "User can visualize, add, modify and delete user records. He can also reset user passwords.",
        "id": 7,
        "name": "Handle users",
        "needs_service": false
    },
    {
        "description": "User can visualize, add, modify and delete group records. He can also handle group permissions.",
        "id": 8,
        "name": "Handle groups",
        "needs_service": false
    },
    {
        "description": "User can visualize, add, modify and delete firewalls.",
        "id": 9,
        "name": "Handle firewalls",
        "needs_service": false
    },
    {
        "description": "User can visualize, add, modify and delete notifications.",
        "id": 10,
        "name": "Handle notifications",
        "needs_service": false
    },
    {
        "description": "User can explore trends related to HTTP transactions",
        "id": 11,
        "name": "Explore trends",
        "needs_service": true
    },
    {
        "description": "User can create, read and delete reports",
        "id": 12,
        "name": "Handle reports",
        "needs_service": true
    }
    ]
},
"message": "List of permissions",
"status": "ok"
}

Gets user-specific generic permissions

Request

Definition

GET /api/v1/permissions/advances/{user_id}

Headers

• Authorization required

  An authentication token with privileges to view the resource.

  Bearer {token}

Response

Status codes

Status code	Message
200	"List of user-specific generic permissions"
400	"Error retrieving advanced permissions"
403	"Forbidden"

Body

{
  "data": {
    "permission": {
      "description": "User can visualize, create, modify and delete rules, either as Application and Source.",
      "hosts": [
        "test.com"
      ],
      "id": 1,
      "name": "Handle rules",
      "service_hosts": {
        "Test": [
          "test.com"
        ]
      },
      "services": [
        "Test"
      ]
    }
  },
  "message": "List of user-specific generic permissions",
  "status": "ok"
}