Skip to content

Commit

Permalink
Update API doc
Browse files Browse the repository at this point in the history
  • Loading branch information
samzhou2 committed Oct 15, 2024
1 parent 6f0b10a commit cc72f29
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 61 deletions.
61 changes: 10 additions & 51 deletions modules/cloud4/modules/rest-api/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,63 +1,22 @@
= TigerGraph Cloud Rest API
:experimental:

This document provides a comprehensive reference for interacting with the TigerGraph Cloud services programmatically. You can manage workspaces, users, and other resources through these APIs.

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

== Workspace Management
[IMPORTANT]
====
TigerGraph Cloud 4 beta is for personal or R&D use and not for production use.
The Workspace Management API allows you to create and manage workspaces within your TigerGraph Cloud instance.
Please see xref:cloud4:resources:terms_conditions.adoc[].
====

=== Create Workspace

**Description:** This endpoint is used to create a new workspace.
== xref:cloud4:security:password-policy.adoc[]

**Endpoint:**
Learn and understand the password policy in TigerGraph Cloud 4.

```
POST /api/workspaces
```

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

Create a new workspace.

**Request:**

```json
{
"name": "NewWorkspace",
"description": "Description of the new workspace"
}
```

**Response:**

```json
{
"error": false,
"message": "Workspace created successfully",
"workspaceId": "workspace123"
}
```

=== List Workspaces

**Description:** This endpoint lists all the workspaces the API have access to.

**Endpoint:**

```
GET /api/workspaces
```

**Description:**

List all workspaces.

**Request:**

```bash
curl -X GET "https://<your-tigergraph-cloud-instance>/api/workspaces" \
-H "Authorization: Bearer <your-api-key>"
Learn and understand IDP intergration with SSO password policy in TigerGraph Cloud 4.
66 changes: 56 additions & 10 deletions modules/cloud4/modules/rest-api/pages/resources.adoc
Original file line number Diff line number Diff line change
@@ -1,17 +1,63 @@
= REST API Resources
:experimental:

TigerGraph Cloud user accounts have their own password requirements separate from the xref:tigergraph-server:security:password-policy.adoc[TigerGraph Server password policy].
This document provides a comprehensive reference for interacting with the TigerGraph Cloud services programmatically. You can manage workspaces, users, and other resources through these APIs.

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

* A special character from the set `!@#$%^&*`
* A lower case character `a-z`
* An upper case character `A-Z`
* A digit `0-9`
== Workspace Management

[NOTE]
This TigerGraph Cloud password policy cannot be changed by users.
The Workspace Management API allows you to create and manage workspaces within your TigerGraph Cloud instance.

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.
=== Create Workspace

**Description:** This endpoint is used to create a new workspace.

**Endpoint:**

```
POST /api/workspaces
```

**Description:**

Create a new workspace.

**Request:**

```json
{
"name": "NewWorkspace",
"description": "Description of the new workspace"
}
```

**Response:**

```json
{
"error": false,
"message": "Workspace created successfully",
"workspaceId": "workspace123"
}
```

=== List Workspaces

**Description:** This endpoint lists all the workspaces the API have access to.

**Endpoint:**

```
GET /api/workspaces
```

**Description:**

List all workspaces.

**Request:**

```bash
curl -X GET "https://<your-tigergraph-cloud-instance>/api/workspaces" \
-H "Authorization: Bearer <your-api-key>"

0 comments on commit cc72f29

Please sign in to comment.