tenants

package
v7.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 9, 2026 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

View Source 
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

View Source 
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

View Source 
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

View Source 
const CertificateCADigicert = shared.CertificateCADigicert

This is an alias to an internal value.

View Source 
const CertificateCAGoogle = shared.CertificateCAGoogle

This is an alias to an internal value.

View Source 
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt

This is an alias to an internal value.

View Source 
const CertificateCASSLCom = shared.CertificateCASSLCom

This is an alias to an internal value.

View Source 
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source 
const CloudflareTunnelConfigSrcCloudflare = shared.CloudflareTunnelConfigSrcCloudflare

This is an alias to an internal value.

View Source 
const CloudflareTunnelConfigSrcLocal = shared.CloudflareTunnelConfigSrcLocal

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

View Source 
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow

This is an alias to an internal value.

View Source 
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny

This is an alias to an internal value.

View Source 
const MemberStatusAccepted = shared.MemberStatusAccepted

This is an alias to an internal value.

View Source 
const MemberStatusPending = shared.MemberStatusPending

This is an alias to an internal value.

View Source 
const RatePlanIDBusiness = shared.RatePlanIDBusiness

This is an alias to an internal value.

View Source 
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise

This is an alias to an internal value.

View Source 
const RatePlanIDFree = shared.RatePlanIDFree

This is an alias to an internal value.

View Source 
const RatePlanIDLite = shared.RatePlanIDLite

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro

This is an alias to an internal value.

View Source 
const RatePlanIDPro = shared.RatePlanIDPro

This is an alias to an internal value.

View Source 
const RatePlanIDProPlus = shared.RatePlanIDProPlus

This is an alias to an internal value.

View Source 
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source 
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly

This is an alias to an internal value.

View Source 
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment

This is an alias to an internal value.

View Source 
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled

This is an alias to an internal value.

View Source 
const SubscriptionStateExpired = shared.SubscriptionStateExpired

This is an alias to an internal value.

View Source 
const SubscriptionStateFailed = shared.SubscriptionStateFailed

This is an alias to an internal value.

View Source 
const SubscriptionStatePaid = shared.SubscriptionStatePaid

This is an alias to an internal value.

View Source 
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned

This is an alias to an internal value.

View Source 
const SubscriptionStateTrial = shared.SubscriptionStateTrial

This is an alias to an internal value.

View Source 
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow

This is an alias to an internal value.

View Source 
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny

This is an alias to an internal value.

View Source 
const TokenStatusActive = shared.TokenStatusActive

This is an alias to an internal value.

View Source 
const TokenStatusDisabled = shared.TokenStatusDisabled

This is an alias to an internal value.

View Source 
const TokenStatusExpired = shared.TokenStatusExpired

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type ASN 

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam 

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AccountService 

type AccountService struct {
	Options []option.RequestOption
}

AccountService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAccountService method instead.

func NewAccountService 

func NewAccountService(opts ...option.RequestOption) (r *AccountService)

NewAccountService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AccountService) List 

func (r *AccountService) List(ctx context.Context, tenantID string, opts ...option.RequestOption) (res *pagination.SinglePage[TenantAccount], err error)

List of accounts for the Tenant.

func (*AccountService) ListAutoPaging 

func (r *AccountService) ListAutoPaging(ctx context.Context, tenantID string, opts ...option.RequestOption) *pagination.SinglePageAutoPager[TenantAccount]

List of accounts for the Tenant.

type AccountTypeService 

type AccountTypeService struct {
	Options []option.RequestOption
}

AccountTypeService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAccountTypeService method instead.

func NewAccountTypeService 

func NewAccountTypeService(opts ...option.RequestOption) (r *AccountTypeService)

NewAccountTypeService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AccountTypeService) List 

func (r *AccountTypeService) List(ctx context.Context, tenantID string, opts ...option.RequestOption) (res *pagination.SinglePage[string], err error)

List of account types available for the Tenant to provision accounts.

func (*AccountTypeService) ListAutoPaging 

func (r *AccountTypeService) ListAutoPaging(ctx context.Context, tenantID string, opts ...option.RequestOption) *pagination.SinglePageAutoPager[string]

List of account types available for the Tenant to provision accounts.

type AuditLog 

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction 

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor 

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType 

type AuditLogActorType = shared.AuditLogActorType

