iam

package
v6.7.0 Latest Latest
Warning

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

Go to latest
Published: Feb 10, 2026 License: Apache-2.0 Imports: 15 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 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 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 IAMService

type IAMService struct {
	Options          []option.RequestOption
	PermissionGroups *PermissionGroupService
	ResourceGroups   *ResourceGroupService
	UserGroups       *UserGroupService
	SSO              *SSOService
}

IAMService 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 NewIAMService method instead.

func NewIAMService

func NewIAMService(opts ...option.RequestOption) (r *IAMService)

NewIAMService 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.

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 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 PermissionGroupGetParams

type PermissionGroupGetParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type PermissionGroupGetResponse

type PermissionGroupGetResponse struct {
	// Identifier of the permission group.
	ID string `json:"id,required"`
	// Attributes associated to the permission group.
	Meta PermissionGroupGetResponseMeta `json:"meta"`
	// Name of the permission group.
	Name string                         `json:"name"`
	JSON permissionGroupGetResponseJSON `json:"-"`
}

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

func (*PermissionGroupGetResponse) UnmarshalJSON

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

type PermissionGroupGetResponseEnvelope added in v6.4.0

type PermissionGroupGetResponseEnvelope struct {
	Errors   []PermissionGroupGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []PermissionGroupGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success PermissionGroupGetResponseEnvelopeSuccess `json:"success,required"`
	// A named group of permissions that map to a group of operations against
	// resources.
	Result PermissionGroupGetResponse             `json:"result"`
	JSON   permissionGroupGetResponseEnvelopeJSON `json:"-"`
}

func (*PermissionGroupGetResponseEnvelope) UnmarshalJSON added in v6.4.0

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

type PermissionGroupGetResponseEnvelopeErrors added in v6.4.0

type PermissionGroupGetResponseEnvelopeErrors struct {
	Code             int64                                          `json:"code,required"`
	Message          string                                         `json:"message,required"`
	DocumentationURL string                                         `json:"documentation_url"`
	Source           PermissionGroupGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             permissionGroupGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*PermissionGroupGetResponseEnvelopeErrors) UnmarshalJSON added in v6.4.0

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

type PermissionGroupGetResponseEnvelopeErrorsSource added in v6.4.0

type PermissionGroupGetResponseEnvelopeErrorsSource struct {
	Pointer string                                             `json:"pointer"`
	JSON    permissionGroupGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*PermissionGroupGetResponseEnvelopeErrorsSource) UnmarshalJSON added in v6.4.0

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

type PermissionGroupGetResponseEnvelopeMessages added in v6.4.0

type PermissionGroupGetResponseEnvelopeMessages struct {
	Code             int64                                            `json:"code,required"`
	Message          string                                           `json:"message,required"`
	DocumentationURL string                                           `json:"documentation_url"`
	Source           PermissionGroupGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             permissionGroupGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*PermissionGroupGetResponseEnvelopeMessages) UnmarshalJSON added in v6.4.0

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

type PermissionGroupGetResponseEnvelopeMessagesSource added in v6.4.0

type PermissionGroupGetResponseEnvelopeMessagesSource struct {
	Pointer string                                               `json:"pointer"`
	JSON    permissionGroupGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*PermissionGroupGetResponseEnvelopeMessagesSource) UnmarshalJSON added in v6.4.0

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

type PermissionGroupGetResponseEnvelopeSuccess added in v6.4.0

type PermissionGroupGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	PermissionGroupGetResponseEnvelopeSuccessTrue PermissionGroupGetResponseEnvelopeSuccess = true
)

func (PermissionGroupGetResponseEnvelopeSuccess) IsKnown added in v6.4.0

type PermissionGroupGetResponseMeta

type PermissionGroupGetResponseMeta struct {
	Key   string                             `json:"key"`
	Value string                             `json:"value"`
	JSON  permissionGroupGetResponseMetaJSON `json:"-"`
}

Attributes associated to the permission group.

func (*PermissionGroupGetResponseMeta) UnmarshalJSON

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

type PermissionGroupListParams

type PermissionGroupListParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// ID of the permission group to be fetched.
	ID param.Field[string] `query:"id"`
	// Label of the permission group to be fetched.
	Label param.Field[string] `query:"label"`
	// Name of the permission group to be fetched.
	Name param.Field[string] `query:"name"`
	// Page number of paginated results.
	Page param.Field[float64] `query:"page"`
	// Maximum number of results per page.
	PerPage param.Field[float64] `query:"per_page"`
}

func (PermissionGroupListParams) URLQuery

func (r PermissionGroupListParams) URLQuery() (v url.Values)

URLQuery serializes PermissionGroupListParams's query parameters as `url.Values`.

type PermissionGroupListResponse

type PermissionGroupListResponse struct {
	// Identifier of the permission group.
	ID string `json:"id,required"`
	// Attributes associated to the permission group.
	Meta PermissionGroupListResponseMeta `json:"meta"`
	// Name of the permission group.
	Name string                          `json:"name"`
	JSON permissionGroupListResponseJSON `json:"-"`
}

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

func (*PermissionGroupListResponse) UnmarshalJSON

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

type PermissionGroupListResponseMeta

type PermissionGroupListResponseMeta struct {
	Key   string                              `json:"key"`
	Value string                              `json:"value"`
	JSON  permissionGroupListResponseMetaJSON `json:"-"`
}

Attributes associated to the permission group.

func (*PermissionGroupListResponseMeta) UnmarshalJSON

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

type PermissionGroupService

type PermissionGroupService struct {
	Options []option.RequestOption
}

PermissionGroupService 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 NewPermissionGroupService method instead.

func NewPermissionGroupService

func NewPermissionGroupService(opts ...option.RequestOption) (r *PermissionGroupService)

NewPermissionGroupService 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 (*PermissionGroupService) Get

Get information about a specific permission group in an account.

func (*PermissionGroupService) List

List all the permissions groups for an account.

func (*PermissionGroupService) ListAutoPaging

List all the permissions groups for an account.

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 ResourceGroupDeleteParams

type ResourceGroupDeleteParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type ResourceGroupDeleteResponse

type ResourceGroupDeleteResponse struct {
	// Identifier
	ID   string                          `json:"id,required"`
	JSON resourceGroupDeleteResponseJSON `json:"-"`
}

func (*ResourceGroupDeleteResponse) UnmarshalJSON

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

type ResourceGroupDeleteResponseEnvelope

type ResourceGroupDeleteResponseEnvelope struct {
	Errors   []ResourceGroupDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ResourceGroupDeleteResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success ResourceGroupDeleteResponseEnvelopeSuccess `json:"success,required"`
	Result  ResourceGroupDeleteResponse                `json:"result,nullable"`
	JSON    resourceGroupDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*ResourceGroupDeleteResponseEnvelope) UnmarshalJSON

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

type ResourceGroupDeleteResponseEnvelopeErrors

type ResourceGroupDeleteResponseEnvelopeErrors struct {
	Code             int64                                           `json:"code,required"`
	Message          string                                          `json:"message,required"`
	DocumentationURL string                                          `json:"documentation_url"`
	Source           ResourceGroupDeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON             resourceGroupDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ResourceGroupDeleteResponseEnvelopeErrors) UnmarshalJSON

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

type ResourceGroupDeleteResponseEnvelopeErrorsSource

type ResourceGroupDeleteResponseEnvelopeErrorsSource struct {
	Pointer string                                              `json:"pointer"`
	JSON    resourceGroupDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ResourceGroupDeleteResponseEnvelopeErrorsSource) UnmarshalJSON

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

type ResourceGroupDeleteResponseEnvelopeMessages

type ResourceGroupDeleteResponseEnvelopeMessages struct {
	Code             int64                                             `json:"code,required"`
	Message          string                                            `json:"message,required"`
	DocumentationURL string                                            `json:"documentation_url"`
	Source           ResourceGroupDeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON             resourceGroupDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ResourceGroupDeleteResponseEnvelopeMessages) UnmarshalJSON

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

type ResourceGroupDeleteResponseEnvelopeMessagesSource

type ResourceGroupDeleteResponseEnvelopeMessagesSource struct {
	Pointer string                                                `json:"pointer"`
	JSON    resourceGroupDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ResourceGroupDeleteResponseEnvelopeMessagesSource) UnmarshalJSON

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

type ResourceGroupDeleteResponseEnvelopeSuccess

type ResourceGroupDeleteResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ResourceGroupDeleteResponseEnvelopeSuccessTrue ResourceGroupDeleteResponseEnvelopeSuccess = true
)

func (ResourceGroupDeleteResponseEnvelopeSuccess) IsKnown

type ResourceGroupGetParams

type ResourceGroupGetParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type ResourceGroupGetResponse

type ResourceGroupGetResponse struct {
	// Identifier of the resource group.
	ID string `json:"id,required"`
	// The scope associated to the resource group
	Scope []ResourceGroupGetResponseScope `json:"scope,required"`
	// Attributes associated to the resource group.
	Meta ResourceGroupGetResponseMeta `json:"meta"`
	// Name of the resource group.
	Name string                       `json:"name"`
	JSON resourceGroupGetResponseJSON `json:"-"`
}

A group of scoped resources.

func (*ResourceGroupGetResponse) UnmarshalJSON

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

type ResourceGroupGetResponseEnvelope added in v6.4.0

type ResourceGroupGetResponseEnvelope struct {
	Errors   []ResourceGroupGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ResourceGroupGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success ResourceGroupGetResponseEnvelopeSuccess `json:"success,required"`
	// A group of scoped resources.
	Result ResourceGroupGetResponse             `json:"result"`
	JSON   resourceGroupGetResponseEnvelopeJSON `json:"-"`
}

func (*ResourceGroupGetResponseEnvelope) UnmarshalJSON added in v6.4.0

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

type ResourceGroupGetResponseEnvelopeErrors added in v6.4.0

type ResourceGroupGetResponseEnvelopeErrors struct {
	Code             int64                                        `json:"code,required"`
	Message          string                                       `json:"message,required"`
	DocumentationURL string                                       `json:"documentation_url"`
	Source           ResourceGroupGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             resourceGroupGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ResourceGroupGetResponseEnvelopeErrors) UnmarshalJSON added in v6.4.0

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

type ResourceGroupGetResponseEnvelopeErrorsSource added in v6.4.0

type ResourceGroupGetResponseEnvelopeErrorsSource struct {
	Pointer string                                           `json:"pointer"`
	JSON    resourceGroupGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ResourceGroupGetResponseEnvelopeErrorsSource) UnmarshalJSON added in v6.4.0

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

type ResourceGroupGetResponseEnvelopeMessages added in v6.4.0

type ResourceGroupGetResponseEnvelopeMessages struct {
	Code             int64                                          `json:"code,required"`
	Message          string                                         `json:"message,required"`
	DocumentationURL string                                         `json:"documentation_url"`
	Source           ResourceGroupGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             resourceGroupGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ResourceGroupGetResponseEnvelopeMessages) UnmarshalJSON added in v6.4.0

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

type ResourceGroupGetResponseEnvelopeMessagesSource added in v6.4.0

type ResourceGroupGetResponseEnvelopeMessagesSource struct {
	Pointer string                                             `json:"pointer"`
	JSON    resourceGroupGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ResourceGroupGetResponseEnvelopeMessagesSource) UnmarshalJSON added in v6.4.0

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

type ResourceGroupGetResponseEnvelopeSuccess added in v6.4.0

type ResourceGroupGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ResourceGroupGetResponseEnvelopeSuccessTrue ResourceGroupGetResponseEnvelopeSuccess = true
)

func (ResourceGroupGetResponseEnvelopeSuccess) IsKnown added in v6.4.0

type ResourceGroupGetResponseMeta

type ResourceGroupGetResponseMeta struct {
	Key   string                           `json:"key"`
	Value string                           `json:"value"`
	JSON  resourceGroupGetResponseMetaJSON `json:"-"`
}

Attributes associated to the resource group.

func (*ResourceGroupGetResponseMeta) UnmarshalJSON

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

type ResourceGroupGetResponseScope

type ResourceGroupGetResponseScope struct {
	// This is a combination of pre-defined resource name and identifier (like Account
	// ID etc.)
	Key string `json:"key,required"`
	// A list of scope objects for additional context.
	Objects []ResourceGroupGetResponseScopeObject `json:"objects,required"`
	JSON    resourceGroupGetResponseScopeJSON     `json:"-"`
}

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

