Skip to content
Start here

Tenants

TenantsAccount Types

TenantsAccounts

List tenant accounts
client.tenants.accounts.list(stringtenantID, AccountListParams { account_pubname, direction, include_total, 7 more } query?, RequestOptionsoptions?): V4PagePaginationArray<AccountListResponse { account_pubname, account_tag, account_type, 2 more } >
GET/tenants/{tenant_id}/accounts
ModelsExpand Collapse
TenantAccount { id, created_on, name, 3 more }
id: string
created_on: string
formatdate-time
name: string | null
settings: Settings { abuse_contact_email, access_approval_expiry, api_access_enabled, 3 more }
abuse_contact_email: string | null
access_approval_expiry: string | null
formatdate-time
api_access_enabled: boolean | null
Deprecateddefault_nameservers: string | null

Use DNS Settings instead. Deprecated.

enforce_twofactor: boolean | null
Deprecateduse_account_custom_ns_by_default: boolean | null

Use DNS Settings instead. Deprecated.

type: "standard" | "enterprise"
One of the following:
"standard"
"enterprise"
tags?: Record<string, string>

Account tags, present only when include_tags=true is requested.

AccountListResponse { account_pubname, account_tag, account_type, 2 more }
account_pubname: string | null
account_tag: string
account_type: "standard" | "enterprise"
One of the following:
"standard"
"enterprise"
created_on: string
formatdate-time
settings: Settings { access_approval_expiry, api_access_enabled, enforce_two_factor, use_account_custom_ns_by_default }
access_approval_expiry: string | null
formatdate-time
api_access_enabled: boolean
enforce_two_factor: boolean
use_account_custom_ns_by_default: boolean

TenantsEntitlements

TenantsMemberships