Merge pull request #59 from tigergraph/cloudBeta

Cloud beta

modules/solutions/pages/access-solution/rest-requests.adoc → modules/cloud/modules/solutions/pages/access-solution/rest-requests.adoc

@@ -81,11 +81,13 @@ This is a sample response, where the string in the response with the key `token`
 --
 ====
 
-=== 4. Send a request using your token
+=== 4. Send a request using your token or secret
 
-Now that you have an authorization token, you can proceed to make requests to your cluster. To use the authorization token, include it in the request header as a bearer token.
+Now that you have an authorization token, you can proceed to make requests to your cluster.
+
+==== Token Request
+To use the authorization token, include it in the request header as a bearer token.
 
-See xref:tigergraph-server:API:built-in-endpoints.adoc[] to learn about all the endpoints available.
 The following example makes a request to the xref:tigergraph-server:API:built-in-endpoints.adoc#_list_vertices[List vertices] endpoint on a cluster with the https://www.youtube.com/watch?v=s6-QapCEz1M&feature=youtu.be&ab_channel=TigerGraph[COVID-19 starter kit].
 
 The request lists 5 patients and their ages.
@@ -104,7 +106,7 @@ $ curl -H "Authorization: Bearer fc6p0i2ijjt031n0sja6m9ci70p232h7" \
 [NOTE]
 For TigerGraph Cloud clusters created before June 20, 2022, replace "443/restpp" with "9000". See the xref:release-notes:index.adoc[] for details.
 --
-Response:
+Response::
 +
 --
 [source,console]
@@ -157,4 +159,16 @@ Response:
 }
 ----
 --
-====
+====
+
+==== Secret Request
+
+To use the authorization secret, include it in the request header as a GSQL-Secret.
+
+[source,console]
+----
+curl -H "Authorization: GSQL-Secret fc6p0i2ijjt031n0sja6m9ci70p232h7" \
+"https://aa768d833bbf47fea6db80a7972a9477.i.tgcloud.io:443/restpp/graph/MyGraph/vertices/Patient?limit=5&select=birth_year"
+----
+
+See xref:tigergraph-server:API:built-in-endpoints.adoc[] to learn about all the endpoints available.

modules/cloudbeta/antora.yml

@@ -0,0 +1,20 @@
+name: cloudBeta
+title: TigerGraph Cloud 4.0
+version: master
+display_version: default
+start_page: overview:index.adoc
+
+nav:
+  - modules/overview/nav.adoc
+  - modules/release-notes/nav.adoc
+  - modules/get-started/nav.adoc
+  - modules/resource-manager/nav.adoc
+  - modules/load-data/nav.adoc
+  - modules/schema-designer/nav.adoc
+  - modules/gsql-editor/nav.adoc
+  - modules/explore-graph/nav.adoc
+  - modules/integrations/nav.adoc
+  - modules/administration/nav.adoc
+  - modules/security/nav.adoc
+  - modules/billing-manager/nav.adoc
+  - modules/resources/nav.adoc

modules/cloudbeta/modules/administration/nav.adoc

@@ -0,0 +1,10 @@
+* xref:index.adoc[Administration]
+** xref:administration:how2-invite-users.adoc[]
+** xref:administration:how2-access-mgnt.adoc[]
+** xref:administration:how2-use-organization-mgnt.adoc[]
+
+////
+** xref:cloudBeta:security:index.adoc[]
+*** xref:cloudBeta:security:password-policy.adoc[]
+*** xref:cloudBeta:security:idp.adoc[]
+////

modules/cloudbeta/modules/administration/pages/how2-access-mgnt.adoc

