Create an in-database user :: TigerGraph Savanna

Creates an in-database GSQL user for a workspace.

POST /controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/dbuser

Authorizations

x-api-key string header required

Authorization for TigerGraph Savanna. Send the key in the x-api-key request header.

Create an API key

Path parameters

# workgroupID string path required

Workgroup ID

# workspaceID string path required

Workspace ID

Body

# password string

Password for the in-database user.

# username string

Username for the in-database user.

Response

application/json

# Error boolean

Indicates whether the request returned an error.

# ErrorDetails object[]

Details about each error returned by the request.

Show child attributes Hide child attributes

FieldNamestring

Field associated with the error.

Reasonstring

Explanation of why the error occurred.

Typestring

Category of the error.

Available options: Internal-Error, Bad-Request, Not-Found, Forbidden, Unauthorized, API-Disabled, Quota-Exceed, Unknown

# Message string

Human-readable summary of the request result.

# RequestID string

Unique identifier for tracing the request.

# Result object

Payload returned by the request.

Show child attributes Hide child attributes

auth0UserIDstring

Identifier of the user in the identity provider.

createdstring

Time the user was created.

descriptionstring

Description of the user.

emailstring

Email address of the user.

enabledboolean

Whether the user can sign in.

firstNamestring

Given name of the user.

idstring

Unique identifier of the user.

lastNamestring

Family name of the user.

metadataobject

Additional details about the user.

pathstring

Hierarchical path of the user within the organization.

rolestring

Role assigned to the user.

tenantIDstring

Unique identifier of the tenant the user belongs to.

trnstring

TigerGraph resource name of the user.

updatedstring

Time the user was last updated.

usernamestring

Username of the user.

Create an in-database user

curl --request POST \
  --url 'https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/dbuser' \
  --header 'x-api-key: <your-api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "password": "<string>",
    "username": "<string>"
  }'

import requests

url = "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/dbuser"
headers = {"x-api-key": "<your-api-key>"}
payload = {
  "password": "<string>",
  "username": "<string>"
}

response = requests.post(url, headers=headers, json=payload)
print(response.json())

const response = await fetch(
  "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/dbuser",
  {
    method: "POST",
    headers: { "x-api-key": "<your-api-key>", "Content-Type": "application/json" },
    body: JSON.stringify({
      "password": "<string>",
      "username": "<string>"
    }),
  }
)
console.log(await response.json())

<?php
$request = curl_init(
  "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/dbuser"
);
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_HTTPHEADER, [
  "x-api-key: <your-api-key>",
  "Content-Type: application/json"
]);
curl_setopt($request, CURLOPT_POSTFIELDS, '{
    "password": "<string>",
    "username": "<string>"
  }');
curl_exec($request);

payload := strings.NewReader(`{
    "password": "<string>",
    "username": "<string>"
  }`)

request, _ := http.NewRequest(
  "POST",
  "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/dbuser",
  payload,
)
request.Header.Add("x-api-key", "<your-api-key>")
request.Header.Add("Content-Type", "application/json")
response, _ := http.DefaultClient.Do(request)

HttpRequest request = HttpRequest.newBuilder()
  .uri(URI.create(
    "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/dbuser"
  ))
  .header("x-api-key", "<your-api-key>")
  .header("Content-Type", "application/json")
  .method("POST", HttpRequest.BodyPublishers.ofString("""
{
      "password": "<string>",
      "username": "<string>"
    }
  """))
  .build();

uri = URI(
  "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/dbuser"
)
request = Net::HTTP::Post.new(uri)
request["x-api-key"] = "<your-api-key>"
request["Content-Type"] = "application/json"
request.body = <<~JSON
{
    "password": "<string>",
    "username": "<string>"
  }
JSON
response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) {
  |http| http.request(request)
}

{
  "Error": false,
  "ErrorDetails": [],
  "Message": "<string>",
  "RequestID": "<string>",
  "Result": {
    "auth0UserID": "<string>",
    "created": "<string>",
    "description": "<string>",
    "email": "<string>",
    "enabled": false,
    "firstName": "<string>",
    "id": "<string>",
    "lastName": "<string>",
    "metadata": "<string>",
    "path": "<string>",
    "role": "<string>",
    "tenantID": "<string>",
    "trn": "<string>",
    "updated": "<string>",
    "username": "<string>"
  }
}

{
  "Error": true,
  "ErrorDetails": [
    {
      "FieldName": "<string>",
      "Reason": "<string>",
      "Type": "Internal-Error"
    }
  ],
  "Message": "<string>",
  "RequestID": "<string>"
}

{
  "Error": true,
  "ErrorDetails": [
    {
      "FieldName": "<string>",
      "Reason": "<string>",
      "Type": "Internal-Error"
    }
  ],
  "Message": "<string>",
  "RequestID": "<string>"
}