func (*ResourceGroupGetResponseScope) UnmarshalJSON

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

type ResourceGroupGetResponseScopeObject

type ResourceGroupGetResponseScopeObject struct {
	// This is a combination of pre-defined resource name and identifier (like Zone ID
	// etc.)
	Key  string                                  `json:"key,required"`
	JSON resourceGroupGetResponseScopeObjectJSON `json:"-"`
}

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

func (*ResourceGroupGetResponseScopeObject) UnmarshalJSON

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

type ResourceGroupListParams

type ResourceGroupListParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// ID of the resource group to be fetched.
	ID param.Field[string] `query:"id"`
	// Name of the resource group to be fetched.
	Name param.Field[string] `query:"name"`
}

func (ResourceGroupListParams) URLQuery

func (r ResourceGroupListParams) URLQuery() (v url.Values)

URLQuery serializes ResourceGroupListParams's query parameters as `url.Values`.

type ResourceGroupListResponse

type ResourceGroupListResponse struct {
	// Identifier of the resource group.
	ID string `json:"id,required"`
	// The scope associated to the resource group
	Scope []ResourceGroupListResponseScope `json:"scope,required"`
	// Attributes associated to the resource group.
	Meta ResourceGroupListResponseMeta `json:"meta"`
	// Name of the resource group.
	Name string                        `json:"name"`
	JSON resourceGroupListResponseJSON `json:"-"`
}

A group of scoped resources.

func (*ResourceGroupListResponse) UnmarshalJSON

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

type ResourceGroupListResponseMeta

type ResourceGroupListResponseMeta struct {
	Key   string                            `json:"key"`
	Value string                            `json:"value"`
	JSON  resourceGroupListResponseMetaJSON `json:"-"`
}

Attributes associated to the resource group.

func (*ResourceGroupListResponseMeta) UnmarshalJSON

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

type ResourceGroupListResponseScope

type ResourceGroupListResponseScope struct {
	// This is a combination of pre-defined resource name and identifier (like Account
	// ID etc.)
	Key string `json:"key,required"`
	// A list of scope objects for additional context.
	Objects []ResourceGroupListResponseScopeObject `json:"objects,required"`
	JSON    resourceGroupListResponseScopeJSON     `json:"-"`
}

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

func (*ResourceGroupListResponseScope) UnmarshalJSON

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

type ResourceGroupListResponseScopeObject

type ResourceGroupListResponseScopeObject struct {
	// This is a combination of pre-defined resource name and identifier (like Zone ID
	// etc.)
	Key  string                                   `json:"key,required"`
	JSON resourceGroupListResponseScopeObjectJSON `json:"-"`
}

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

func (*ResourceGroupListResponseScopeObject) UnmarshalJSON

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

type ResourceGroupNewParams

type ResourceGroupNewParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// Name of the resource group
	Name param.Field[string] `json:"name,required"`
	// A scope is a combination of scope objects which provides additional context.
	Scope param.Field[ResourceGroupNewParamsScope] `json:"scope,required"`
}

func (ResourceGroupNewParams) MarshalJSON

func (r ResourceGroupNewParams) MarshalJSON() (data []byte, err error)

type ResourceGroupNewParamsScope

type ResourceGroupNewParamsScope struct {
	// This is a combination of pre-defined resource name and identifier (like Account
	// ID etc.)
	Key param.Field[string] `json:"key,required"`
	// A list of scope objects for additional context. The number of Scope objects
	// should not be zero.
	Objects param.Field[[]ResourceGroupNewParamsScopeObject] `json:"objects,required"`
}

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

func (ResourceGroupNewParamsScope) MarshalJSON

func (r ResourceGroupNewParamsScope) MarshalJSON() (data []byte, err error)

type ResourceGroupNewParamsScopeObject

type ResourceGroupNewParamsScopeObject struct {
	// This is a combination of pre-defined resource name and identifier (like Zone ID
	// etc.)
	Key param.Field[string] `json:"key,required"`
}

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

func (ResourceGroupNewParamsScopeObject) MarshalJSON

func (r ResourceGroupNewParamsScopeObject) MarshalJSON() (data []byte, err error)

type ResourceGroupNewResponse

type ResourceGroupNewResponse struct {
	// Identifier of the resource group.
	ID string `json:"id,required"`
	// The scope associated to the resource group
	Scope []ResourceGroupNewResponseScope `json:"scope,required"`
	// Attributes associated to the resource group.
	Meta ResourceGroupNewResponseMeta `json:"meta"`
	// Name of the resource group.
	Name string                       `json:"name"`
	JSON resourceGroupNewResponseJSON `json:"-"`
}

A group of scoped resources.

func (*ResourceGroupNewResponse) UnmarshalJSON

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

type ResourceGroupNewResponseEnvelope added in v6.4.0

type ResourceGroupNewResponseEnvelope struct {
	Errors   []ResourceGroupNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ResourceGroupNewResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success ResourceGroupNewResponseEnvelopeSuccess `json:"success,required"`
	// A group of scoped resources.
	Result ResourceGroupNewResponse             `json:"result"`
	JSON   resourceGroupNewResponseEnvelopeJSON `json:"-"`
}

func (*ResourceGroupNewResponseEnvelope) UnmarshalJSON added in v6.4.0

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

type ResourceGroupNewResponseEnvelopeErrors added in v6.4.0

type ResourceGroupNewResponseEnvelopeErrors struct {
	Code             int64                                        `json:"code,required"`
	Message          string                                       `json:"message,required"`
	DocumentationURL string                                       `json:"documentation_url"`
	Source           ResourceGroupNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             resourceGroupNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ResourceGroupNewResponseEnvelopeErrors) UnmarshalJSON added in v6.4.0

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

type ResourceGroupNewResponseEnvelopeErrorsSource added in v6.4.0

type ResourceGroupNewResponseEnvelopeErrorsSource struct {
	Pointer string                                           `json:"pointer"`
	JSON    resourceGroupNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ResourceGroupNewResponseEnvelopeErrorsSource) UnmarshalJSON added in v6.4.0

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

type ResourceGroupNewResponseEnvelopeMessages added in v6.4.0

type ResourceGroupNewResponseEnvelopeMessages struct {
	Code             int64                                          `json:"code,required"`
	Message          string                                         `json:"message,required"`
	DocumentationURL string                                         `json:"documentation_url"`
	Source           ResourceGroupNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             resourceGroupNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ResourceGroupNewResponseEnvelopeMessages) UnmarshalJSON added in v6.4.0

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

type ResourceGroupNewResponseEnvelopeMessagesSource added in v6.4.0

type ResourceGroupNewResponseEnvelopeMessagesSource struct {
	Pointer string                                             `json:"pointer"`
	JSON    resourceGroupNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ResourceGroupNewResponseEnvelopeMessagesSource) UnmarshalJSON added in v6.4.0

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

type ResourceGroupNewResponseEnvelopeSuccess added in v6.4.0

type ResourceGroupNewResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ResourceGroupNewResponseEnvelopeSuccessTrue ResourceGroupNewResponseEnvelopeSuccess = true
)

func (ResourceGroupNewResponseEnvelopeSuccess) IsKnown added in v6.4.0

type ResourceGroupNewResponseMeta added in v6.4.0

type ResourceGroupNewResponseMeta struct {
	Key   string                           `json:"key"`
	Value string                           `json:"value"`
	JSON  resourceGroupNewResponseMetaJSON `json:"-"`
}

Attributes associated to the resource group.

func (*ResourceGroupNewResponseMeta) UnmarshalJSON added in v6.4.0

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

type ResourceGroupNewResponseScope

type ResourceGroupNewResponseScope struct {
	// This is a combination of pre-defined resource name and identifier (like Account
	// ID etc.)
	Key string `json:"key,required"`
	// A list of scope objects for additional context.
	Objects []ResourceGroupNewResponseScopeObject `json:"objects,required"`
	JSON    resourceGroupNewResponseScopeJSON     `json:"-"`
}

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

func (*ResourceGroupNewResponseScope) UnmarshalJSON

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

type ResourceGroupNewResponseScopeObject

type ResourceGroupNewResponseScopeObject struct {
	// This is a combination of pre-defined resource name and identifier (like Zone ID
	// etc.)
	Key  string                                  `json:"key,required"`
	JSON resourceGroupNewResponseScopeObjectJSON `json:"-"`
}

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

func (*ResourceGroupNewResponseScopeObject) UnmarshalJSON

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

type ResourceGroupService

type ResourceGroupService struct {
	Options []option.RequestOption
}

ResourceGroupService 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 NewResourceGroupService method instead.

func NewResourceGroupService

func NewResourceGroupService(opts ...option.RequestOption) (r *ResourceGroupService)

NewResourceGroupService 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 (*ResourceGroupService) Delete

Remove a resource group from an account.

func (*ResourceGroupService) Get

func (r *ResourceGroupService) Get(ctx context.Context, resourceGroupID string, query ResourceGroupGetParams, opts ...option.RequestOption) (res *ResourceGroupGetResponse, err error)

Get information about a specific resource group in an account.

func (*ResourceGroupService) List

List all the resource groups for an account.

func (*ResourceGroupService) ListAutoPaging

List all the resource groups for an account.

func (*ResourceGroupService) New

Create a new Resource Group under the specified account.

func (*ResourceGroupService) Update

func (r *ResourceGroupService) Update(ctx context.Context, resourceGroupID string, params ResourceGroupUpdateParams, opts ...option.RequestOption) (res *ResourceGroupUpdateResponse, err error)

Modify an existing resource group.

type ResourceGroupUpdateParams

type ResourceGroupUpdateParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// Name of the resource group
	Name param.Field[string] `json:"name"`
	// A scope is a combination of scope objects which provides additional context.
	Scope param.Field[ResourceGroupUpdateParamsScope] `json:"scope"`
}

func (ResourceGroupUpdateParams) MarshalJSON

func (r ResourceGroupUpdateParams) MarshalJSON() (data []byte, err error)

type ResourceGroupUpdateParamsScope

type ResourceGroupUpdateParamsScope struct {
	// This is a combination of pre-defined resource name and identifier (like Account
	// ID etc.)
	Key param.Field[string] `json:"key,required"`
	// A list of scope objects for additional context. The number of Scope objects
	// should not be zero.
	Objects param.Field[[]ResourceGroupUpdateParamsScopeObject] `json:"objects,required"`
}

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

func (ResourceGroupUpdateParamsScope) MarshalJSON

func (r ResourceGroupUpdateParamsScope) MarshalJSON() (data []byte, err error)

type ResourceGroupUpdateParamsScopeObject

type ResourceGroupUpdateParamsScopeObject struct {
	// This is a combination of pre-defined resource name and identifier (like Zone ID
	// etc.)
	Key param.Field[string] `json:"key,required"`
}

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

func (ResourceGroupUpdateParamsScopeObject) MarshalJSON

func (r ResourceGroupUpdateParamsScopeObject) MarshalJSON() (data []byte, err error)

type ResourceGroupUpdateResponse

type ResourceGroupUpdateResponse struct {
	// Identifier of the resource group.
	ID string `json:"id,required"`
	// The scope associated to the resource group
	Scope []ResourceGroupUpdateResponseScope `json:"scope,required"`
	// Attributes associated to the resource group.
	Meta ResourceGroupUpdateResponseMeta `json:"meta"`
	// Name of the resource group.
	Name string                          `json:"name"`
	JSON resourceGroupUpdateResponseJSON `json:"-"`
}

A group of scoped resources.

func (*ResourceGroupUpdateResponse) UnmarshalJSON

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

type ResourceGroupUpdateResponseEnvelope added in v6.4.0

type ResourceGroupUpdateResponseEnvelope struct {
	Errors   []ResourceGroupUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ResourceGroupUpdateResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success ResourceGroupUpdateResponseEnvelopeSuccess `json:"success,required"`
	// A group of scoped resources.
	Result ResourceGroupUpdateResponse             `json:"result"`
	JSON   resourceGroupUpdateResponseEnvelopeJSON `json:"-"`
}

func (*ResourceGroupUpdateResponseEnvelope) UnmarshalJSON added in v6.4.0

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

type ResourceGroupUpdateResponseEnvelopeErrors added in v6.4.0