The type of actor, whether a User, Cloudflare Admin, or an Automated System.

This is an alias to an internal type.

type AuditLogOwner 

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource 

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type CertificateCA 

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate.

This is an alias to an internal type.

type CertificateRequestType 

type CertificateRequestType = shared.CertificateRequestType

Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).

This is an alias to an internal type.

type CloudflareTunnel 

type CloudflareTunnel = shared.CloudflareTunnel

A Cloudflare Tunnel that connects your origin to Cloudflare's edge.

This is an alias to an internal type.

type CloudflareTunnelConfigSrc 

type CloudflareTunnelConfigSrc = shared.CloudflareTunnelConfigSrc

Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel on the Zero Trust dashboard.

This is an alias to an internal type.

type CloudflareTunnelConnection 

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelStatus 

type CloudflareTunnelStatus = shared.CloudflareTunnelStatus

The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).

This is an alias to an internal type.

type CloudflareTunnelTunType 

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

type EntitlementGetResponseEnvelope 

type EntitlementGetResponseEnvelope struct {
	Errors   []interface{}                         `json:"errors" api:"required"`
	Messages []shared.ResponseInfo                 `json:"messages" api:"required"`
	Result   TenantEntitlements                    `json:"result" api:"required"`
	Success  EntitlementGetResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON     entitlementGetResponseEnvelopeJSON    `json:"-"`
}

func (*EntitlementGetResponseEnvelope) UnmarshalJSON 

func (r *EntitlementGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EntitlementGetResponseEnvelopeSuccess 

type EntitlementGetResponseEnvelopeSuccess bool
const (
	EntitlementGetResponseEnvelopeSuccessTrue EntitlementGetResponseEnvelopeSuccess = true
)

func (EntitlementGetResponseEnvelopeSuccess) IsKnown 

func (r EntitlementGetResponseEnvelopeSuccess) IsKnown() bool

type EntitlementService 

type EntitlementService struct {
	Options []option.RequestOption
}

EntitlementService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewEntitlementService method instead.

func NewEntitlementService 

func NewEntitlementService(opts ...option.RequestOption) (r *EntitlementService)

NewEntitlementService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*EntitlementService) Get 

func (r *EntitlementService) Get(ctx context.Context, tenantID string, opts ...option.RequestOption) (res *TenantEntitlements, err error)

List of innate entitlements available for the Tenant.

type Error 

type Error = apierror.Error

type ErrorData 

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type ErrorDataSource 

type ErrorDataSource = shared.ErrorDataSource

This is an alias to an internal type.

type Member 

type Member = shared.Member

This is an alias to an internal type.

type MemberPoliciesAccess 

type MemberPoliciesAccess = shared.MemberPoliciesAccess

Allow or deny operations against the resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroup 

type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroupsMeta 

type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type MemberPoliciesResourceGroup 

type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup

A group of scoped resources.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsMeta 

type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta

Attributes associated to the resource group.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScope 

type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope

A scope is a combination of scope objects which provides additional context.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScopeObject 

type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject

A scope object represents any resource that can have actions applied against invite.

This is an alias to an internal type.

type MemberPolicy 

type MemberPolicy = shared.MemberPolicy

This is an alias to an internal type.

type MemberStatus 

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUser 

type MemberUser = shared.MemberUser

Details of the user associated to the membership.

This is an alias to an internal type.

type MembershipService 

type MembershipService struct {
	Options []option.RequestOption
}

MembershipService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewMembershipService method instead.

func NewMembershipService 

func NewMembershipService(opts ...option.RequestOption) (r *MembershipService)

NewMembershipService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*MembershipService) List 

func (r *MembershipService) List(ctx context.Context, tenantID string, opts ...option.RequestOption) (res *pagination.SinglePage[TenantMembership], err error)

List of active members (Cloudflare users) for the Tenant.

func (*MembershipService) ListAutoPaging 

func (r *MembershipService) ListAutoPaging(ctx context.Context, tenantID string, opts ...option.RequestOption) *pagination.SinglePageAutoPager[TenantMembership]

List of active members (Cloudflare users) for the Tenant.

type Permission 

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant 

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam 

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type RatePlan 

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

type RatePlanID 

type RatePlanID = shared.RatePlanID

The ID of the rate plan.

This is an alias to an internal type.

type RatePlanParam 

