Skip to content

Modify Role¶

POST /api/v1/role/{role_uuid}/modify

Overview¶

Modify an existing role

Route Parameters¶

Parameter Name	Type	Required	Description
role_uuid	string	Yes	Role UUID

Body Request Parameters¶

Parameter Name	Type	Required	Description
name	string	Yes	Role name Example: Role No.1 Allow null: False Maximum length: 256
desc	string	No	Description of the role Example: CUSTOM Allow null: False Allow empty string: True Maximum length: 3000
keys	array	No	Selected permission list, must have at least one permission Example: [] Allow null: False

Additional Parameter Notes¶

Request Example¶

curl 'https://openapi.guance.com/api/v1/role/role_xxxx32/modify' \
-H 'Accept: application/json, text/plain, */*' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-raw '{"name":"test_temp_role1","desc":"test","keys":["workspace.readMember","label.labelCfgManage","share.shareManage","snapshot.delete","snapshot.create","log.externalIndexManage"]}' \
--compressed

Response¶

{
    "code": 200,
    "content": true,
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-647377FA-46A6-419A-AC26-CB0E871DBA28"
}