Skip to content

Commit

Permalink
Added API pages
Browse files Browse the repository at this point in the history
  • Loading branch information
samzhou2 committed Oct 15, 2024
1 parent 817adfb commit 1666d71
Show file tree
Hide file tree
Showing 8 changed files with 112 additions and 0 deletions.
1 change: 1 addition & 0 deletions modules/cloud/antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ nav:
- modules/release-notes/nav.adoc
- modules/solutions/nav.adoc
- modules/security/nav.adoc
- modules/rest-api/nav.adoc
- modules/billing/nav.adoc
- modules/support/nav.adoc
- modules/reference/nav.adoc
1 change: 1 addition & 0 deletions modules/cloud4/modules/administration/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
** xref:administration:how2-invite-users.adoc[]
** xref:administration:how2-access-mgnt.adoc[]
** xref:administration:how2-use-organization-mgnt.adoc[]
** xref:administration:how2-create-api-key.adoc[]
////
** xref:cloud4:security:index.adoc[]
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
= Organization Management
:experimental:

As an organization administrator, you have access to organization management features that allow you to configure organization settings.

== Manage Organization Setting

.To make organization settings changes:
. Navigate to the btn:[Setting] tag
+
image::Screenshot 2024-04-18 at 10.23.26 AM.png[width=300]

. Once clicked, the btn:[Organization Setting] panel will display the btn:[Basic Information] used with each organization.
+
image::Screenshot 2024-04-18 at 10.22.57 AM.png[]
+
.Here you will find the basic information to set up a new organization.
* *Organization Name*: The name of your organization within TigerGraph Cloud.
This is a unique identifier for your organization and is used for administrative purposes.
* *Display Name*: The display name is the name that will be shown in the user interface and other user-facing areas.
It can be a more user-friendly or descriptive name compared to the organization name.
+
[TIP]
====
The display name helps users easily identify your organization within TigerGraph Cloud.
====
* *Organization Logo URL*: The URL to the logo image file for your organization.
This logo will be displayed in the TigerGraph Cloud navigation bar and can be used to represent your organization visually.
+
[TIP]
====
Providing a logo adds a professional touch and helps users quickly recognize your organization within TigerGraph Cloud.
====

== Next Steps

Next, continue on to learn about xref:security:index.adoc[] or additional xref:cloud4:resources:index.adoc[] in TigerGraph Cloud 4.

Return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic.


4 changes: 4 additions & 0 deletions modules/cloud4/modules/administration/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ Learn how to manage access to workspaces and resources within TigerGraph Cloud 4

Learn about the organization management features that allow you to configure organization settings.

== xref:cloud4:administration:how2-create-api-key.adoc[]

Learn how to create API keys for your organization.

== Next Steps

Next, learn about xref:security:index.adoc[] or additional xref:cloud4:resources:index.adoc[] in TigerGraph Cloud 4.
Expand Down
3 changes: 3 additions & 0 deletions modules/cloud4/modules/rest-api/nav.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
* xref:index.adoc[]
** xref:rest-api:authentication.adoc[]
** xref:rest-api:deprecations.adoc[]
23 changes: 23 additions & 0 deletions modules/cloud4/modules/rest-api/pages/authentication.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
= IDP integration with SSO

////
By default, user management in a TigerGraph Cloud organization happens in the xref:manage-org-users.adoc[] section of the TigerGraph Cloud interface.

If you have another preferred identity provider (IDP), you can integrate with it instead using SAML 2.0 to handle your user management needs outside of TigerGraph Cloud.
////

IDP integration is currently available at the Organization level, so one IDP will handle user management for all clusters in that organization.
Only one IDP can be connected to a single Organization.

== Process Outline

. Have IDP enabled on your TigerGraph Cloud Organization account.
. Create an app integration on the IDP side to configure it to link with TigerGraph Cloud.
. Users log in to the TigerGraph Cloud portal using credentials from your IDP.
. Organization Admins assign roles to the users being created in the cloud organization via successful login from the IDP.

== Setup

This process is currently done through TigerGraph support.
Please contact [email protected] to reach out to a technical support engineer who will guide you through the process.

17 changes: 17 additions & 0 deletions modules/cloud4/modules/rest-api/pages/deprecations.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
= Password Policy
:experimental:

TigerGraph Cloud user accounts have their own password requirements separate from the xref:tigergraph-server:security:password-policy.adoc[TigerGraph Server password policy].

No empty passwords are permitted. Each password must be at least 12 characters long and include at least one of the following:

* A special character from the set `!@#$%^&*`
* A lower case character `a-z`
* An upper case character `A-Z`
* A digit `0-9`
[NOTE]
This TigerGraph Cloud password policy cannot be changed by users.

Organization Admins do not have access to change or reset user passwords in an Organization account.
If you forget your password, click the btn:[Forgot Password?] button during login, or contact [email protected] for assistance.
22 changes: 22 additions & 0 deletions modules/cloud4/modules/rest-api/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
= Security
:experimental:


Here you can learn different security practices and policies in TigerGraph Cloud 4.

[IMPORTANT]
====
TigerGraph Cloud 4 beta is for personal or R&D use and not for production use.
Please see xref:cloud4:resources:terms_conditions.adoc[].
====


== xref:cloud4:security:password-policy.adoc[]

Learn and understand the password policy in TigerGraph Cloud 4.


== xref:cloud4:security:idp.adoc[]

Learn and understand IDP intergration with SSO password policy in TigerGraph Cloud 4.

0 comments on commit 1666d71

Please sign in to comment.