type ResourceGroupUpdateResponseEnvelopeErrors struct {
	Code             int64                                           `json:"code,required"`
	Message          string                                          `json:"message,required"`
	DocumentationURL string                                          `json:"documentation_url"`
	Source           ResourceGroupUpdateResponseEnvelopeErrorsSource `json:"source"`
	JSON             resourceGroupUpdateResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ResourceGroupUpdateResponseEnvelopeErrors) UnmarshalJSON added in v6.4.0

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

type ResourceGroupUpdateResponseEnvelopeErrorsSource added in v6.4.0

type ResourceGroupUpdateResponseEnvelopeErrorsSource struct {
	Pointer string                                              `json:"pointer"`
	JSON    resourceGroupUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ResourceGroupUpdateResponseEnvelopeErrorsSource) UnmarshalJSON added in v6.4.0

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

type ResourceGroupUpdateResponseEnvelopeMessages added in v6.4.0

type ResourceGroupUpdateResponseEnvelopeMessages struct {
	Code             int64                                             `json:"code,required"`
	Message          string                                            `json:"message,required"`
	DocumentationURL string                                            `json:"documentation_url"`
	Source           ResourceGroupUpdateResponseEnvelopeMessagesSource `json:"source"`
	JSON             resourceGroupUpdateResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ResourceGroupUpdateResponseEnvelopeMessages) UnmarshalJSON added in v6.4.0

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

type ResourceGroupUpdateResponseEnvelopeMessagesSource added in v6.4.0

type ResourceGroupUpdateResponseEnvelopeMessagesSource struct {
	Pointer string                                                `json:"pointer"`
	JSON    resourceGroupUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ResourceGroupUpdateResponseEnvelopeMessagesSource) UnmarshalJSON added in v6.4.0

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

type ResourceGroupUpdateResponseEnvelopeSuccess added in v6.4.0

type ResourceGroupUpdateResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ResourceGroupUpdateResponseEnvelopeSuccessTrue ResourceGroupUpdateResponseEnvelopeSuccess = true
)

func (ResourceGroupUpdateResponseEnvelopeSuccess) IsKnown added in v6.4.0

type ResourceGroupUpdateResponseMeta

type ResourceGroupUpdateResponseMeta struct {
	Key   string                              `json:"key"`
	Value string                              `json:"value"`
	JSON  resourceGroupUpdateResponseMetaJSON `json:"-"`
}

Attributes associated to the resource group.

func (*ResourceGroupUpdateResponseMeta) UnmarshalJSON

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

type ResourceGroupUpdateResponseScope

type ResourceGroupUpdateResponseScope struct {
	// This is a combination of pre-defined resource name and identifier (like Account
	// ID etc.)
	Key string `json:"key,required"`
	// A list of scope objects for additional context.
	Objects []ResourceGroupUpdateResponseScopeObject `json:"objects,required"`
	JSON    resourceGroupUpdateResponseScopeJSON     `json:"-"`
}

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

func (*ResourceGroupUpdateResponseScope) UnmarshalJSON

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

type ResourceGroupUpdateResponseScopeObject

type ResourceGroupUpdateResponseScopeObject struct {
	// This is a combination of pre-defined resource name and identifier (like Zone ID
	// etc.)
	Key  string                                     `json:"key,required"`
	JSON resourceGroupUpdateResponseScopeObjectJSON `json:"-"`
}

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

func (*ResourceGroupUpdateResponseScopeObject) UnmarshalJSON

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

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 SSOBeginVerificationParams added in v6.3.0

type SSOBeginVerificationParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type SSOBeginVerificationResponse added in v6.3.0

type SSOBeginVerificationResponse struct {
	Errors   []SSOBeginVerificationResponseError   `json:"errors,required"`
	Messages []SSOBeginVerificationResponseMessage `json:"messages,required"`
	// Whether the API call was successful.
	Success SSOBeginVerificationResponseSuccess `json:"success,required"`
	JSON    ssoBeginVerificationResponseJSON    `json:"-"`
}

func (*SSOBeginVerificationResponse) UnmarshalJSON added in v6.3.0

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

type SSOBeginVerificationResponseError added in v6.3.0

type SSOBeginVerificationResponseError struct {
	Code             int64                                    `json:"code,required"`
	Message          string                                   `json:"message,required"`
	DocumentationURL string                                   `json:"documentation_url"`
	Source           SSOBeginVerificationResponseErrorsSource `json:"source"`
	JSON             ssoBeginVerificationResponseErrorJSON    `json:"-"`
}

func (*SSOBeginVerificationResponseError) UnmarshalJSON added in v6.3.0

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

type SSOBeginVerificationResponseErrorsSource added in v6.3.0

type SSOBeginVerificationResponseErrorsSource struct {
	Pointer string                                       `json:"pointer"`
	JSON    ssoBeginVerificationResponseErrorsSourceJSON `json:"-"`
}

func (*SSOBeginVerificationResponseErrorsSource) UnmarshalJSON added in v6.3.0

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

type SSOBeginVerificationResponseMessage added in v6.3.0

type SSOBeginVerificationResponseMessage struct {
	Code             int64                                      `json:"code,required"`
	Message          string                                     `json:"message,required"`
	DocumentationURL string                                     `json:"documentation_url"`
	Source           SSOBeginVerificationResponseMessagesSource `json:"source"`
	JSON             ssoBeginVerificationResponseMessageJSON    `json:"-"`
}

func (*SSOBeginVerificationResponseMessage) UnmarshalJSON added in v6.3.0

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

type SSOBeginVerificationResponseMessagesSource added in v6.3.0

type SSOBeginVerificationResponseMessagesSource struct {
	Pointer string                                         `json:"pointer"`
	JSON    ssoBeginVerificationResponseMessagesSourceJSON `json:"-"`
}

func (*SSOBeginVerificationResponseMessagesSource) UnmarshalJSON added in v6.3.0

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

type SSOBeginVerificationResponseSuccess added in v6.3.0

type SSOBeginVerificationResponseSuccess bool

Whether the API call was successful.

const (
	SSOBeginVerificationResponseSuccessTrue SSOBeginVerificationResponseSuccess = true
)

func (SSOBeginVerificationResponseSuccess) IsKnown added in v6.3.0

type SSODeleteParams added in v6.3.0

type SSODeleteParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type SSODeleteResponse added in v6.3.0

type SSODeleteResponse struct {
	// Identifier
	ID   string                `json:"id,required"`
	JSON ssoDeleteResponseJSON `json:"-"`
}

func (*SSODeleteResponse) UnmarshalJSON added in v6.3.0

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

type SSODeleteResponseEnvelope added in v6.3.0

type SSODeleteResponseEnvelope struct {
	Errors   []SSODeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SSODeleteResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success SSODeleteResponseEnvelopeSuccess `json:"success,required"`
	Result  SSODeleteResponse                `json:"result,nullable"`
	JSON    ssoDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*SSODeleteResponseEnvelope) UnmarshalJSON added in v6.3.0

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

type SSODeleteResponseEnvelopeErrors added in v6.3.0

type SSODeleteResponseEnvelopeErrors struct {
	Code             int64                                 `json:"code,required"`
	Message          string                                `json:"message,required"`
	DocumentationURL string                                `json:"documentation_url"`
	Source           SSODeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON             ssoDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SSODeleteResponseEnvelopeErrors) UnmarshalJSON added in v6.3.0

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

type SSODeleteResponseEnvelopeErrorsSource added in v6.3.0

type SSODeleteResponseEnvelopeErrorsSource struct {
	Pointer string                                    `json:"pointer"`
	JSON    ssoDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SSODeleteResponseEnvelopeErrorsSource) UnmarshalJSON added in v6.3.0

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

type SSODeleteResponseEnvelopeMessages added in v6.3.0

type SSODeleteResponseEnvelopeMessages struct {
	Code             int64                                   `json:"code,required"`
	Message          string                                  `json:"message,required"`
	DocumentationURL string                                  `json:"documentation_url"`
	Source           SSODeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON             ssoDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SSODeleteResponseEnvelopeMessages) UnmarshalJSON added in v6.3.0

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

type SSODeleteResponseEnvelopeMessagesSource added in v6.3.0

type SSODeleteResponseEnvelopeMessagesSource struct {
	Pointer string                                      `json:"pointer"`
	JSON    ssoDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SSODeleteResponseEnvelopeMessagesSource) UnmarshalJSON added in v6.3.0

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

type SSODeleteResponseEnvelopeSuccess added in v6.3.0

type SSODeleteResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	SSODeleteResponseEnvelopeSuccessTrue SSODeleteResponseEnvelopeSuccess = true
)

func (SSODeleteResponseEnvelopeSuccess) IsKnown added in v6.3.0

type SSOGetParams added in v6.3.0

type SSOGetParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type SSOGetResponse added in v6.3.0

type SSOGetResponse struct {
	// SSO Connector identifier tag.
	ID string `json:"id"`
	// Timestamp for the creation of the SSO connector
	CreatedOn   time.Time `json:"created_on" format:"date-time"`
	EmailDomain string    `json:"email_domain"`
	Enabled     bool      `json:"enabled"`
	// Timestamp for the last update of the SSO connector
	UpdatedOn time.Time `json:"updated_on" format:"date-time"`
	// Controls the display of FedRAMP language to the user during SSO login
	UseFedrampLanguage bool                       `json:"use_fedramp_language"`
	Verification       SSOGetResponseVerification `json:"verification"`
	JSON               ssoGetResponseJSON         `json:"-"`
}

func (*SSOGetResponse) UnmarshalJSON added in v6.3.0

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

type SSOGetResponseEnvelope added in v6.3.0

type SSOGetResponseEnvelope struct {
	Errors   []SSOGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SSOGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success SSOGetResponseEnvelopeSuccess `json:"success,required"`
	Result  SSOGetResponse                `json:"result"`
	JSON    ssoGetResponseEnvelopeJSON    `json:"-"`
}

func (*SSOGetResponseEnvelope) UnmarshalJSON added in v6.3.0

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

type SSOGetResponseEnvelopeErrors added in v6.3.0

type SSOGetResponseEnvelopeErrors struct {
	Code             int64                              `json:"code,required"`
	Message          string                             `json:"message,required"`
	DocumentationURL string                             `json:"documentation_url"`
	Source           SSOGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             ssoGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SSOGetResponseEnvelopeErrors) UnmarshalJSON added in v6.3.0

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

type SSOGetResponseEnvelopeErrorsSource added in v6.3.0

type SSOGetResponseEnvelopeErrorsSource struct {
	Pointer string                                 `json:"pointer"`
	JSON    ssoGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SSOGetResponseEnvelopeErrorsSource) UnmarshalJSON added in v6.3.0

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

type SSOGetResponseEnvelopeMessages added in v6.3.0

type SSOGetResponseEnvelopeMessages struct {
	Code             int64                                `json:"code,required"`
	Message          string                               `json:"message,required"`
	DocumentationURL string                               `json:"documentation_url"`
	Source           SSOGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             ssoGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SSOGetResponseEnvelopeMessages) UnmarshalJSON added in v6.3.0

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

type SSOGetResponseEnvelopeMessagesSource added in v6.3.0

type SSOGetResponseEnvelopeMessagesSource struct {
	Pointer string                                   `json:"pointer"`
	JSON    ssoGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SSOGetResponseEnvelopeMessagesSource) UnmarshalJSON added in v6.3.0

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

type SSOGetResponseEnvelopeSuccess added in v6.3.0

type SSOGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	SSOGetResponseEnvelopeSuccessTrue SSOGetResponseEnvelopeSuccess = true
)

func (SSOGetResponseEnvelopeSuccess) IsKnown added in v6.3.0

func (r SSOGetResponseEnvelopeSuccess) IsKnown() bool

type SSOGetResponseVerification added in v6.3.0

type SSOGetResponseVerification struct {
	// DNS verification code. Add this entire string to the DNS TXT record of the email
	// domain to validate ownership.
	Code string `json:"code"`
	// The status of the verification code from the verification process.
	Status SSOGetResponseVerificationStatus `json:"status"`
	JSON   ssoGetResponseVerificationJSON   `json:"-"`
}

func (*SSOGetResponseVerification) UnmarshalJSON added in v6.3.0

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

type SSOGetResponseVerificationStatus added in v6.3.0

type SSOGetResponseVerificationStatus string

