-
Notifications
You must be signed in to change notification settings - Fork 228
User ops audit log #7847
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
User ops audit log #7847
Changes from all commits
fa20e43
1b8b329
9bcf6e7
98d3f22
1f01b7b
1331e6c
dca0c98
a50cfe7
7660cff
d134ca3
6bbfe82
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| --- | ||
| id: audit-operations | ||
| title: Audit operations | ||
| description: "Learn how to audit operations." | ||
| --- | ||
|
|
||
| Audit [operations](../user-operations-audit-log/overview.md) in Camunda 8 Identity. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| To follow the steps in this guide, you must be [authorized to view operations in the audit log](../user-operations-audit-log/overview/access-control.md). | ||
|
|
||
| ## Audit operations | ||
|
|
||
| In Identity, you can audit all [`ADMIN` operations](../user-operations-audit-log/overview/recorded-operations.md#admin-operations): | ||
|
|
||
| 1. In the top navigation, click **Operations log**. | ||
| 2. To sort the log, click a column header. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm not sure if this second step is necessary. My rational was twofold:
|
||
|
|
||
| ## Next steps | ||
|
|
||
| - [Learn about the operation data structure in the operations log.](../user-operations-audit-log/overview/operation-structure.md) | ||
| - [Use the Audit Log REST API to programmatically access the audit log](../../apis-tools/orchestration-cluster-api-rest/specifications/search-audit-logs.api.mdx). | ||
alexronquillo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| --- | ||
| id: audit-operations | ||
| title: Audit operations | ||
| description: "Learn how to audit operations." | ||
| --- | ||
|
|
||
| Audit [operations](../../user-operations-audit-log/overview.md) in Camunda 8 Operate. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| To follow the steps in this guide, you must be [authorized to view operations in the audit log](../../user-operations-audit-log/overview/access-control.md). | ||
|
|
||
| ## Audit all operations | ||
|
|
||
| In Operate, you can audit all [`DEPLOYED_RESOURCES` and `USER_TASKS` operations](../../user-operations-audit-log/overview/recorded-operations.md) in the general operations log: | ||
|
|
||
| 1. In the top navigation, click **Operations Log**. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I pointed this out in another channel, but the spelling is "Operations Log" (capital 'L') in Operate and "Operations log" (lowercase 'l') in Identity. I think we should make those consistent before we release the product and docs. |
||
| 2. To sort the log, click a column header. | ||
| 3. To see the details of a particular operation, click the info icon at the end of the row. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🔧 We will also add some filtering in the general audit log tab. But let's only document this when it's added.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. TODO |
||
|
|
||
| ## Audit process instance operations | ||
|
|
||
| You can also review operations at the process instance level: | ||
|
|
||
| 1. On the **Processes** page, in the **Process Instances** table, click the **Process Instance Key** of the instance you want to audit. | ||
alexronquillo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 2. Under the process diagram, click **Operations Log**. | ||
| 3. To sort the log, click a column header. | ||
| 4. To see the details of a particular operation, click the info icon at the end of the row. | ||
|
|
||
| ## Next steps | ||
|
|
||
| - [Learn about the operation data structure in the operations log.](../../user-operations-audit-log/overview/operation-structure.md) | ||
| - [Use the Audit Log REST API to programmatically access the audit log](../../../apis-tools/orchestration-cluster-api-rest/specifications/search-audit-logs.api.mdx). | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -21,5 +21,5 @@ On the batch operation details page, expand a failed item row to view the failur | |
|
|
||
| ## Next steps | ||
|
|
||
| - [Learn how to monitor a process instance operation](./monitor-operation-status.md). | ||
| - [Learn how to audit process instance operations](./audit-operations.md). | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Removed the old "Monitor" guide and pointed to the new audit instead. |
||
| - [Learn how to manage a batch operation](./manage-batch-operation.md). | ||
This file was deleted.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,16 +14,19 @@ You can assign these [in the Identity UI](components/identity/authorization.md#c | |
|
|
||
| The following mandatory authorizations are required to work with Tasklist: | ||
|
|
||
| | Authorization type | Resource type | Resource ID | Permission | | ||
| | :---------------------------- | :------------------- | :--------------------------------------------------------------------------------- | :--------------- | | ||
| | Component access for Tasklist | `Component` | `tasklist` or `*` (for access to all web components). | `ACCESS` | | ||
| | Read user tasks | `Process Definition` | ID of the respective BPMN process definition or `*` (for all process definitions). | `READ_USER_TASK` | | ||
| | Authorization type | Resource type | Resource ID | Permission | | ||
| | :----------------------------- | :------------------- | :--------------------------------------------------------------------------------- | :--------------- | | ||
| | Component access for Tasklist. | `Component` | `tasklist` or `*` (for access to all web components). | `ACCESS` | | ||
| | Read user tasks. | `Process Definition` | ID of the respective BPMN process definition or `*` (for all process definitions). | `READ_USER_TASK` | | ||
|
|
||
| ## Optional authorizations | ||
|
|
||
| The following optional authorizations can also be defined: | ||
|
|
||
| | Authorization type | Resource type | Resource ID | Permission | | ||
| | :----------------------------- | :------------------- | :--------------------------------------------------------------------------------- | :------------------------ | | ||
| | Assign and complete user tasks | `Process Definition` | ID of the respective BPMN process definition or `*` (for all process definitions). | `UPDATE_USER_TASK` | | ||
| | View BPMN diagrams | `Process Definition` | ID of the respective BPMN process definition or `*` (for all process definitions). | `READ_PROCESS_DEFINITION` | | ||
| | Authorization type | Resource type | Resource ID | Permission | | ||
| | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------- | :--------------------------------------------------------------------------------- | :------------------------ | | ||
| | View task history records. | `AUDIT_LOG` | `USER_TASKS` or `*` for all categories. | `READ` | | ||
| | Assign and complete user tasks. | `Process Definition` | ID of the respective BPMN process definition or `*` (for all process definitions). | `UPDATE_USER_TASK` | | ||
| | View BPMN diagrams. | `Process Definition` | ID of the respective BPMN process definition or `*` (for all process definitions). | `READ_PROCESS_DEFINITION` | | ||
| | View [`USER_TASKS` operations](../../user-operations-audit-log/overview/recorded-operations.md#user_tasks-operations) for instances of a specific process definition. | `PROCESS_DEFINITION` | A process definition ID or `*` for all process definitions. | `READ_USER_TASK` | | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Because we've added the operations log, I added the corresponding authorizations under "Optional authorizations" |
||
| | View task history records related to specific tasks the user has access to based on task properties. | `USER_TASK` | A user task property (`assignee`, `candidateUsers`, `candidateGroups`). | `READ` | | ||
Uh oh!
There was an error while loading. Please reload this page.