@@ -0,0 +1,244 @@
+= Access Management
+:experimental:
+
+As an organization administrator, you can define permissions for users, controlling their level of access to workspaces, workgroup and features. This allows you to ensure data security and enforce access control policies within your organization.
+In TigerGraph Cloud 4.0, access management allows you to configure permissions at both the *Resource* level and the *User* level.
+
+== Resource Level
+
+At the resource level, you can configure permissions that apply to specific workspaces within your TigerGraph Cloud organization.
+Resource-level permissions determine what actions a user can perform on a specific resource.
+
+[TIP]
+====
+These permissions allow you to control access to individual resources based on the needs and responsibilities of different users.
+====
+
+You can go to xref:cloudBeta:resource-manager:how2-workgroup-access.adoc[] to manage access at the resource level.
+
+== User Level Permission
+At the user level, you can define permissions that apply to individual users or groups of users.
+User-level permissions determine what actions a user can perform across the entire TigerGraph Cloud 4.0 organization.
+
+[TIP]
+====
+These permissions are typically related to administrative tasks and access to workgroups and workspaces.
+====
+
+== How to Manage User Permissions
+
+.To manage user permissions:
+. Click on a btn:[User Name] from user list.
++
+image::userlist.png[]
++
+image::permissions-select a user.png[]
+
+. You will now be able to see the btn:[Permissions] on the btn:[User Detail] panel of the selected user.
++
+image::Screenshot 2024-04-28 at 4.24.00 PM.png[width=500]
+
+. Once you make a change to one of the dropdown menus.
+Select either the btn:[Cancel] button to cancel the changes or the btn:[Save] button to save the changes.
++
+image::permissions_saveorCancealchanges.png[]
+
+
+== Permissions
+
+Please refer to the following tables of the roles and permissions for the organization, workgroup, and workspace.
+
+=== Org Level Permissions
+.Org Level
+[cols="7", separator=¦]
+|===
+¦Feature Flags ¦Org Admin (Owner) ¦Billing Admin ¦Billing Viewer ¦Workgroup Admin ¦Workspace Admin¦Workspace Member
+
+¦Org Level Permission Scope ¦Organization ¦Organization ¦Organization ¦Workgroup ¦Workspace ¦Workspace
+
+¦Manage Organization
+¦Yes
+¦No
+¦No
+¦No
+¦No
+¦No
+
+¦Manage Org Permission
+¦Yes
+¦No
+¦No
+¦No
+¦No
+¦No
+
+¦Manage Billing
+¦Yes
+¦No
+¦No
+¦No
+¦No
+¦No
+
+¦Invite new members to org
+¦Yes
+¦No
+¦No
+¦No
+¦No
+¦No
+
+¦Manage access for the org
+¦Yes
+¦No
+¦No
+¦No
+¦No
+¦No
+
+¦Create Workgroup
+¦Yes
+¦No
+¦No
+¦No
+¦No
+¦No
+
+¦Configure Add-Ons
+¦Yes
+¦No
+¦No
+¦No
+¦No
+¦No
+
+¦Manage Payment Methods
+¦Yes
+¦Yes
+¦No
+¦No
+¦No
+¦No
+
+¦View Billing Information
+¦Yes
+¦Yes
+¦Yes
+¦No
+¦No
+¦No
+|===
+
+=== Workgroup level Permissions
+
+.Workgroup Level
+[cols="7", separator=¦]
+|===
+¦Feature Flags ¦Org Admin (Owner) ¦Billing Admin ¦Billing Viewer ¦Workgroup Admin ¦Workspace Admin¦Workspace Member
+¦Workgroup Level Permission Scope ¦Organization ¦Organization ¦Organization ¦Workgroup ¦Workspace ¦Workspace
+
+¦Edit workgroup
+¦Yes
+¦No
+¦No
+¦Yes
+¦No
+¦No
+
+¦Delete workgroup
+¦Yes
+¦No
+¦No
+¦No
+¦No
+¦No
+
+¦Create new workspace within workgroup
+¦Yes
+¦No
+¦No
+¦Yes
+¦No
+¦No
+
+¦Manage permissions for workgroup
+¦Yes
+¦No
+¦No
+¦Yes
+¦No
+¦No
+|===
+
+=== Workspace level Permissions
+
+.Workspace Level
+[cols="7", separator=¦]
+|===
+¦Feature Flags ¦Org Admin (Owner) ¦Billing Admin ¦Billing Viewer ¦Workgroup Admin ¦Workspace Admin¦Workspace Member
+¦Workspace Level Permission Scope ¦Organization ¦Organization ¦Organization ¦Workgroup ¦Workspace ¦Workspace
+
+¦Edit workspace
+¦Yes
+¦No
+¦No
+¦Yes
+¦Yes
+¦No
+
+¦Delete workspace
+¦Yes
+¦No
+¦No
+¦Yes
+¦No
+¦No
+
+¦Manage permissions for workspace
+¦Yes
+¦No
+¦No
+¦Yes
+¦Yes
+¦No
+
+¦Run GSQL Editor
+¦Yes
+¦No
+¦No
+¦Yes
+¦Yes
+¦Yes *
+
+¦Loading Data
+¦Yes
+¦No
+¦No
+¦Yes
+¦Yes
+¦Yes *
+
+¦Data Insights
+¦Yes
+¦No
+¦No
+¦Yes
+¦Yes
+¦Yes *
+
+¦Install Solutions
+¦Yes
+¦No
+¦No
+¦Yes
+¦Yes
+¦Yes *
+
+|===
+
+== Next Steps
+
+Next, learn about xref:cloudBeta:administration:how2-use-organization-mgnt.adoc[]
+or continue on to learn about xref:security:index.adoc[] or additional xref:cloudBeta:resources:index.adoc[] in TigerGraph Cloud 4.0.
+
+Return to the xref:cloudBeta:overview:index.adoc[Overview] page for a different topic.