List Tenants Endpoint

GET

/admin/global-tenant-list

Authorizations

• Admin Key

Responses

200

Successful Response

Response List Tenants Endpoint Admin Global Tenant List Get

Array<object>

Tenant

object

id

required

Id

string

owner

required

Owner

object

namespace

required

Namespace

string

owner_id

required

Owner Id

string

display_name

Any of:

string

string

null

null

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

string

null

null

key

required

Key

string

id

required

Id

string

create_date_time

required

Create Date Time

string format: date-time

last_known_version

Any of:

string

string

null

null

last_known_features

Any of:

string

string

null

null

destroy_date_time

Any of:

string

string format: date-time

null

null

infra_id

Any of:

string

string

null

null

demo

required

Demo

boolean

ephemeral

Ephemeral

boolean

auth_functions

Auth Functions

Array

default:

Any of:

UserAuthFunction

UserAuthFunction

object

auth_fn

Auth Fn

string

default: auth_user

user_id

required

User Id

string

EmailDomainFunction

EmailDomainFunction

Grants access for users from a specific connection (e.g. gmail) having email addresses from a given domain (e.g. @tenzir.com)

object

auth_fn

Auth Fn

string

default: auth_email_suffix

connection

Any of:

string

string

null

null

email_domain

required

Email Domain

string

OrganizationRoleFunction

OrganizationRoleFunction

Grants access to users who have some role in some organization.

object

auth_fn

Auth Fn

string

default: auth_organization_role

connection

Any of:

string

string

null

null

roles_claim

required

Roles Claim

string

role

required

Role

string

organization_claim

required

Organization Claim

string

organization

required

Organization

string

OrganizationMembershipFunction

OrganizationMembershipFunction

Grants access to users that belong to some organization.

object

auth_fn

Auth Fn

string

default: auth_organization

connection

Any of:

string

string

null

null

organization_claim

required

Organization Claim

string

organization

required

Organization

string

AllowAllAuthFunction

AllowAllAuthFunction

object

auth_fn

Auth Fn

string

default: auth_allow_all

name

Name

string

""

icon_url

Icon Url

string

""

alerts

Any of:

object

object

key

additional properties

NodeOfflineAlert

object

type

Type

string

default: node_offline

id

required

Id

string

node_id

required

Node Id

string

duration

required

Duration

integer

webhook_url

required

Webhook Url

string

webhook_body

required

Webhook Body

string

null

null

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

id

required

Id

string

name

required

Name

string

is_writable

required

Is Writable

boolean

is_deletable

required

Is Deletable

boolean

options

required

Any of:

AwsWorkspaceSecretOptions

AwsWorkspaceSecretOptions

object

region

required

Region

string

assumed_role_arn

required

Assumed Role Arn

string

access_key

Any of:

AwsAccessKey

AwsAccessKey

object

access_key_id

required

Access Key Id

string

secret_access_key

required

Secret Access Key

string format: password

null

null

BuiltinWorkspaceSecretOptions

BuiltinWorkspaceSecretOptions

object

derived_key

Any of:

DerivedKey

DerivedKey

object

public_key

required

Public Key

string

keypath

required

Keypath

string

null

null

current_default_secret_store

Current Default Secret Store

string

default: default

node_registration_key

Any of:

string

string

null

null