security iam role modify

The security iam role modify updates the description of a custom role.

You can run the security iam role modify command on a primary cluster only.

Syntax

CLI
maprcli security iam role modify -name <Role Name> -desc <Description Message>
REST
Request Type POST
Request URL 
http[s]://<host>:<port>/rest/iam/role/modify?<parameters>

Parameters

Parameter Description
name (Required) Name of the role.
desc (Required) Description for the role.
cluster (Optional) Name of the cluster.

Example

Modify the Eng role to add the description as Dev Engineers

maprcli security iam role modify -name Eng -desc "Dev Engineers" -json
{
        "timestamp":1726571720425,
        "timeofday":"2024-09-17 04:15:20.425 GMT-0700 AM",
        "status":"OK",
        "total":0,
        "data":[
        
        ],
        "messages":[
                "Successfully modified the role 'Eng'"
        ]
}

REST

curl -u <username> -X POST 'https://server.sj.us:8443/rest/security/iam/role/modify?name=Eng&desc="Dev Engineers"'