type RatePlanParam = shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

type ResponseInfo 

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type ResponseInfoSource 

type ResponseInfoSource = shared.ResponseInfoSource

This is an alias to an internal type.

type Role 

type Role = shared.Role

This is an alias to an internal type.

type RoleParam 

type RoleParam = shared.RoleParam

This is an alias to an internal type.

type RolePermissions 

type RolePermissions = shared.RolePermissions

This is an alias to an internal type.

type RolePermissionsParam 

type RolePermissionsParam = shared.RolePermissionsParam

This is an alias to an internal type.

type SortDirection 

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type Subscription 

type Subscription = shared.Subscription

This is an alias to an internal type.

type SubscriptionFrequency 

type SubscriptionFrequency = shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

type SubscriptionParam 

type SubscriptionParam = shared.SubscriptionParam

This is an alias to an internal type.

type SubscriptionState 

type SubscriptionState = shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

type Tenant 

type Tenant struct {
	Cdate          time.Time            `json:"cdate" api:"required" format:"date-time"`
	Edate          time.Time            `json:"edate" api:"required" format:"date-time"`
	TenantContacts TenantTenantContacts `json:"tenant_contacts" api:"required"`
	TenantLabels   []string             `json:"tenant_labels" api:"required"`
	TenantMetadata TenantTenantMetadata `json:"tenant_metadata" api:"required"`
	TenantName     string               `json:"tenant_name" api:"required"`
	TenantNetwork  interface{}          `json:"tenant_network" api:"required"`
	TenantStatus   string               `json:"tenant_status" api:"required"`
	TenantTag      string               `json:"tenant_tag" api:"required"`
	TenantType     string               `json:"tenant_type" api:"required"`
	TenantUnits    []TenantTenantUnit   `json:"tenant_units" api:"required"`
	CustomerID     string               `json:"customer_id"`
	JSON           tenantJSON           `json:"-"`
}

func (*Tenant) UnmarshalJSON 

func (r *Tenant) UnmarshalJSON(data []byte) (err error)

type TenantAccount 

type TenantAccount struct {
	ID        string                `json:"id" api:"required"`
	CreatedOn time.Time             `json:"created_on" api:"required" format:"date-time"`
	Name      string                `json:"name" api:"required,nullable"`
	Settings  TenantAccountSettings `json:"settings" api:"required"`
	Type      TenantAccountType     `json:"type" api:"required"`
	JSON      tenantAccountJSON     `json:"-"`
}

func (*TenantAccount) UnmarshalJSON 

func (r *TenantAccount) UnmarshalJSON(data []byte) (err error)

type TenantAccountSettings 

type TenantAccountSettings struct {
	AbuseContactEmail    string    `json:"abuse_contact_email" api:"required,nullable"`
	AccessApprovalExpiry time.Time `json:"access_approval_expiry" api:"required,nullable" format:"date-time"`
	APIAccessEnabled     bool      `json:"api_access_enabled" api:"required,nullable"`
	// Use
	// [DNS Settings](https://developers.cloudflare.com/api/operations/dns-settings-for-an-account-list-dns-settings)
	// instead. Deprecated.
	//
	// Deprecated: deprecated
	DefaultNameservers string `json:"default_nameservers" api:"required,nullable"`
	EnforceTwofactor   bool   `json:"enforce_twofactor" api:"required,nullable"`
	// Use
	// [DNS Settings](https://developers.cloudflare.com/api/operations/dns-settings-for-an-account-list-dns-settings)
	// instead. Deprecated.
	//
	// Deprecated: deprecated
	UseAccountCustomNSByDefault bool                      `json:"use_account_custom_ns_by_default" api:"required,nullable"`
	JSON                        tenantAccountSettingsJSON `json:"-"`
}

func (*TenantAccountSettings) UnmarshalJSON 

func (r *TenantAccountSettings) UnmarshalJSON(data []byte) (err error)

type TenantAccountType 

type TenantAccountType string
const (
	TenantAccountTypeStandard   TenantAccountType = "standard"
	TenantAccountTypeEnterprise TenantAccountType = "enterprise"
)

func (TenantAccountType) IsKnown 

func (r TenantAccountType) IsKnown() bool

type TenantEntitlements 

