Documentation
¶
Index ¶
- Constants
- type ASN
- type ASNParam
- type AuditLog
- type AuditLogAction
- type AuditLogActor
- type AuditLogActorType
- type AuditLogOwner
- type AuditLogResource
- type CertificateCA
- type CertificateRequestType
- type CloudflareTunnel
- type CloudflareTunnelConfigSrc
- type CloudflareTunnelConnection
- type CloudflareTunnelStatus
- type CloudflareTunnelTunType
- type Error
- type ErrorData
- type ErrorDataSource
- type Member
- type MemberGetResponseEnvelope
- type MemberGetResponseEnvelopeSuccess
- type MemberListParams
- type MemberListParamsStatus
- type MemberListParamsUser
- type MemberNewParams
- type MemberNewParamsMember
- type MemberNewParamsMemberStatus
- type MemberNewParamsMemberUser
- type MemberNewResponseEnvelope
- type MemberNewResponseEnvelopeSuccess
- type MemberPoliciesAccess
- type MemberPoliciesPermissionGroup
- type MemberPoliciesPermissionGroupsMeta
- type MemberPoliciesResourceGroup
- type MemberPoliciesResourceGroupsMeta
- type MemberPoliciesResourceGroupsScope
- type MemberPoliciesResourceGroupsScopeObject
- type MemberPolicy
- type MemberService
- func (r *MemberService) Delete(ctx context.Context, organizationID string, memberID string, ...) (err error)
- func (r *MemberService) Get(ctx context.Context, organizationID string, memberID string, ...) (res *OrganizationMember, err error)
- func (r *MemberService) List(ctx context.Context, organizationID string, query MemberListParams, ...) (res *pagination.SinglePage[OrganizationMember], err error)
- func (r *MemberService) ListAutoPaging(ctx context.Context, organizationID string, query MemberListParams, ...) *pagination.SinglePageAutoPager[OrganizationMember]
- func (r *MemberService) New(ctx context.Context, organizationID string, body MemberNewParams, ...) (res *OrganizationMember, err error)
- type MemberStatus
- type MemberUser
- type Organization
- type OrganizationAccountGetParams
- type OrganizationAccountGetParamsAccountPubname
- type OrganizationAccountGetParamsName
- type OrganizationAccountGetResponse
- type OrganizationAccountGetResponseEnvelope
- type OrganizationAccountGetResponseEnvelopeResultInfo
- type OrganizationAccountGetResponseEnvelopeSuccess
- type OrganizationAccountGetResponseSettings
- type OrganizationAccountGetResponseType
- type OrganizationAccountService
- type OrganizationDeleteResponse
- type OrganizationDeleteResponseEnvelope
- type OrganizationDeleteResponseEnvelopeSuccess
- type OrganizationGetResponseEnvelope
- type OrganizationGetResponseEnvelopeSuccess
- type OrganizationListParams
- type OrganizationListParamsContaining
- type OrganizationListParamsName
- type OrganizationListParamsParent
- type OrganizationListParamsParentID
- type OrganizationMember
- type OrganizationMemberStatus
- type OrganizationMemberUser
- type OrganizationMeta
- type OrganizationMetaFlags
- type OrganizationMetaFlagsParam
- type OrganizationMetaParam
- type OrganizationNewParams
- type OrganizationNewResponseEnvelope
- type OrganizationNewResponseEnvelopeSuccess
- type OrganizationParam
- type OrganizationParent
- type OrganizationParentParam
- type OrganizationProfileGetResponseEnvelope
- type OrganizationProfileGetResponseEnvelopeSuccess
- type OrganizationProfileService
- type OrganizationProfileUpdateParams
- type OrganizationService
- func (r *OrganizationService) Delete(ctx context.Context, organizationID string, opts ...option.RequestOption) (res *OrganizationDeleteResponse, err error)
- func (r *OrganizationService) Get(ctx context.Context, organizationID string, opts ...option.RequestOption) (res *Organization, err error)
- func (r *OrganizationService) List(ctx context.Context, query OrganizationListParams, ...) (res *pagination.SinglePage[Organization], err error)
- func (r *OrganizationService) ListAutoPaging(ctx context.Context, query OrganizationListParams, ...) *pagination.SinglePageAutoPager[Organization]
- func (r *OrganizationService) New(ctx context.Context, body OrganizationNewParams, opts ...option.RequestOption) (res *Organization, err error)
- func (r *OrganizationService) Update(ctx context.Context, organizationID string, body OrganizationUpdateParams, ...) (res *Organization, err error)
- type OrganizationUpdateParams
- type OrganizationUpdateResponseEnvelope
- type OrganizationUpdateResponseEnvelopeSuccess
- type Permission
- type PermissionGrant
- type PermissionGrantParam
- type RatePlan
- type RatePlanID
- type RatePlanParam
- type ResponseInfo
- type ResponseInfoSource
- type Role
- type RoleParam
- type RolePermissions
- type RolePermissionsParam
- type SortDirection
- type Subscription
- type SubscriptionFrequency
- type SubscriptionParam
- type SubscriptionState
- type Token
- type TokenCondition
- type TokenConditionCIDRList
- type TokenConditionCIDRListParam
- type TokenConditionParam
- type TokenConditionRequestIP
- type TokenConditionRequestIPParam
- type TokenParam
- type TokenPolicy
- type TokenPolicyEffect
- type TokenPolicyParam
- type TokenPolicyPermissionGroup
- type TokenPolicyPermissionGroupParam
- type TokenPolicyPermissionGroupsMeta
- type TokenPolicyPermissionGroupsMetaParam
- type TokenPolicyResourcesIAMResourcesTypeObjectNested
- type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam
- type TokenPolicyResourcesIAMResourcesTypeObjectString
- type TokenPolicyResourcesIAMResourcesTypeObjectStringParam
- type TokenPolicyResourcesUnion
- type TokenPolicyResourcesUnionParam
- type TokenStatus
- type TokenValue
Constants ¶
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin
This is an alias to an internal value.
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare
This is an alias to an internal value.
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser
This is an alias to an internal value.
const CertificateCADigicert = shared.CertificateCADigicert
This is an alias to an internal value.
const CertificateCAGoogle = shared.CertificateCAGoogle
This is an alias to an internal value.
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt
This is an alias to an internal value.
const CertificateCASSLCom = shared.CertificateCASSLCom
This is an alias to an internal value.
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate
This is an alias to an internal value.
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC
This is an alias to an internal value.
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA
This is an alias to an internal value.
const CloudflareTunnelConfigSrcCloudflare = shared.CloudflareTunnelConfigSrcCloudflare
This is an alias to an internal value.
const CloudflareTunnelConfigSrcLocal = shared.CloudflareTunnelConfigSrcLocal
This is an alias to an internal value.
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded
This is an alias to an internal value.
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown
This is an alias to an internal value.
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy
This is an alias to an internal value.
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive
This is an alias to an internal value.
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI
This is an alias to an internal value.
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel
This is an alias to an internal value.
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE
This is an alias to an internal value.
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec
This is an alias to an internal value.
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector
This is an alias to an internal value.
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow
This is an alias to an internal value.
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny
This is an alias to an internal value.
const MemberStatusAccepted = shared.MemberStatusAccepted
This is an alias to an internal value.
const MemberStatusPending = shared.MemberStatusPending
This is an alias to an internal value.
const RatePlanIDBusiness = shared.RatePlanIDBusiness
This is an alias to an internal value.
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise
This is an alias to an internal value.
const RatePlanIDFree = shared.RatePlanIDFree
This is an alias to an internal value.
const RatePlanIDLite = shared.RatePlanIDLite
This is an alias to an internal value.
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness
This is an alias to an internal value.
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise
This is an alias to an internal value.
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree
This is an alias to an internal value.
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro
This is an alias to an internal value.
const RatePlanIDPro = shared.RatePlanIDPro
This is an alias to an internal value.
const RatePlanIDProPlus = shared.RatePlanIDProPlus
This is an alias to an internal value.
const SortDirectionAsc = shared.SortDirectionAsc
This is an alias to an internal value.
const SortDirectionDesc = shared.SortDirectionDesc
This is an alias to an internal value.
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly
This is an alias to an internal value.
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly
This is an alias to an internal value.
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly
This is an alias to an internal value.
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly
This is an alias to an internal value.
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment
This is an alias to an internal value.
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled
This is an alias to an internal value.
const SubscriptionStateExpired = shared.SubscriptionStateExpired
This is an alias to an internal value.
const SubscriptionStateFailed = shared.SubscriptionStateFailed
This is an alias to an internal value.
const SubscriptionStatePaid = shared.SubscriptionStatePaid
This is an alias to an internal value.
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned
This is an alias to an internal value.
const SubscriptionStateTrial = shared.SubscriptionStateTrial
This is an alias to an internal value.
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow
This is an alias to an internal value.
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny
This is an alias to an internal value.
const TokenStatusActive = shared.TokenStatusActive
This is an alias to an internal value.
const TokenStatusDisabled = shared.TokenStatusDisabled
This is an alias to an internal value.
const TokenStatusExpired = shared.TokenStatusExpired
This is an alias to an internal value.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
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 ErrorDataSource ¶
type ErrorDataSource = shared.ErrorDataSource
This is an alias to an internal type.
type MemberGetResponseEnvelope ¶
type MemberGetResponseEnvelope struct {
Errors []interface{} `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result OrganizationMember `json:"result,required"`
Success MemberGetResponseEnvelopeSuccess `json:"success,required"`
JSON memberGetResponseEnvelopeJSON `json:"-"`
}
func (*MemberGetResponseEnvelope) UnmarshalJSON ¶
func (r *MemberGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type MemberGetResponseEnvelopeSuccess ¶
type MemberGetResponseEnvelopeSuccess bool
const (
MemberGetResponseEnvelopeSuccessTrue MemberGetResponseEnvelopeSuccess = true
)
func (MemberGetResponseEnvelopeSuccess) IsKnown ¶
func (r MemberGetResponseEnvelopeSuccess) IsKnown() bool
type MemberListParams ¶
type MemberListParams struct {
// The amount of items to return. Defaults to 10.
PageSize param.Field[int64] `query:"page_size"`
// An opaque token returned from the last list response that when provided will
// retrieve the next page.
//
// Parameters used to filter the retrieved list must remain in subsequent requests
// with a page token.
PageToken param.Field[string] `query:"page_token"`
// Filter the list of memberships by membership status.
Status param.Field[[]MemberListParamsStatus] `query:"status"`
User param.Field[MemberListParamsUser] `query:"user"`
}
func (MemberListParams) URLQuery ¶
func (r MemberListParams) URLQuery() (v url.Values)
URLQuery serializes MemberListParams's query parameters as `url.Values`.
type MemberListParamsStatus ¶
type MemberListParamsStatus string
const ( MemberListParamsStatusActive MemberListParamsStatus = "active" MemberListParamsStatusCanceled MemberListParamsStatus = "canceled" )
func (MemberListParamsStatus) IsKnown ¶
func (r MemberListParamsStatus) IsKnown() bool
type MemberListParamsUser ¶
type MemberListParamsUser struct {
// Filter the list of memberships for a specific email that ends with a substring.
Email param.Field[string] `query:"email"`
}
func (MemberListParamsUser) URLQuery ¶
func (r MemberListParamsUser) URLQuery() (v url.Values)
URLQuery serializes MemberListParamsUser's query parameters as `url.Values`.
type MemberNewParams ¶
type MemberNewParams struct {
Member param.Field[MemberNewParamsMember] `json:"member,required"`
}
func (MemberNewParams) MarshalJSON ¶
func (r MemberNewParams) MarshalJSON() (data []byte, err error)
type MemberNewParamsMember ¶
type MemberNewParamsMember struct {
User param.Field[MemberNewParamsMemberUser] `json:"user,required"`
Status param.Field[MemberNewParamsMemberStatus] `json:"status"`
}
func (MemberNewParamsMember) MarshalJSON ¶
func (r MemberNewParamsMember) MarshalJSON() (data []byte, err error)
type MemberNewParamsMemberStatus ¶
type MemberNewParamsMemberStatus string
const ( MemberNewParamsMemberStatusActive MemberNewParamsMemberStatus = "active" MemberNewParamsMemberStatusCanceled MemberNewParamsMemberStatus = "canceled" )
func (MemberNewParamsMemberStatus) IsKnown ¶
func (r MemberNewParamsMemberStatus) IsKnown() bool
type MemberNewParamsMemberUser ¶
func (MemberNewParamsMemberUser) MarshalJSON ¶
func (r MemberNewParamsMemberUser) MarshalJSON() (data []byte, err error)
type MemberNewResponseEnvelope ¶
type MemberNewResponseEnvelope struct {
Errors []interface{} `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result OrganizationMember `json:"result,required"`
Success MemberNewResponseEnvelopeSuccess `json:"success,required"`
JSON memberNewResponseEnvelopeJSON `json:"-"`
}
func (*MemberNewResponseEnvelope) UnmarshalJSON ¶
func (r *MemberNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type MemberNewResponseEnvelopeSuccess ¶
type MemberNewResponseEnvelopeSuccess bool
const (
MemberNewResponseEnvelopeSuccessTrue MemberNewResponseEnvelopeSuccess = true
)
func (MemberNewResponseEnvelopeSuccess) IsKnown ¶
func (r MemberNewResponseEnvelopeSuccess) IsKnown() bool
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 MemberService ¶
type MemberService struct {
Options []option.RequestOption
}
MemberService 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 NewMemberService method instead.
func NewMemberService ¶
func NewMemberService(opts ...option.RequestOption) (r *MemberService)
NewMemberService 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 (*MemberService) Delete ¶ added in v6.2.0
func (r *MemberService) Delete(ctx context.Context, organizationID string, memberID string, opts ...option.RequestOption) (err error)
Delete a membership to a particular Organization. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)
func (*MemberService) Get ¶
func (r *MemberService) Get(ctx context.Context, organizationID string, memberID string, opts ...option.RequestOption) (res *OrganizationMember, err error)
Retrieve a single membership from an Organization. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)
func (*MemberService) List ¶
func (r *MemberService) List(ctx context.Context, organizationID string, query MemberListParams, opts ...option.RequestOption) (res *pagination.SinglePage[OrganizationMember], err error)
List memberships for an Organization. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)
func (*MemberService) ListAutoPaging ¶
func (r *MemberService) ListAutoPaging(ctx context.Context, organizationID string, query MemberListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[OrganizationMember]
List memberships for an Organization. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)
func (*MemberService) New ¶
func (r *MemberService) New(ctx context.Context, organizationID string, body MemberNewParams, opts ...option.RequestOption) (res *OrganizationMember, err error)
Create a membership that grants access to a specific Organization. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)
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 Organization ¶
type Organization struct {
ID string `json:"id,required"`
CreateTime time.Time `json:"create_time,required" format:"date-time"`
Meta OrganizationMeta `json:"meta,required"`
Name string `json:"name,required"`
Parent OrganizationParent `json:"parent"`
Profile accounts.AccountProfile `json:"profile"`
JSON organizationJSON `json:"-"`
}
References an Organization in the Cloudflare data model.
func (*Organization) UnmarshalJSON ¶
func (r *Organization) UnmarshalJSON(data []byte) (err error)
type OrganizationAccountGetParams ¶
type OrganizationAccountGetParams struct {
AccountPubname param.Field[OrganizationAccountGetParamsAccountPubname] `query:"account_pubname"`
Name param.Field[OrganizationAccountGetParamsName] `query:"name"`
// The amount of items to return. Defaults to 10.
PageSize param.Field[int64] `query:"page_size"`
// An opaque token returned from the last list response that when provided will
// retrieve the next page.
//
// Parameters used to filter the retrieved list must remain in subsequent requests
// with a page token.
PageToken param.Field[string] `query:"page_token"`
}
func (OrganizationAccountGetParams) URLQuery ¶
func (r OrganizationAccountGetParams) URLQuery() (v url.Values)
URLQuery serializes OrganizationAccountGetParams's query parameters as `url.Values`.
type OrganizationAccountGetParamsAccountPubname ¶
type OrganizationAccountGetParamsAccountPubname struct {
// (case-insensitive) Filter the list of accounts to where the account_pubname
// contains a particular string.
Contains param.Field[string] `query:"contains"`
// (case-insensitive) Filter the list of accounts to where the account_pubname ends
// with a particular string.
EndsWith param.Field[string] `query:"endsWith"`
// (case-insensitive) Filter the list of accounts to where the account_pubname
// starts with a particular string.
StartsWith param.Field[string] `query:"startsWith"`
}
func (OrganizationAccountGetParamsAccountPubname) URLQuery ¶
func (r OrganizationAccountGetParamsAccountPubname) URLQuery() (v url.Values)
URLQuery serializes OrganizationAccountGetParamsAccountPubname's query parameters as `url.Values`.
type OrganizationAccountGetParamsName ¶
type OrganizationAccountGetParamsName struct {
// (case-insensitive) Filter the list of accounts to where the name contains a
// particular string.
Contains param.Field[string] `query:"contains"`
// (case-insensitive) Filter the list of accounts to where the name ends with a
// particular string.
EndsWith param.Field[string] `query:"endsWith"`
// (case-insensitive) Filter the list of accounts to where the name starts with a
// particular string.
StartsWith param.Field[string] `query:"startsWith"`
}
func (OrganizationAccountGetParamsName) URLQuery ¶
func (r OrganizationAccountGetParamsName) URLQuery() (v url.Values)
URLQuery serializes OrganizationAccountGetParamsName's query parameters as `url.Values`.
type OrganizationAccountGetResponse ¶
type OrganizationAccountGetResponse struct {
ID string `json:"id,required"`
CreatedOn time.Time `json:"created_on,required" format:"date-time"`
Name string `json:"name,required,nullable"`
Settings OrganizationAccountGetResponseSettings `json:"settings,required"`
Type OrganizationAccountGetResponseType `json:"type,required"`
JSON organizationAccountGetResponseJSON `json:"-"`
}
func (*OrganizationAccountGetResponse) UnmarshalJSON ¶
func (r *OrganizationAccountGetResponse) UnmarshalJSON(data []byte) (err error)
type OrganizationAccountGetResponseEnvelope ¶
type OrganizationAccountGetResponseEnvelope struct {
Errors []interface{} `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result []OrganizationAccountGetResponse `json:"result,required"`
ResultInfo OrganizationAccountGetResponseEnvelopeResultInfo `json:"result_info,required"`
Success OrganizationAccountGetResponseEnvelopeSuccess `json:"success,required"`
JSON organizationAccountGetResponseEnvelopeJSON `json:"-"`
}
func (*OrganizationAccountGetResponseEnvelope) UnmarshalJSON ¶
func (r *OrganizationAccountGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type OrganizationAccountGetResponseEnvelopeResultInfo ¶
type OrganizationAccountGetResponseEnvelopeResultInfo struct {
// Use this opaque token in the next request to retrieve the next page.
//
// Parameters used to filter the retrieved list must remain in subsequent requests
// with a page token.
NextPageToken string `json:"next_page_token"`
// Counts the total amount of items in a list with the applied filters. The API
// omits next_page_token to indicate no more items in a particular list.
TotalSize int64 `json:"total_size"`
JSON organizationAccountGetResponseEnvelopeResultInfoJSON `json:"-"`
}
func (*OrganizationAccountGetResponseEnvelopeResultInfo) UnmarshalJSON ¶
func (r *OrganizationAccountGetResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)
type OrganizationAccountGetResponseEnvelopeSuccess ¶
type OrganizationAccountGetResponseEnvelopeSuccess bool
const (
OrganizationAccountGetResponseEnvelopeSuccessTrue OrganizationAccountGetResponseEnvelopeSuccess = true
)
func (OrganizationAccountGetResponseEnvelopeSuccess) IsKnown ¶
func (r OrganizationAccountGetResponseEnvelopeSuccess) IsKnown() bool
type OrganizationAccountGetResponseSettings ¶
type OrganizationAccountGetResponseSettings struct {
AbuseContactEmail string `json:"abuse_contact_email,required,nullable"`
AccessApprovalExpiry time.Time `json:"access_approval_expiry,required,nullable" format:"date-time"`
APIAccessEnabled bool `json:"api_access_enabled,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,required,nullable"`
EnforceTwofactor bool `json:"enforce_twofactor,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,required,nullable"`
JSON organizationAccountGetResponseSettingsJSON `json:"-"`
}
func (*OrganizationAccountGetResponseSettings) UnmarshalJSON ¶
func (r *OrganizationAccountGetResponseSettings) UnmarshalJSON(data []byte) (err error)
type OrganizationAccountGetResponseType ¶
type OrganizationAccountGetResponseType string
const ( OrganizationAccountGetResponseTypeStandard OrganizationAccountGetResponseType = "standard" OrganizationAccountGetResponseTypeEnterprise OrganizationAccountGetResponseType = "enterprise" )
func (OrganizationAccountGetResponseType) IsKnown ¶
func (r OrganizationAccountGetResponseType) IsKnown() bool
type OrganizationAccountService ¶
type OrganizationAccountService struct {
Options []option.RequestOption
}
OrganizationAccountService 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 NewOrganizationAccountService method instead.
func NewOrganizationAccountService ¶
func NewOrganizationAccountService(opts ...option.RequestOption) (r *OrganizationAccountService)
NewOrganizationAccountService 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 (*OrganizationAccountService) Get ¶
func (r *OrganizationAccountService) Get(ctx context.Context, organizationID string, query OrganizationAccountGetParams, opts ...option.RequestOption) (res *[]OrganizationAccountGetResponse, err error)
Retrieve a list of accounts that belong to a specific organization. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)
type OrganizationDeleteResponse ¶ added in v6.2.0
type OrganizationDeleteResponse struct {
ID string `json:"id,required"`
JSON organizationDeleteResponseJSON `json:"-"`
}
func (*OrganizationDeleteResponse) UnmarshalJSON ¶ added in v6.2.0
func (r *OrganizationDeleteResponse) UnmarshalJSON(data []byte) (err error)
type OrganizationDeleteResponseEnvelope ¶ added in v6.2.0
type OrganizationDeleteResponseEnvelope struct {
Errors []interface{} `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result OrganizationDeleteResponse `json:"result,required"`
Success OrganizationDeleteResponseEnvelopeSuccess `json:"success,required"`
JSON organizationDeleteResponseEnvelopeJSON `json:"-"`
}
func (*OrganizationDeleteResponseEnvelope) UnmarshalJSON ¶ added in v6.2.0
func (r *OrganizationDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type OrganizationDeleteResponseEnvelopeSuccess ¶ added in v6.2.0
type OrganizationDeleteResponseEnvelopeSuccess bool
const (
OrganizationDeleteResponseEnvelopeSuccessTrue OrganizationDeleteResponseEnvelopeSuccess = true
)
func (OrganizationDeleteResponseEnvelopeSuccess) IsKnown ¶ added in v6.2.0
func (r OrganizationDeleteResponseEnvelopeSuccess) IsKnown() bool
type OrganizationGetResponseEnvelope ¶
type OrganizationGetResponseEnvelope struct {
Errors []interface{} `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
// References an Organization in the Cloudflare data model.
Result Organization `json:"result,required"`
Success OrganizationGetResponseEnvelopeSuccess `json:"success,required"`
JSON organizationGetResponseEnvelopeJSON `json:"-"`
}
func (*OrganizationGetResponseEnvelope) UnmarshalJSON ¶
func (r *OrganizationGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type OrganizationGetResponseEnvelopeSuccess ¶
type OrganizationGetResponseEnvelopeSuccess bool
const (
OrganizationGetResponseEnvelopeSuccessTrue OrganizationGetResponseEnvelopeSuccess = true
)
func (OrganizationGetResponseEnvelopeSuccess) IsKnown ¶
func (r OrganizationGetResponseEnvelopeSuccess) IsKnown() bool
type OrganizationListParams ¶ added in v6.2.0
type OrganizationListParams struct {
// Only return organizations with the specified IDs (ex. id=foo&id=bar). Send
// multiple elements by repeating the query value.
ID param.Field[[]string] `query:"id"`
Containing param.Field[OrganizationListParamsContaining] `query:"containing"`
Name param.Field[OrganizationListParamsName] `query:"name"`
// The amount of items to return. Defaults to 10.
PageSize param.Field[int64] `query:"page_size"`
// An opaque token returned from the last list response that when provided will
// retrieve the next page.
//
// Parameters used to filter the retrieved list must remain in subsequent requests
// with a page token.
PageToken param.Field[string] `query:"page_token"`
Parent param.Field[OrganizationListParamsParent] `query:"parent"`
}
func (OrganizationListParams) URLQuery ¶ added in v6.2.0
func (r OrganizationListParams) URLQuery() (v url.Values)
URLQuery serializes OrganizationListParams's query parameters as `url.Values`.
type OrganizationListParamsContaining ¶ added in v6.2.0
type OrganizationListParamsContaining struct {
// Filter the list of organizations to the ones that contain this particular
// account.
Account param.Field[string] `query:"account"`
// Filter the list of organizations to the ones that contain this particular
// organization.
Organization param.Field[string] `query:"organization"`
// Filter the list of organizations to the ones that contain this particular user.
//
// IMPORTANT: Just because an organization "contains" a user is not a
// representation of any authorization or privilege to manage any resources
// therein. An organization "containing" a user simply means the user is managed by
// that organization.
User param.Field[string] `query:"user"`
}
func (OrganizationListParamsContaining) URLQuery ¶ added in v6.2.0
func (r OrganizationListParamsContaining) URLQuery() (v url.Values)
URLQuery serializes OrganizationListParamsContaining's query parameters as `url.Values`.
type OrganizationListParamsName ¶ added in v6.2.0
type OrganizationListParamsName struct {
// (case-insensitive) Filter the list of organizations to where the name contains a
// particular string.
Contains param.Field[string] `query:"contains"`
// (case-insensitive) Filter the list of organizations to where the name ends with
// a particular string.
EndsWith param.Field[string] `query:"endsWith"`
// (case-insensitive) Filter the list of organizations to where the name starts
// with a particular string.
StartsWith param.Field[string] `query:"startsWith"`
}
func (OrganizationListParamsName) URLQuery ¶ added in v6.2.0
func (r OrganizationListParamsName) URLQuery() (v url.Values)
URLQuery serializes OrganizationListParamsName's query parameters as `url.Values`.
type OrganizationListParamsParent ¶ added in v6.2.0
type OrganizationListParamsParent struct {
// Filter the list of organizations to the ones that are a sub-organization of the
// specified organization.
//
// "null" is a valid value to provide for this parameter. It means "where an
// organization has no parent (i.e. it is a 'root' organization)."
ID param.Field[OrganizationListParamsParentID] `query:"id"`
}
func (OrganizationListParamsParent) URLQuery ¶ added in v6.2.0
func (r OrganizationListParamsParent) URLQuery() (v url.Values)
URLQuery serializes OrganizationListParamsParent's query parameters as `url.Values`.
type OrganizationListParamsParentID ¶ added in v6.2.0
type OrganizationListParamsParentID string
Filter the list of organizations to the ones that are a sub-organization of the specified organization.
"null" is a valid value to provide for this parameter. It means "where an organization has no parent (i.e. it is a 'root' organization)."
const (
OrganizationListParamsParentIDNull OrganizationListParamsParentID = "null"
)
func (OrganizationListParamsParentID) IsKnown ¶ added in v6.2.0
func (r OrganizationListParamsParentID) IsKnown() bool
type OrganizationMember ¶
type OrganizationMember struct {
// Organization Member ID
ID string `json:"id,required"`
CreateTime time.Time `json:"create_time,required" format:"date-time"`
Meta map[string]interface{} `json:"meta,required"`
Status OrganizationMemberStatus `json:"status,required"`
UpdateTime time.Time `json:"update_time,required" format:"date-time"`
User OrganizationMemberUser `json:"user,required"`
JSON organizationMemberJSON `json:"-"`
}
func (*OrganizationMember) UnmarshalJSON ¶
func (r *OrganizationMember) UnmarshalJSON(data []byte) (err error)
type OrganizationMemberStatus ¶
type OrganizationMemberStatus string
const ( OrganizationMemberStatusActive OrganizationMemberStatus = "active" OrganizationMemberStatusCanceled OrganizationMemberStatus = "canceled" )
func (OrganizationMemberStatus) IsKnown ¶
func (r OrganizationMemberStatus) IsKnown() bool
type OrganizationMemberUser ¶
type OrganizationMemberUser struct {
ID string `json:"id,required"`
Email string `json:"email,required"`
Name string `json:"name,required"`
TwoFactorAuthenticationEnabled bool `json:"two_factor_authentication_enabled,required"`
JSON organizationMemberUserJSON `json:"-"`
}
func (*OrganizationMemberUser) UnmarshalJSON ¶
func (r *OrganizationMemberUser) UnmarshalJSON(data []byte) (err error)
type OrganizationMeta ¶
type OrganizationMeta struct {
// Enable features for Organizations.
Flags OrganizationMetaFlags `json:"flags"`
ManagedBy string `json:"managed_by"`
ExtraFields map[string]interface{} `json:"-,extras"`
JSON organizationMetaJSON `json:"-"`
}
func (*OrganizationMeta) UnmarshalJSON ¶
func (r *OrganizationMeta) UnmarshalJSON(data []byte) (err error)
type OrganizationMetaFlags ¶
type OrganizationMetaFlags struct {
AccountCreation string `json:"account_creation,required"`
AccountDeletion string `json:"account_deletion,required"`
AccountMigration string `json:"account_migration,required"`
AccountMobility string `json:"account_mobility,required"`
SubOrgCreation string `json:"sub_org_creation,required"`
JSON organizationMetaFlagsJSON `json:"-"`
}
Enable features for Organizations.
func (*OrganizationMetaFlags) UnmarshalJSON ¶
func (r *OrganizationMetaFlags) UnmarshalJSON(data []byte) (err error)
type OrganizationMetaFlagsParam ¶
type OrganizationMetaFlagsParam struct {
AccountCreation param.Field[string] `json:"account_creation,required"`
AccountDeletion param.Field[string] `json:"account_deletion,required"`
AccountMigration param.Field[string] `json:"account_migration,required"`
AccountMobility param.Field[string] `json:"account_mobility,required"`
SubOrgCreation param.Field[string] `json:"sub_org_creation,required"`
}
Enable features for Organizations.
func (OrganizationMetaFlagsParam) MarshalJSON ¶
func (r OrganizationMetaFlagsParam) MarshalJSON() (data []byte, err error)
type OrganizationMetaParam ¶
type OrganizationMetaParam struct {
// Enable features for Organizations.
Flags param.Field[OrganizationMetaFlagsParam] `json:"flags"`
ManagedBy param.Field[string] `json:"managed_by"`
ExtraFields map[string]interface{} `json:"-,extras"`
}
func (OrganizationMetaParam) MarshalJSON ¶
func (r OrganizationMetaParam) MarshalJSON() (data []byte, err error)
type OrganizationNewParams ¶
type OrganizationNewParams struct {
// References an Organization in the Cloudflare data model.
Organization OrganizationParam `json:"organization,required"`
}
func (OrganizationNewParams) MarshalJSON ¶
func (r OrganizationNewParams) MarshalJSON() (data []byte, err error)
type OrganizationNewResponseEnvelope ¶
type OrganizationNewResponseEnvelope struct {
Errors []interface{} `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
// References an Organization in the Cloudflare data model.
Result Organization `json:"result,required"`
Success OrganizationNewResponseEnvelopeSuccess `json:"success,required"`
JSON organizationNewResponseEnvelopeJSON `json:"-"`
}
func (*OrganizationNewResponseEnvelope) UnmarshalJSON ¶
func (r *OrganizationNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type OrganizationNewResponseEnvelopeSuccess ¶
type OrganizationNewResponseEnvelopeSuccess bool
const (
OrganizationNewResponseEnvelopeSuccessTrue OrganizationNewResponseEnvelopeSuccess = true
)
func (OrganizationNewResponseEnvelopeSuccess) IsKnown ¶
func (r OrganizationNewResponseEnvelopeSuccess) IsKnown() bool
type OrganizationParam ¶
type OrganizationParam struct {
Name param.Field[string] `json:"name,required"`
Parent param.Field[OrganizationParentParam] `json:"parent"`
Profile param.Field[accounts.AccountProfileParam] `json:"profile"`
}
References an Organization in the Cloudflare data model.
func (OrganizationParam) MarshalJSON ¶
func (r OrganizationParam) MarshalJSON() (data []byte, err error)
type OrganizationParent ¶
type OrganizationParent struct {
ID string `json:"id,required"`
Name string `json:"name,required"`
JSON organizationParentJSON `json:"-"`
}
func (*OrganizationParent) UnmarshalJSON ¶
func (r *OrganizationParent) UnmarshalJSON(data []byte) (err error)
type OrganizationParentParam ¶
func (OrganizationParentParam) MarshalJSON ¶
func (r OrganizationParentParam) MarshalJSON() (data []byte, err error)
type OrganizationProfileGetResponseEnvelope ¶
type OrganizationProfileGetResponseEnvelope struct {
Errors []interface{} `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result accounts.AccountProfile `json:"result,required"`
Success OrganizationProfileGetResponseEnvelopeSuccess `json:"success,required"`
JSON organizationProfileGetResponseEnvelopeJSON `json:"-"`
}
func (*OrganizationProfileGetResponseEnvelope) UnmarshalJSON ¶
func (r *OrganizationProfileGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type OrganizationProfileGetResponseEnvelopeSuccess ¶
type OrganizationProfileGetResponseEnvelopeSuccess bool
const (
OrganizationProfileGetResponseEnvelopeSuccessTrue OrganizationProfileGetResponseEnvelopeSuccess = true
)
func (OrganizationProfileGetResponseEnvelopeSuccess) IsKnown ¶
func (r OrganizationProfileGetResponseEnvelopeSuccess) IsKnown() bool
type OrganizationProfileService ¶
type OrganizationProfileService struct {
Options []option.RequestOption
}
OrganizationProfileService 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 NewOrganizationProfileService method instead.
func NewOrganizationProfileService ¶
func NewOrganizationProfileService(opts ...option.RequestOption) (r *OrganizationProfileService)
NewOrganizationProfileService 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 (*OrganizationProfileService) Get ¶
func (r *OrganizationProfileService) Get(ctx context.Context, organizationID string, opts ...option.RequestOption) (res *accounts.AccountProfile, err error)
Get an organizations profile if it exists. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)
func (*OrganizationProfileService) Update ¶
func (r *OrganizationProfileService) Update(ctx context.Context, organizationID string, body OrganizationProfileUpdateParams, opts ...option.RequestOption) (err error)
Modify organization profile. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)
type OrganizationProfileUpdateParams ¶
type OrganizationProfileUpdateParams struct {
AccountProfile accounts.AccountProfileParam `json:"account_profile,required"`
}
func (OrganizationProfileUpdateParams) MarshalJSON ¶
func (r OrganizationProfileUpdateParams) MarshalJSON() (data []byte, err error)
type OrganizationService ¶
type OrganizationService struct {
Options []option.RequestOption
OrganizationAccounts *OrganizationAccountService
OrganizationProfile *OrganizationProfileService
Members *MemberService
}
OrganizationService 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 NewOrganizationService method instead.
func NewOrganizationService ¶
func NewOrganizationService(opts ...option.RequestOption) (r *OrganizationService)
NewOrganizationService 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 (*OrganizationService) Delete ¶
func (r *OrganizationService) Delete(ctx context.Context, organizationID string, opts ...option.RequestOption) (res *OrganizationDeleteResponse, err error)
Delete an organization. The organization MUST be empty before deleting. It must not contain any sub-organizations, accounts, members or users. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)
func (*OrganizationService) Get ¶
func (r *OrganizationService) Get(ctx context.Context, organizationID string, opts ...option.RequestOption) (res *Organization, err error)
Retrieve the details of a certain organization. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)
func (*OrganizationService) List ¶ added in v6.2.0
func (r *OrganizationService) List(ctx context.Context, query OrganizationListParams, opts ...option.RequestOption) (res *pagination.SinglePage[Organization], err error)
Retrieve a list of organizations a particular user has access to. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)
func (*OrganizationService) ListAutoPaging ¶ added in v6.2.0
func (r *OrganizationService) ListAutoPaging(ctx context.Context, query OrganizationListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[Organization]
Retrieve a list of organizations a particular user has access to. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)
func (*OrganizationService) New ¶
func (r *OrganizationService) New(ctx context.Context, body OrganizationNewParams, opts ...option.RequestOption) (res *Organization, err error)
Create a new organization for a user. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)
func (*OrganizationService) Update ¶
func (r *OrganizationService) Update(ctx context.Context, organizationID string, body OrganizationUpdateParams, opts ...option.RequestOption) (res *Organization, err error)
Modify organization. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)
type OrganizationUpdateParams ¶
type OrganizationUpdateParams struct {
// References an Organization in the Cloudflare data model.
Organization OrganizationParam `json:"organization,required"`
}
func (OrganizationUpdateParams) MarshalJSON ¶
func (r OrganizationUpdateParams) MarshalJSON() (data []byte, err error)
type OrganizationUpdateResponseEnvelope ¶
type OrganizationUpdateResponseEnvelope struct {
Errors []interface{} `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
// References an Organization in the Cloudflare data model.
Result Organization `json:"result,required"`
Success OrganizationUpdateResponseEnvelopeSuccess `json:"success,required"`
JSON organizationUpdateResponseEnvelopeJSON `json:"-"`
}
func (*OrganizationUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *OrganizationUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type OrganizationUpdateResponseEnvelopeSuccess ¶
type OrganizationUpdateResponseEnvelopeSuccess bool
const (
OrganizationUpdateResponseEnvelopeSuccessTrue OrganizationUpdateResponseEnvelopeSuccess = true
)
func (OrganizationUpdateResponseEnvelopeSuccess) IsKnown ¶
func (r OrganizationUpdateResponseEnvelopeSuccess) IsKnown() bool
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 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 ResponseInfoSource ¶
type ResponseInfoSource = shared.ResponseInfoSource
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 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 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 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.