Version:

PermissionGroups

PermissionGroups - Create

Creates a new permission group in a Fabric-enabled LogPoint.

POST

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/PermissionGroups

Parameter

Field

Label in UI

Type

Description

description

Description

String

Description of the permission group. Optional Field.

name

Name

String

Name of the permission group. The value of the name field must contain unique alphanumeric values that can include the hyphen (-) and underscore () characters. It must not begin or end with a white space character, hyphen (-) or an underscore () . The total length has to be between 2 and 100 characters. Mandatory Field.

permissions

-

[json]

Permission items list. To define permissions, use the following parameters:

entity: Permission item name. Can be either of the following:

  • Normalization Packages

  • Lists

  • Fields

  • Macros

  • Label Packages

  • Devices, DeviceGroups, Log Collection Policy and Parsers

  • Distributed Collectors

  • Processing Policy

  • Distributed LogPoints

  • Export Management

  • Raw Syslog Forwarder

  • SOAR Playbooks-Playbook Actions

  • SOAR Playbooks-Manage Playbook Triggers

  • SOAR Settings-Integrations

  • SOAR Settings-API Key

  • SOAR Settings-Licensing

  • SOAR Settings-My Products

  • SOAR Settings-Lists Management

  • SOAR Settings-Import

  • SOAR Settings-System Health

  • SOAR Cases-Manage Cases

SOAR permission can be configured only when enable_soar is set as true in SystemSettingsGeneral. Obtain the value of enable_soar from SystemSettingsGeneral - List. Mandatory Field.

permission: Permission level for the entity. Can have value as READ, CREATE_EDIT, DELETE or NONE. CREATE_EDIT includes the READ permission. DELETE includes READ and CREATE_EDIT permissions. NONE grants no permissions. Mandatory Field.

  • To configure the collectors and fetchers in devices, the minimum requirement is to grant the READ permission for Distributed Collectors, Processing Policy and Distributed LogPoints.

  • To create/update Processing Policy, the minimum requirement is to grant the READ permission for Normalization Packages.

  • To configure SOAR Playbooks-Manage Playbook Triggers, the minimum requirement is to grant the READ permission for SOAR Playbooks-Playbook Actions.

  • To configure SOAR Playbooks-Playbook Actions, the minimum requirement is to grant the READ permission for SOAR Settings-Integrations, SOAR Settings-My Products, and SOAR Settings-Lists Management.

  • To configure SOAR Settings-Integrations, the minimum requirement is to grant the READ permission for SOAR Settings-My Products.

  • To configure SOAR Settings-My Products, the minimum requirement is to grant the READ permission for SOAR Settings-Integrations.

Optional Field.

Request Example

{
    "data": {
        "description": "Permission User",
        "name": "User",
        "permissions": [
            {
                "entity": "Devices, DeviceGroups, Log Collection Policy and Parsers",
                "permission": "READ"
            }
        ]
    }
}

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

PermissionGroups - Edit

Edits an existing permission group in a Fabric-enabled LogPoint.

PUT

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/PermissionGroups/{id}

Parameter

Field

Label in UI

Type

Description

description

Description

String

Description of the permission group. Optional Field.

id

-

String

Existing permission group id . Obtain the value of the required permission group id using PermissionGroups - List API. Mandatory Field.

name

Name

String

Name of the permission group. The value of the name field must contain unique alphanumeric values that can include the hyphen (-) and underscore () characters. It must not begin or end with a white space character, hyphen (-) or an underscore () . The total length has to be between 2 and 100 characters. Mandatory Field.

permissions

-

[json]

Permission items list. To define permissions, use the following parameters:

entity: Permission item name. Can be either of the following:

  • Normalization Packages

  • Lists

  • Fields

  • Macros

  • Label Packages

  • Devices, DeviceGroups, Log Collection Policy and Parsers

  • Distributed Collectors

  • Processing Policy

  • Distributed LogPoints

  • Export Management

  • Raw Syslog Forwarder

  • SOAR Playbooks-Playbook Actions

  • SOAR Playbooks-Manage Playbook Triggers

  • SOAR Settings-Integrations

  • SOAR Settings-API Key

  • SOAR Settings-Licensing

  • SOAR Settings-My Products

  • SOAR Settings-Lists Management

  • SOAR Settings-Import

  • SOAR Settings-System Health

  • SOAR Cases-Manage Cases

SOAR permission can be configured only when enable_soar is set as true in SystemSettingsGeneral. Obtain the value of enable_soar from SystemSettingsGeneral - List. Mandatory Field.

permission: Permission level for the entity. Can have value as READ, CREATE_EDIT, DELETE or NONE. CREATE_EDIT includes the READ permission. DELETE includes READ and CREATE_EDIT permissions. NONE grants no permissions. Mandatory Field.

  • To configure the collectors and fetchers in devices, the minimum requirement is to grant the READ permission for Distributed Collectors, Processing Policy and Distributed LogPoints.

  • To create/update Processing Policy, the minimum requirement is to grant the READ permission for Normalization Packages.

  • To configure SOAR Playbooks-Manage Playbook Triggers, the minimum requirement is to grant the READ permission for SOAR Playbooks-Playbook Actions.

  • To configure SOAR Playbooks-Playbook Actions, the minimum requirement is to grant the READ permission for SOAR Settings-Integrations, SOAR Settings-My Products, and SOAR Settings-Lists Management.

  • To configure SOAR Settings-Integrations, the minimum requirement is to grant the READ permission for SOAR Settings-My Products.

  • To configure SOAR Settings-My Products, the minimum requirement is to grant the READ permission for SOAR Settings-Integrations.