type TenantEntitlements struct {
	AllowAddSubdomain      TenantEntitlementsAllowAddSubdomain      `json:"allow_add_subdomain" api:"required"`
	AllowAutoAcceptInvites TenantEntitlementsAllowAutoAcceptInvites `json:"allow_auto_accept_invites" api:"required"`
	CNAMESetupAllowed      TenantEntitlementsCNAMESetupAllowed      `json:"cname_setup_allowed" api:"required"`
	CustomEntitlements     []TenantEntitlementsCustomEntitlement    `json:"custom_entitlements" api:"required,nullable"`
	MhsCertificateCount    TenantEntitlementsMhsCertificateCount    `json:"mhs_certificate_count" api:"required"`
	PartialSetupAllowed    TenantEntitlementsPartialSetupAllowed    `json:"partial_setup_allowed" api:"required"`
	JSON                   tenantEntitlementsJSON                   `json:"-"`
}

func (*TenantEntitlements) UnmarshalJSON 

func (r *TenantEntitlements) UnmarshalJSON(data []byte) (err error)

type TenantEntitlementsAllowAddSubdomain 

type TenantEntitlementsAllowAddSubdomain struct {
	Type  TenantEntitlementsAllowAddSubdomainType `json:"type" api:"required"`
	Value bool                                    `json:"value" api:"required"`
	JSON  tenantEntitlementsAllowAddSubdomainJSON `json:"-"`
}

func (*TenantEntitlementsAllowAddSubdomain) UnmarshalJSON 

func (r *TenantEntitlementsAllowAddSubdomain) UnmarshalJSON(data []byte) (err error)

type TenantEntitlementsAllowAddSubdomainType 

type TenantEntitlementsAllowAddSubdomainType string
const (
	TenantEntitlementsAllowAddSubdomainTypeBool TenantEntitlementsAllowAddSubdomainType = "bool"
)

func (TenantEntitlementsAllowAddSubdomainType) IsKnown 

func (r TenantEntitlementsAllowAddSubdomainType) IsKnown() bool

type TenantEntitlementsAllowAutoAcceptInvites 

type TenantEntitlementsAllowAutoAcceptInvites struct {
	Type  TenantEntitlementsAllowAutoAcceptInvitesType `json:"type" api:"required"`
	Value bool                                         `json:"value" api:"required"`
	JSON  tenantEntitlementsAllowAutoAcceptInvitesJSON `json:"-"`
}

func (*TenantEntitlementsAllowAutoAcceptInvites) UnmarshalJSON 

func (r *TenantEntitlementsAllowAutoAcceptInvites) UnmarshalJSON(data []byte) (err error)

type TenantEntitlementsAllowAutoAcceptInvitesType 

type TenantEntitlementsAllowAutoAcceptInvitesType string
const (
	TenantEntitlementsAllowAutoAcceptInvitesTypeBool TenantEntitlementsAllowAutoAcceptInvitesType = "bool"
)

func (TenantEntitlementsAllowAutoAcceptInvitesType) IsKnown 

func (r TenantEntitlementsAllowAutoAcceptInvitesType) IsKnown() bool

type TenantEntitlementsCNAMESetupAllowed 

type TenantEntitlementsCNAMESetupAllowed struct {
	Type  TenantEntitlementsCNAMESetupAllowedType `json:"type" api:"required"`
	Value bool                                    `json:"value" api:"required"`
	JSON  tenantEntitlementsCNAMESetupAllowedJSON `json:"-"`
}

func (*TenantEntitlementsCNAMESetupAllowed) UnmarshalJSON 

func (r *TenantEntitlementsCNAMESetupAllowed) UnmarshalJSON(data []byte) (err error)

type TenantEntitlementsCNAMESetupAllowedType 

type TenantEntitlementsCNAMESetupAllowedType string
const (
	TenantEntitlementsCNAMESetupAllowedTypeBool TenantEntitlementsCNAMESetupAllowedType = "bool"
)

func (TenantEntitlementsCNAMESetupAllowedType) IsKnown 

func (r TenantEntitlementsCNAMESetupAllowedType) IsKnown() bool

type TenantEntitlementsCustomEntitlement 

type TenantEntitlementsCustomEntitlement struct {
	Allocation TenantEntitlementsCustomEntitlementsAllocation `json:"allocation" api:"required"`
	Feature    TenantEntitlementsCustomEntitlementsFeature    `json:"feature" api:"required"`
	JSON       tenantEntitlementsCustomEntitlementJSON        `json:"-"`
}

