Manage Actions
- Print
- PDF
Manage Actions
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
1. Get All Actions
This GET method returns the details of all actions.
Note: To execute this API, the user should have permission assigned (through policy) with action as authz.action.list.
| GET | {{url}}/api/v1/policy-admin/actions |
curl -X GET '{{url}}/api/v1/policy-admin/actions' -H 'Authorization: Bearer <token>'Response Example
| Status: 200 Ok |
{
"result": [
{
"tenantId": "default",
"name": "ada.queryengine.view",
"description": "Queryengine view action",
"consumer": "ada",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "ada.riskanalytics.view",
"description": "Riskanalytics view action",
"consumer": "ada",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "apps.app.list",
"description": "Application list action",
"consumer": "apps",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "apps.app.manage",
"description": "Application manage action",
"consumer": "apps",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "apps.app.view",
"description": "Application view action",
"consumer": "apps",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.*.*",
"description": "Auth - all actions",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.action.list",
"description": "Action list action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.action.read",
"description": "Action read action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.approval.list",
"description": "Approval get all action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.condition.*",
"description": "Condition - all actions",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.condition.create",
"description": "Condition create action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.condition.delete",
"description": "Condition delete action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.condition.list",
"description": "Condition list action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.condition.read",
"description": "Condition read action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.condition.update",
"description": "Condition update action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.consumer.list",
"description": "Consumer list action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.consumer.read",
"description": "Consumer read action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.permission.*",
"description": "Permission - all actions",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.permission.create",
"description": "Permission create action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.permission.delete",
"description": "Permission delete action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.permission.list",
"description": "Permission list action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.permission.read",
"description": "Permission read action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.permission.update",
"description": "Permission update action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.policy.*",
"description": "Policy - all actions",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.policy.create",
"description": "Policy create action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.policy.delete",
"description": "Policy delete action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.policy.list",
"description": "Policy list action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.policy.read",
"description": "Policy read action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.policy.update",
"description": "Policy update action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.role.*",
"description": "Role - all actions",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.role.create",
"description": "Role create action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.role.delete",
"description": "Role delete action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.role.list",
"description": "Role list action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.role.read",
"description": "Role read action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.role.update",
"description": "Role update action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "diagnostics.audit.list",
"description": "Audit log list action",
"consumer": "diagnostics",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "diagnostics.audit.view",
"description": "Audit log view action",
"consumer": "diagnostics",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "identity.user.list",
"description": "Identity Management list action",
"consumer": "identity",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "identity.user.manage",
"description": "Identity Management view manage",
"consumer": "identity",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "identity.user.view",
"description": "Identity Management view action",
"consumer": "identity",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "nm.*.*",
"description": "Notification Medium All actions",
"consumer": "notificationmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "nm.channels.list",
"description": "get channel list",
"consumer": "notificationmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "nm.notification.*",
"description": "Notification All actions",
"consumer": "notificationmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "nm.notification.create",
"description": "Create Notification Medium",
"consumer": "notificationmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "nm.notification.delete",
"description": "Delete Notification Medium",
"consumer": "notificationmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "nm.notification.list",
"description": "List Notification Medium",
"consumer": "notificationmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "nm.notification.read",
"description": "Get Notification Medium",
"consumer": "notificationmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "nm.notification.update",
"description": "Update Notification Medium",
"consumer": "notificationmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "nm.notificationmetadata.list",
"description": "List Notification Medium Metadata",
"consumer": "notificationmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "nm.notificationmetadata.read",
"description": "Get Notification Medium Metadata",
"consumer": "notificationmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "reports.report.list",
"description": "Report list action",
"consumer": "reports",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "reports.report.view",
"description": "Report view action",
"consumer": "reports",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "securityadmin.security.list",
"description": "Security list action",
"consumer": "securityadmin",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "securityadmin.security.manage",
"description": "Security manage action",
"consumer": "securityadmin",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "securityadmin.security.view",
"description": "Security view action",
"consumer": "securityadmin",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "sm.*.*",
"description": "Secret Manager all actions",
"consumer": "secretmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "sm.key.rotate",
"description": "Key rotation action",
"consumer": "secretmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "sm.node.*",
"description": "Node all actions",
"consumer": "secretmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "sm.node.create",
"description": "Node create action",
"consumer": "secretmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "sm.node.delete",
"description": "Node delete action",
"consumer": "secretmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "sm.node.list",
"description": "Node list action",
"consumer": "secretmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "sm.node.read",
"description": "Node read action",
"consumer": "secretmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "sm.node.update",
"description": "Node update action",
"consumer": "secretmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "sm.passwordpolicy.*",
"description": "Password Policy all actions",
"consumer": "secretmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "sm.passwordpolicy.create",
"description": "Password Policy create action",
"consumer": "secretmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "sm.passwordpolicy.delete",
"description": "Password Policy delete action",
"consumer": "secretmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "sm.passwordpolicy.list",
"description": "Password Policy list action",
"consumer": "secretmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "sm.passwordpolicy.read",
"description": "Password policy read action",
"consumer": "secretmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "sm.passwordpolicy.update",
"description": "Password Policy update action",
"consumer": "secretmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "sm.secret.*",
"description": "Secret all actions",
"consumer": "secretmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "sm.secret.create",
"description": "Secret create action",
"consumer": "secretmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "sm.secret.delete",
"description": "Secret delete action",
"consumer": "secretmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "sm.secret.list",
"description": "Secret list action",
"consumer": "secretmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "sm.secret.read",
"description": "Secret read action",
"consumer": "secretmanager",
"isApprovalApplicable": true
},
{
"tenantId": "default",
"name": "sm.secret.update",
"description": "Secret update action",
"consumer": "secretmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "sm.secrettemplate.*",
"description": "Secret Template all actions",
"consumer": "secretmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "sm.secrettemplate.create",
"description": "Secret Template create action",
"consumer": "secretmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "sm.secrettemplate.delete",
"description": "Secret Template delete action",
"consumer": "secretmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "sm.secrettemplate.list",
"description": "Secret Template list action",
"consumer": "secretmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "sm.secrettemplate.read",
"description": "Secret Template read action",
"consumer": "secretmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "sm.secrettemplate.update",
"description": "Secret Template update action",
"consumer": "secretmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "sm.vault.*",
"description": "Vault all actions",
"consumer": "secretmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "sm.vault.create",
"description": "Vault create action",
"consumer": "secretmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "sm.vault.delete",
"description": "Vault delete action",
"consumer": "secretmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "sm.vault.list",
"description": "Vault list action",
"consumer": "secretmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "sm.vault.read",
"description": "Vault read action",
"consumer": "secretmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "sm.vault.update",
"description": "Vault update action",
"consumer": "secretmanager",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "workflows.notification.list",
"description": "Workflow list action",
"consumer": "workflows",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "workflows.notification.manage",
"description": "Workflow manage action",
"consumer": "workflows",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "workflows.notification.view",
"description": "Workflow view action",
"consumer": "workflows",
"isApprovalApplicable": false
}
]
}2. Get Action by Name
This GET method returns details of a specified actions, filtered by action name.
Note: To execute this API, the user should have permission assigned (through policy) with action as authz.action.list.
| GET | {{url}}/api/v1/policyadmin/actions?filter=name eq {{name}} |
Request Parameters
The request parameter used in this method is shown in the following table:
| Parameter | Description | Data Type | Required |
filter | The filter that can filter the list of actions based on the name of an action. The supported operators are 'eq', 'sw' and 'co'. An example format is given here: name eq sm.vault | String | Mandatory |
Request Example
curl -X GET '{{url}}/api/v1/policy-admin/actions?filter=name%20eq%20sm.vault.*' -H 'Authorization: Bearer <token>'Response Example
| Status: 200 Ok |
{
"result": [
{
"tenantId": "default",
"name": "sm.vault.*",
"description": "Vault all actions",
"consumer": "secretmanager",
"isApprovalApplicable": false
}
]
}3. Get Consumer Specific Actions
This GET method returns all actions specific to a consumer. The list can be filtered using a consumer name.
Note: To execute this API, the user should have permission assigned (through policy) with action as authz.action.list.
| GET | {{url}}/policyadmin/actionspolicy-admin/actions?filter=consumer eq {{name}} |
Request Parameters
The request parameters used in this method are shown in the following table:
| Parameter | Description | Data Type | Required |
filter | The filter that can filter the list of actions based on the consumer name. The supported operators are 'eq', 'sw' and 'co'. An example format is given here: name eq authz | String | Mandatory |
Request Example
curl -X GET '{{url}}/policy-admin/actions?filter=consumer%20eq%20authz' -H 'Authorization: Bearer <token>'Response Example
| Status: 200 Ok |
{
"result": [
{
"tenantId": "default",
"name": "authz.condition.update",
"description": "Condition update action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.permission.read",
"description": "Permission read action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.role.update",
"description": "Role update action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.condition.list",
"description": "Condition list action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.role.delete",
"description": "Role delete action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.condition.*",
"description": "Condition - all actions",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.action.list",
"description": "Action list action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.role.*",
"description": "Role - all actions",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.permission.create",
"description": "Permission create action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.*.*",
"description": "Auth - all actions",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.action.read",
"description": "Action read action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.policy.delete",
"description": "Policy delete action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.permission.update",
"description": "Permission update action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.policy.*",
"description": "Policy - all actions",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.condition.create",
"description": "Condition create action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.permission.*",
"description": "Permission - all actions",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.role.create",
"description": "Role create action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.policy.create",
"description": "Policy create action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.condition.read",
"description": "Condition read action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.consumer.read",
"description": "Consumer read action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.consumer.list",
"description": "Consumer list action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.permission.list",
"description": "Permission list action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.policy.update",
"description": "Policy update action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.role.list",
"description": "Role list action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.permission.delete",
"description": "Permission delete action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.approval.list",
"description": "Approval get all action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.policy.list",
"description": "Policy list action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.condition.delete",
"description": "Condition delete action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.policy.read",
"description": "Policy read action",
"consumer": "authz",
"isApprovalApplicable": false
},
{
"tenantId": "default",
"name": "authz.role.read",
"description": "Role read action",
"consumer": "authz",
"isApprovalApplicable": false
}
]
}Was this article helpful?
