Skip to content

Commit 03d4ad0

Browse files
author
Donna-Marie Smith
committed
Added Studio Authorisation pages
1 parent 9481ee2 commit 03d4ad0

File tree

8 files changed

+109
-7
lines changed

8 files changed

+109
-7
lines changed
Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
---
2+
title: "Studio Authorisation"
3+
linkTitle: "Studio Authorisation"
4+
description: "Manage the authorisation for access to flows in {{% ctx %}} Gateway."
5+
weight: 50
6+
---
7+
8+
# {{% param title %}}
9+
10+
## Summary
11+
12+
The Studio Authorisation page is used to manage the authorisation for access to flows within {{% ctx %}} Gateway. Each flow can be set to have [View][] or [Edit][] permissions assigned to LDAP Groups, or no access permissions at all.
13+
14+
| | |
15+
|------------------------------|-----------------------------------------------------------------|
16+
| **Roles Required:** | Admin |
17+
18+
## Anatomy
19+
20+
{{< figure src="/images/Studio Authorisation.png" title="Studio Authorisation" >}}
21+
22+
The LDAP Groups that may be granted access are limited to those assigned the Studio role in LDAP Authorisation.
23+
24+
Permissions are set either explicitly or implicitly. Explicitly set permissions are assigned by the user performing an explicit action to set that item’s permissions, whereas implicitly set permissions are assigned automatically by the user explicitly setting the permissions on a parent group.
25+
26+
Permissions are explicitly set by setting the checkbox in either the [View][] or [Edit][] columns of the appropriate LDAP Group where it intersects with the flow or flow Group to which the permissions are to be assigned. Permissions are explicitly removed by clearing the checkbox.
27+
28+
If an item is explicitly set with [Edit][] permissions, then that item will also be implicitly set with [View][] permissions. Explicitly setting an item with [View][] permissions does not implicitly set it with Edit permissions.
29+
30+
## Actions
31+
32+
### View
33+
34+
If an LDAP group is given `View` permissions on a flow, the members of the LDAP group can:
35+
36+
* View the flow
37+
* Execute the flow
38+
39+
If an LDAP Group is given `View` only permissions on a flow group, the members of that LDAP group can only access existing flows and flow groups within that flow group.
40+
41+
If a flow group has `View` permissions either explicitly set or implicitly set, then its child flow groups or flows will have their `View` permissions be implicitly set.
42+
43+
If a flow group has its `View` permissions removed, then all its child flow groups or flows will have their `View` permissions removed, regardless of whether they were set explicitly or implicitly.
44+
45+
See the [Manage Flow Access][Manage Flow Access tutorial] tutorial for a step-by-step guide.
46+
47+
### Edit
48+
49+
If an LDAP group is given `Edit` permissions on a flow, the members of the LDAP group can:
50+
51+
* View the flow
52+
* Execute the flow
53+
* Edit the flow
54+
* Delete the flow
55+
* Commit changes to the flow
56+
* Get the master version of the flow
57+
58+
If an LDAP Group is given `Edit` permissions on a flow group, the members of that LDAP group can create new flows and groups within that flow group.
59+
60+
If a flow group has `Edit` permissions explicitly set, then its child flow groups or flows will be implicitly set with both `Edit` and [`View`][View] permissions.
61+
62+
If a flow group has its `Edit` permissions removed, then all its child flow groups or flows will have their `Edit` permissions removed, regardless of whether they were set explicitly or implicitly.
63+
64+
If a flow is explicitly set with `Edit` permissions, then any parent Groups, which have not been explicitly set with [`View`][View] permissions, will be also implicitly set with [`View`][View] permissions.
65+
66+
See the [Manage Flow Access][Manage Flow Access tutorial] tutorial for a step-by-step guide.
67+
68+
## Remarks
69+
70+
### Known Limitations
71+
72+
* If a flow group is explicitly set Edit permissions, then the Groups View permissions will be implicitly set. However, if the explicitly set Edit permissions are removed from the Group, the implicitly set View permissions are not removed.
73+
74+
## See Also
75+
76+
### Related Concepts
77+
78+
None
79+
80+
### Related Tutorials
81+
82+
* [Manage Flow Access][Manage Flow Access tutorial]
83+
84+
[Edit]: {{< ref "#edit">}}
85+
[View]: {{< ref "#view">}}
86+
[Manage Flow Access tutorial]: {{< url path="Cortex.Tutorials.Administration.StudioAuthorisation.ManageFlowAccess" >}}

