List Permissions¶
GET /api/v1/permission/list
Overview¶
List all permissions
Query Parameters¶
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| isSupportCustomRole | boolean | Filter permissions that support custom role selection Example: True Allow Empty: False |
Parameter Additional Description¶
Parameter Description
| Parameter Name | Type | Required | Default Value | Description |
|---|---|---|---|---|
| isSupportCustomRole | boolean | Filter permissions that support custom role selection |
If you want to add permissions to a custom role, set isSupportCustomRole = true when querying all permissions
Request Example¶
curl 'https://openapi.guance.com/api/v1/permission/list?isSupportCustomRole=true' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--compressed
Response¶
{
"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": "scene.serviceManage",
"name": "Service Catalog 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.re 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": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 0,
"isSupportOwner": 1,
"isSupportReadOnly": 0,
"isSupportWsAdmin": 1,
"key": "log.indexManage",
"name": "Log Index Management"
},
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 0,
"isSupportOwner": 1,
"isSupportReadOnly": 0,
"isSupportWsAdmin": 1,
"key": "dataProcessing.dataQueryRule",
"name": "Log Data Access Configuration Management"
}
]
},
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 1,
"isSupportOwner": 1,
"isSupportReadOnly": 0,
"isSupportWsAdmin": 1,
"key": "metric.*",
"name": "Metric",
"subs": [
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 1,
"isSupportOwner": 1,
"isSupportReadOnly": 1,
"isSupportWsAdmin": 1,
"key": "metric.Query",
"name": "Metric Data Query"
},
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 1,
"isSupportOwner": 1,
"isSupportReadOnly": 0,
"isSupportWsAdmin": 1,
"key": "metric.metricManage",
"name": "Metric Description Management"
}
]
},
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 1,
"isSupportOwner": 1,
"isSupportReadOnly": 0,
"isSupportWsAdmin": 1,
"key": "pipeline.*",
"name": "Pipelines",
"subs": [
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 1,
"isSupportOwner": 1,
"isSupportReadOnly": 0,
"isSupportWsAdmin": 1,
"key": "pipeline.pipelineManage",
"name": "pipelines Management"
}
]
},
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 1,
"isSupportOwner": 1,
"isSupportReadOnly": 0,
"isSupportWsAdmin": 1,
"key": "blacklist.*",
"name": "Blacklist",
"subs": [
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 1,
"isSupportOwner": 1,
"isSupportReadOnly": 0,
"isSupportWsAdmin": 1,
"key": "blacklist.Manage",
"name": "Blacklist Management"
}
]
},
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 1,
"isSupportOwner": 1,
"isSupportReadOnly": 0,
"isSupportWsAdmin": 1,
"key": "generateMetrics.*",
"name": "Generate Metric",
"subs": [
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 1,
"isSupportOwner": 1,
"isSupportReadOnly": 0,
"isSupportWsAdmin": 1,
"key": "generateMetrics.cfgManage",
"name": "Generate Metric Configuration Management"
}
]
},
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 1,
"isSupportOwner": 1,
"isSupportReadOnly": 0,
"isSupportWsAdmin": 1,
"key": "trace.*",
"name": "Application Performance Monitoring",
"subs": [
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 1,
"isSupportOwner": 1,
"isSupportReadOnly": 1,
"isSupportWsAdmin": 1,
"key": "trace.Query",
"name": "Application Performance Data Query"
},
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 1,
"isSupportOwner": 1,
"isSupportReadOnly": 0,
"isSupportWsAdmin": 1,
"key": "trace.refLogManage",
"name": "Associated Log Management"
},
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 1,
"isSupportOwner": 1,
"isSupportReadOnly": 0,
"isSupportWsAdmin": 1,
"key": "trace.serviceManage",
"name": "Service Catalog Management"
}
]
},
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 1,
"isSupportOwner": 1,
"isSupportReadOnly": 0,
"isSupportWsAdmin": 1,
"key": "rum.*",
"name": "User Access Monitoring",
"subs": [
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 1,
"isSupportOwner": 1,
"isSupportReadOnly": 1,
"isSupportWsAdmin": 1,
"key": "rum.Query",
"name": "User Access Data Query"
},
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 1,
"isSupportOwner": 1,
"isSupportReadOnly": 0,
"isSupportWsAdmin": 1,
"key": "rum.trackCfgManage",
"name": "Trace Configuration Management"
},
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 1,
"isSupportOwner": 1,
"isSupportReadOnly": 0,
"isSupportWsAdmin": 1,
"key": "rum.rumCfgManage",
"name": "Application Configuration Management"
}
]
},
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 1,
"isSupportOwner": 1,
"isSupportReadOnly": 0,
"isSupportWsAdmin": 1,
"key": "dialTest.*",
"name": "Availability Monitoring",
"subs": [
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 1,
"isSupportOwner": 1,
"isSupportReadOnly": 0,
"isSupportWsAdmin": 1,
"key": "dialTest.taskManage",
"name": "Task Configuration Management"
},
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 1,
"isSupportOwner": 1,
"isSupportReadOnly": 0,
"isSupportWsAdmin": 1,
"key": "dialTest.customNodeManage",
"name": "Self-built Node Configuration Management"
}
]
},
{
"desc": "",
"disabled": 1,
"isSupportCustomRole": 0,
"isSupportGeneral": 0,
"isSupportOwner": 1,
"isSupportReadOnly": 0,
"isSupportWsAdmin": 1,
"key": "monitor.*",
"name": "Monitoring",
"subs": [
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 1,
"isSupportOwner": 1,
"isSupportReadOnly": 0,
"isSupportWsAdmin": 1,
"key": "monitor.cfgManage",
"name": "Monitor Configuration Management"
},
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 1,
"isSupportOwner": 1,
"isSupportReadOnly": 0,
"isSupportWsAdmin": 1,
"key": "monitor.obsCfgManage",
"name": "Smart Inspection Configuration Management"
},
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 1,
"isSupportOwner": 1,
"isSupportReadOnly": 0,
"isSupportWsAdmin": 1,
"key": "monitor.sloCfgManage",
"name": "SLO Configuration Management"
},
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 1,
"isSupportOwner": 1,
"isSupportReadOnly": 0,
"isSupportWsAdmin": 1,
"key": "monitor.muteCfgManage",
"name": "Silence Configuration Management"
},
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 1,
"isSupportOwner": 1,
"isSupportReadOnly": 0,
"isSupportWsAdmin": 1,
"key": "monitor.alarmPolicyMange",
"name": "Alert Policy Configuration Management"
},
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 0,
"isSupportOwner": 1,
"isSupportReadOnly": 0,
"isSupportWsAdmin": 1,
"key": "monitor.notifyObjCfgManage",
"name": "Notification Target Configuration Management"
}
]
},
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 0,
"isSupportOwner": 1,
"isSupportReadOnly": 0,
"isSupportWsAdmin": 1,
"key": "dca.*",
"name": "DCA",
"subs": [
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 0,
"isSupportOwner": 1,
"isSupportReadOnly": 0,
"isSupportWsAdmin": 1,
"key": "dca.dcaManage",
"name": "DCA Configuration Management"
}
]
},
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 1,
"isSupportOwner": 1,
"isSupportReadOnly": 0,
"isSupportWsAdmin": 1,
"key": "anomaly.*",
"name": "Exception Tracking",
"subs": [
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 1,
"isSupportOwner": 1,
"isSupportReadOnly": 0,
"isSupportWsAdmin": 1,
"key": "anomaly.issueReplyManage",
"name": "Reply Management"
},
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 0,
"isSupportOwner": 1,
"isSupportReadOnly": 0,
"isSupportWsAdmin": 1,
"key": "anomaly.issueLevelManage",
"name": "issueLevel Management"
},
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 1,
"isSupportOwner": 1,
"isSupportReadOnly": 0,
"isSupportWsAdmin": 1,
"key": "anomaly.channelManage",
"name": "Channel Management"
},
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 1,
"isSupportOwner": 1,
"isSupportReadOnly": 0,
"isSupportWsAdmin": 1,
"key": "anomaly.issueManage",
"name": "Problem Management"
}
]
},
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 1,
"isSupportOwner": 1,
"isSupportReadOnly": 1,
"isSupportWsAdmin": 1,
"key": "security.*",
"name": "Security Inspection",
"subs": [
{
"desc": "",
"disabled": 0,
"isSupportCustomRole": 1,
"isSupportGeneral": 1,
"isSupportOwner": 1,
"isSupportReadOnly": 1,
"isSupportWsAdmin": 1,
"key": "security.Query",
"name": "Security Inspection Data Query"
}
]
}
],
"errorCode": "",
"message": "",
"success": true,
"traceId": "6723047324511428850"
}