List Tenants Endpoint

GET

/admin/global-tenant-list

const url = 'https://example.com/admin/global-tenant-list';
const options = {method: 'GET', headers: {'X-Tenzir-AdminKey': '<X-Tenzir-AdminKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/admin/global-tenant-list \
  --header 'X-Tenzir-AdminKey: <X-Tenzir-AdminKey>'

Authorizations

Admin Key

Responses

200

Successful Response

application/json

Response List Tenants Endpoint Admin Global Tenant List Get

Array<object>

Tenant

object

required

string

owner

required

Owner

object

namespace

required

Namespace

string

owner_id

required

Owner Id

string

display_name

Any of:

string
null

string

create_date_time

required

Create Date Time

string format: date-time

nodes

required

Nodes

Array<object>

Node

object

name

required

Name

string

connection_id

Any of:

string
null

string

key

required

Key

string

required

string

create_date_time

required

Create Date Time

string format: date-time

last_known_version

Any of:

string
null

string

last_known_features

Any of:

string
null

string

destroy_date_time

Any of:

string
null

string format: date-time

infra_id

Any of:

string
null

string

demo

required

Demo

boolean

ephemeral

Ephemeral

boolean

auth_functions

Auth Functions

Array

default:

Any of:

UserAuthFunction

object

auth_fn

Auth Fn

string

default: auth_user

Allowed value: auth_user

user_id

required

User Id

string

name

Name

string

icon_url

Icon Url

string

alerts

Any of:

object
null

object

key

additional properties

NodeOfflineAlert

object

type

Type

string

default: node_offline

Allowed value: node_offline

required

string

node_id

required

Node Id

string

duration

required

Duration

integer

webhook_url

required

Webhook Url

string

webhook_body

required

Webhook Body

string

metrics_opt_out

Metrics Opt Out

boolean

secret_stores

Secret Stores

Array<object>

default: [object Object]

SecretStoreDetails

object

type

required

SecretStoreType

string

Allowed values: aws tenzir

required

string

name

required

Name

string

is_writable

required

Is Writable

boolean

is_deletable

required

Is Deletable

boolean

options

required

Any of:

AwsWorkspaceSecretOptions
BuiltinWorkspaceSecretOptions

AwsWorkspaceSecretOptions

object

region

required

Region

string

assumed_role_arn

required

Assumed Role Arn

string

access_key

Any of:

AwsAccessKey
null

AwsAccessKey

object

access_key_id

required

Access Key Id

string

secret_access_key

required

Secret Access Key

string format: password

current_default_secret_store

Current Default Secret Store

string

default: default

node_registration_key

Any of:

string
null

string

Example

[
  {
    "nodes": [
      {
        "ephemeral": false
      }
    ],
    "auth_functions": [],
    "name": "",
    "icon_url": "",
    "alerts": {},
    "metrics_opt_out": false,
    "secret_stores": [
      {
        "type": "tenzir",
        "id": "default",
        "name": "Tenzir Platform",
        "is_writable": true,
        "is_deletable": false,
        "options": {}
      }
    ],
    "current_default_secret_store": "default"
  }
]