The status of the verification code from the verification process.

const (
	SSOGetResponseVerificationStatusAwaiting SSOGetResponseVerificationStatus = "awaiting"
	SSOGetResponseVerificationStatusPending  SSOGetResponseVerificationStatus = "pending"
	SSOGetResponseVerificationStatusFailed   SSOGetResponseVerificationStatus = "failed"
	SSOGetResponseVerificationStatusVerified SSOGetResponseVerificationStatus = "verified"
)

func (SSOGetResponseVerificationStatus) IsKnown added in v6.3.0

type SSOListParams added in v6.3.0

type SSOListParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type SSOListResponse added in v6.3.0

type SSOListResponse struct {
	// SSO Connector identifier tag.
	ID string `json:"id"`
	// Timestamp for the creation of the SSO connector
	CreatedOn   time.Time `json:"created_on" format:"date-time"`
	EmailDomain string    `json:"email_domain"`
	Enabled     bool      `json:"enabled"`
	// Timestamp for the last update of the SSO connector
	UpdatedOn time.Time `json:"updated_on" format:"date-time"`
	// Controls the display of FedRAMP language to the user during SSO login
	UseFedrampLanguage bool                        `json:"use_fedramp_language"`
	Verification       SSOListResponseVerification `json:"verification"`
	JSON               ssoListResponseJSON         `json:"-"`
}

func (*SSOListResponse) UnmarshalJSON added in v6.3.0

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

type SSOListResponseVerification added in v6.3.0

type SSOListResponseVerification struct {
	// DNS verification code. Add this entire string to the DNS TXT record of the email
	// domain to validate ownership.
	Code string `json:"code"`
	// The status of the verification code from the verification process.
	Status SSOListResponseVerificationStatus `json:"status"`
	JSON   ssoListResponseVerificationJSON   `json:"-"`
}

func (*SSOListResponseVerification) UnmarshalJSON added in v6.3.0

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

type SSOListResponseVerificationStatus added in v6.3.0

type SSOListResponseVerificationStatus string

The status of the verification code from the verification process.

const (
	SSOListResponseVerificationStatusAwaiting SSOListResponseVerificationStatus = "awaiting"
	SSOListResponseVerificationStatusPending  SSOListResponseVerificationStatus = "pending"
	SSOListResponseVerificationStatusFailed   SSOListResponseVerificationStatus = "failed"
	SSOListResponseVerificationStatusVerified SSOListResponseVerificationStatus = "verified"
)

func (SSOListResponseVerificationStatus) IsKnown added in v6.3.0

type SSONewParams added in v6.3.0

type SSONewParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// Email domain of the new SSO connector
	EmailDomain param.Field[string] `json:"email_domain,required"`
	// Begin the verification process after creation
	BeginVerification param.Field[bool] `json:"begin_verification"`
	// Controls the display of FedRAMP language to the user during SSO login
	UseFedrampLanguage param.Field[bool] `json:"use_fedramp_language"`
}

func (SSONewParams) MarshalJSON added in v6.3.0

func (r SSONewParams) MarshalJSON() (data []byte, err error)

type SSONewResponse added in v6.3.0

type SSONewResponse struct {
	// SSO Connector identifier tag.
	ID string `json:"id"`
	// Timestamp for the creation of the SSO connector
	CreatedOn   time.Time `json:"created_on" format:"date-time"`
	EmailDomain string    `json:"email_domain"`
	Enabled     bool      `json:"enabled"`
	// Timestamp for the last update of the SSO connector
	UpdatedOn time.Time `json:"updated_on" format:"date-time"`
	// Controls the display of FedRAMP language to the user during SSO login
	UseFedrampLanguage bool                       `json:"use_fedramp_language"`
	Verification       SSONewResponseVerification `json:"verification"`
	JSON               ssoNewResponseJSON         `json:"-"`
}

func (*SSONewResponse) UnmarshalJSON added in v6.3.0

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

type SSONewResponseEnvelope added in v6.3.0

type SSONewResponseEnvelope struct {
	Errors   []SSONewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SSONewResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success SSONewResponseEnvelopeSuccess `json:"success,required"`
	Result  SSONewResponse                `json:"result"`
	JSON    ssoNewResponseEnvelopeJSON    `json:"-"`
}

func (*SSONewResponseEnvelope) UnmarshalJSON added in v6.3.0

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

type SSONewResponseEnvelopeErrors added in v6.3.0

type SSONewResponseEnvelopeErrors struct {
	Code             int64                              `json:"code,required"`
	Message          string                             `json:"message,required"`
	DocumentationURL string                             `json:"documentation_url"`
	Source           SSONewResponseEnvelopeErrorsSource `json:"source"`
	JSON             ssoNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SSONewResponseEnvelopeErrors) UnmarshalJSON added in v6.3.0

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

type SSONewResponseEnvelopeErrorsSource added in v6.3.0

type SSONewResponseEnvelopeErrorsSource struct {
	Pointer string                                 `json:"pointer"`
	JSON    ssoNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SSONewResponseEnvelopeErrorsSource) UnmarshalJSON added in v6.3.0

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

type SSONewResponseEnvelopeMessages added in v6.3.0

type SSONewResponseEnvelopeMessages struct {
	Code             int64                                `json:"code,required"`
	Message          string                               `json:"message,required"`
	DocumentationURL string                               `json:"documentation_url"`
	Source           SSONewResponseEnvelopeMessagesSource `json:"source"`
	JSON             ssoNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SSONewResponseEnvelopeMessages) UnmarshalJSON added in v6.3.0

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

type SSONewResponseEnvelopeMessagesSource added in v6.3.0

type SSONewResponseEnvelopeMessagesSource struct {
	Pointer string                                   `json:"pointer"`
	JSON    ssoNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SSONewResponseEnvelopeMessagesSource) UnmarshalJSON added in v6.3.0

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

type SSONewResponseEnvelopeSuccess added in v6.3.0

type SSONewResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	SSONewResponseEnvelopeSuccessTrue SSONewResponseEnvelopeSuccess = true
)

func (SSONewResponseEnvelopeSuccess) IsKnown added in v6.3.0

func (r SSONewResponseEnvelopeSuccess) IsKnown() bool

type SSONewResponseVerification added in v6.3.0

type SSONewResponseVerification struct {
	// DNS verification code. Add this entire string to the DNS TXT record of the email
	// domain to validate ownership.
	Code string `json:"code"`
	// The status of the verification code from the verification process.
	Status SSONewResponseVerificationStatus `json:"status"`
	JSON   ssoNewResponseVerificationJSON   `json:"-"`
}

func (*SSONewResponseVerification) UnmarshalJSON added in v6.3.0

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

type SSONewResponseVerificationStatus added in v6.3.0

type SSONewResponseVerificationStatus string

The status of the verification code from the verification process.

const (
	SSONewResponseVerificationStatusAwaiting SSONewResponseVerificationStatus = "awaiting"
	SSONewResponseVerificationStatusPending  SSONewResponseVerificationStatus = "pending"
	SSONewResponseVerificationStatusFailed   SSONewResponseVerificationStatus = "failed"
	SSONewResponseVerificationStatusVerified SSONewResponseVerificationStatus = "verified"
)

func (SSONewResponseVerificationStatus) IsKnown added in v6.3.0

type SSOService added in v6.3.0

type SSOService struct {
	Options []option.RequestOption
}

SSOService 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 NewSSOService method instead.

func NewSSOService added in v6.3.0

func NewSSOService(opts ...option.RequestOption) (r *SSOService)

NewSSOService 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 (*SSOService) BeginVerification added in v6.3.0

func (r *SSOService) BeginVerification(ctx context.Context, ssoConnectorID string, body SSOBeginVerificationParams, opts ...option.RequestOption) (res *SSOBeginVerificationResponse, err error)

Begin SSO connector verification

func (*SSOService) Delete added in v6.3.0

func (r *SSOService) Delete(ctx context.Context, ssoConnectorID string, body SSODeleteParams, opts ...option.RequestOption) (res *SSODeleteResponse, err error)

Delete SSO connector

func (*SSOService) Get added in v6.3.0

func (r *SSOService) Get(ctx context.Context, ssoConnectorID string, query SSOGetParams, opts ...option.RequestOption) (res *SSOGetResponse, err error)

Get single SSO connector

func (*SSOService) List added in v6.3.0

Get all SSO connectors

func (*SSOService) ListAutoPaging added in v6.3.0

Get all SSO connectors

func (*SSOService) New added in v6.3.0

func (r *SSOService) New(ctx context.Context, params SSONewParams, opts ...option.RequestOption) (res *SSONewResponse, err error)

Initialize new SSO connector

func (*SSOService) Update added in v6.3.0

func (r *SSOService) Update(ctx context.Context, ssoConnectorID string, params SSOUpdateParams, opts ...option.RequestOption) (res *SSOUpdateResponse, err error)

Update SSO connector state

type SSOUpdateParams added in v6.3.0

type SSOUpdateParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// SSO Connector enabled state
	Enabled param.Field[bool] `json:"enabled"`
	// Controls the display of FedRAMP language to the user during SSO login
	UseFedrampLanguage param.Field[bool] `json:"use_fedramp_language"`
}

func (SSOUpdateParams) MarshalJSON added in v6.3.0

func (r SSOUpdateParams) MarshalJSON() (data []byte, err error)

type SSOUpdateResponse added in v6.3.0

type SSOUpdateResponse struct {
	// SSO Connector identifier tag.
	ID string `json:"id"`
	// Timestamp for the creation of the SSO connector
	CreatedOn   time.Time `json:"created_on" format:"date-time"`
	EmailDomain string    `json:"email_domain"`
	Enabled     bool      `json:"enabled"`
	// Timestamp for the last update of the SSO connector
	UpdatedOn time.Time `json:"updated_on" format:"date-time"`
	// Controls the display of FedRAMP language to the user during SSO login
	UseFedrampLanguage bool                          `json:"use_fedramp_language"`
	Verification       SSOUpdateResponseVerification `json:"verification"`
	JSON               ssoUpdateResponseJSON         `json:"-"`
}

func (*SSOUpdateResponse) UnmarshalJSON added in v6.3.0

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

type SSOUpdateResponseEnvelope added in v6.3.0

type SSOUpdateResponseEnvelope struct {
	Errors   []SSOUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SSOUpdateResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success SSOUpdateResponseEnvelopeSuccess `json:"success,required"`
	Result  SSOUpdateResponse                `json:"result"`
	JSON    ssoUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*SSOUpdateResponseEnvelope) UnmarshalJSON added in v6.3.0

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

type SSOUpdateResponseEnvelopeErrors added in v6.3.0

type SSOUpdateResponseEnvelopeErrors struct {
	Code             int64                                 `json:"code,required"`
	Message          string                                `json:"message,required"`
	DocumentationURL string                                `json:"documentation_url"`
	Source           SSOUpdateResponseEnvelopeErrorsSource `json:"source"`
	JSON             ssoUpdateResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SSOUpdateResponseEnvelopeErrors) UnmarshalJSON added in v6.3.0

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

type SSOUpdateResponseEnvelopeErrorsSource added in v6.3.0

type SSOUpdateResponseEnvelopeErrorsSource struct {
	Pointer string                                    `json:"pointer"`
	JSON    ssoUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SSOUpdateResponseEnvelopeErrorsSource) UnmarshalJSON added in v6.3.0

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

type SSOUpdateResponseEnvelopeMessages added in v6.3.0

type SSOUpdateResponseEnvelopeMessages struct {
	Code             int64                                   `json:"code,required"`
	Message          string                                  `json:"message,required"`
	DocumentationURL string                                  `json:"documentation_url"`
	Source           SSOUpdateResponseEnvelopeMessagesSource `json:"source"`
	JSON             ssoUpdateResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SSOUpdateResponseEnvelopeMessages) UnmarshalJSON added in v6.3.0

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

type SSOUpdateResponseEnvelopeMessagesSource added in v6.3.0

type SSOUpdateResponseEnvelopeMessagesSource struct {
	Pointer string                                      `json:"pointer"`
	JSON    ssoUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SSOUpdateResponseEnvelopeMessagesSource) UnmarshalJSON added in v6.3.0

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

type SSOUpdateResponseEnvelopeSuccess added in v6.3.0

type SSOUpdateResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	SSOUpdateResponseEnvelopeSuccessTrue SSOUpdateResponseEnvelopeSuccess = true
)

func (SSOUpdateResponseEnvelopeSuccess) IsKnown added in v6.3.0

type SSOUpdateResponseVerification added in v6.3.0

type SSOUpdateResponseVerification struct {
	// DNS verification code. Add this entire string to the DNS TXT record of the email
	// domain to validate ownership.
	Code string `json:"code"`
	// The status of the verification code from the verification process.
	Status SSOUpdateResponseVerificationStatus `json:"status"`
	JSON   ssoUpdateResponseVerificationJSON   `json:"-"`
}

func (*SSOUpdateResponseVerification) UnmarshalJSON added in v6.3.0

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

type SSOUpdateResponseVerificationStatus added in v6.3.0

type SSOUpdateResponseVerificationStatus string

The status of the verification code from the verification process.

const (
	SSOUpdateResponseVerificationStatusAwaiting SSOUpdateResponseVerificationStatus = "awaiting"
	SSOUpdateResponseVerificationStatusPending  SSOUpdateResponseVerificationStatus = "pending"
	SSOUpdateResponseVerificationStatusFailed   SSOUpdateResponseVerificationStatus = "failed"
	SSOUpdateResponseVerificationStatusVerified SSOUpdateResponseVerificationStatus = "verified"
)

func (SSOUpdateResponseVerificationStatus) IsKnown added in v6.3.0

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 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.

type UserGroupDeleteParams

type UserGroupDeleteParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type UserGroupDeleteResponse

type UserGroupDeleteResponse struct {
	// Identifier
	ID   string                      `json:"id,required"`
	JSON userGroupDeleteResponseJSON `json:"-"`
}

func (*UserGroupDeleteResponse) UnmarshalJSON

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

type UserGroupDeleteResponseEnvelope

type UserGroupDeleteResponseEnvelope struct {
	Errors   []UserGroupDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []UserGroupDeleteResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success UserGroupDeleteResponseEnvelopeSuccess `json:"success,required"`
	Result  UserGroupDeleteResponse                `json:"result,nullable"`
	JSON    userGroupDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*UserGroupDeleteResponseEnvelope) UnmarshalJSON

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

type UserGroupDeleteResponseEnvelopeErrors

type UserGroupDeleteResponseEnvelopeErrors struct {
	Code             int64                                       `json:"code,required"`
	Message          string                                      `json:"message,required"`
	DocumentationURL string                                      `json:"documentation_url"`
	Source           UserGroupDeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON             userGroupDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*UserGroupDeleteResponseEnvelopeErrors) UnmarshalJSON

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

type UserGroupDeleteResponseEnvelopeErrorsSource

type UserGroupDeleteResponseEnvelopeErrorsSource struct {
	Pointer string                                          `json:"pointer"`
	JSON    userGroupDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*UserGroupDeleteResponseEnvelopeErrorsSource) UnmarshalJSON

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

type UserGroupDeleteResponseEnvelopeMessages

type UserGroupDeleteResponseEnvelopeMessages struct {
	Code             int64                                         `json:"code,required"`
	Message          string                                        `json:"message,required"`
	DocumentationURL string                                        `json:"documentation_url"`
	Source           UserGroupDeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON             userGroupDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*UserGroupDeleteResponseEnvelopeMessages) UnmarshalJSON

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

type UserGroupDeleteResponseEnvelopeMessagesSource

type UserGroupDeleteResponseEnvelopeMessagesSource struct {
	Pointer string                                            `json:"pointer"`
	JSON    userGroupDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*UserGroupDeleteResponseEnvelopeMessagesSource) UnmarshalJSON

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

type UserGroupDeleteResponseEnvelopeSuccess

type UserGroupDeleteResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	UserGroupDeleteResponseEnvelopeSuccessTrue UserGroupDeleteResponseEnvelopeSuccess = true
)

func (UserGroupDeleteResponseEnvelopeSuccess) IsKnown

type UserGroupGetParams

type UserGroupGetParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type UserGroupGetResponse

type UserGroupGetResponse struct {
	// User Group identifier tag.
	ID string `json:"id,required"`
	// Timestamp for the creation of the user group
	CreatedOn time.Time `json:"created_on,required" format:"date-time"`
	// Last time the user group was modified.
	ModifiedOn time.Time `json:"modified_on,required" format:"date-time"`
	// Name of the user group.
	Name string `json:"name,required"`
	// Policies attached to the User group
	Policies []UserGroupGetResponsePolicy `json:"policies"`
	JSON     userGroupGetResponseJSON     `json:"-"`
}

A group of policies resources.

func (*UserGroupGetResponse) UnmarshalJSON

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

type UserGroupGetResponseEnvelope

type UserGroupGetResponseEnvelope struct {
	Errors   []UserGroupGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []UserGroupGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success UserGroupGetResponseEnvelopeSuccess `json:"success,required"`
	// A group of policies resources.
	Result UserGroupGetResponse             `json:"result"`
	JSON   userGroupGetResponseEnvelopeJSON `json:"-"`
}

func (*UserGroupGetResponseEnvelope) UnmarshalJSON

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

type UserGroupGetResponseEnvelopeErrors

type UserGroupGetResponseEnvelopeErrors struct {
	Code             int64                                    `json:"code,required"`
	Message          string                                   `json:"message,required"`
	DocumentationURL string                                   `json:"documentation_url"`
	Source           UserGroupGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             userGroupGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*UserGroupGetResponseEnvelopeErrors) UnmarshalJSON

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

type UserGroupGetResponseEnvelopeErrorsSource

type UserGroupGetResponseEnvelopeErrorsSource struct {
	Pointer string                                       `json:"pointer"`
	JSON    userGroupGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*UserGroupGetResponseEnvelopeErrorsSource) UnmarshalJSON

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

type UserGroupGetResponseEnvelopeMessages

type UserGroupGetResponseEnvelopeMessages struct {
	Code             int64                                      `json:"code,required"`
	Message          string                                     `json:"message,required"`
	DocumentationURL string                                     `json:"documentation_url"`
	Source           UserGroupGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             userGroupGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*UserGroupGetResponseEnvelopeMessages) UnmarshalJSON

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

type UserGroupGetResponseEnvelopeMessagesSource

type UserGroupGetResponseEnvelopeMessagesSource struct {
	Pointer string                                         `json:"pointer"`
	JSON    userGroupGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*UserGroupGetResponseEnvelopeMessagesSource) UnmarshalJSON

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

type UserGroupGetResponseEnvelopeSuccess

type UserGroupGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	UserGroupGetResponseEnvelopeSuccessTrue UserGroupGetResponseEnvelopeSuccess = true
)

func (UserGroupGetResponseEnvelopeSuccess) IsKnown

type UserGroupGetResponsePoliciesAccess

type UserGroupGetResponsePoliciesAccess string

Allow or deny operations against the resources.

const (
	UserGroupGetResponsePoliciesAccessAllow UserGroupGetResponsePoliciesAccess = "allow"
	UserGroupGetResponsePoliciesAccessDeny  UserGroupGetResponsePoliciesAccess = "deny"
)

func (UserGroupGetResponsePoliciesAccess) IsKnown

type UserGroupGetResponsePoliciesPermissionGroup

type UserGroupGetResponsePoliciesPermissionGroup struct {
	// Identifier of the permission group.
	ID string `json:"id,required"`
	// Attributes associated to the permission group.
	Meta UserGroupGetResponsePoliciesPermissionGroupsMeta `json:"meta"`
	// Name of the permission group.
	Name string                                          `json:"name"`
	JSON userGroupGetResponsePoliciesPermissionGroupJSON `json:"-"`
}

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

func (*UserGroupGetResponsePoliciesPermissionGroup) UnmarshalJSON

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

type UserGroupGetResponsePoliciesPermissionGroupsMeta

type UserGroupGetResponsePoliciesPermissionGroupsMeta struct {
	Key   string                                               `json:"key"`
	Value string                                               `json:"value"`
	JSON  userGroupGetResponsePoliciesPermissionGroupsMetaJSON `json:"-"`
}

Attributes associated to the permission group.

func (*UserGroupGetResponsePoliciesPermissionGroupsMeta) UnmarshalJSON

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

type UserGroupGetResponsePoliciesResourceGroup

type UserGroupGetResponsePoliciesResourceGroup struct {
	// Identifier of the resource group.
	ID string `json:"id,required"`
	// The scope associated to the resource group
	Scope []UserGroupGetResponsePoliciesResourceGroupsScope `json:"scope,required"`
	// Attributes associated to the resource group.
	Meta UserGroupGetResponsePoliciesResourceGroupsMeta `json:"meta"`
	// Name of the resource group.
	Name string                                        `json:"name"`
	JSON userGroupGetResponsePoliciesResourceGroupJSON `json:"-"`
}

A group of scoped resources.

func (*UserGroupGetResponsePoliciesResourceGroup) UnmarshalJSON

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

type UserGroupGetResponsePoliciesResourceGroupsMeta

type UserGroupGetResponsePoliciesResourceGroupsMeta struct {
	Key   string                                             `json:"key"`
	Value string                                             `json:"value"`
	JSON  userGroupGetResponsePoliciesResourceGroupsMetaJSON `json:"-"`
}

Attributes associated to the resource group.

func (*UserGroupGetResponsePoliciesResourceGroupsMeta) UnmarshalJSON

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

type UserGroupGetResponsePoliciesResourceGroupsScope

type UserGroupGetResponsePoliciesResourceGroupsScope struct {
	// This is a combination of pre-defined resource name and identifier (like Account
	// ID etc.)
	Key string `json:"key,required"`
	// A list of scope objects for additional context.
	Objects []UserGroupGetResponsePoliciesResourceGroupsScopeObject `json:"objects,required"`
	JSON    userGroupGetResponsePoliciesResourceGroupsScopeJSON     `json:"-"`
}

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

func (*UserGroupGetResponsePoliciesResourceGroupsScope) UnmarshalJSON

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

type UserGroupGetResponsePoliciesResourceGroupsScopeObject

type UserGroupGetResponsePoliciesResourceGroupsScopeObject struct {
	// This is a combination of pre-defined resource name and identifier (like Zone ID
	// etc.)
	Key  string                                                    `json:"key,required"`
	JSON userGroupGetResponsePoliciesResourceGroupsScopeObjectJSON `json:"-"`
}

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

func (*UserGroupGetResponsePoliciesResourceGroupsScopeObject) UnmarshalJSON

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

type UserGroupGetResponsePolicy

type UserGroupGetResponsePolicy struct {
	// Policy identifier.
	ID string `json:"id"`
	// Allow or deny operations against the resources.
	Access UserGroupGetResponsePoliciesAccess `json:"access"`
	// A set of permission groups that are specified to the policy.
	PermissionGroups []UserGroupGetResponsePoliciesPermissionGroup `json:"permission_groups"`
	// A list of resource groups that the policy applies to.
	ResourceGroups []UserGroupGetResponsePoliciesResourceGroup `json:"resource_groups"`
	JSON           userGroupGetResponsePolicyJSON              `json:"-"`
}

Policy

func (*UserGroupGetResponsePolicy) UnmarshalJSON

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

type UserGroupListParams

type UserGroupListParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// ID of the user group to be fetched.
	ID param.Field[string] `query:"id"`
	// The sort order of returned user groups by name. Default sort order is ascending.
	// To switch to descending, set this parameter to "desc"
	Direction param.Field[string] `query:"direction"`
	// A string used for searching for user groups containing that substring.
	FuzzyName param.Field[string] `query:"fuzzyName"`
	// Name of the user group to be fetched.
	Name param.Field[string] `query:"name"`
	// Page number of paginated results.
	Page param.Field[float64] `query:"page"`
	// Maximum number of results per page.
	PerPage param.Field[float64] `query:"per_page"`
}

func (UserGroupListParams) URLQuery

func (r UserGroupListParams) URLQuery() (v url.Values)

URLQuery serializes UserGroupListParams's query parameters as `url.Values`.

type UserGroupListResponse

type UserGroupListResponse struct {
	// User Group identifier tag.
	ID string `json:"id,required"`
	// Timestamp for the creation of the user group
	CreatedOn time.Time `json:"created_on,required" format:"date-time"`
	// Last time the user group was modified.
	ModifiedOn time.Time `json:"modified_on,required" format:"date-time"`
	// Name of the user group.
	Name string `json:"name,required"`
	// Policies attached to the User group
	Policies []UserGroupListResponsePolicy `json:"policies"`
	JSON     userGroupListResponseJSON     `json:"-"`
}

