List Permission Information¶

GET /api/v1/permission/list

Overview¶

List all permission information

Query Request Parameters¶

Parameter Additional Explanation¶

Parameter Description

If you want to add permissions to a custom role, please set isSupportCustomRole = true when querying all permission lists.

Request Example¶

curl 'https://openapi.guance.com/api/v1/permission/list?isSupportCustomRole=true' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--compressed

Response¶

```shell { "code": 200, "content": [ { "desc": "", "disabled": 0, "isSupportCustomRole": 1, "isSupportGeneral": 0, "isSupportOwner": 1, "isSupportReadOnly": 0, "isSupportWsAdmin": 1, "key": "routine.", "name": "General", "subs": [ { "desc": "", "disabled": 0, "isSupportCustomRole": 1, "isSupportGeneral": 0, "isSupportOwner": 1, "isSupportReadOnly": 0, "isSupportWsAdmin": 1, "key": "routine.viewerManage", "name": "Viewer-Quick Filter Management" }, { "desc": "", "disabled": 0, "isSupportCustomRole": 1, "isSupportGeneral": 1, "isSupportOwner": 1, "isSupportReadOnly": 0, "isSupportWsAdmin": 1, "key": "routine.exportManage", "name": "Export Management" } ] }, { "desc": "", "disabled": 0, "isSupportCustomRole": 1, "isSupportGeneral": 0, "isSupportOwner": 1, "isSupportReadOnly": 0, "isSupportWsAdmin": 1, "key": "label.", "name": "Global Tag", "subs": [ { "desc": "", "disabled": 0, "isSupportCustomRole": 1, "isSupportGeneral": 0, "isSupportOwner": 1, "isSupportReadOnly": 0, "isSupportWsAdmin": 1, "key": "label.labelCfgManage", "name": "Tag Management" } ] }, { "desc": "", "disabled": 1, "isSupportCustomRole": 0, "isSupportGeneral": 0, "isSupportOwner": 1, "isSupportReadOnly": 0, "isSupportWsAdmin": 0, "key": "workspace.", "name": "Workspace Management", "subs": [ { "desc": "", "disabled": 0, "isSupportCustomRole": 1, "isSupportGeneral": 1, "isSupportOwner": 1, "isSupportReadOnly": 0, "isSupportWsAdmin": 1, "key": "workspace.readMember", "name": "Member Management View" }, { "desc": "", "disabled": 0, "isSupportCustomRole": 1, "isSupportGeneral": 1, "isSupportOwner": 1, "isSupportReadOnly": 0, "isSupportWsAdmin": 1, "key": "workspace.inviteMembers", "name": "Invite Member" }, { "desc": "", "disabled": 0, "isSupportCustomRole": 1, "isSupportGeneral": 0, "isSupportOwner": 1, "isSupportReadOnly": 0, "isSupportWsAdmin": 1, "key": "workspace.memberManage", "name": "Member Management" } ] }, { "desc": "", "disabled": 0, "isSupportCustomRole": 1, "isSupportGeneral": 0, "isSupportOwner": 1, "isSupportReadOnly": 0, "isSupportWsAdmin": 1, "key": "dataScanner.", "name": "Sensitive Data Scanning", "subs": [ { "desc": "", "disabled": 0, "isSupportCustomRole": 1, "isSupportGeneral": 0, "isSupportOwner": 1, "isSupportReadOnly": 0, "isSupportWsAdmin": 1, "key": "dataScanner.cfgManage", "name": "Configuration Management" } ] }, { "desc": "", "disabled": 0, "isSupportCustomRole": 1, "isSupportGeneral": 0, "isSupportOwner": 1, "isSupportReadOnly": 0, "isSupportWsAdmin": 1, "key": "dataRightsManage.", "name": "Data Permission Management", "subs": [ { "desc": "", "disabled": 0, "isSupportCustomRole": 1, "isSupportGeneral": 0, "isSupportOwner": 1, "isSupportReadOnly": 0, "isSupportWsAdmin": 1, "key": "dataRightsManage.workspaceConfigManage", "name": "Configuration Management" } ] }, { "desc": "", "disabled": 0, "isSupportCustomRole": 1, "isSupportGeneral": 1, "isSupportOwner": 1, "isSupportReadOnly": 0, "isSupportWsAdmin": 1, "key": "field.", "name": "Field Management", "subs": [ { "desc": "", "disabled": 0, "isSupportCustomRole": 1, "isSupportGeneral": 1, "isSupportOwner": 1, "isSupportReadOnly": 0, "isSupportWsAdmin": 1, "key": "field.fieldCfgManage", "name": "Field Configuration Management" } ] }, { "desc": "", "disabled": 0, "isSupportCustomRole": 1, "isSupportGeneral": 0, "isSupportOwner": 1, "isSupportReadOnly": 0, "isSupportWsAdmin": 1, "key": "reExpr.", "name": "Regular Expression", "subs": [ { "desc": "", "disabled": 0, "isSupportCustomRole": 1, "isSupportGeneral": 0, "isSupportOwner": 1, "isSupportReadOnly": 0, "isSupportWsAdmin": 1, "key": "reExpr.reExprManage", "name": "Regex Configuration Management" } ] }, { "desc": "", "disabled": 0, "isSupportCustomRole": 1, "isSupportGeneral": 1, "isSupportOwner": 1, "isSupportReadOnly": 0, "isSupportWsAdmin": 1, "key": "share.", "name": "Share Management", "subs": [ { "desc": "", "disabled": 0, "isSupportCustomRole": 1, "isSupportGeneral": 1, "isSupportOwner": 1, "isSupportReadOnly": 0, "isSupportWsAdmin": 1, "key": "share.shareManage", "name": "Share Configuration Management" } ] }, { "desc": "", "disabled": 0, "isSupportCustomRole": 1, "isSupportGeneral": 1, "isSupportOwner": 1, "isSupportReadOnly": 0, "isSupportWsAdmin": 1, "key": "snapshot.", "name": "Snapshot", "subs": [ { "desc": "", "disabled": 0, "isSupportCustomRole": 1, "isSupportGeneral": 1, "isSupportOwner": 1, "isSupportReadOnly": 1, "isSupportWsAdmin": 1, "key": "snapshot.create", "name": "New Snapshot" }, { "desc": "", "disabled": 0, "isSupportCustomRole": 1, "isSupportGeneral": 1, "isSupportOwner": 1, "isSupportReadOnly": 0, "isSupportWsAdmin": 1, "key": "snapshot.delete", "name": "Delete Snapshot" } ] }, { "desc": "", "disabled": 1, "isSupportCustomRole": 0, "isSupportGeneral": 0, "isSupportOwner": 1, "isSupportReadOnly": 0, "isSupportWsAdmin": 0, "key": "billing.", "name": "Billing And Usage", "subs": [ { "desc": "", "disabled": 0, "isSupportCustomRole": 1, "isSupportGeneral": 0, "isSupportOwner": 1, "isSupportReadOnly": 0, "isSupportWsAdmin": 1, "key": "billing.billingRead", "name": "Billing And Usage Read" } ] }, { "desc": "", "disabled": 0, "isSupportCustomRole": 1, "isSupportGeneral": 1, "isSupportOwner": 1, "isSupportReadOnly": 0, "isSupportWsAdmin": 1, "key": "scene.", "name": "Scene", "subs": [ { "desc": "", "disabled": 0, "isSupportCustomRole": 1, "isSupportGeneral": 1, "isSupportOwner": 1, "isSupportReadOnly": 0, "isSupportWsAdmin": 1, "key": "scene.setManage", "name": "Scenario Configuration Management" }, { "desc": "", "disabled": 0, "isSupportCustomRole": 1, "isSupportGeneral": 1, "isSupportOwner": 1, "isSupportReadOnly": 0, "isSupportWsAdmin": 1, "key": "scene.chartManage", "name": "Chart Configuration Management" } ] }, { "desc": "", "disabled": 0, "isSupportCustomRole": 1, "isSupportGeneral": 1, "isSupportOwner": 1, "isSupportReadOnly": 0, "isSupportWsAdmin": 1, "key": "event.", "name": "Event", "subs": [ { "desc": "", "disabled": 0, "isSupportCustomRole": 1, "isSupportGeneral": 1, "isSupportOwner": 1, "isSupportReadOnly": 1, "isSupportWsAdmin": 1, "key": "event.Query", "name": "Event Data Query" }, { "desc": "", "disabled": 0, "isSupportCustomRole": 1, "isSupportGeneral": 1, "isSupportOwner": 1, "isSupportReadOnly": 0, "isSupportWsAdmin": 1, "key": "event.recover", "name": "Manual Recovery" } ] }, { "desc": "", "disabled": 0, "isSupportCustomRole": 1, "isSupportGeneral": 0, "isSupportOwner": 1, "isSupportReadOnly": 0, "isSupportWsAdmin": 1, "key": "infrastructure.", "name": "Infrastructure", "subs": [ { "desc": "", "disabled": 0, "isSupportCustomRole": 1, "isSupportGeneral": 1, "isSupportOwner": 1, "isSupportReadOnly": 1, "isSupportWsAdmin": 1, "key": "infrastructure.Query", "name": "Infrastructure Data Query" }, { "desc": "", "disabled": 0, "isSupportCustomRole": 1, "isSupportGeneral": 0, "isSupportOwner": 1, "isSupportReadOnly": 0, "isSupportWsAdmin": 1, "key": "infrastructure.setManage", "name": "Infrastructure Configuration Management" } ] }, { "desc": "", "disabled": 0, "isSupportCustomRole": 1, "isSupportGeneral": 0, "isSupportOwner": 1, "isSupportReadOnly": 0, "isSupportWsAdmin": 1, "key": "log.", "name": "Log", "subs": [ { "desc": "", "disabled": 0, "isSupportCustomRole": 1, "isSupportGeneral": 1, "isSupportOwner": 1, "isSupportReadOnly": 1, "isSupportWsAdmin": 1, "key": "log.Query", "name": "Log Data Query" }, { "desc": "", "disabled": 0, "isSupportCustomRole": 1, "isSupportGeneral": 0, "isSupportOwner": 1, "isSupportReadOnly": 0, "isSupportWsAdmin": 1, "key": "log.externalIndexManage", "name": "External Index Management" }, { "desc": "", "disabled": 0, "isSupportCustomRole": 1, "isSupportGeneral": 0, "isSupportOwner": 1, "isSupportReadOnly": 0, "isSupportWsAdmin": 1, "key": "log.backupLogManage", "name": "Backup Log Management" }, { "desc": "", "