Tenants

Get tenant

client.Tenants.Get(ctx, tenantID) (*Tenant, error)

GET/tenants/{tenant_id}

ModelsExpand Collapse

type Tenant struct{…}

Cdate Time

formatdate-time

Edate Time

formatdate-time

TenantContacts TenantTenantContacts

Email stringOptional

Website stringOptional

TenantLabels []string

TenantMetadata TenantTenantMetadata

DNS TenantTenantMetadataDNSOptional

NSPool TenantTenantMetadataDNSNSPool

Primary stringOptional

Secondary stringOptional

TenantName string

TenantNetwork unknown

TenantStatus string

TenantTag string

TenantType string

TenantUnits []TenantTenantUnit

UnitMemberships []unknown

UnitMetadata unknown

UnitName string

UnitStatus string

UnitTag string

CustomerID stringOptional

TenantsAccount Types

Get tenant account types

client.Tenants.AccountTypes.List(ctx, tenantID) (*SinglePage[string], error)

GET/tenants/{tenant_id}/account_types

TenantsAccounts

List tenant accounts

client.Tenants.Accounts.List(ctx, tenantID) (*SinglePage[TenantAccount], error)

GET/tenants/{tenant_id}/accounts

ModelsExpand Collapse

type TenantAccount struct{…}

ID string

CreatedOn Time

formatdate-time

Name string

Settings TenantAccountSettings

AbuseContactEmail string

AccessApprovalExpiry Time

formatdate-time

APIAccessEnabled bool

DeprecatedDefaultNameservers string

Use DNS Settings instead. Deprecated.

EnforceTwofactor bool

DeprecatedUseAccountCustomNSByDefault bool

Use DNS Settings instead. Deprecated.

Type TenantAccountType

One of the following:

const TenantAccountTypeStandard TenantAccountType = "standard"

const TenantAccountTypeEnterprise TenantAccountType = "enterprise"

TenantsEntitlements

List tenant entitlements

client.Tenants.Entitlements.Get(ctx, tenantID) (*TenantEntitlements, error)

GET/tenants/{tenant_id}/entitlements

ModelsExpand Collapse

type TenantEntitlements struct{…}

AllowAddSubdomain TenantEntitlementsAllowAddSubdomain

Type TenantEntitlementsAllowAddSubdomainType

Value bool

AllowAutoAcceptInvites TenantEntitlementsAllowAutoAcceptInvites

Type TenantEntitlementsAllowAutoAcceptInvitesType

Value bool

CNAMESetupAllowed TenantEntitlementsCNAMESetupAllowed

Type TenantEntitlementsCNAMESetupAllowedType

Value bool

CustomEntitlements []TenantEntitlementsCustomEntitlement

Allocation TenantEntitlementsCustomEntitlementsAllocation

One of the following:

type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIMaxCountAllocation struct{…}

Type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIMaxCountAllocationType

Value int64

type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIBoolAllocation struct{…}

Type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIBoolAllocationType

Value bool

type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPINullAllocation struct{…}

Type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPINullAllocationType

Value unknownOptional

Feature TenantEntitlementsCustomEntitlementsFeature

Key string

MhsCertificateCount TenantEntitlementsMhsCertificateCount

Type TenantEntitlementsMhsCertificateCountType

Value int64

PartialSetupAllowed TenantEntitlementsPartialSetupAllowed

Type TenantEntitlementsPartialSetupAllowedType

Value bool

TenantsMemberships

List tenant memberships

client.Tenants.Memberships.List(ctx, tenantID) (*SinglePage[TenantMembership], error)

GET/tenants/{tenant_id}/memberships

ModelsExpand Collapse

type TenantMembership struct{…}

UserEmail string

UserName string

UserTag string