Skip to content

Commit

Permalink
Merge pull request #584 from RizaFarheen/main
Browse files Browse the repository at this point in the history
updates
  • Loading branch information
nhandt2021 authored Dec 6, 2023
2 parents c9af1f4 + 6aba826 commit 9e14350
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion docs/access-control-and-security/applications.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,25 @@ To create a new application,
2. Click **Create application** and provide an app name.
3. Once your application is created, click the edit button next to its name.

Depending upon your role, you can see two different role sections that can be granted to the application.

<p align="center"><img src="/content/img/app-roles.png" alt="App roles" width="100%" height="auto"></img></p>

The general application roles that can be granted include:

The following roles can be granted to the application.
* **Worker**: Poll and update tasks. It requires EXECUTE permissions on the tasks.
* **Metadata API**: Create and manage workflow and task definitions.
* **Application API**: Create and manage applications.

The application behavior depends entirely on the app role chosen. Ensure that you select the role based on your requirements.

In addition, if you are an Admin in the Orkes Conductor console, then you can see an additional set of following unrestricted roles that are to be granted carefully as they provide full access to different APIs:

- **Unrestricted Worker** - Poll, execute updates, maintain logs, and handle any task without any constraints
- **Metadata Manager** - Create, update, delete, and administer Workflow or Task definitions permissions.
- **Workflow Manager** - Responsible for managing the lifecycle of workflows within the system. Initiate, pause, resume, rerun, delete, and oversee any Workflow operation.
- **Application Manager** - Handles the creation, modification, and deletion of applications within the system.

### Generating Access Keys​
Once your application's permission levels are chosen, access must be granted to the application. This is done by generating an Access Key. Click **Create access key** to generate a unique **Key Id** and **Key Secret**. These values are shown only once, so ensure to copy the credentials and store them privately.

Expand Down
Binary file added static/img/app-roles.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9e14350

Please sign in to comment.