A group of policies resources.

func (*UserGroupListResponse) UnmarshalJSON

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

type UserGroupListResponsePoliciesAccess

type UserGroupListResponsePoliciesAccess string

Allow or deny operations against the resources.

const (
	UserGroupListResponsePoliciesAccessAllow UserGroupListResponsePoliciesAccess = "allow"
	UserGroupListResponsePoliciesAccessDeny  UserGroupListResponsePoliciesAccess = "deny"
)

func (UserGroupListResponsePoliciesAccess) IsKnown

type UserGroupListResponsePoliciesPermissionGroup

type UserGroupListResponsePoliciesPermissionGroup struct {
	// Identifier of the permission group.
	ID string `json:"id,required"`
	// Attributes associated to the permission group.
	Meta UserGroupListResponsePoliciesPermissionGroupsMeta `json:"meta"`
	// Name of the permission group.
	Name string                                           `json:"name"`
	JSON userGroupListResponsePoliciesPermissionGroupJSON `json:"-"`
}

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

func (*UserGroupListResponsePoliciesPermissionGroup) UnmarshalJSON

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

type UserGroupListResponsePoliciesPermissionGroupsMeta

type UserGroupListResponsePoliciesPermissionGroupsMeta struct {
	Key   string                                                `json:"key"`
	Value string                                                `json:"value"`
	JSON  userGroupListResponsePoliciesPermissionGroupsMetaJSON `json:"-"`
}

Attributes associated to the permission group.

func (*UserGroupListResponsePoliciesPermissionGroupsMeta) UnmarshalJSON

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

type UserGroupListResponsePoliciesResourceGroup

type UserGroupListResponsePoliciesResourceGroup struct {
	// Identifier of the resource group.
	ID string `json:"id,required"`
	// The scope associated to the resource group
	Scope []UserGroupListResponsePoliciesResourceGroupsScope `json:"scope,required"`
	// Attributes associated to the resource group.
	Meta UserGroupListResponsePoliciesResourceGroupsMeta `json:"meta"`
	// Name of the resource group.
	Name string                                         `json:"name"`
	JSON userGroupListResponsePoliciesResourceGroupJSON `json:"-"`
}

A group of scoped resources.

func (*UserGroupListResponsePoliciesResourceGroup) UnmarshalJSON

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

type UserGroupListResponsePoliciesResourceGroupsMeta

type UserGroupListResponsePoliciesResourceGroupsMeta struct {
	Key   string                                              `json:"key"`
	Value string                                              `json:"value"`
	JSON  userGroupListResponsePoliciesResourceGroupsMetaJSON `json:"-"`
}

Attributes associated to the resource group.

func (*UserGroupListResponsePoliciesResourceGroupsMeta) UnmarshalJSON

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

type UserGroupListResponsePoliciesResourceGroupsScope

type UserGroupListResponsePoliciesResourceGroupsScope struct {
	// This is a combination of pre-defined resource name and identifier (like Account
	// ID etc.)
	Key string `json:"key,required"`
	// A list of scope objects for additional context.
	Objects []UserGroupListResponsePoliciesResourceGroupsScopeObject `json:"objects,required"`
	JSON    userGroupListResponsePoliciesResourceGroupsScopeJSON     `json:"-"`
}

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

func (*UserGroupListResponsePoliciesResourceGroupsScope) UnmarshalJSON

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

type UserGroupListResponsePoliciesResourceGroupsScopeObject

type UserGroupListResponsePoliciesResourceGroupsScopeObject struct {
	// This is a combination of pre-defined resource name and identifier (like Zone ID
	// etc.)
	Key  string                                                     `json:"key,required"`
	JSON userGroupListResponsePoliciesResourceGroupsScopeObjectJSON `json:"-"`
}

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

func (*UserGroupListResponsePoliciesResourceGroupsScopeObject) UnmarshalJSON

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

type UserGroupListResponsePolicy

type UserGroupListResponsePolicy struct {
	// Policy identifier.
	ID string `json:"id"`
	// Allow or deny operations against the resources.
	Access UserGroupListResponsePoliciesAccess `json:"access"`
	// A set of permission groups that are specified to the policy.
	PermissionGroups []UserGroupListResponsePoliciesPermissionGroup `json:"permission_groups"`
	// A list of resource groups that the policy applies to.
	ResourceGroups []UserGroupListResponsePoliciesResourceGroup `json:"resource_groups"`
	JSON           userGroupListResponsePolicyJSON              `json:"-"`
}

Policy

func (*UserGroupListResponsePolicy) UnmarshalJSON

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

type UserGroupMemberDeleteParams

type UserGroupMemberDeleteParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type UserGroupMemberDeleteResponse

type UserGroupMemberDeleteResponse struct {
	// Account member identifier.
	ID string `json:"id,required"`
	// The contact email address of the user.
	Email string `json:"email"`
	// The member's status in the account.
	Status UserGroupMemberDeleteResponseStatus `json:"status"`
	JSON   userGroupMemberDeleteResponseJSON   `json:"-"`
}

Member attached to a User Group.

func (*UserGroupMemberDeleteResponse) UnmarshalJSON

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

type UserGroupMemberDeleteResponseEnvelope

type UserGroupMemberDeleteResponseEnvelope struct {
	Errors   []UserGroupMemberDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []UserGroupMemberDeleteResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success UserGroupMemberDeleteResponseEnvelopeSuccess `json:"success,required"`
	// Member attached to a User Group.
	Result UserGroupMemberDeleteResponse             `json:"result"`
	JSON   userGroupMemberDeleteResponseEnvelopeJSON `json:"-"`
}

func (*UserGroupMemberDeleteResponseEnvelope) UnmarshalJSON

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

type UserGroupMemberDeleteResponseEnvelopeErrors

type UserGroupMemberDeleteResponseEnvelopeErrors struct {
	Code             int64                                             `json:"code,required"`
	Message          string                                            `json:"message,required"`
	DocumentationURL string                                            `json:"documentation_url"`
	Source           UserGroupMemberDeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON             userGroupMemberDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*UserGroupMemberDeleteResponseEnvelopeErrors) UnmarshalJSON

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

type UserGroupMemberDeleteResponseEnvelopeErrorsSource

type UserGroupMemberDeleteResponseEnvelopeErrorsSource struct {
	Pointer string                                                `json:"pointer"`
	JSON    userGroupMemberDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*UserGroupMemberDeleteResponseEnvelopeErrorsSource) UnmarshalJSON

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

type UserGroupMemberDeleteResponseEnvelopeMessages

type UserGroupMemberDeleteResponseEnvelopeMessages struct {
	Code             int64                                               `json:"code,required"`
	Message          string                                              `json:"message,required"`
	DocumentationURL string                                              `json:"documentation_url"`
	Source           UserGroupMemberDeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON             userGroupMemberDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*UserGroupMemberDeleteResponseEnvelopeMessages) UnmarshalJSON

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

type UserGroupMemberDeleteResponseEnvelopeMessagesSource

type UserGroupMemberDeleteResponseEnvelopeMessagesSource struct {
	Pointer string                                                  `json:"pointer"`
	JSON    userGroupMemberDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*UserGroupMemberDeleteResponseEnvelopeMessagesSource) UnmarshalJSON

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

type UserGroupMemberDeleteResponseEnvelopeSuccess

type UserGroupMemberDeleteResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	UserGroupMemberDeleteResponseEnvelopeSuccessTrue UserGroupMemberDeleteResponseEnvelopeSuccess = true
)

func (UserGroupMemberDeleteResponseEnvelopeSuccess) IsKnown

type UserGroupMemberDeleteResponseStatus

type UserGroupMemberDeleteResponseStatus string

The member's status in the account.

const (
	UserGroupMemberDeleteResponseStatusAccepted UserGroupMemberDeleteResponseStatus = "accepted"
	UserGroupMemberDeleteResponseStatusPending  UserGroupMemberDeleteResponseStatus = "pending"
)

func (UserGroupMemberDeleteResponseStatus) IsKnown

type UserGroupMemberListParams

type UserGroupMemberListParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// Page number of paginated results.
	Page param.Field[float64] `query:"page"`
	// Maximum number of results per page.
	PerPage param.Field[float64] `query:"per_page"`
}

func (UserGroupMemberListParams) URLQuery

func (r UserGroupMemberListParams) URLQuery() (v url.Values)

URLQuery serializes UserGroupMemberListParams's query parameters as `url.Values`.

type UserGroupMemberListResponse

type UserGroupMemberListResponse struct {
	// Account member identifier.
	ID string `json:"id,required"`
	// The contact email address of the user.
	Email string `json:"email"`
	// The member's status in the account.
	Status UserGroupMemberListResponseStatus `json:"status"`
	JSON   userGroupMemberListResponseJSON   `json:"-"`
}

Member attached to a User Group.

func (*UserGroupMemberListResponse) UnmarshalJSON

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

type UserGroupMemberListResponseStatus

type UserGroupMemberListResponseStatus string

The member's status in the account.

const (
	UserGroupMemberListResponseStatusAccepted UserGroupMemberListResponseStatus = "accepted"
	UserGroupMemberListResponseStatusPending  UserGroupMemberListResponseStatus = "pending"
)

func (UserGroupMemberListResponseStatus) IsKnown

type UserGroupMemberNewParams

type UserGroupMemberNewParams struct {
	// Account identifier tag.
	AccountID param.Field[string]            `path:"account_id,required"`
	Body      []UserGroupMemberNewParamsBody `json:"body,required"`
}

func (UserGroupMemberNewParams) MarshalJSON

func (r UserGroupMemberNewParams) MarshalJSON() (data []byte, err error)

type UserGroupMemberNewParamsBody

type UserGroupMemberNewParamsBody struct {
	// The identifier of an existing account Member.
	ID param.Field[string] `json:"id,required"`
}

func (UserGroupMemberNewParamsBody) MarshalJSON

func (r UserGroupMemberNewParamsBody) MarshalJSON() (data []byte, err error)

type UserGroupMemberNewResponse

type UserGroupMemberNewResponse struct {
	// Account member identifier.
	ID string `json:"id,required"`
	// The contact email address of the user.
	Email string `json:"email"`
	// The member's status in the account.
	Status UserGroupMemberNewResponseStatus `json:"status"`
	JSON   userGroupMemberNewResponseJSON   `json:"-"`
}

Member attached to a User Group.

func (*UserGroupMemberNewResponse) UnmarshalJSON

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

type UserGroupMemberNewResponseEnvelope

type UserGroupMemberNewResponseEnvelope struct {
	Errors   []UserGroupMemberNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []UserGroupMemberNewResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success UserGroupMemberNewResponseEnvelopeSuccess `json:"success,required"`
	// Member attached to a User Group.
	Result UserGroupMemberNewResponse             `json:"result"`
	JSON   userGroupMemberNewResponseEnvelopeJSON `json:"-"`
}

func (*UserGroupMemberNewResponseEnvelope) UnmarshalJSON

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

type UserGroupMemberNewResponseEnvelopeErrors

type UserGroupMemberNewResponseEnvelopeErrors struct {
	Code             int64                                          `json:"code,required"`
	Message          string                                         `json:"message,required"`
	DocumentationURL string                                         `json:"documentation_url"`
	Source           UserGroupMemberNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             userGroupMemberNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*UserGroupMemberNewResponseEnvelopeErrors) UnmarshalJSON

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

type UserGroupMemberNewResponseEnvelopeErrorsSource

type UserGroupMemberNewResponseEnvelopeErrorsSource struct {
	Pointer string                                             `json:"pointer"`
	JSON    userGroupMemberNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*UserGroupMemberNewResponseEnvelopeErrorsSource) UnmarshalJSON

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

type UserGroupMemberNewResponseEnvelopeMessages

type UserGroupMemberNewResponseEnvelopeMessages struct {
	Code             int64                                            `json:"code,required"`
	Message          string                                           `json:"message,required"`
	DocumentationURL string                                           `json:"documentation_url"`
	Source           UserGroupMemberNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             userGroupMemberNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*UserGroupMemberNewResponseEnvelopeMessages) UnmarshalJSON

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

