List org users :: TigerGraph Savanna

Lists the users in your organization. This endpoint does not support API key authentication.

GET /users

Response

200 application/json

# auth0UserID string

Identifier of the user in the identity provider.

# authID string

Identifier issued by the authentication provider.

# created string

Time the user was created.

# email string

Email address of the user.

# enabled boolean

Whether the user can sign in.

# firstName string

Given name of the user.

# id string

Unique identifier of the user.

# lastName string

Family name of the user.

# metadata object

Additional details about the user.

Show child attributes Hide child attributes

attachedTostring[]

Resources the user is attached to.

lastLoginstring

Time the user last signed in.

# path string

Hierarchical path of the user within the organization.

# roles object[]

Roles assigned to the user.

Show child attributes Hide child attributes

displayNamestring

Name of the role as it appears in the TigerGraph Savanna console.

idstring

Unique identifier of the role.

namestring

Name of the role.

pathstring

Hierarchical path of the role within the organization.

tenantIDstring

Unique identifier of the tenant the role belongs to.

trnstring

TigerGraph resource name of the role.

# tenantID string

Unique identifier of the tenant the user belongs to.

# trn string

TigerGraph resource name of the user.

# updated string

Time the user was last updated.

# username string

Username of the user.

List org users

curl --request GET \
  --url 'https://api.tgcloud.io/users' \
  --header 'x-api-key: <your-api-key>'

import requests

url = "https://api.tgcloud.io/users"
headers = {"x-api-key": "<your-api-key>"}
response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://api.tgcloud.io/users",
  {
    method: "GET",
    headers: { "x-api-key": "<your-api-key>" },
  }
)
console.log(await response.json())

<?php
$request = curl_init(
  "https://api.tgcloud.io/users"
);
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($request, CURLOPT_HTTPHEADER, [
  "x-api-key: <your-api-key>"
]);
curl_exec($request);

request, _ := http.NewRequest(
  "GET",
  "https://api.tgcloud.io/users",
  nil,
)
request.Header.Add("x-api-key", "<your-api-key>")
response, _ := http.DefaultClient.Do(request)

HttpRequest request = HttpRequest.newBuilder()
  .uri(URI.create(
    "https://api.tgcloud.io/users"
  ))
  .header("x-api-key", "<your-api-key>")
  .GET()
  .build();

uri = URI(
  "https://api.tgcloud.io/users"
)
request = Net::HTTP::Get.new(uri)
request["x-api-key"] = "<your-api-key>"
response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) {
  |http| http.request(request)
}

{
  "auth0UserID": "<string>",
  "authID": "<string>",
  "created": "<string>",
  "email": "<string>",
  "enabled": false,
  "firstName": "<string>",
  "id": "<string>",
  "lastName": "<string>",
  "metadata": {
    "attachedTo": [
      "<string>"
    ],
    "lastLogin": "<string>"
  },
  "path": "<string>",
  "roles": [
    {
      "displayName": "<string>",
      "id": "<string>",
      "name": "<string>",
      "path": "<string>",
      "tenantID": "<string>",
      "trn": "<string>"
    }
  ],
  "tenantID": "<string>",
  "trn": "<string>",
  "updated": "<string>",
  "username": "<string>"
}