Tenants

Get tenant

GET/tenants/{tenant_id}

ModelsExpand Collapse

Tenant object { cdate, edate, tenant_contacts, 9 more }

cdate: string

formatdate-time

edate: string

formatdate-time

tenant_contacts: object { email, website }

email: optional string

website: optional string

tenant_labels: array of string

tenant_metadata: object { dns }

dns: optional object { ns_pool }

ns_pool: object { primary, secondary }

primary: optional string

secondary: optional string

tenant_name: string

tenant_network: unknown

tenant_status: string

tenant_tag: string

tenant_type: string

tenant_units: array of object { unit_memberships, unit_metadata, unit_name, 2 more }

unit_memberships: array of unknown

unit_metadata: unknown

unit_name: string

unit_status: string

unit_tag: string

customer_id: optional string

TenantsAccount Types

Get tenant account types

GET/tenants/{tenant_id}/account_types

ModelsExpand Collapse

AccountTypeListResponse = string

TenantsAccounts

List tenant accounts

GET/tenants/{tenant_id}/accounts

ModelsExpand Collapse

TenantAccount object { id, created_on, name, 2 more }

id: string

created_on: string

formatdate-time

name: string

settings: object { abuse_contact_email, access_approval_expiry, api_access_enabled, 3 more }

abuse_contact_email: string

access_approval_expiry: string

formatdate-time

api_access_enabled: boolean

Deprecateddefault_nameservers: string

Use DNS Settings instead. Deprecated.

enforce_twofactor: boolean

Deprecateduse_account_custom_ns_by_default: boolean

Use DNS Settings instead. Deprecated.

type: "standard" or "enterprise"

One of the following:

"standard"

"enterprise"

TenantsEntitlements

List tenant entitlements

GET/tenants/{tenant_id}/entitlements

ModelsExpand Collapse

TenantEntitlements object { allow_add_subdomain, allow_auto_accept_invites, cname_setup_allowed, 3 more }

allow_add_subdomain: object { type, value }

type: "bool"

value: boolean

allow_auto_accept_invites: object { type, value }

type: "bool"

value: boolean

cname_setup_allowed: object { type, value }

type: "bool"

value: boolean

custom_entitlements: array of object { allocation, feature }

allocation: object { type, value } or object { type, value } or object { type, value }

One of the following:

OrganizationsAPIMaxCountAllocation object { type, value }

type: "max_count"

value: number

OrganizationsAPIBoolAllocation object { type, value }

type: "bool"

value: boolean

OrganizationsAPINullAllocation object { type, value }

type: ""

value: optional unknown

feature: object { key }

key: string

mhs_certificate_count: object { type, value }

type: "max_count"

value: number

partial_setup_allowed: object { type, value }

type: "bool"

value: boolean

TenantsMemberships

List tenant memberships

GET/tenants/{tenant_id}/memberships

ModelsExpand Collapse

TenantMembership object { user_email, user_name, user_tag }

user_email: string

user_name: string

user_tag: string