From cfeb20ded29c362ee9b45dc104240a432cb57569 Mon Sep 17 00:00:00 2001 From: Chloe Date: Fri, 9 Jun 2023 10:50:05 -0400 Subject: [PATCH] Updates roles and permissions topic --- .../getting-started/roles_persmissions.adoc | 440 ++++++++++++------ 1 file changed, 304 insertions(+), 136 deletions(-) diff --git a/docs/modules/ROOT/pages/getting-started/roles_persmissions.adoc b/docs/modules/ROOT/pages/getting-started/roles_persmissions.adoc index 6d1a85e5..2bb2f721 100644 --- a/docs/modules/ROOT/pages/getting-started/roles_persmissions.adoc +++ b/docs/modules/ROOT/pages/getting-started/roles_persmissions.adoc @@ -1,231 +1,399 @@ = Permissions and roles -As a workspace owner, you can https://placeholder.com[invite] one or more collaborators to your workspace by adding their user ID, such as an external SSO ID. After https://placeholder.com[adding a user to a workspace], you assign them a specific role that determines the actions they can take in a workspace. +As a workspace *Owner*, you can invite collaborators to your workspace by adding a user ID such as an external SSO ID. After you add a user to a workspace, you assign a specific role to designate what actions that user can perform. -The roles available for a workspace, from least access to most access, are: +The following list shows the roles that are available in a workspace: -* *Contributor*: Ideal for users who actively push to your workspace. +* *Contributor*: Ideal for users who actively push to your workspace +* *Maintainer*: Ideal for users who need to manage the workspace, but who don't need access to sensitive actions like managing security or deleting a workspace +* *Owner*: Ideal for users who need full access to the workspace, including sensitive actions like managing security or deleting a workspace -* *Maintainer*: Ideal for users who need to manage the workspace without access to sensitive actions like managing security or deleting a workspace. +NOTE: By default, any collaborator that you invite has the role of *Contributor*. -* *Owner*: Ideal for users who need full access to the workspace, including sensitive and destructive actions like managing security or deleting a workspace. +== Permissions by role -NOTE: By default, the role for newly invited collaborators is *Contributor* but you can upgrade it to *Maintainer* or *Owner*. +The role that you assign to a user determines the permissions that the user has in the workspace. The *Owner* role assigns all permissions. -== Permissions for each role - -The role assigned to a user determines the permissions they have within a workspace, with the Owner role assigning all permissions. +The following table shows the actions that each type of collaborator can perform: +.Permissions for each type of collaborator |=== -|Permissions for |Action |Contributor |Maintainer |Owner +|Action |Contributor |Maintainer |Owner |Tenant Admin + +|*Workspace:* -.4+|Workspace -|View -^|✔️ -^|✔️ -^|✔️ +View a workspace +^.>|✔️ +^.>|✔️ +^.>|✔️ +^.>|✔️ -|Create +|Create a workspace | | +^.^|✔️ +^.^|✔️ + +|Update a workspace | -|Update +^.^|✔️ +^.^|✔️ +^.^|✔️ +|Delete a workspace +| | +^.^|✔️ +^.^|✔️ + +|*Application:* + +View an application +^.>|✔️ +^.>|✔️ +^.>|✔️ +^.>|✔️ + +|Create an application | | -|Delete +^.^|✔️ +^.^|✔️ + +|Update an application | +^.^|✔️ +^.^|✔️ +^.^|✔️ +|Delete an application | | -.4+|Applications -|View -^|✔️ +^.^|✔️ +^.^|✔️ -^|✔️ -^|✔️ -|Create + +|*Component:* + +View a component +^.>|✔️ +^.>|✔️ +^.>|✔️ +^.>|✔️ + +|Create a component | -^|✔️ +^.^|✔️ +^.^|✔️ +^.^|✔️ -^|✔️ -|Update +|Update a component | -^|✔️ -^|✔️ +^.^|✔️ +^.^|✔️ +^.^|✔️ -|Delete +|Delete a component | | -^|✔️ -.4+|Component +^.^|✔️ +^.^|✔️ + -|View -^|✔️ -^|✔️ -^|✔️ -|Create +|*Environment:* +View an environment + +^.>|✔️ +^.>|✔️ +^.>|✔️ +^.>|✔️ + +|Create an environment | -^|✔️ -^|✔️ -|Update +^.^|✔️ +^.^|✔️ +^.^|✔️ + +|Update an environment | +^.^|✔️ +^.^|✔️ +^.^|✔️ -^|✔️ -^|✔️ +|Delete an environment | +^.^|✔️ +^.^|✔️ +^.^|✔️ + +|*Pipeline run:* + +View pipeline run + +^.>|✔️ +^.>|✔️ +^.>|✔️ +^.>|✔️ + +|Create pipeline run +^.^|✔️ +^.^|✔️ +^.^|✔️ +^.^|✔️ + +|Update pipeline run | +^.^|✔️ +^.^|✔️ +^.^|✔️ + +|Delete pipeline run | +^.^|✔️ +^.^|✔️ +^.^|✔️ + +|*IntegrationTestScenario:* + +View IntegrationTestScenario + +^.>|✔️ +^.>|✔️ +^.>|✔️ +^.>|✔️ + +|Create IntegrationTestScenario +| +^.^|✔️ +^.^|✔️ +^.^|✔️ + +|Update IntegrationTestScenario +| +^.^|✔️ +^.^|✔️ +^.^|✔️ + +|Delete IntegrationTestScenario +| +^.^|✔️ +^.^|✔️ +^.^|✔️ + +|*Enterprise Contract:* -^|✔️ -.4+|Environment -|View -^|✔️ -^|✔️ +View Enterprise Contract +^.>|✔️ +^.>|✔️ +^.>|✔️ +^.>|✔️ -^|✔️ -|Create +|Create Enterprise Contract | | -^|✔️ +| +^.^|✔️ -|Update +|Update Enterprise Contract | | -^|✔️ -|Delete +^.^|✔️ +^.^|✔️ +|Delete Enterprise Contract | | -^|✔️ -.4+|IntegrationTestScenario -|View +^.^|✔️ +^.^|✔️ + +|*Release strategy:* + +View Release strategy + +^.>|✔️ +^.>|✔️ +^.>|✔️ +^.>|✔️ -^|✔️ -^|✔️ -^|✔️ -|Create +|Create Release strategy | +^.^|✔️ +^.^|✔️ +^.^|✔️ -^|✔️ -^|✔️ -|Update +|Update Release strategy | -^|✔️ +^.^|✔️ +^.^|✔️ +^.^|✔️ -^|✔️ -|Delete +|Delete Release strategy | -^|✔️ -^|✔️ +^.^|✔️ +^.^|✔️ +^.^|✔️ -.4+|EnterpriseContract -|View -^|✔️ -^|✔️ -^|✔️ +|*Release Admission Plan:* +View Release Admission Plan -|Create +^.>|✔️ +^.>|✔️ +^.>|✔️ +^.>|✔️ + +|Create Release Admission Plan | +^.^|✔️ +^.^|✔️ +^.^|✔️ + +|Update Release Admission Plan | -^|✔️ -|Update +^.^|✔️ +^.^|✔️ +^.^|✔️ +|Delete Release Admission Plan | +^.^|✔️ +^.^|✔️ +^.^|✔️ + +|*User:* + +View a user +^.>|✔️ +^.>|✔️ +^.>|✔️ +^.>|✔️ + +|Create a user | -^|✔️ -|Delete +^.^|✔️ +^.^|✔️ +^.^|✔️ + +|Update a user | +^.^|✔️ +^.^|✔️ +^.^|✔️ +|Delete a user | -^|✔️ -.4+|ReleaseStrategy -|View -^|✔️ +^.^|✔️ +^.^|✔️ +^.^|✔️ + +|*User group:* + +View a user group -^|✔️ -^|✔️ -|Create +^.>|✔️ +^.>|✔️ +^.>|✔️ +^.>|✔️ + +|Create a user group | | +^.^|✔️ +^.^|✔️ -^|✔️ -|Update +|Update a user group | +^.^|✔️ +^.^|✔️ +^.^|✔️ + +|Delete a user group | -^|✔️ +^.^|✔️ +^.^|✔️ +^.^|✔️ + +|*Custom role:* + +View a custom role -|Delete +^.>|✔️ +^.>|✔️ +^.>|✔️ +^.>|✔️ + +|Create a custom role | | -^|✔️ -.4+|ReleasePlanAdmission - -|View -^|✔️ -^|✔️ -^|✔️ -|Create +^.^|✔️ +^.^|✔️ +|Update a custom role | -^|✔️ -^|✔️ -|Update | +^.^|✔️ +^.^|✔️ -^|✔️ -^|✔️ -|Delete +|Delete a custom role | -^|✔️ +| +^.^|✔️ +^.^|✔️ -^|✔️ -.4+|User -|View -^|✔️ -^|✔️ -^|✔️ -|Create -| -^|✔️ -^|✔️ +|*Tenant:* -|Update +View tenant + +| | -^|✔️ -^|✔️ -|Delete +^.>|✔️ +^.>|✔️ +|Create tenant | -^|✔️ -^|✔️ -.4+|User Group -|View +| +^.>|✔️ +^.>|✔️ -^|✔️ -^|✔️ -^|✔️ -|Create +|Update tenant +| | +^.^|✔️ +^.^|✔️ +|Delete tenant | -^|✔️ -|Update | -^|✔️ +^.^|✔️ +^.^|✔️ -^|✔️ -|Delete +|*Organization:* + +View organization + +^.>|✔️ +^.>|✔️ +^.>|✔️ +^.>|✔️ + +|Create organization +| | -^|✔️ -^|✔️ +^.^|✔️ +^.^|✔️ -|=== +|Update organization +| +^.^|✔️ +^.^|✔️ +^.^|✔️ -== Additional resources +|Delete organization +| +^.^|✔️ +^.^|✔️ +^.^|✔️ -* https://placeholder.com[Managing members of a project] +|=== \ No newline at end of file