---
title: "List org users"
component: "savanna"
version: "main"
module: "rest-api"
html_url: "/savanna/main/rest-api/endpoints/list-org-users"
---

[View as HTML](/savanna/main/rest-api/endpoints/list-org-users)

# List org users

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

GET `/users` 

## Response

200 application/json 

[#](#response-auth0-user-id) `auth0UserID` string 

Identifier of the user in the identity provider.

[#](#response-auth-id) `authID` string 

Identifier issued by the authentication provider.

[#](#response-created) `created` string 

Time the user was created.

[#](#response-email) `email` string 

Email address of the user.

[#](#response-enabled) `enabled` boolean 

Whether the user can sign in.

[#](#response-first-name) `firstName` string 

Given name of the user.

[#](#response-id) `id` string 

Unique identifier of the user.

[#](#response-last-name) `lastName` string 

Family name of the user.

[#](#response-metadata) `metadata` object 

Additional details about the user.

Show child attributes Hide child attributes 

`attachedTo`string\[\]

Resources the user is attached to.

`lastLogin`string

Time the user last signed in.

[#](#response-path) `path` string 

Hierarchical path of the user within the organization.

[#](#response-roles) `roles` object\[\] 

Roles assigned to the user.

Show child attributes Hide child attributes 

`displayName`string

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

`id`string

Unique identifier of the role.

`name`string

Name of the role.

`path`string

Hierarchical path of the role within the organization.

`tenantID`string

Unique identifier of the tenant the role belongs to.

`trn`string

TigerGraph resource name of the role.

[#](#response-tenant-id) `tenantID` string 

Unique identifier of the tenant the user belongs to.

[#](#response-trn) `trn` string 

TigerGraph resource name of the user.

[#](#response-updated) `updated` string 

Time the user was last updated.

[#](#response-username) `username` string 

Username of the user.

List org users 

cURL 

cURL Python JavaScript PHP Go Java Ruby 

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

```python
import requests

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

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

```php
<?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);
```

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

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

```ruby
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)
}
```

200 

```json
{
  "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>"
}
```