content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/Admin/studio-export.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Studio Export"
33
linkTitle: "Studio Export"
44
description: "Export flows from {{% ctx %}} Gateway."
5-
weight: 50
5+
weight: 60
66
---
77

88
# {{% param title %}}

content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/Admin/studio-import.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Studio Import"
33
linkTitle: "Studio Import"
44
description: "Import flows into {{% ctx %}} Gateway."
5-
weight: 25
5+
weight: 40
66
---
77

88
# {{% param title %}}
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: "Studio Authorisation"
3+
linkTitle: "Studio Authorisation"
4+
description: "This section includes tutorials about management of flow access."
5+
weight: 50
6+
---
7+
8+
# {{% param title %}}
9+
10+
## Manage Flow Access
11+
12+
{{< scribe title="How_to_Manage_Access_to_Flows_using_Studio_Authorisation" id="jtyNjnwZT862BQVl2KLskQ" >}}

content/en/docs/2025.3/Tutorials/Administration/studio-export.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Studio Export"
33
linkTitle: "Studio Export"
44
description: "This section includes tutorials about exporting individual flows."
5-
weight: 100
5+
weight: 60
66
---
77

88
# {{% param title %}}

content/en/docs/2025.3/Tutorials/Administration/studio-import.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Studio Import"
33
linkTitle: "Studio Import"
44
description: "This section includes tutorials about importing individual flows."
5-
weight: 50
5+
weight: 40
66
---
77

88
# {{% param title %}}
204 KB
Loading

data/urls.toml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -495,7 +495,6 @@
495495
MainDoc = "/docs/getting-started/cloud/add-observability-to-innovation/grafana/install-promtail/configure-promtail"
496496
[Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.TryItOut]
497497
MainDoc = "/docs/getting-started/cloud/add-observability-to-innovation/grafana/try-it-out/"
498-
499498
[Cortex.Guides]
500499
MainDoc = "/docs/guides/"
501500
[Cortex.Guides.Studio]
@@ -943,8 +942,7 @@
943942
Unpublish = "/docs/guides/user-guides/user-interfaces/gateway/admin/packages/package-version-editor/#unpublish-a-package-version"
944943
[Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.StudioImport]
945944
MainDoc = "/docs/guides/user-guides/user-interfaces/gateway/admin/studio-import/"
946-
947-
[Cortex.Reference]
945+
[Cortex.Reference]
948946
MainDoc = "/docs/reference/"
949947
[Cortex.Reference.Apis]
950948
MainDoc = "/docs/reference/Apis/"
@@ -2786,6 +2784,12 @@
27862784
[Cortex.Tutorials.Administration.StudioExport]
27872785
MainDoc = "/docs/tutorials/administration/studio-export"
27882786
ExportIndividualFlows = "/docs/tutorials/administration/studio-export/#export-individual-flows"
2787+
[Cortex.Tutorials.Administration.StudioAuthorisation]
2788+
MainDoc = "/docs/tutorials/administration/studio-authorisation"
2789+
ManageFlowAccess = "/docs/tutorials/administration/studio-authorisation/#manage-flow-access"
2790+
[Cortex.Tutorials.Administration.StudioHierarchy]
2791+
MainDoc = "/docs/tutorials/administration/studio-hierarchy"
2792+
ManageFlowHierarchy = "/docs/tutorials/administration/studio-hierarchy/#manage-flow-hierarchy"
27892793
[Cortex.Tutorials.Operations]
27902794
MainDoc = "/docs/tutorials/Operations"
27912795
[Cortex.Tutorials.Operations.Overview]

0 commit comments

Comments
 (0)