type UserGroupMemberNewResponseEnvelopeMessagesSource

type UserGroupMemberNewResponseEnvelopeMessagesSource struct {
	Pointer string                                               `json:"pointer"`
	JSON    userGroupMemberNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*UserGroupMemberNewResponseEnvelopeMessagesSource) UnmarshalJSON

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

type UserGroupMemberNewResponseEnvelopeSuccess

type UserGroupMemberNewResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	UserGroupMemberNewResponseEnvelopeSuccessTrue UserGroupMemberNewResponseEnvelopeSuccess = true
)

func (UserGroupMemberNewResponseEnvelopeSuccess) IsKnown

type UserGroupMemberNewResponseStatus

type UserGroupMemberNewResponseStatus string

The member's status in the account.

const (
	UserGroupMemberNewResponseStatusAccepted UserGroupMemberNewResponseStatus = "accepted"
	UserGroupMemberNewResponseStatusPending  UserGroupMemberNewResponseStatus = "pending"
)

func (UserGroupMemberNewResponseStatus) IsKnown

type UserGroupMemberService

type UserGroupMemberService struct {
	Options []option.RequestOption
}

UserGroupMemberService 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 NewUserGroupMemberService method instead.

func NewUserGroupMemberService

func NewUserGroupMemberService(opts ...option.RequestOption) (r *UserGroupMemberService)

NewUserGroupMemberService 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 (*UserGroupMemberService) Delete

Remove a member from User Group

func (*UserGroupMemberService) List

List all the members attached to a user group.

func (*UserGroupMemberService) ListAutoPaging

List all the members attached to a user group.

func (*UserGroupMemberService) New

Add members to a User Group.

func (*UserGroupMemberService) Update

Replace the set of members attached to a User Group.

func (*UserGroupMemberService) UpdateAutoPaging

Replace the set of members attached to a User Group.

type UserGroupMemberUpdateParams

type UserGroupMemberUpdateParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// Set/Replace members to a user group.
	Body []UserGroupMemberUpdateParamsBody `json:"body,required"`
}

func (UserGroupMemberUpdateParams) MarshalJSON

func (r UserGroupMemberUpdateParams) MarshalJSON() (data []byte, err error)

type UserGroupMemberUpdateParamsBody

type UserGroupMemberUpdateParamsBody struct {
	// The identifier of an existing account Member.
	ID param.Field[string] `json:"id,required"`
}

func (UserGroupMemberUpdateParamsBody) MarshalJSON

func (r UserGroupMemberUpdateParamsBody) MarshalJSON() (data []byte, err error)

type UserGroupMemberUpdateResponse

type UserGroupMemberUpdateResponse struct {
	// Account member identifier.
	ID string `json:"id,required"`
	// The contact email address of the user.
	Email string `json:"email"`
	// The member's status in the account.
	Status UserGroupMemberUpdateResponseStatus `json:"status"`
	JSON   userGroupMemberUpdateResponseJSON   `json:"-"`
}

Member attached to a User Group.

func (*UserGroupMemberUpdateResponse) UnmarshalJSON

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

type UserGroupMemberUpdateResponseStatus

type UserGroupMemberUpdateResponseStatus string

The member's status in the account.

const (
	UserGroupMemberUpdateResponseStatusAccepted UserGroupMemberUpdateResponseStatus = "accepted"
	UserGroupMemberUpdateResponseStatusPending  UserGroupMemberUpdateResponseStatus = "pending"
)

func (UserGroupMemberUpdateResponseStatus) IsKnown

type UserGroupNewParams

type UserGroupNewParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// Name of the User group.
	Name param.Field[string] `json:"name,required"`
	// Policies attached to the User group
	Policies param.Field[[]UserGroupNewParamsPolicy] `json:"policies,required"`
}

func (UserGroupNewParams) MarshalJSON

func (r UserGroupNewParams) MarshalJSON() (data []byte, err error)

type UserGroupNewParamsPoliciesAccess

type UserGroupNewParamsPoliciesAccess string

Allow or deny operations against the resources.

const (
	UserGroupNewParamsPoliciesAccessAllow UserGroupNewParamsPoliciesAccess = "allow"
	UserGroupNewParamsPoliciesAccessDeny  UserGroupNewParamsPoliciesAccess = "deny"
)

func (UserGroupNewParamsPoliciesAccess) IsKnown

type UserGroupNewParamsPoliciesPermissionGroup

type UserGroupNewParamsPoliciesPermissionGroup struct {
	// Permission Group identifier tag.
	ID param.Field[string] `json:"id,required"`
}

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

func (UserGroupNewParamsPoliciesPermissionGroup) MarshalJSON

func (r UserGroupNewParamsPoliciesPermissionGroup) MarshalJSON() (data []byte, err error)

type UserGroupNewParamsPoliciesResourceGroup

type UserGroupNewParamsPoliciesResourceGroup struct {
	// Resource Group identifier tag.
	ID param.Field[string] `json:"id,required"`
}

A group of scoped resources.

func (UserGroupNewParamsPoliciesResourceGroup) MarshalJSON

func (r UserGroupNewParamsPoliciesResourceGroup) MarshalJSON() (data []byte, err error)

type UserGroupNewParamsPolicy

type UserGroupNewParamsPolicy struct {
	// Allow or deny operations against the resources.
	Access param.Field[UserGroupNewParamsPoliciesAccess] `json:"access,required"`
	// A set of permission groups that are specified to the policy.
	PermissionGroups param.Field[[]UserGroupNewParamsPoliciesPermissionGroup] `json:"permission_groups,required"`
	// A set of resource groups that are specified to the policy.
	ResourceGroups param.Field[[]UserGroupNewParamsPoliciesResourceGroup] `json:"resource_groups,required"`
}

func (UserGroupNewParamsPolicy) MarshalJSON

func (r UserGroupNewParamsPolicy) MarshalJSON() (data []byte, err error)

type UserGroupNewResponse

type UserGroupNewResponse struct {
	// User Group identifier tag.
	ID string `json:"id,required"`
	// Timestamp for the creation of the user group
	CreatedOn time.Time `json:"created_on,required" format:"date-time"`
	// Last time the user group was modified.
	ModifiedOn time.Time `json:"modified_on,required" format:"date-time"`
	// Name of the user group.
	Name string `json:"name,required"`
	// Policies attached to the User group
	Policies []UserGroupNewResponsePolicy `json:"policies"`
	JSON     userGroupNewResponseJSON     `json:"-"`
}

A group of policies resources.

func (*UserGroupNewResponse) UnmarshalJSON

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

type UserGroupNewResponseEnvelope

type UserGroupNewResponseEnvelope struct {
	Errors   []UserGroupNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []UserGroupNewResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success UserGroupNewResponseEnvelopeSuccess `json:"success,required"`
	// A group of policies resources.
	Result UserGroupNewResponse             `json:"result"`
	JSON   userGroupNewResponseEnvelopeJSON `json:"-"`
}

func (*UserGroupNewResponseEnvelope) UnmarshalJSON

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

type UserGroupNewResponseEnvelopeErrors

type UserGroupNewResponseEnvelopeErrors struct {
	Code             int64                                    `json:"code,required"`
	Message          string                                   `json:"message,required"`
	DocumentationURL string                                   `json:"documentation_url"`
	Source           UserGroupNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             userGroupNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*UserGroupNewResponseEnvelopeErrors) UnmarshalJSON

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

type UserGroupNewResponseEnvelopeErrorsSource

type UserGroupNewResponseEnvelopeErrorsSource struct {
	Pointer string                                       `json:"pointer"`
	JSON    userGroupNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*UserGroupNewResponseEnvelopeErrorsSource) UnmarshalJSON

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

type UserGroupNewResponseEnvelopeMessages

type UserGroupNewResponseEnvelopeMessages struct {
	Code             int64                                      `json:"code,required"`
	Message          string                                     `json:"message,required"`
	DocumentationURL string                                     `json:"documentation_url"`
	Source           UserGroupNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             userGroupNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*UserGroupNewResponseEnvelopeMessages) UnmarshalJSON

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

type UserGroupNewResponseEnvelopeMessagesSource

type UserGroupNewResponseEnvelopeMessagesSource struct {
	Pointer string                                         `json:"pointer"`
	JSON    userGroupNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*UserGroupNewResponseEnvelopeMessagesSource) UnmarshalJSON

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

type UserGroupNewResponseEnvelopeSuccess

type UserGroupNewResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	UserGroupNewResponseEnvelopeSuccessTrue UserGroupNewResponseEnvelopeSuccess = true
)

func (UserGroupNewResponseEnvelopeSuccess) IsKnown

type UserGroupNewResponsePoliciesAccess

type UserGroupNewResponsePoliciesAccess string

Allow or deny operations against the resources.

const (
	UserGroupNewResponsePoliciesAccessAllow UserGroupNewResponsePoliciesAccess = "allow"
	UserGroupNewResponsePoliciesAccessDeny  UserGroupNewResponsePoliciesAccess = "deny"
)

func (UserGroupNewResponsePoliciesAccess) IsKnown

type UserGroupNewResponsePoliciesPermissionGroup

type UserGroupNewResponsePoliciesPermissionGroup struct {
	// Identifier of the permission group.
	ID string `json:"id,required"`
	// Attributes associated to the permission group.
	Meta UserGroupNewResponsePoliciesPermissionGroupsMeta `json:"meta"`
	// Name of the permission group.
	Name string                                          `json:"name"`
	JSON userGroupNewResponsePoliciesPermissionGroupJSON `json:"-"`
}

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

func (*UserGroupNewResponsePoliciesPermissionGroup) UnmarshalJSON

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

type UserGroupNewResponsePoliciesPermissionGroupsMeta

type UserGroupNewResponsePoliciesPermissionGroupsMeta struct {
	Key   string                                               `json:"key"`
	Value string                                               `json:"value"`
	JSON  userGroupNewResponsePoliciesPermissionGroupsMetaJSON `json:"-"`
}

Attributes associated to the permission group.

func (*UserGroupNewResponsePoliciesPermissionGroupsMeta) UnmarshalJSON

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

type UserGroupNewResponsePoliciesResourceGroup

type UserGroupNewResponsePoliciesResourceGroup struct {
	// Identifier of the resource group.
	ID string `json:"id,required"`
	// The scope associated to the resource group
	Scope []UserGroupNewResponsePoliciesResourceGroupsScope `json:"scope,required"`
	// Attributes associated to the resource group.
	Meta UserGroupNewResponsePoliciesResourceGroupsMeta `json:"meta"`
	// Name of the resource group.
	Name string                                        `json:"name"`
	JSON userGroupNewResponsePoliciesResourceGroupJSON `json:"-"`
}

A group of scoped resources.

func (*UserGroupNewResponsePoliciesResourceGroup) UnmarshalJSON

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

type UserGroupNewResponsePoliciesResourceGroupsMeta

type UserGroupNewResponsePoliciesResourceGroupsMeta struct {
	Key   string                                             `json:"key"`
	Value string                                             `json:"value"`
	JSON  userGroupNewResponsePoliciesResourceGroupsMetaJSON `json:"-"`
}

Attributes associated to the resource group.

func (*UserGroupNewResponsePoliciesResourceGroupsMeta) UnmarshalJSON

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

type UserGroupNewResponsePoliciesResourceGroupsScope

type UserGroupNewResponsePoliciesResourceGroupsScope struct {
	// This is a combination of pre-defined resource name and identifier (like Account
	// ID etc.)
	Key string `json:"key,required"`
	// A list of scope objects for additional context.
	Objects []UserGroupNewResponsePoliciesResourceGroupsScopeObject `json:"objects,required"`
	JSON    userGroupNewResponsePoliciesResourceGroupsScopeJSON     `json:"-"`
}

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

func (*UserGroupNewResponsePoliciesResourceGroupsScope) UnmarshalJSON

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

type UserGroupNewResponsePoliciesResourceGroupsScopeObject

type UserGroupNewResponsePoliciesResourceGroupsScopeObject struct {
	// This is a combination of pre-defined resource name and identifier (like Zone ID
	// etc.)
	Key  string                                                    `json:"key,required"`
	JSON userGroupNewResponsePoliciesResourceGroupsScopeObjectJSON `json:"-"`
}

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