Optional Field.

Request Example

{
    "data": {
        "description": "Permission User",
        "name": "User",
        "permissions": [
            {
                "entity": "Devices, DeviceGroups, Log Collection Policy and Parsers",
                "permission": "READ"
            }
        ]
    }
}

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

PermissionGroups - Get

Lists all existing Permission Groups.

GET

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/PermissionGroups/{id}

Parameter

Field

Label in UI

Type

Description

id

-

String

ID of the existing permission group that you want to fetch.

Success Response

{
    "name": "permissiongroupname",
    "description": "Test Permission Group",
    "tid": "",
    "active": true,
    "permissions": [
        {
            "entity": "Normalization Packages",
            "permission": "DELETE"
        },
        {
            "entity": "Lists",
            "permission": "DELETE"
        },
        {
            "entity": "Fields",
            "permission": "DELETE"
        },
        {
            "entity": "Macros",
            "permission": "DELETE"
        },
        {
            "entity": "Label Packages",
            "permission": "DELETE"
        },
        {
            "entity": "Devices, DeviceGroups, Log Collection Policy and Parsers",
            "permission": "DELETE"
        },
        {
            "entity": "Distributed Collectors",
            "permission": "DELETE"
        },
        {
            "entity": "Processing Policy",
            "permission": "DELETE"
        },
        {
            "entity": "Distributed LogPoints",
            "permission": "DELETE"
        },
        {
            "entity": "Export Management",
            "permission": "DELETE"
        },
        {
            "entity": "Raw Syslog Forwarder",
            "permission": "NONE"
        },
        {
            "entity": "SOAR Playbooks-Playbook Actions",
            "permission": "READ"
        },
        {
            "entity": "SOAR Playbooks-Manage Playbook Triggers",
            "permission": "DELETE"
        },
        {
            "entity": "SOAR Settings-Integrations",
            "permission": "DELETE"
        },
        {
            "entity": "SOAR Settings-API Key",
            "permission": "DELETE"
        },
        {
            "entity": "SOAR Settings-Licensing",
            "permission": "DELETE"
        },
        {
            "entity": "SOAR Settings-My Products",
            "permission": "DELETE"
        },
        {
            "entity": "SOAR Settings-Lists Management",
            "permission": "DELETE"
        },
        {
            "entity": "SOAR Settings-Import",
            "permission": "DELETE"
        },
        {
            "entity": "SOAR Settings-System Health",
            "permission": "DELETE"
        },
        {
            "entity": "SOAR Cases-Manage Cases",
            "permission": "CREATE_EDIT"
        }
    ],
    "id": "6311c733fe0249378c55bfa1"
}

PermissionGroups - List

Lists all existing Permission Groups.

GET

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/PermissionGroups

Success Response

[
    {
        "name": "permissiongroupname",
        "description": "Test Permission Group",
        "tid": "",
        "active": true,
        "permissions": [
            {
                "entity": "Normalization Packages",
                "permission": "DELETE"
            },
            {
                "entity": "Lists",
                "permission": "DELETE"
            },
            {
                "entity": "Fields",
                "permission": "DELETE"
            },
            {
                "entity": "Macros",
                "permission": "DELETE"
            },
            {
                "entity": "Label Packages",
                "permission": "DELETE"
            },
            {
                "entity": "Devices, DeviceGroups, Log Collection Policy and Parsers",
                "permission": "DELETE"
            },
            {
                "entity": "Distributed Collectors",
                "permission": "DELETE"
            },
            {
                "entity": "Processing Policy",
                "permission": "DELETE"
            },
            {
                "entity": "Distributed LogPoints",
                "permission": "DELETE"
            },
            {
                "entity": "Export Management",
                "permission": "DELETE"
            },
            {
                "entity": "Raw Syslog Forwarder",
                "permission": "NONE"
            },
            {
                "entity": "SOAR Playbooks-Playbook Actions",
                "permission": "READ"
            },
            {
                "entity": "SOAR Playbooks-Manage Playbook Triggers",
                "permission": "DELETE"
            },
            {
                "entity": "SOAR Settings-Integrations",
                "permission": "DELETE"
            },
            {
                "entity": "SOAR Settings-API Key",
                "permission": "DELETE"
            },
            {
                "entity": "SOAR Settings-Licensing",
                "permission": "DELETE"
            },
            {
                "entity": "SOAR Settings-My Products",
                "permission": "DELETE"
            },
            {
                "entity": "SOAR Settings-Lists Management",
                "permission": "DELETE"
            },
            {
                "entity": "SOAR Settings-Import",
                "permission": "DELETE"
            },
            {
                "entity": "SOAR Settings-System Health",
                "permission": "DELETE"
            },
            {
                "entity": "SOAR Cases-Manage Cases",
                "permission": "CREATE_EDIT"
            }
        ],
        "id": "6311c733fe0249378c55bfa1"
    }
]

PermissionGroups - Trash

Removes the permission group with the given ID.

DELETE

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/PermissionGroups/{id}

Parameter

Field

Label in UI

Type

Description

id

-

String

ID of the existing permission group that you want to delete. Mandatory Field.

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}
Helpful?

We are glad this guide helped.


Please don't include any personal information in your comment

Contact Support