modifyKeyPermission
This API modifies key group permissions.
URL
<http/https>://<host-name>:<Port>/protectappws/services/rest/key/modifyKeyPermission
Input Parameters
| Parameters | Description |
|---|---|
| userName | User name (optional). |
| password | Password associated with the user (optional). |
| keyName | Name of the key for which usage permissions are to be modified for the associated groups. |
| permission | Tag using which the key permissions are set for each group. Permission for multiple groups can be set in a single request. |
| groupName | Name of the group for which the key permissions are to be set. |
| export | Set to true to have key export permission for the group using the key. Possible values: — true — false (default) |
| encrypt | Set to true to have encrypt permission for the group using the key. Possible values: — true — false (default) |
| decrypt | Set to true to have decrypt permission for the group using the key. Possible values: — true — false (default) |
| mac | Set to true to have MAC operation permission for the group using an HMAC key. Possible values: — true — false (default) |
| macv | set to true to have MAC Verify permission for the group using an HMAC key. Possible values: — true — false (default) |
| sign | Set to true to have signing operation permission for the group using an RSA key. Possible values: — true — false (default) |
| signv | Set to true to have sign verifying operation permission for the group using an RSA key. Possible values: — true — false (default) |
| certAlias | Client certificate alias for making SSL connections (optional). |
| certPass | Password for the provided certificate alias (optional). |
Note
Values for all the XML tags are to be provided in the XML request, even if a particular permission is not to be modified. Example: enter true for the encrypt parameter even if the group has encryption permission for the key, as leaving it blank will set the permission to false.
Sample REST call for cxf
request
{
"GroupPermissionsUpdateRequest": {
"userName": "twguser",
"password": "asdf1234",
"keyName": "Test_key_JCE",
"permissions": {
"permission": [
{
"groupName": "Group1",
"export": "true",
"encrypt": "false",
"decrypt": "true",
"mac": "",
"macv": "",
"sign": "false",
"signv": "false"
},
{
"groupName": "Group2",
"export": "false",
"encrypt": "false",
"decrypt": "true",
"mac": "",
"macv": "",
"sign": "false",
"signv": "false"
}
]
}
}
}
response
{
" GroupPermissionUpdateResponse": {
"result": "permissions are updated successfully."
}
}