func (*TenantEntitlementsCustomEntitlement) UnmarshalJSON 

func (r *TenantEntitlementsCustomEntitlement) UnmarshalJSON(data []byte) (err error)

type TenantEntitlementsCustomEntitlementsAllocation 

type TenantEntitlementsCustomEntitlementsAllocation struct {
	Type TenantEntitlementsCustomEntitlementsAllocationType `json:"type" api:"required"`
	// This field can have the runtime type of [int64], [bool], [interface{}].
	Value interface{}                                        `json:"value"`
	JSON  tenantEntitlementsCustomEntitlementsAllocationJSON `json:"-"`
	// contains filtered or unexported fields
}

func (TenantEntitlementsCustomEntitlementsAllocation) AsUnion 

func (r TenantEntitlementsCustomEntitlementsAllocation) AsUnion() TenantEntitlementsCustomEntitlementsAllocationUnion

AsUnion returns a TenantEntitlementsCustomEntitlementsAllocationUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIMaxCountAllocation, TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIBoolAllocation, TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPINullAllocation.

func (*TenantEntitlementsCustomEntitlementsAllocation) UnmarshalJSON 

func (r *TenantEntitlementsCustomEntitlementsAllocation) UnmarshalJSON(data []byte) (err error)

type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIBoolAllocation 

type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIBoolAllocation struct {
	Type  TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIBoolAllocationType `json:"type" api:"required"`
	Value bool                                                                             `json:"value" api:"required"`
	JSON  tenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIBoolAllocationJSON `json:"-"`
}

func (*TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIBoolAllocation) UnmarshalJSON 

func (r *TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIBoolAllocation) UnmarshalJSON(data []byte) (err error)

type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIBoolAllocationType 

type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIBoolAllocationType string
const (
	TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIBoolAllocationTypeBool TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIBoolAllocationType = "bool"
)

func (TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIBoolAllocationType) IsKnown 

func (r TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIBoolAllocationType) IsKnown() bool

type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIMaxCountAllocation 

type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIMaxCountAllocation struct {
	Type  TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIMaxCountAllocationType `json:"type" api:"required"`
	Value int64                                                                                `json:"value" api:"required"`
	JSON  tenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIMaxCountAllocationJSON `json:"-"`
}

func (*TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIMaxCountAllocation) UnmarshalJSON 

func (r *TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIMaxCountAllocation) UnmarshalJSON(data []byte) (err error)

type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIMaxCountAllocationType 

type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIMaxCountAllocationType string
const (
	TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIMaxCountAllocationTypeMaxCount TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIMaxCountAllocationType = "max_count"
)

func (TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIMaxCountAllocationType) IsKnown 

func (r TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIMaxCountAllocationType) IsKnown() bool

type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPINullAllocation 

type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPINullAllocation struct {
	Type  TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPINullAllocationType `json:"type" api:"required"`
	Value interface{}                                                                      `json:"value"`
	JSON  tenantEntitlementsCustomEntitlementsAllocationOrganizationsAPINullAllocationJSON `json:"-"`
}

func (*TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPINullAllocation) UnmarshalJSON 

func (r *TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPINullAllocation) UnmarshalJSON(data []byte) (err error)

type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPINullAllocationType 

type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPINullAllocationType string
const (
	TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPINullAllocationTypeEmpty TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPINullAllocationType = ""
)

func (TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPINullAllocationType) IsKnown 

func (r TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPINullAllocationType) IsKnown() bool

type TenantEntitlementsCustomEntitlementsAllocationType 

type TenantEntitlementsCustomEntitlementsAllocationType string
const (
	TenantEntitlementsCustomEntitlementsAllocationTypeMaxCount TenantEntitlementsCustomEntitlementsAllocationType = "max_count"
	TenantEntitlementsCustomEntitlementsAllocationTypeBool     TenantEntitlementsCustomEntitlementsAllocationType = "bool"
	TenantEntitlementsCustomEntitlementsAllocationTypeEmpty    TenantEntitlementsCustomEntitlementsAllocationType = ""
)

func (TenantEntitlementsCustomEntitlementsAllocationType) IsKnown 

func (r TenantEntitlementsCustomEntitlementsAllocationType) IsKnown() bool