func (*UserGroupNewResponsePoliciesResourceGroupsScopeObject) UnmarshalJSON

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

type UserGroupNewResponsePolicy

type UserGroupNewResponsePolicy struct {
	// Policy identifier.
	ID string `json:"id"`
	// Allow or deny operations against the resources.
	Access UserGroupNewResponsePoliciesAccess `json:"access"`
	// A set of permission groups that are specified to the policy.
	PermissionGroups []UserGroupNewResponsePoliciesPermissionGroup `json:"permission_groups"`
	// A list of resource groups that the policy applies to.
	ResourceGroups []UserGroupNewResponsePoliciesResourceGroup `json:"resource_groups"`
	JSON           userGroupNewResponsePolicyJSON              `json:"-"`
}

Policy

func (*UserGroupNewResponsePolicy) UnmarshalJSON

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

type UserGroupService

type UserGroupService struct {
	Options []option.RequestOption
	Members *UserGroupMemberService
}

UserGroupService 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 NewUserGroupService method instead.

func NewUserGroupService

func NewUserGroupService(opts ...option.RequestOption) (r *UserGroupService)

NewUserGroupService 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 (*UserGroupService) Delete

func (r *UserGroupService) Delete(ctx context.Context, userGroupID string, body UserGroupDeleteParams, opts ...option.RequestOption) (res *UserGroupDeleteResponse, err error)

Remove a user group from an account.

func (*UserGroupService) Get

func (r *UserGroupService) Get(ctx context.Context, userGroupID string, query UserGroupGetParams, opts ...option.RequestOption) (res *UserGroupGetResponse, err error)

Get information about a specific user group in an account.

func (*UserGroupService) List

List all the user groups for an account.

func (*UserGroupService) ListAutoPaging

List all the user groups for an account.

func (*UserGroupService) New

Create a new user group under the specified account.

func (*UserGroupService) Update

func (r *UserGroupService) Update(ctx context.Context, userGroupID string, params UserGroupUpdateParams, opts ...option.RequestOption) (res *UserGroupUpdateResponse, err error)

Modify an existing user group.

type UserGroupUpdateParams

type UserGroupUpdateParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// Name of the User group.
	Name param.Field[string] `json:"name"`
	// Policies attached to the User group
	Policies param.Field[[]UserGroupUpdateParamsPolicy] `json:"policies"`
}

func (UserGroupUpdateParams) MarshalJSON

func (r UserGroupUpdateParams) MarshalJSON() (data []byte, err error)

type UserGroupUpdateParamsPoliciesAccess

type UserGroupUpdateParamsPoliciesAccess string

Allow or deny operations against the resources.

const (
	UserGroupUpdateParamsPoliciesAccessAllow UserGroupUpdateParamsPoliciesAccess = "allow"
	UserGroupUpdateParamsPoliciesAccessDeny  UserGroupUpdateParamsPoliciesAccess = "deny"
)

func (UserGroupUpdateParamsPoliciesAccess) IsKnown

type UserGroupUpdateParamsPoliciesPermissionGroup

type UserGroupUpdateParamsPoliciesPermissionGroup struct {
	// Permission Group identifier tag.
	ID param.Field[string] `json:"id,required"`
}

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

func (UserGroupUpdateParamsPoliciesPermissionGroup) MarshalJSON

func (r UserGroupUpdateParamsPoliciesPermissionGroup) MarshalJSON() (data []byte, err error)

type UserGroupUpdateParamsPoliciesResourceGroup

type UserGroupUpdateParamsPoliciesResourceGroup struct {
	// Resource Group identifier tag.
	ID param.Field[string] `json:"id,required"`
}

A group of scoped resources.

func (UserGroupUpdateParamsPoliciesResourceGroup) MarshalJSON

func (r UserGroupUpdateParamsPoliciesResourceGroup) MarshalJSON() (data []byte, err error)

type UserGroupUpdateParamsPolicy

type UserGroupUpdateParamsPolicy struct {
	// Policy identifier.
	ID param.Field[string] `json:"id,required"`
	// Allow or deny operations against the resources.
	Access param.Field[UserGroupUpdateParamsPoliciesAccess] `json:"access,required"`
	// A set of permission groups that are specified to the policy.
	PermissionGroups param.Field[[]UserGroupUpdateParamsPoliciesPermissionGroup] `json:"permission_groups,required"`
	// A set of resource groups that are specified to the policy.
	ResourceGroups param.Field[[]UserGroupUpdateParamsPoliciesResourceGroup] `json:"resource_groups,required"`
}

func (UserGroupUpdateParamsPolicy) MarshalJSON

func (r UserGroupUpdateParamsPolicy) MarshalJSON() (data []byte, err error)

type UserGroupUpdateResponse

type UserGroupUpdateResponse struct {
	// User Group identifier tag.
	ID string `json:"id,required"`
	// Timestamp for the creation of the user group
	CreatedOn time.Time `json:"created_on,required" format:"date-time"`
	// Last time the user group was modified.
	ModifiedOn time.Time `json:"modified_on,required" format:"date-time"`
	// Name of the user group.
	Name string `json:"name,required"`
	// Policies attached to the User group
	Policies []UserGroupUpdateResponsePolicy `json:"policies"`
	JSON     userGroupUpdateResponseJSON     `json:"-"`
}

A group of policies resources.

func (*UserGroupUpdateResponse) UnmarshalJSON

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

type UserGroupUpdateResponseEnvelope

type UserGroupUpdateResponseEnvelope struct {
	Errors   []UserGroupUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []UserGroupUpdateResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success UserGroupUpdateResponseEnvelopeSuccess `json:"success,required"`
	// A group of policies resources.
	Result UserGroupUpdateResponse             `json:"result"`
	JSON   userGroupUpdateResponseEnvelopeJSON `json:"-"`
}

func (*UserGroupUpdateResponseEnvelope) UnmarshalJSON

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

type UserGroupUpdateResponseEnvelopeErrors

type UserGroupUpdateResponseEnvelopeErrors struct {
	Code             int64                                       `json:"code,required"`
	Message          string                                      `json:"message,required"`
	DocumentationURL string                                      `json:"documentation_url"`
	Source           UserGroupUpdateResponseEnvelopeErrorsSource `json:"source"`
	JSON             userGroupUpdateResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*UserGroupUpdateResponseEnvelopeErrors) UnmarshalJSON

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

type UserGroupUpdateResponseEnvelopeErrorsSource

type UserGroupUpdateResponseEnvelopeErrorsSource struct {
	Pointer string                                          `json:"pointer"`
	JSON    userGroupUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*UserGroupUpdateResponseEnvelopeErrorsSource) UnmarshalJSON

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

type UserGroupUpdateResponseEnvelopeMessages

type UserGroupUpdateResponseEnvelopeMessages struct {
	Code             int64                                         `json:"code,required"`
	Message          string                                        `json:"message,required"`
	DocumentationURL string                                        `json:"documentation_url"`
	Source           UserGroupUpdateResponseEnvelopeMessagesSource `json:"source"`
	JSON             userGroupUpdateResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*UserGroupUpdateResponseEnvelopeMessages) UnmarshalJSON

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

type UserGroupUpdateResponseEnvelopeMessagesSource

type UserGroupUpdateResponseEnvelopeMessagesSource struct {
	Pointer string                                            `json:"pointer"`
	JSON    userGroupUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*UserGroupUpdateResponseEnvelopeMessagesSource) UnmarshalJSON

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

type UserGroupUpdateResponseEnvelopeSuccess

type UserGroupUpdateResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	UserGroupUpdateResponseEnvelopeSuccessTrue UserGroupUpdateResponseEnvelopeSuccess = true
)

func (UserGroupUpdateResponseEnvelopeSuccess) IsKnown

type UserGroupUpdateResponsePoliciesAccess

type UserGroupUpdateResponsePoliciesAccess string

Allow or deny operations against the resources.

const (
	UserGroupUpdateResponsePoliciesAccessAllow UserGroupUpdateResponsePoliciesAccess = "allow"
	UserGroupUpdateResponsePoliciesAccessDeny  UserGroupUpdateResponsePoliciesAccess = "deny"
)

func (UserGroupUpdateResponsePoliciesAccess) IsKnown

type UserGroupUpdateResponsePoliciesPermissionGroup

type UserGroupUpdateResponsePoliciesPermissionGroup struct {
	// Identifier of the permission group.
	ID string `json:"id,required"`
	// Attributes associated to the permission group.
	Meta UserGroupUpdateResponsePoliciesPermissionGroupsMeta `json:"meta"`
	// Name of the permission group.
	Name string                                             `json:"name"`
	JSON userGroupUpdateResponsePoliciesPermissionGroupJSON `json:"-"`
}

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

func (*UserGroupUpdateResponsePoliciesPermissionGroup) UnmarshalJSON

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

type UserGroupUpdateResponsePoliciesPermissionGroupsMeta

type UserGroupUpdateResponsePoliciesPermissionGroupsMeta struct {
	Key   string                                                  `json:"key"`
	Value string                                                  `json:"value"`
	JSON  userGroupUpdateResponsePoliciesPermissionGroupsMetaJSON `json:"-"`
}

Attributes associated to the permission group.

func (*UserGroupUpdateResponsePoliciesPermissionGroupsMeta) UnmarshalJSON

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

type UserGroupUpdateResponsePoliciesResourceGroup

type UserGroupUpdateResponsePoliciesResourceGroup struct {
	// Identifier of the resource group.
	ID string `json:"id,required"`
	// The scope associated to the resource group
	Scope []UserGroupUpdateResponsePoliciesResourceGroupsScope `json:"scope,required"`
	// Attributes associated to the resource group.
	Meta UserGroupUpdateResponsePoliciesResourceGroupsMeta `json:"meta"`
	// Name of the resource group.
	Name string                                           `json:"name"`
	JSON userGroupUpdateResponsePoliciesResourceGroupJSON `json:"-"`
}

A group of scoped resources.

func (*UserGroupUpdateResponsePoliciesResourceGroup) UnmarshalJSON

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

type UserGroupUpdateResponsePoliciesResourceGroupsMeta

type UserGroupUpdateResponsePoliciesResourceGroupsMeta struct {
	Key   string                                                `json:"key"`
	Value string                                                `json:"value"`
	JSON  userGroupUpdateResponsePoliciesResourceGroupsMetaJSON `json:"-"`
}

Attributes associated to the resource group.

func (*UserGroupUpdateResponsePoliciesResourceGroupsMeta) UnmarshalJSON

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

type UserGroupUpdateResponsePoliciesResourceGroupsScope

type UserGroupUpdateResponsePoliciesResourceGroupsScope struct {
	// This is a combination of pre-defined resource name and identifier (like Account
	// ID etc.)
	Key string `json:"key,required"`
	// A list of scope objects for additional context.
	Objects []UserGroupUpdateResponsePoliciesResourceGroupsScopeObject `json:"objects,required"`
	JSON    userGroupUpdateResponsePoliciesResourceGroupsScopeJSON     `json:"-"`
}

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

func (*UserGroupUpdateResponsePoliciesResourceGroupsScope) UnmarshalJSON

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

type UserGroupUpdateResponsePoliciesResourceGroupsScopeObject

type UserGroupUpdateResponsePoliciesResourceGroupsScopeObject struct {
	// This is a combination of pre-defined resource name and identifier (like Zone ID
	// etc.)
	Key  string                                                       `json:"key,required"`
	JSON userGroupUpdateResponsePoliciesResourceGroupsScopeObjectJSON `json:"-"`
}

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

func (*UserGroupUpdateResponsePoliciesResourceGroupsScopeObject) UnmarshalJSON

type UserGroupUpdateResponsePolicy

type UserGroupUpdateResponsePolicy struct {
	// Policy identifier.
	ID string `json:"id"`
	// Allow or deny operations against the resources.
	Access UserGroupUpdateResponsePoliciesAccess `json:"access"`
	// A set of permission groups that are specified to the policy.
	PermissionGroups []UserGroupUpdateResponsePoliciesPermissionGroup `json:"permission_groups"`
	// A list of resource groups that the policy applies to.
	ResourceGroups []UserGroupUpdateResponsePoliciesResourceGroup `json:"resource_groups"`
	JSON           userGroupUpdateResponsePolicyJSON              `json:"-"`
}

Policy

func (*UserGroupUpdateResponsePolicy) UnmarshalJSON

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL