From 1666d7187159d8448a39608fb729c150c33d606d Mon Sep 17 00:00:00 2001 From: Sam Zhou Date: Tue, 15 Oct 2024 15:14:06 +0800 Subject: [PATCH] Added API pages --- modules/cloud/antora.yml | 1 + .../cloud4/modules/administration/nav.adoc | 1 + .../pages/how2-create-api-key.adoc | 41 +++++++++++++++++++ .../modules/administration/pages/index.adoc | 4 ++ modules/cloud4/modules/rest-api/nav.adoc | 3 ++ .../rest-api/pages/authentication.adoc | 23 +++++++++++ .../modules/rest-api/pages/deprecations.adoc | 17 ++++++++ .../cloud4/modules/rest-api/pages/index.adoc | 22 ++++++++++ 8 files changed, 112 insertions(+) create mode 100644 modules/cloud4/modules/administration/pages/how2-create-api-key.adoc create mode 100644 modules/cloud4/modules/rest-api/nav.adoc create mode 100644 modules/cloud4/modules/rest-api/pages/authentication.adoc create mode 100644 modules/cloud4/modules/rest-api/pages/deprecations.adoc create mode 100644 modules/cloud4/modules/rest-api/pages/index.adoc diff --git a/modules/cloud/antora.yml b/modules/cloud/antora.yml index 1a1eea87..207279f4 100644 --- a/modules/cloud/antora.yml +++ b/modules/cloud/antora.yml @@ -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 \ No newline at end of file diff --git a/modules/cloud4/modules/administration/nav.adoc b/modules/cloud4/modules/administration/nav.adoc index 4c93856f..1c029508 100644 --- a/modules/cloud4/modules/administration/nav.adoc +++ b/modules/cloud4/modules/administration/nav.adoc @@ -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[] diff --git a/modules/cloud4/modules/administration/pages/how2-create-api-key.adoc b/modules/cloud4/modules/administration/pages/how2-create-api-key.adoc new file mode 100644 index 00000000..45a2d8f2 --- /dev/null +++ b/modules/cloud4/modules/administration/pages/how2-create-api-key.adoc @@ -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. + + diff --git a/modules/cloud4/modules/administration/pages/index.adoc b/modules/cloud4/modules/administration/pages/index.adoc index 5a1b8499..04e22a21 100644 --- a/modules/cloud4/modules/administration/pages/index.adoc +++ b/modules/cloud4/modules/administration/pages/index.adoc @@ -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. diff --git a/modules/cloud4/modules/rest-api/nav.adoc b/modules/cloud4/modules/rest-api/nav.adoc new file mode 100644 index 00000000..c6fe7c9e --- /dev/null +++ b/modules/cloud4/modules/rest-api/nav.adoc @@ -0,0 +1,3 @@ +* xref:index.adoc[] +** xref:rest-api:authentication.adoc[] +** xref:rest-api:deprecations.adoc[] \ No newline at end of file diff --git a/modules/cloud4/modules/rest-api/pages/authentication.adoc b/modules/cloud4/modules/rest-api/pages/authentication.adoc new file mode 100644 index 00000000..c517ffa8 --- /dev/null +++ b/modules/cloud4/modules/rest-api/pages/authentication.adoc @@ -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 support@tigergraph.com to reach out to a technical support engineer who will guide you through the process. + diff --git a/modules/cloud4/modules/rest-api/pages/deprecations.adoc b/modules/cloud4/modules/rest-api/pages/deprecations.adoc new file mode 100644 index 00000000..8a822e7b --- /dev/null +++ b/modules/cloud4/modules/rest-api/pages/deprecations.adoc @@ -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 support@tigergraph.com for assistance. \ No newline at end of file diff --git a/modules/cloud4/modules/rest-api/pages/index.adoc b/modules/cloud4/modules/rest-api/pages/index.adoc new file mode 100644 index 00000000..4c166f69 --- /dev/null +++ b/modules/cloud4/modules/rest-api/pages/index.adoc @@ -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.