type TenantEntitlementsCustomEntitlementsAllocationUnion 

type TenantEntitlementsCustomEntitlementsAllocationUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIMaxCountAllocation, TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIBoolAllocation or TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPINullAllocation.

type TenantEntitlementsCustomEntitlementsFeature 

type TenantEntitlementsCustomEntitlementsFeature struct {
	Key  string                                          `json:"key" api:"required"`
	JSON tenantEntitlementsCustomEntitlementsFeatureJSON `json:"-"`
}

func (*TenantEntitlementsCustomEntitlementsFeature) UnmarshalJSON 

func (r *TenantEntitlementsCustomEntitlementsFeature) UnmarshalJSON(data []byte) (err error)

type TenantEntitlementsMhsCertificateCount 

type TenantEntitlementsMhsCertificateCount struct {
	Type  TenantEntitlementsMhsCertificateCountType `json:"type" api:"required"`
	Value int64                                     `json:"value" api:"required"`
	JSON  tenantEntitlementsMhsCertificateCountJSON `json:"-"`
}

func (*TenantEntitlementsMhsCertificateCount) UnmarshalJSON 

func (r *TenantEntitlementsMhsCertificateCount) UnmarshalJSON(data []byte) (err error)

type TenantEntitlementsMhsCertificateCountType 

type TenantEntitlementsMhsCertificateCountType string
const (
	TenantEntitlementsMhsCertificateCountTypeMaxCount TenantEntitlementsMhsCertificateCountType = "max_count"
)

func (TenantEntitlementsMhsCertificateCountType) IsKnown 

func (r TenantEntitlementsMhsCertificateCountType) IsKnown() bool

type TenantEntitlementsPartialSetupAllowed 

type TenantEntitlementsPartialSetupAllowed struct {
	Type  TenantEntitlementsPartialSetupAllowedType `json:"type" api:"required"`
	Value bool                                      `json:"value" api:"required"`
	JSON  tenantEntitlementsPartialSetupAllowedJSON `json:"-"`
}

func (*TenantEntitlementsPartialSetupAllowed) UnmarshalJSON 

func (r *TenantEntitlementsPartialSetupAllowed) UnmarshalJSON(data []byte) (err error)

type TenantEntitlementsPartialSetupAllowedType 

type TenantEntitlementsPartialSetupAllowedType string
const (
	TenantEntitlementsPartialSetupAllowedTypeBool TenantEntitlementsPartialSetupAllowedType = "bool"
)

func (TenantEntitlementsPartialSetupAllowedType) IsKnown 

func (r TenantEntitlementsPartialSetupAllowedType) IsKnown() bool

type TenantGetResponseEnvelope 

type TenantGetResponseEnvelope struct {
	Errors   []interface{}                    `json:"errors" api:"required"`
	Messages []shared.ResponseInfo            `json:"messages" api:"required"`
	Result   Tenant                           `json:"result" api:"required"`
	Success  TenantGetResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON     tenantGetResponseEnvelopeJSON    `json:"-"`
}

func (*TenantGetResponseEnvelope) UnmarshalJSON 

func (r *TenantGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type TenantGetResponseEnvelopeSuccess 

type TenantGetResponseEnvelopeSuccess bool
const (
	TenantGetResponseEnvelopeSuccessTrue TenantGetResponseEnvelopeSuccess = true
)

func (TenantGetResponseEnvelopeSuccess) IsKnown 

func (r TenantGetResponseEnvelopeSuccess) IsKnown() bool

type TenantMembership 

type TenantMembership struct {
	UserEmail string               `json:"user_email" api:"required"`
	UserName  string               `json:"user_name" api:"required"`
	UserTag   string               `json:"user_tag" api:"required"`
	JSON      tenantMembershipJSON `json:"-"`
}

func (*TenantMembership) UnmarshalJSON 

func (r *TenantMembership) UnmarshalJSON(data []byte) (err error)

type TenantService 

type TenantService struct {
	Options      []option.RequestOption
	AccountTypes *AccountTypeService
	Accounts     *AccountService
	Entitlements *EntitlementService
	Memberships  *MembershipService
}

TenantService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewTenantService method instead.

func NewTenantService 

func NewTenantService(opts ...option.RequestOption) (r *TenantService)

NewTenantService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*TenantService) Get 

