Granting Permissions to Users or Groups
Use the post /v1/cckm/external-cm/domains/{id}/update-acls
API to grant permissions to users or groups to perform specified operations on an external CipherTrust Manager domain using CCKM.
User ID and group are mutually exclusive – specify either. For the first time users or groups, actions are permitted as configured by the CCKM administrator. However, if the permissions of a user or group need to be modified later, for example, a new action is to be permitted or an existing action is to be revoked, the CCKM administrator needs to set that particular action to true
or false
.
For example, a user or group is permitted actions, keycreate
and refresh
. Now, to permit one more action keydelete
to the user or group, set "permit":true
and "actions": "keydelete"
and run the API. Similarly, now to deny permission to the action keycreate
, set "permit":false
, "actions": "keycreate"
, and run the API.
Refer to Actions for actions supported by different APIs.
Syntax
Here, {id}
represents the ID of the external CipherTrust Manager domain resource on the CipherTrust Manager. Refer to Adding External CipherTrust Manager Domains to find out the resource ID of a domain.
Request Parameters
Parameter | Type | Description |
---|---|---|
AUTHTOKEN | string | Authorization token. |
acls | array of JSONs | Permissions to be granted to users and groups. Refer to ACLs for details. |
ACLs
Parameter | Type | Description |
---|---|---|
actions | array of strings | List of actions. The actions can be: • keycreate • keydelete • view • refresh Refer to Actions for details. |
group | string | Name of the user group to be granted permissions. User ID and group are mutually exclusive – specify either. |
permit | boolean | Whether to permit users to perform specific operations. Set true to permit, false to deny. |
user_id | string | ID of the user to be granted permissions. User ID and group are mutually exclusive – specify either. |
Actions
The following table lists the accepted values:
APIs | Actions | Description |
---|---|---|
Create | keycreate | Permission to create external CipherTrust Manager keys. |
Delete | keydelete | Permission to delete external CipherTrust Manager keys. |
Refresh | refresh | Permission to refresh external CipherTrust Manager domains. |
List | view | Permission to view external CipherTrust Manager domains and their keys. |
Get (External CipherTrust Manager domain keys) | view | Permission to view details of an external CipherTrust Manager key. |
List (External CipherTrust Manager domains) | view | Permission to view external CipherTrust Manager domains and their keys. |
Get (External CipherTrust Manager domain) | view | Permission to view details of an external CipherTrust Manager domain. |
Example Request
Example Response
The output shows the updated permissions for the domain with ID 0b840971-a6b8-460b-b01c-a982dd053939
.
Response Codes
Response Code | Description |
---|---|
2xx | Success |
4xx | Client errors |
5xx | Server errors |
Refer to HTTP status codes for details.