diff --git a/en/asgardeo/docs/assets/img/guides/workflows/approval-details.png b/en/asgardeo/docs/assets/img/guides/workflows/approval-details.png new file mode 100644 index 0000000000..f4489a8cdd Binary files /dev/null and b/en/asgardeo/docs/assets/img/guides/workflows/approval-details.png differ diff --git a/en/asgardeo/docs/assets/img/guides/workflows/myaccount-approval.png b/en/asgardeo/docs/assets/img/guides/workflows/myaccount-approval.png new file mode 100644 index 0000000000..75816cf288 Binary files /dev/null and b/en/asgardeo/docs/assets/img/guides/workflows/myaccount-approval.png differ diff --git a/en/asgardeo/docs/assets/img/guides/workflows/workflow-approvals.png b/en/asgardeo/docs/assets/img/guides/workflows/workflow-approvals.png new file mode 100644 index 0000000000..e050748904 Binary files /dev/null and b/en/asgardeo/docs/assets/img/guides/workflows/workflow-approvals.png differ diff --git a/en/asgardeo/docs/assets/img/guides/workflows/workflow-request-details.png b/en/asgardeo/docs/assets/img/guides/workflows/workflow-request-details.png new file mode 100644 index 0000000000..387e7f2564 Binary files /dev/null and b/en/asgardeo/docs/assets/img/guides/workflows/workflow-request-details.png differ diff --git a/en/asgardeo/docs/assets/img/guides/workflows/workflow-requests.png b/en/asgardeo/docs/assets/img/guides/workflows/workflow-requests.png new file mode 100644 index 0000000000..d05aa688fe Binary files /dev/null and b/en/asgardeo/docs/assets/img/guides/workflows/workflow-requests.png differ diff --git a/en/asgardeo/docs/assets/img/guides/workflows/workflow-steps-configuration.png b/en/asgardeo/docs/assets/img/guides/workflows/workflow-steps-configuration.png new file mode 100644 index 0000000000..9b70c364d8 Binary files /dev/null and b/en/asgardeo/docs/assets/img/guides/workflows/workflow-steps-configuration.png differ diff --git a/en/asgardeo/docs/guides/user-self-service/manage-approvals.md b/en/asgardeo/docs/guides/user-self-service/manage-approvals.md new file mode 100644 index 0000000000..e89845afaf --- /dev/null +++ b/en/asgardeo/docs/guides/user-self-service/manage-approvals.md @@ -0,0 +1 @@ +{% include "../../../../includes/guides/user-self-service/manage-approvals.md" %} diff --git a/en/asgardeo/docs/guides/workflows/approve-workflow.md b/en/asgardeo/docs/guides/workflows/approve-workflow.md new file mode 100644 index 0000000000..dca327f313 --- /dev/null +++ b/en/asgardeo/docs/guides/workflows/approve-workflow.md @@ -0,0 +1 @@ +{% include "../../../../includes/guides/workflows/approve-workflow.md" %} diff --git a/en/asgardeo/docs/guides/workflows/index.md b/en/asgardeo/docs/guides/workflows/index.md new file mode 100644 index 0000000000..b010e5884b --- /dev/null +++ b/en/asgardeo/docs/guides/workflows/index.md @@ -0,0 +1 @@ +{% include "../../../../includes/guides/workflows/index.md" %} diff --git a/en/asgardeo/docs/guides/workflows/workflow-requests.md b/en/asgardeo/docs/guides/workflows/workflow-requests.md new file mode 100644 index 0000000000..1ae59dad0c --- /dev/null +++ b/en/asgardeo/docs/guides/workflows/workflow-requests.md @@ -0,0 +1 @@ +{% include "../../../../includes/guides/workflows/workflow-requests.md" %} diff --git a/en/asgardeo/mkdocs.yml b/en/asgardeo/mkdocs.yml index c84973e747..7566d62028 100644 --- a/en/asgardeo/mkdocs.yml +++ b/en/asgardeo/mkdocs.yml @@ -394,6 +394,10 @@ nav: - Manage remote user stores: guides/users/user-stores/update-user-stores.md - Deployment best practices: guides/users/user-stores/deployment-best-practices.md - Advanced configuration for the agent: guides/users/user-stores/advanced-configurations-for-the-agent.md + - Workflows: + - Workflows: guides/workflows/index.md + - Approvals: guides/workflows/approve-workflow.md + - Workflow requests: guides/workflows/workflow-requests.md - Account configurations: - Account configurations: guides/account-configurations/index.md - Login security: @@ -428,6 +432,7 @@ nav: - Enroll TOTP: guides/user-self-service/enable-totp.md - Manage backup codes: guides/user-self-service/manage-backup-codes.md - Discover applications: guides/user-self-service/discover-applications.md + - Manage approvals: guides/user-self-service/manage-approvals.md - Build self-service capabilities: guides/user-self-service/build-self-service-capabilities.md - Organizations: - Organizations: guides/organization-management/index.md diff --git a/en/identity-server/next/docs/assets/img/guides/workflows/approval-details.png b/en/identity-server/next/docs/assets/img/guides/workflows/approval-details.png new file mode 100644 index 0000000000..f4489a8cdd Binary files /dev/null and b/en/identity-server/next/docs/assets/img/guides/workflows/approval-details.png differ diff --git a/en/identity-server/next/docs/assets/img/guides/workflows/myaccount-approval.png b/en/identity-server/next/docs/assets/img/guides/workflows/myaccount-approval.png new file mode 100644 index 0000000000..75816cf288 Binary files /dev/null and b/en/identity-server/next/docs/assets/img/guides/workflows/myaccount-approval.png differ diff --git a/en/identity-server/next/docs/assets/img/guides/workflows/workflow-approvals.png b/en/identity-server/next/docs/assets/img/guides/workflows/workflow-approvals.png new file mode 100644 index 0000000000..e050748904 Binary files /dev/null and b/en/identity-server/next/docs/assets/img/guides/workflows/workflow-approvals.png differ diff --git a/en/identity-server/next/docs/assets/img/guides/workflows/workflow-request-details.png b/en/identity-server/next/docs/assets/img/guides/workflows/workflow-request-details.png new file mode 100644 index 0000000000..387e7f2564 Binary files /dev/null and b/en/identity-server/next/docs/assets/img/guides/workflows/workflow-request-details.png differ diff --git a/en/identity-server/next/docs/assets/img/guides/workflows/workflow-requests.png b/en/identity-server/next/docs/assets/img/guides/workflows/workflow-requests.png new file mode 100644 index 0000000000..d05aa688fe Binary files /dev/null and b/en/identity-server/next/docs/assets/img/guides/workflows/workflow-requests.png differ diff --git a/en/identity-server/next/docs/assets/img/guides/workflows/workflow-steps-configuration.png b/en/identity-server/next/docs/assets/img/guides/workflows/workflow-steps-configuration.png new file mode 100644 index 0000000000..9b70c364d8 Binary files /dev/null and b/en/identity-server/next/docs/assets/img/guides/workflows/workflow-steps-configuration.png differ diff --git a/en/identity-server/next/docs/guides/user-self-service/manage-approvals.md b/en/identity-server/next/docs/guides/user-self-service/manage-approvals.md new file mode 100644 index 0000000000..4e1059523d --- /dev/null +++ b/en/identity-server/next/docs/guides/user-self-service/manage-approvals.md @@ -0,0 +1 @@ +{% include "../../../../../includes/guides/user-self-service/manage-approvals.md" %} diff --git a/en/identity-server/next/docs/guides/workflows/approve-workflow.md b/en/identity-server/next/docs/guides/workflows/approve-workflow.md new file mode 100644 index 0000000000..c267455b2b --- /dev/null +++ b/en/identity-server/next/docs/guides/workflows/approve-workflow.md @@ -0,0 +1 @@ +{% include "../../../../../includes/guides/workflows/approve-workflow.md" %} diff --git a/en/identity-server/next/docs/guides/workflows/index.md b/en/identity-server/next/docs/guides/workflows/index.md new file mode 100644 index 0000000000..b9265469bb --- /dev/null +++ b/en/identity-server/next/docs/guides/workflows/index.md @@ -0,0 +1 @@ +{% include "../../../../../includes/guides/workflows/index.md" %} diff --git a/en/identity-server/next/docs/guides/workflows/workflow-requests.md b/en/identity-server/next/docs/guides/workflows/workflow-requests.md new file mode 100644 index 0000000000..1346d5acb1 --- /dev/null +++ b/en/identity-server/next/docs/guides/workflows/workflow-requests.md @@ -0,0 +1 @@ +{% include "../../../../../includes/guides/workflows/workflow-requests.md" %} diff --git a/en/identity-server/next/mkdocs.yml b/en/identity-server/next/mkdocs.yml index 1bb664babe..d4ed841124 100644 --- a/en/identity-server/next/mkdocs.yml +++ b/en/identity-server/next/mkdocs.yml @@ -657,6 +657,10 @@ nav: - Migrate users to WSO2 Identity Server: guides/users/migrate-users/index.md - Migrate user accounts: guides/users/migrate-users/migrate-users.md - Migrate user passwords: guides/users/migrate-users/migrate-passwords.md + - Workflows: + - Workflows: guides/workflows/index.md + - Approvals: guides/workflows/approve-workflow.md + - Workflow requests: guides/workflows/workflow-requests.md - Account configurations: - Account configurations: guides/account-configurations/index.md - Login security: @@ -692,6 +696,8 @@ nav: - Enroll TOTP: guides/user-self-service/enable-totp.md - Manage backup codes: guides/user-self-service/manage-backup-codes.md - Discover applications: guides/user-self-service/discover-applications.md + - Manage approvals: guides/user-self-service/manage-approvals.md + - Build self-service capabilities: guides/user-self-service/build-self-service-capabilities.md - Organizations: - Organizations: guides/organization-management/index.md diff --git a/en/includes/guides/user-self-service/configure-self-service-portal.md b/en/includes/guides/user-self-service/configure-self-service-portal.md index 5bf17785dc..e0015cb7f9 100644 --- a/en/includes/guides/user-self-service/configure-self-service-portal.md +++ b/en/includes/guides/user-self-service/configure-self-service-portal.md @@ -13,9 +13,6 @@ Users can access the My Account portal using the following link - {{my_account_l ``` bash {{my_account_org_link}} ``` - - - Listed below are self-service features that are available for the user in the **My Account portal**. - [Update profile information]({{base_path}}/guides/user-self-service/update-profile-info/) @@ -29,8 +26,10 @@ Listed below are self-service features that are available for the user in the ** - [Manage password recovery]({{base_path}}/guides/user-self-service/user-password-recovery/) - [Discover and maintain applications]({{base_path}}/guides/user-self-service/discover-applications/) - [Register passkeys]({{base_path}}/guides/user-self-service/register-passkey/) +- [View and update the approvals]({{base_path}}/guides/user-self-service/manage-approvals/) {% if product_name == "Asgardeo" or (product_name == "WSO2 Identity Server" and is_version != "7.0.0")%} + ## Enable/Disable the My Account portal Follow the steps given below to manage access to the My Account portal for users in your organization. @@ -59,4 +58,4 @@ To do so, !!! note Explore the authentication options offered by {{product_name}} in the [Authentication]({{base_path}}/guides/authentication/) section. -4. Click **Update** to save the changes. \ No newline at end of file +4. Click **Update** to save the changes. diff --git a/en/includes/guides/user-self-service/manage-approvals.md b/en/includes/guides/user-self-service/manage-approvals.md new file mode 100644 index 0000000000..716750a038 --- /dev/null +++ b/en/includes/guides/user-self-service/manage-approvals.md @@ -0,0 +1,9 @@ +Using the My Account Portal, users can view and update their approvals. This allows users to manage their pending requests and actions that require their attention. + +To view the approvals, user can navigate to the **Approvals** section from the My Account Portal side menu. + +![My Account Approvals]({{base_path}}/assets/img/guides/workflows/myaccount-approval.png){: width="800" style="display: block; margin: 0; border: 0.3px solid lightgrey;"} + +This page shows all the approvals available for the user to approve. + +Learn more about the approvals and its lifecycle in the [Approvals]({{base_path}}/guides/workflows/approve-workflow/) guide. diff --git a/en/includes/guides/workflows/approve-workflow.md b/en/includes/guides/workflows/approve-workflow.md new file mode 100644 index 0000000000..f9ab6e407c --- /dev/null +++ b/en/includes/guides/workflows/approve-workflow.md @@ -0,0 +1,24 @@ +To view the workflow approvals, you need to navigate to the **Approvals** page under the **User Management** in the admin console or in the [My Account]({{base_path}}/guides/user-self-service/manage-approvals/). There, you will see a list of approvals that you can approve. + +![Workflow approval page]({{base_path}}/assets/img/guides/workflows/workflow-approvals.png){: width="800" style="display: block; margin: 0; border: 0.3px solid lightgrey;"} + +### Approval lifecycle + +Approval lifecycle contains several states: + +- **Reserved**: You have claimed(assigned) the approval, so no one else can approve it until you either approve or release it. +- **Ready**: You can approve this request. This status appears when no one has claimed it yet. +- **Approved**: You have approved the request. +- **Rejected**: You have rejected the request. +- **Blocked**: Another participant has claimed the approval, so you can’t act on it. + +!!! Note + Claiming an approval lets you assign it to yourself. Once you claim an approval, no one else can approve it. This helps ensure that only you approve the request. + + Also note that even if you claim an approval, you can still release it back to the pool of approvals so that other participants can approve it. + +### View approval details + +To view the details of an approval, you can click on the approval in the list. This will open the approval details page where you can see the details of the approval related to the operation. + +![Approval details]({{base_path}}/assets/img/guides/workflows/approval-details.png){: width="800" style="display: block; margin: 0; border: 0.3px solid lightgrey;"} diff --git a/en/includes/guides/workflows/index.md b/en/includes/guides/workflows/index.md new file mode 100644 index 0000000000..ba0c675f78 --- /dev/null +++ b/en/includes/guides/workflows/index.md @@ -0,0 +1,36 @@ +Workflows are a series of steps that require to complete a selected operation in the {{ product_name }}. These workflows +should be configured by the administrators by defining the steps and the participants involved in each step. + +### Create a workflow + +To create a workflow, visit the **Workflows** section in the admin console and go to the **Approval Workflows** section. +Now you can create a new workflow by clicking on the **New Approval Workflow** button. You will be prompted to provide a + name and description for the workflow. + +### Configure workflow operations + +Once you have provided the name and description, you can select the operations that this workflow should support. +The workflows are supported following types of operations: + +- **User Creation**: Triggered when a new user is created. +- **User Deletion**: Triggered when a user is deleted. +- **Role Creation**: Triggered when a new role is created. +- **User Role Assignment**: Triggered when users of a role have changed. + +!!! note + In the workflow creation page, you can select multiple operations if approval steps are common for those operations. + +### Configure workflow steps + +The final configuration of the workflow creation is to configure the steps of the workflow. You can add multiple steps to a workflow and each step can have multiple participants. The participants can be either users or roles. + +![Workflow steps configuration]({{base_path}}/assets/img/guides/workflows/workflow-steps-configuration.png){: width="600" style="display: block; margin: 0; border: 0.3px solid lightgrey;"} + +Once you have configured the steps, you can save the workflow. The workflow will now be available for use in the system. + +!!! note + If you assign admin user in the first step of approval and if admin creates a user, still workflow will be triggered. + And also other participants of the first step will also receive the approval request. + +Once the workflow is created, you can view the details of the workflow, edit it or delete it. +To approve the workflow, you need to go the approvals section under the User Management in the console or use my account approvals. See [Approve a workflow]({{base_path}}/guides/workflows/approve-workflow/) for more information on how to approve a workflow. diff --git a/en/includes/guides/workflows/workflow-requests.md b/en/includes/guides/workflows/workflow-requests.md new file mode 100644 index 0000000000..45d87691c8 --- /dev/null +++ b/en/includes/guides/workflows/workflow-requests.md @@ -0,0 +1,20 @@ +Workflow request page is located under the workflows section. It gives administrators full visibility into every workflow approval request across the tenant. +Administrators can use it to audit progress, and detect bottlenecks. + +![Workflow request page]({{base_path}}/assets/img/guides/workflows/workflow-requests.png){: width="800" style="display: block; margin: 0; border: 0.3px solid lightgrey;"} + +This page lists all the workflow requests that are the tenant. You can filter the requests by the Operation Type, Status, Created Time Range and Updated Time Range. + +### Status of the workflow requests + +- **Pending**: The workflow request is pending and waiting for approval. +- **Approved**: The workflow request is approved by the participant/s. +- **Rejected**: The workflow request is rejected by a participant. +- **Failed**: The workflow request has failed after the approval due to an error. +- **Deleted**: The workflow request has been deleted by the administrator. + +### View workflow request details + +To view the details of a workflow request, you can click on the request in the list. + +![Workflow request page]({{base_path}}/assets/img/guides/workflows/workflow-request-details.png){: width="800" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}