func (r *TenantService) Get(ctx context.Context, tenantID string, opts ...option.RequestOption) (res *Tenant, err error)

Retrieves a Tenant by Tenant ID.

type TenantTenantContacts 

type TenantTenantContacts struct {
	Email   string                   `json:"email"`
	Website string                   `json:"website"`
	JSON    tenantTenantContactsJSON `json:"-"`
}

func (*TenantTenantContacts) UnmarshalJSON 

func (r *TenantTenantContacts) UnmarshalJSON(data []byte) (err error)

type TenantTenantMetadata 

type TenantTenantMetadata struct {
	DNS  TenantTenantMetadataDNS  `json:"dns"`
	JSON tenantTenantMetadataJSON `json:"-"`
}

func (*TenantTenantMetadata) UnmarshalJSON 

func (r *TenantTenantMetadata) UnmarshalJSON(data []byte) (err error)

type TenantTenantMetadataDNS 

type TenantTenantMetadataDNS struct {
	NSPool TenantTenantMetadataDNSNSPool `json:"ns_pool" api:"required"`
	JSON   tenantTenantMetadataDNSJSON   `json:"-"`
}

func (*TenantTenantMetadataDNS) UnmarshalJSON 

func (r *TenantTenantMetadataDNS) UnmarshalJSON(data []byte) (err error)

type TenantTenantMetadataDNSNSPool 

type TenantTenantMetadataDNSNSPool struct {
	Primary   string                            `json:"primary"`
	Secondary string                            `json:"secondary"`
	JSON      tenantTenantMetadataDnsnsPoolJSON `json:"-"`
}

func (*TenantTenantMetadataDNSNSPool) UnmarshalJSON 

func (r *TenantTenantMetadataDNSNSPool) UnmarshalJSON(data []byte) (err error)

type TenantTenantUnit 

type TenantTenantUnit struct {
	UnitMemberships []interface{}        `json:"unit_memberships" api:"required"`
	UnitMetadata    interface{}          `json:"unit_metadata" api:"required"`
	UnitName        string               `json:"unit_name" api:"required"`
	UnitStatus      string               `json:"unit_status" api:"required"`
	UnitTag         string               `json:"unit_tag" api:"required"`
	JSON            tenantTenantUnitJSON `json:"-"`
}

func (*TenantTenantUnit) UnmarshalJSON 

func (r *TenantTenantUnit) UnmarshalJSON(data []byte) (err error)

type Token 

type Token = shared.Token

This is an alias to an internal type.

type TokenCondition 

type TokenCondition = shared.TokenCondition

This is an alias to an internal type.

type TokenConditionCIDRList 

type TokenConditionCIDRList = shared.TokenConditionCIDRList

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionCIDRListParam 

type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionParam 

type TokenConditionParam = shared.TokenConditionParam

This is an alias to an internal type.

type TokenConditionRequestIP 

type TokenConditionRequestIP = shared.TokenConditionRequestIP

Client IP restrictions.

This is an alias to an internal type.

type TokenConditionRequestIPParam 

type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam

Client IP restrictions.

This is an alias to an internal type.

type TokenParam 

type TokenParam = shared.TokenParam

This is an alias to an internal type.

type TokenPolicy 

type TokenPolicy = shared.TokenPolicy

This is an alias to an internal type.

type TokenPolicyEffect 

type TokenPolicyEffect = shared.TokenPolicyEffect

Allow or deny operations against the resources.

This is an alias to an internal type.

type TokenPolicyParam 

type TokenPolicyParam = shared.TokenPolicyParam

This is an alias to an internal type.

type TokenPolicyPermissionGroup 

type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type TokenPolicyPermissionGroupParam 

type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMeta 

type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMetaParam 

type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNested 

type TokenPolicyResourcesIAMResourcesTypeObjectNested = shared.TokenPolicyResourcesIAMResourcesTypeObjectNested

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam 

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectNestedParam

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectString 

type TokenPolicyResourcesIAMResourcesTypeObjectString = shared.TokenPolicyResourcesIAMResourcesTypeObjectString

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam 

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectStringParam

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesUnion 

type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenPolicyResourcesUnionParam 

type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenStatus 

type TokenStatus = shared.TokenStatus

Status of the token.

This is an alias to an internal type.

type TokenValue 

type TokenValue = shared.TokenValue

The token value.

This is an alias to an internal type.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.