zero_trust

package
v2.0.0-beta.4 Latest Latest
Warning

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

 Go to latest Published: Mar 12, 2024 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessAccessRequests 

type AccessAccessRequests struct {
	// The event that occurred, such as a login attempt.
	Action string `json:"action"`
	// The result of the authentication event.
	Allowed bool `json:"allowed"`
	// The URL of the Access application.
	AppDomain string `json:"app_domain"`
	// The unique identifier for the Access application.
	AppUid interface{} `json:"app_uid"`
	// The IdP used to authenticate.
	Connection string    `json:"connection"`
	CreatedAt  time.Time `json:"created_at" format:"date-time"`
	// The IP address of the authenticating user.
	IPAddress string `json:"ip_address"`
	// The unique identifier for the request to Cloudflare.
	RayID string `json:"ray_id"`
	// The email address of the authenticating user.
	UserEmail string                   `json:"user_email" format:"email"`
	JSON      accessAccessRequestsJSON `json:"-"`
}

func (*AccessAccessRequests) UnmarshalJSON 

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

type AccessApplicationCADeleteParams 

type AccessApplicationCADeleteParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type AccessApplicationCADeleteResponse 

type AccessApplicationCADeleteResponse struct {
	// The ID of the CA.
	ID   string                                `json:"id"`
	JSON accessApplicationCADeleteResponseJSON `json:"-"`
}

func (*AccessApplicationCADeleteResponse) UnmarshalJSON 

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

type AccessApplicationCADeleteResponseEnvelope 

type AccessApplicationCADeleteResponseEnvelope struct {
	Errors   []AccessApplicationCADeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessApplicationCADeleteResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessApplicationCADeleteResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success AccessApplicationCADeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessApplicationCADeleteResponseEnvelopeJSON    `json:"-"`
}

func (*AccessApplicationCADeleteResponseEnvelope) UnmarshalJSON 

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

type AccessApplicationCADeleteResponseEnvelopeErrors 

type AccessApplicationCADeleteResponseEnvelopeErrors struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    accessApplicationCADeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessApplicationCADeleteResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessApplicationCADeleteResponseEnvelopeMessages 

type AccessApplicationCADeleteResponseEnvelopeMessages struct {
	Code    int64                                                 `json:"code,required"`
	Message string                                                `json:"message,required"`
	JSON    accessApplicationCADeleteResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessApplicationCADeleteResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessApplicationCADeleteResponseEnvelopeSuccess 

type AccessApplicationCADeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessApplicationCADeleteResponseEnvelopeSuccessTrue AccessApplicationCADeleteResponseEnvelopeSuccess = true
)

type AccessApplicationCAGetParams 

type AccessApplicationCAGetParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type AccessApplicationCAGetResponse 

type AccessApplicationCAGetResponse interface {
	ImplementsZeroTrustAccessApplicationCAGetResponse()
}

Union satisfied by zero_trust.AccessApplicationCAGetResponseUnknown or shared.UnionString.

type AccessApplicationCAGetResponseEnvelope 

type AccessApplicationCAGetResponseEnvelope struct {
	Errors   []AccessApplicationCAGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessApplicationCAGetResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessApplicationCAGetResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success AccessApplicationCAGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessApplicationCAGetResponseEnvelopeJSON    `json:"-"`
}

func (*AccessApplicationCAGetResponseEnvelope) UnmarshalJSON 

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

type AccessApplicationCAGetResponseEnvelopeErrors 

type AccessApplicationCAGetResponseEnvelopeErrors struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    accessApplicationCAGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessApplicationCAGetResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessApplicationCAGetResponseEnvelopeMessages 

type AccessApplicationCAGetResponseEnvelopeMessages struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    accessApplicationCAGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessApplicationCAGetResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessApplicationCAGetResponseEnvelopeSuccess 

type AccessApplicationCAGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessApplicationCAGetResponseEnvelopeSuccessTrue AccessApplicationCAGetResponseEnvelopeSuccess = true
)

type AccessApplicationCAListParams 

type AccessApplicationCAListParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type AccessApplicationCAListResponseEnvelope 

type AccessApplicationCAListResponseEnvelope struct {
	Errors   []AccessApplicationCAListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessApplicationCAListResponseEnvelopeMessages `json:"messages,required"`
	Result   []AccessCA                                        `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    AccessApplicationCAListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo AccessApplicationCAListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       accessApplicationCAListResponseEnvelopeJSON       `json:"-"`
}

func (*AccessApplicationCAListResponseEnvelope) UnmarshalJSON 

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

type AccessApplicationCAListResponseEnvelopeErrors 

type AccessApplicationCAListResponseEnvelopeErrors struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    accessApplicationCAListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessApplicationCAListResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessApplicationCAListResponseEnvelopeMessages 

type AccessApplicationCAListResponseEnvelopeMessages struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    accessApplicationCAListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessApplicationCAListResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessApplicationCAListResponseEnvelopeResultInfo 

type AccessApplicationCAListResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                               `json:"total_count"`
	JSON       accessApplicationCAListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*AccessApplicationCAListResponseEnvelopeResultInfo) UnmarshalJSON 

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

type AccessApplicationCAListResponseEnvelopeSuccess 

type AccessApplicationCAListResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessApplicationCAListResponseEnvelopeSuccessTrue AccessApplicationCAListResponseEnvelopeSuccess = true
)

type AccessApplicationCANewParams 

type AccessApplicationCANewParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type AccessApplicationCANewResponse 

type AccessApplicationCANewResponse interface {
	ImplementsZeroTrustAccessApplicationCANewResponse()
}

Union satisfied by zero_trust.AccessApplicationCANewResponseUnknown or shared.UnionString.

type AccessApplicationCANewResponseEnvelope 

type AccessApplicationCANewResponseEnvelope struct {
	Errors   []AccessApplicationCANewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessApplicationCANewResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessApplicationCANewResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success AccessApplicationCANewResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessApplicationCANewResponseEnvelopeJSON    `json:"-"`
}

func (*AccessApplicationCANewResponseEnvelope) UnmarshalJSON 

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

type AccessApplicationCANewResponseEnvelopeErrors 

type AccessApplicationCANewResponseEnvelopeErrors struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    accessApplicationCANewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessApplicationCANewResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessApplicationCANewResponseEnvelopeMessages 

type AccessApplicationCANewResponseEnvelopeMessages struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    accessApplicationCANewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessApplicationCANewResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessApplicationCANewResponseEnvelopeSuccess 

type AccessApplicationCANewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessApplicationCANewResponseEnvelopeSuccessTrue AccessApplicationCANewResponseEnvelopeSuccess = true
)

type AccessApplicationCAService 

type AccessApplicationCAService struct {
	Options []option.RequestOption
}

AccessApplicationCAService 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 NewAccessApplicationCAService method instead.

func NewAccessApplicationCAService 

func NewAccessApplicationCAService(opts ...option.RequestOption) (r *AccessApplicationCAService)

NewAccessApplicationCAService 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 (*AccessApplicationCAService) Delete 

func (r *AccessApplicationCAService) Delete(ctx context.Context, uuid string, body AccessApplicationCADeleteParams, opts ...option.RequestOption) (res *AccessApplicationCADeleteResponse, err error)

Deletes a short-lived certificate CA.

func (*AccessApplicationCAService) Get 

func (r *AccessApplicationCAService) Get(ctx context.Context, uuid string, query AccessApplicationCAGetParams, opts ...option.RequestOption) (res *AccessApplicationCAGetResponse, err error)

Fetches a short-lived certificate CA and its public key.

func (*AccessApplicationCAService) List 

func (r *AccessApplicationCAService) List(ctx context.Context, query AccessApplicationCAListParams, opts ...option.RequestOption) (res *[]AccessCA, err error)

Lists short-lived certificate CAs and their public keys.

func (*AccessApplicationCAService) New 

func (r *AccessApplicationCAService) New(ctx context.Context, uuid string, body AccessApplicationCANewParams, opts ...option.RequestOption) (res *AccessApplicationCANewResponse, err error)

Generates a new short-lived certificate CA and public key.

type AccessApplicationDeleteParams 

type AccessApplicationDeleteParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type AccessApplicationDeleteParamsAppID 

type AccessApplicationDeleteParamsAppID interface {
	ImplementsZeroTrustAccessApplicationDeleteParamsAppID()
}

Identifier

Satisfied by shared.UnionString, shared.UnionString.

type AccessApplicationDeleteResponse 

type AccessApplicationDeleteResponse struct {
	// UUID
	ID   string                              `json:"id"`
	JSON accessApplicationDeleteResponseJSON `json:"-"`
}

func (*AccessApplicationDeleteResponse) UnmarshalJSON 

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

type AccessApplicationDeleteResponseEnvelope 

type AccessApplicationDeleteResponseEnvelope struct {
	Errors   []AccessApplicationDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessApplicationDeleteResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessApplicationDeleteResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success AccessApplicationDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessApplicationDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*AccessApplicationDeleteResponseEnvelope) UnmarshalJSON 

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

type AccessApplicationDeleteResponseEnvelopeErrors 

type AccessApplicationDeleteResponseEnvelopeErrors struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    accessApplicationDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessApplicationDeleteResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessApplicationDeleteResponseEnvelopeMessages 

type AccessApplicationDeleteResponseEnvelopeMessages struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    accessApplicationDeleteResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessApplicationDeleteResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessApplicationDeleteResponseEnvelopeSuccess 

type AccessApplicationDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessApplicationDeleteResponseEnvelopeSuccessTrue AccessApplicationDeleteResponseEnvelopeSuccess = true
)

type AccessApplicationGetParams 

type AccessApplicationGetParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type AccessApplicationGetParamsAppID 

type AccessApplicationGetParamsAppID interface {
	ImplementsZeroTrustAccessApplicationGetParamsAppID()
}

Identifier

Satisfied by shared.UnionString, shared.UnionString.

type AccessApplicationGetResponseEnvelope 

type AccessApplicationGetResponseEnvelope struct {
	Errors   []AccessApplicationGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessApplicationGetResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessApps                                     `json:"result,required"`
	// Whether the API call was successful
	Success AccessApplicationGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessApplicationGetResponseEnvelopeJSON    `json:"-"`
}

func (*AccessApplicationGetResponseEnvelope) UnmarshalJSON 

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

type AccessApplicationGetResponseEnvelopeErrors 

type AccessApplicationGetResponseEnvelopeErrors struct {
	Code    int64                                          `json:"code,required"`
	Message string                                         `json:"message,required"`
	JSON    accessApplicationGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessApplicationGetResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessApplicationGetResponseEnvelopeMessages 

type AccessApplicationGetResponseEnvelopeMessages struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    accessApplicationGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessApplicationGetResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessApplicationGetResponseEnvelopeSuccess 

type AccessApplicationGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessApplicationGetResponseEnvelopeSuccessTrue AccessApplicationGetResponseEnvelopeSuccess = true
)

type AccessApplicationListParams 

type AccessApplicationListParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type AccessApplicationListResponseEnvelope 

type AccessApplicationListResponseEnvelope struct {
	Errors   []AccessApplicationListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessApplicationListResponseEnvelopeMessages `json:"messages,required"`
	Result   []AccessApps                                    `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    AccessApplicationListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo AccessApplicationListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       accessApplicationListResponseEnvelopeJSON       `json:"-"`
}

func (*AccessApplicationListResponseEnvelope) UnmarshalJSON 

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

type AccessApplicationListResponseEnvelopeErrors 

type AccessApplicationListResponseEnvelopeErrors struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    accessApplicationListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessApplicationListResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessApplicationListResponseEnvelopeMessages 

type AccessApplicationListResponseEnvelopeMessages struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    accessApplicationListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessApplicationListResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessApplicationListResponseEnvelopeResultInfo 

type AccessApplicationListResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                             `json:"total_count"`
	JSON       accessApplicationListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*AccessApplicationListResponseEnvelopeResultInfo) UnmarshalJSON 

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

type AccessApplicationListResponseEnvelopeSuccess 

type AccessApplicationListResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessApplicationListResponseEnvelopeSuccessTrue AccessApplicationListResponseEnvelopeSuccess = true
)

type AccessApplicationNewParams 

type AccessApplicationNewParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
	// When set to true, users can authenticate to this application using their WARP
	// session. When set to false this application will always require direct IdP
	// authentication. This setting always overrides the organization setting for WARP
	// authentication.
	AllowAuthenticateViaWARP param.Field[bool] `json:"allow_authenticate_via_warp"`
	// The identity providers your users can select when connecting to this
	// application. Defaults to all IdPs configured in your account.
	AllowedIdps        param.Field[[]string]    `json:"allowed_idps"`
	AppLauncherVisible param.Field[interface{}] `json:"app_launcher_visible"`
	// When set to `true`, users skip the identity provider selection step during
	// login. You must specify only one identity provider in allowed_idps.
	AutoRedirectToIdentity param.Field[bool]                                  `json:"auto_redirect_to_identity"`
	CorsHeaders            param.Field[AccessApplicationNewParamsCorsHeaders] `json:"cors_headers"`
	// The custom error message shown to a user when they are denied access to the
	// application.
	CustomDenyMessage param.Field[string] `json:"custom_deny_message"`
	// The custom URL a user is redirected to when they are denied access to the
	// application when failing identity-based rules.
	CustomDenyURL param.Field[string] `json:"custom_deny_url"`
	// The custom URL a user is redirected to when they are denied access to the
	// application when failing non-identity rules.
	CustomNonIdentityDenyURL param.Field[string] `json:"custom_non_identity_deny_url"`
	// The custom pages that will be displayed when applicable for this application
	CustomPages param.Field[[]string] `json:"custom_pages"`
	// The URL or domain of the bookmark.
	Domain param.Field[interface{}] `json:"domain"`
	// Enables the binding cookie, which increases security against compromised
	// authorization tokens and CSRF attacks.
	EnableBindingCookie param.Field[bool] `json:"enable_binding_cookie"`
	// Enables the HttpOnly cookie attribute, which increases security against XSS
	// attacks.
	HTTPOnlyCookieAttribute param.Field[bool] `json:"http_only_cookie_attribute"`
	// The image URL for the logo shown in the App Launcher dashboard.
	LogoURL param.Field[string] `json:"logo_url"`
	// The name of the application.
	Name param.Field[string] `json:"name"`
	// Enables cookie paths to scope an application's JWT to the application path. If
	// disabled, the JWT will scope to the hostname by default
	PathCookieAttribute param.Field[bool]                              `json:"path_cookie_attribute"`
	SaasApp             param.Field[AccessApplicationNewParamsSaasApp] `json:"saas_app"`
	// Sets the SameSite cookie setting, which provides increased security against CSRF
	// attacks.
	SameSiteCookieAttribute param.Field[string] `json:"same_site_cookie_attribute"`
	// List of domains that Access will secure.
	SelfHostedDomains param.Field[[]string] `json:"self_hosted_domains"`
	// Returns a 401 status code when the request is blocked by a Service Auth policy.
	ServiceAuth401Redirect param.Field[bool] `json:"service_auth_401_redirect"`
	// The amount of time that tokens issued for this application will be valid. Must
	// be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms,
	// s, m, h.
	SessionDuration param.Field[string] `json:"session_duration"`
	// Enables automatic authentication through cloudflared.
	SkipInterstitial param.Field[bool] `json:"skip_interstitial"`
	// The tags you want assigned to an application. Tags are used to filter
	// applications in the App Launcher dashboard.
	Tags param.Field[[]string] `json:"tags"`
	// The application type.
	Type param.Field[string] `json:"type"`
}

func (AccessApplicationNewParams) MarshalJSON 

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

type AccessApplicationNewParamsCorsHeaders 

type AccessApplicationNewParamsCorsHeaders struct {
	// Allows all HTTP request headers.
	AllowAllHeaders param.Field[bool] `json:"allow_all_headers"`
	// Allows all HTTP request methods.
	AllowAllMethods param.Field[bool] `json:"allow_all_methods"`
	// Allows all origins.
	AllowAllOrigins param.Field[bool] `json:"allow_all_origins"`
	// When set to `true`, includes credentials (cookies, authorization headers, or TLS
	// client certificates) with requests.
	AllowCredentials param.Field[bool] `json:"allow_credentials"`
	// Allowed HTTP request headers.
	AllowedHeaders param.Field[[]interface{}] `json:"allowed_headers"`
	// Allowed HTTP request methods.
	AllowedMethods param.Field[[]AccessApplicationNewParamsCorsHeadersAllowedMethod] `json:"allowed_methods"`
	// Allowed origins.
	AllowedOrigins param.Field[[]interface{}] `json:"allowed_origins"`
	// The maximum number of seconds the results of a preflight request can be cached.
	MaxAge param.Field[float64] `json:"max_age"`
}

func (AccessApplicationNewParamsCorsHeaders) MarshalJSON 

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

type AccessApplicationNewParamsCorsHeadersAllowedMethod 

type AccessApplicationNewParamsCorsHeadersAllowedMethod string
const (
	AccessApplicationNewParamsCorsHeadersAllowedMethodGet     AccessApplicationNewParamsCorsHeadersAllowedMethod = "GET"
	AccessApplicationNewParamsCorsHeadersAllowedMethodPost    AccessApplicationNewParamsCorsHeadersAllowedMethod = "POST"
	AccessApplicationNewParamsCorsHeadersAllowedMethodHead    AccessApplicationNewParamsCorsHeadersAllowedMethod = "HEAD"
	AccessApplicationNewParamsCorsHeadersAllowedMethodPut     AccessApplicationNewParamsCorsHeadersAllowedMethod = "PUT"
	AccessApplicationNewParamsCorsHeadersAllowedMethodDelete  AccessApplicationNewParamsCorsHeadersAllowedMethod = "DELETE"
	AccessApplicationNewParamsCorsHeadersAllowedMethodConnect AccessApplicationNewParamsCorsHeadersAllowedMethod = "CONNECT"
	AccessApplicationNewParamsCorsHeadersAllowedMethodOptions AccessApplicationNewParamsCorsHeadersAllowedMethod = "OPTIONS"
	AccessApplicationNewParamsCorsHeadersAllowedMethodTrace   AccessApplicationNewParamsCorsHeadersAllowedMethod = "TRACE"
	AccessApplicationNewParamsCorsHeadersAllowedMethodPatch   AccessApplicationNewParamsCorsHeadersAllowedMethod = "PATCH"
)

type AccessApplicationNewParamsSaasApp 

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

Satisfied by zero_trust.AccessApplicationNewParamsSaasAppAccessSamlSaasApp, zero_trust.AccessApplicationNewParamsSaasAppAccessOidcSaasApp.

type AccessApplicationNewParamsSaasAppAccessOidcSaasApp 

type AccessApplicationNewParamsSaasAppAccessOidcSaasApp struct {
	// The URL where this applications tile redirects users
	AppLauncherURL param.Field[string] `json:"app_launcher_url"`
	// Identifier of the authentication protocol used for the saas app. Required for
	// OIDC.
	AuthType param.Field[AccessApplicationNewParamsSaasAppAccessOidcSaasAppAuthType] `json:"auth_type"`
	// The application client id
	ClientID param.Field[string] `json:"client_id"`
	// The application client secret, only returned on POST request.
	ClientSecret param.Field[string] `json:"client_secret"`
	// The OIDC flows supported by this application
	GrantTypes param.Field[[]AccessApplicationNewParamsSaasAppAccessOidcSaasAppGrantType] `json:"grant_types"`
	// A regex to filter Cloudflare groups returned in ID token and userinfo endpoint
	GroupFilterRegex param.Field[string] `json:"group_filter_regex"`
	// The Access public certificate that will be used to verify your identity.
	PublicKey param.Field[string] `json:"public_key"`
	// The permitted URL's for Cloudflare to return Authorization codes and Access/ID
	// tokens
	RedirectURIs param.Field[[]string] `json:"redirect_uris"`
	// Define the user information shared with access
	Scopes param.Field[[]AccessApplicationNewParamsSaasAppAccessOidcSaasAppScope] `json:"scopes"`
}

func (AccessApplicationNewParamsSaasAppAccessOidcSaasApp) MarshalJSON 

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

type AccessApplicationNewParamsSaasAppAccessOidcSaasAppAuthType 

type AccessApplicationNewParamsSaasAppAccessOidcSaasAppAuthType string

Identifier of the authentication protocol used for the saas app. Required for OIDC. 

const (
	AccessApplicationNewParamsSaasAppAccessOidcSaasAppAuthTypeSaml AccessApplicationNewParamsSaasAppAccessOidcSaasAppAuthType = "saml"
	AccessApplicationNewParamsSaasAppAccessOidcSaasAppAuthTypeOidc AccessApplicationNewParamsSaasAppAccessOidcSaasAppAuthType = "oidc"
)

type AccessApplicationNewParamsSaasAppAccessOidcSaasAppGrantType 

type AccessApplicationNewParamsSaasAppAccessOidcSaasAppGrantType string
const (
	AccessApplicationNewParamsSaasAppAccessOidcSaasAppGrantTypeAuthorizationCode         AccessApplicationNewParamsSaasAppAccessOidcSaasAppGrantType = "authorization_code"
	AccessApplicationNewParamsSaasAppAccessOidcSaasAppGrantTypeAuthorizationCodeWithPkce AccessApplicationNewParamsSaasAppAccessOidcSaasAppGrantType = "authorization_code_with_pkce"
)

type AccessApplicationNewParamsSaasAppAccessOidcSaasAppScope 

type AccessApplicationNewParamsSaasAppAccessOidcSaasAppScope string
const (
	AccessApplicationNewParamsSaasAppAccessOidcSaasAppScopeOpenid  AccessApplicationNewParamsSaasAppAccessOidcSaasAppScope = "openid"
	AccessApplicationNewParamsSaasAppAccessOidcSaasAppScopeGroups  AccessApplicationNewParamsSaasAppAccessOidcSaasAppScope = "groups"
	AccessApplicationNewParamsSaasAppAccessOidcSaasAppScopeEmail   AccessApplicationNewParamsSaasAppAccessOidcSaasAppScope = "email"
	AccessApplicationNewParamsSaasAppAccessOidcSaasAppScopeProfile AccessApplicationNewParamsSaasAppAccessOidcSaasAppScope = "profile"
)

type AccessApplicationNewParamsSaasAppAccessSamlSaasApp 

type AccessApplicationNewParamsSaasAppAccessSamlSaasApp struct {
	// Optional identifier indicating the authentication protocol used for the saas
	// app. Required for OIDC. Default if unset is "saml"
	AuthType param.Field[AccessApplicationNewParamsSaasAppAccessSamlSaasAppAuthType] `json:"auth_type"`
	// The service provider's endpoint that is responsible for receiving and parsing a
	// SAML assertion.
	ConsumerServiceURL param.Field[string]                                                             `json:"consumer_service_url"`
	CustomAttributes   param.Field[AccessApplicationNewParamsSaasAppAccessSamlSaasAppCustomAttributes] `json:"custom_attributes"`
	// The URL that the user will be redirected to after a successful login for IDP
	// initiated logins.
	DefaultRelayState param.Field[string] `json:"default_relay_state"`
	// The unique identifier for your SaaS application.
	IdpEntityID param.Field[string] `json:"idp_entity_id"`
	// The format of the name identifier sent to the SaaS application.
	NameIDFormat param.Field[AccessApplicationNewParamsSaasAppAccessSamlSaasAppNameIDFormat] `json:"name_id_format"`
	// A [JSONata](https://jsonata.org/) expression that transforms an application's
	// user identities into a NameID value for its SAML assertion. This expression
	// should evaluate to a singular string. The output of this expression can override
	// the `name_id_format` setting.
	NameIDTransformJsonata param.Field[string] `json:"name_id_transform_jsonata"`
	// The Access public certificate that will be used to verify your identity.
	PublicKey param.Field[string] `json:"public_key"`
	// A globally unique name for an identity or service provider.
	SpEntityID param.Field[string] `json:"sp_entity_id"`
	// The endpoint where your SaaS application will send login requests.
	SSOEndpoint param.Field[string] `json:"sso_endpoint"`
}

func (AccessApplicationNewParamsSaasAppAccessSamlSaasApp) MarshalJSON 

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

type AccessApplicationNewParamsSaasAppAccessSamlSaasAppAuthType 

type AccessApplicationNewParamsSaasAppAccessSamlSaasAppAuthType string

Optional identifier indicating the authentication protocol used for the saas app. Required for OIDC. Default if unset is "saml" 

const (
	AccessApplicationNewParamsSaasAppAccessSamlSaasAppAuthTypeSaml AccessApplicationNewParamsSaasAppAccessSamlSaasAppAuthType = "saml"
	AccessApplicationNewParamsSaasAppAccessSamlSaasAppAuthTypeOidc AccessApplicationNewParamsSaasAppAccessSamlSaasAppAuthType = "oidc"
)

type AccessApplicationNewParamsSaasAppAccessSamlSaasAppCustomAttributes 

type AccessApplicationNewParamsSaasAppAccessSamlSaasAppCustomAttributes struct {
	// The name of the attribute.
	Name param.Field[string] `json:"name"`
	// A globally unique name for an identity or service provider.
	NameFormat param.Field[AccessApplicationNewParamsSaasAppAccessSamlSaasAppCustomAttributesNameFormat] `json:"name_format"`
	Source     param.Field[AccessApplicationNewParamsSaasAppAccessSamlSaasAppCustomAttributesSource]     `json:"source"`
}

func (AccessApplicationNewParamsSaasAppAccessSamlSaasAppCustomAttributes) MarshalJSON 

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

type AccessApplicationNewParamsSaasAppAccessSamlSaasAppCustomAttributesNameFormat 

type AccessApplicationNewParamsSaasAppAccessSamlSaasAppCustomAttributesNameFormat string

A globally unique name for an identity or service provider. 

const (
	AccessApplicationNewParamsSaasAppAccessSamlSaasAppCustomAttributesNameFormatUrnOasisNamesTcSaml2_0AttrnameFormatUnspecified AccessApplicationNewParamsSaasAppAccessSamlSaasAppCustomAttributesNameFormat = "urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified"
	AccessApplicationNewParamsSaasAppAccessSamlSaasAppCustomAttributesNameFormatUrnOasisNamesTcSaml2_0AttrnameFormatBasic       AccessApplicationNewParamsSaasAppAccessSamlSaasAppCustomAttributesNameFormat = "urn:oasis:names:tc:SAML:2.0:attrname-format:basic"
	AccessApplicationNewParamsSaasAppAccessSamlSaasAppCustomAttributesNameFormatUrnOasisNamesTcSaml2_0AttrnameFormatURI         AccessApplicationNewParamsSaasAppAccessSamlSaasAppCustomAttributesNameFormat = "urn:oasis:names:tc:SAML:2.0:attrname-format:uri"
)

type AccessApplicationNewParamsSaasAppAccessSamlSaasAppCustomAttributesSource 

type AccessApplicationNewParamsSaasAppAccessSamlSaasAppCustomAttributesSource struct {
	// The name of the IdP attribute.
	Name param.Field[string] `json:"name"`
}

func (AccessApplicationNewParamsSaasAppAccessSamlSaasAppCustomAttributesSource) MarshalJSON 

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

type AccessApplicationNewParamsSaasAppAccessSamlSaasAppNameIDFormat 

type AccessApplicationNewParamsSaasAppAccessSamlSaasAppNameIDFormat string

The format of the name identifier sent to the SaaS application. 

const (
	AccessApplicationNewParamsSaasAppAccessSamlSaasAppNameIDFormatID    AccessApplicationNewParamsSaasAppAccessSamlSaasAppNameIDFormat = "id"
	AccessApplicationNewParamsSaasAppAccessSamlSaasAppNameIDFormatEmail AccessApplicationNewParamsSaasAppAccessSamlSaasAppNameIDFormat = "email"
)

type AccessApplicationNewResponseEnvelope 

type AccessApplicationNewResponseEnvelope struct {
	Errors   []AccessApplicationNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessApplicationNewResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessApps                                     `json:"result,required"`
	// Whether the API call was successful
	Success AccessApplicationNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessApplicationNewResponseEnvelopeJSON    `json:"-"`
}

func (*AccessApplicationNewResponseEnvelope) UnmarshalJSON 

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

type AccessApplicationNewResponseEnvelopeErrors 

type AccessApplicationNewResponseEnvelopeErrors struct {
	Code    int64                                          `json:"code,required"`
	Message string                                         `json:"message,required"`
	JSON    accessApplicationNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessApplicationNewResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessApplicationNewResponseEnvelopeMessages 

type AccessApplicationNewResponseEnvelopeMessages struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    accessApplicationNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessApplicationNewResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessApplicationNewResponseEnvelopeSuccess 

type AccessApplicationNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessApplicationNewResponseEnvelopeSuccessTrue AccessApplicationNewResponseEnvelopeSuccess = true
)

type AccessApplicationPolicyDeleteParams 

type AccessApplicationPolicyDeleteParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type AccessApplicationPolicyDeleteResponse 

type AccessApplicationPolicyDeleteResponse struct {
	// UUID
	ID   string                                    `json:"id"`
	JSON accessApplicationPolicyDeleteResponseJSON `json:"-"`
}

func (*AccessApplicationPolicyDeleteResponse) UnmarshalJSON 

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

type AccessApplicationPolicyDeleteResponseEnvelope 

type AccessApplicationPolicyDeleteResponseEnvelope struct {
	Errors   []AccessApplicationPolicyDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessApplicationPolicyDeleteResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessApplicationPolicyDeleteResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success AccessApplicationPolicyDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessApplicationPolicyDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*AccessApplicationPolicyDeleteResponseEnvelope) UnmarshalJSON 

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

type AccessApplicationPolicyDeleteResponseEnvelopeErrors 

type AccessApplicationPolicyDeleteResponseEnvelopeErrors struct {
	Code    int64                                                   `json:"code,required"`
	Message string                                                  `json:"message,required"`
	JSON    accessApplicationPolicyDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessApplicationPolicyDeleteResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessApplicationPolicyDeleteResponseEnvelopeMessages 

type AccessApplicationPolicyDeleteResponseEnvelopeMessages struct {
	Code    int64                                                     `json:"code,required"`
	Message string                                                    `json:"message,required"`
	JSON    accessApplicationPolicyDeleteResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessApplicationPolicyDeleteResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessApplicationPolicyDeleteResponseEnvelopeSuccess 

type AccessApplicationPolicyDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessApplicationPolicyDeleteResponseEnvelopeSuccessTrue AccessApplicationPolicyDeleteResponseEnvelopeSuccess = true
)

type AccessApplicationPolicyGetParams 

type AccessApplicationPolicyGetParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type AccessApplicationPolicyGetResponseEnvelope 

type AccessApplicationPolicyGetResponseEnvelope struct {
	Errors   []AccessApplicationPolicyGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessApplicationPolicyGetResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessPolicies                                       `json:"result,required"`
	// Whether the API call was successful
	Success AccessApplicationPolicyGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessApplicationPolicyGetResponseEnvelopeJSON    `json:"-"`
}

func (*AccessApplicationPolicyGetResponseEnvelope) UnmarshalJSON 

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

type AccessApplicationPolicyGetResponseEnvelopeErrors 

type AccessApplicationPolicyGetResponseEnvelopeErrors struct {
	Code    int64                                                `json:"code,required"`
	Message string                                               `json:"message,required"`
	JSON    accessApplicationPolicyGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessApplicationPolicyGetResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessApplicationPolicyGetResponseEnvelopeMessages 

type AccessApplicationPolicyGetResponseEnvelopeMessages struct {
	Code    int64                                                  `json:"code,required"`
	Message string                                                 `json:"message,required"`
	JSON    accessApplicationPolicyGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessApplicationPolicyGetResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessApplicationPolicyGetResponseEnvelopeSuccess 

type AccessApplicationPolicyGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessApplicationPolicyGetResponseEnvelopeSuccessTrue AccessApplicationPolicyGetResponseEnvelopeSuccess = true
)

type AccessApplicationPolicyListParams 

type AccessApplicationPolicyListParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type AccessApplicationPolicyListResponseEnvelope 

type AccessApplicationPolicyListResponseEnvelope struct {
	Errors   []AccessApplicationPolicyListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessApplicationPolicyListResponseEnvelopeMessages `json:"messages,required"`
	Result   []AccessPolicies                                      `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    AccessApplicationPolicyListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo AccessApplicationPolicyListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       accessApplicationPolicyListResponseEnvelopeJSON       `json:"-"`
}

func (*AccessApplicationPolicyListResponseEnvelope) UnmarshalJSON 

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

type AccessApplicationPolicyListResponseEnvelopeErrors 

type AccessApplicationPolicyListResponseEnvelopeErrors struct {
	Code    int64                                                 `json:"code,required"`
	Message string                                                `json:"message,required"`
	JSON    accessApplicationPolicyListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessApplicationPolicyListResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessApplicationPolicyListResponseEnvelopeMessages 

type AccessApplicationPolicyListResponseEnvelopeMessages struct {
	Code    int64                                                   `json:"code,required"`
	Message string                                                  `json:"message,required"`
	JSON    accessApplicationPolicyListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessApplicationPolicyListResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessApplicationPolicyListResponseEnvelopeResultInfo 

type AccessApplicationPolicyListResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                                   `json:"total_count"`
	JSON       accessApplicationPolicyListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*AccessApplicationPolicyListResponseEnvelopeResultInfo) UnmarshalJSON 

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

type AccessApplicationPolicyListResponseEnvelopeSuccess 

type AccessApplicationPolicyListResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessApplicationPolicyListResponseEnvelopeSuccessTrue AccessApplicationPolicyListResponseEnvelopeSuccess = true
)

type AccessApplicationPolicyNewParams 

type AccessApplicationPolicyNewParams struct {
	// The action Access will take if a user matches this policy.
	Decision param.Field[AccessApplicationPolicyNewParamsDecision] `json:"decision,required"`
	// Rules evaluated with an OR logical operator. A user needs to meet only one of
	// the Include rules.
	Include param.Field[[]AccessApplicationPolicyNewParamsInclude] `json:"include,required"`
	// The name of the Access policy.
	Name param.Field[string] `json:"name,required"`
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
	// Administrators who can approve a temporary authentication request.
	ApprovalGroups param.Field[[]AccessApplicationPolicyNewParamsApprovalGroup] `json:"approval_groups"`
	// Requires the user to request access from an administrator at the start of each
	// session.
	ApprovalRequired param.Field[bool] `json:"approval_required"`
	// Rules evaluated with a NOT logical operator. To match the policy, a user cannot
	// meet any of the Exclude rules.
	Exclude param.Field[[]AccessApplicationPolicyNewParamsExclude] `json:"exclude"`
	// Require this application to be served in an isolated browser for users matching
	// this policy. 'Client Web Isolation' must be on for the account in order to use
	// this feature.
	IsolationRequired param.Field[bool] `json:"isolation_required"`
	// The order of execution for this policy. Must be unique for each policy.
	Precedence param.Field[int64] `json:"precedence"`
	// A custom message that will appear on the purpose justification screen.
	PurposeJustificationPrompt param.Field[string] `json:"purpose_justification_prompt"`
	// Require users to enter a justification when they log in to the application.
	PurposeJustificationRequired param.Field[bool] `json:"purpose_justification_required"`
	// Rules evaluated with an AND logical operator. To match the policy, a user must
	// meet all of the Require rules.
	Require param.Field[[]AccessApplicationPolicyNewParamsRequire] `json:"require"`
	// The amount of time that tokens issued for the application will be valid. Must be
	// in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s,
	// m, h.
	SessionDuration param.Field[string] `json:"session_duration"`
}

func (AccessApplicationPolicyNewParams) MarshalJSON 

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

type AccessApplicationPolicyNewParamsApprovalGroup 

type AccessApplicationPolicyNewParamsApprovalGroup struct {
	// The number of approvals needed to obtain access.
	ApprovalsNeeded param.Field[float64] `json:"approvals_needed,required"`
	// A list of emails that can approve the access request.
	EmailAddresses param.Field[[]interface{}] `json:"email_addresses"`
	// The UUID of an re-usable email list.
	EmailListUUID param.Field[string] `json:"email_list_uuid"`
}

A group of email addresses that can approve a temporary authentication request.

func (AccessApplicationPolicyNewParamsApprovalGroup) MarshalJSON 

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

type AccessApplicationPolicyNewParamsDecision 

type AccessApplicationPolicyNewParamsDecision string

The action Access will take if a user matches this policy. 

const (
	AccessApplicationPolicyNewParamsDecisionAllow       AccessApplicationPolicyNewParamsDecision = "allow"
	AccessApplicationPolicyNewParamsDecisionDeny        AccessApplicationPolicyNewParamsDecision = "deny"
	AccessApplicationPolicyNewParamsDecisionNonIdentity AccessApplicationPolicyNewParamsDecision = "non_identity"
	AccessApplicationPolicyNewParamsDecisionBypass      AccessApplicationPolicyNewParamsDecision = "bypass"
)

type AccessApplicationPolicyNewParamsExclude 

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

Matches a specific email.

Satisfied by zero_trust.AccessApplicationPolicyNewParamsExcludeAccessEmailRule, zero_trust.AccessApplicationPolicyNewParamsExcludeAccessEmailListRule, zero_trust.AccessApplicationPolicyNewParamsExcludeAccessDomainRule, zero_trust.AccessApplicationPolicyNewParamsExcludeAccessEveryoneRule, zero_trust.AccessApplicationPolicyNewParamsExcludeAccessIPRule, zero_trust.AccessApplicationPolicyNewParamsExcludeAccessIPListRule, zero_trust.AccessApplicationPolicyNewParamsExcludeAccessCertificateRule, zero_trust.AccessApplicationPolicyNewParamsExcludeAccessAccessGroupRule, zero_trust.AccessApplicationPolicyNewParamsExcludeAccessAzureGroupRule, zero_trust.AccessApplicationPolicyNewParamsExcludeAccessGitHubOrganizationRule, zero_trust.AccessApplicationPolicyNewParamsExcludeAccessGsuiteGroupRule, zero_trust.AccessApplicationPolicyNewParamsExcludeAccessOktaGroupRule, zero_trust.AccessApplicationPolicyNewParamsExcludeAccessSamlGroupRule, zero_trust.AccessApplicationPolicyNewParamsExcludeAccessServiceTokenRule, zero_trust.AccessApplicationPolicyNewParamsExcludeAccessAnyValidServiceTokenRule, zero_trust.AccessApplicationPolicyNewParamsExcludeAccessExternalEvaluationRule, zero_trust.AccessApplicationPolicyNewParamsExcludeAccessCountryRule, zero_trust.AccessApplicationPolicyNewParamsExcludeAccessAuthenticationMethodRule, zero_trust.AccessApplicationPolicyNewParamsExcludeAccessDevicePostureRule.

type AccessApplicationPolicyNewParamsExcludeAccessAccessGroupRule 

type AccessApplicationPolicyNewParamsExcludeAccessAccessGroupRule struct {
	Group param.Field[AccessApplicationPolicyNewParamsExcludeAccessAccessGroupRuleGroup] `json:"group,required"`
}

Matches an Access group.

func (AccessApplicationPolicyNewParamsExcludeAccessAccessGroupRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsExcludeAccessAccessGroupRuleGroup 

type AccessApplicationPolicyNewParamsExcludeAccessAccessGroupRuleGroup struct {
	// The ID of a previously created Access group.
	ID param.Field[string] `json:"id,required"`
}

func (AccessApplicationPolicyNewParamsExcludeAccessAccessGroupRuleGroup) MarshalJSON 

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

type AccessApplicationPolicyNewParamsExcludeAccessAnyValidServiceTokenRule 

type AccessApplicationPolicyNewParamsExcludeAccessAnyValidServiceTokenRule struct {
	// An empty object which matches on all service tokens.
	AnyValidServiceToken param.Field[interface{}] `json:"any_valid_service_token,required"`
}

Matches any valid Access Service Token

func (AccessApplicationPolicyNewParamsExcludeAccessAnyValidServiceTokenRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsExcludeAccessAuthenticationMethodRule 

type AccessApplicationPolicyNewParamsExcludeAccessAuthenticationMethodRule struct {
	AuthMethod param.Field[AccessApplicationPolicyNewParamsExcludeAccessAuthenticationMethodRuleAuthMethod] `json:"auth_method,required"`
}

Enforce different MFA options

func (AccessApplicationPolicyNewParamsExcludeAccessAuthenticationMethodRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsExcludeAccessAuthenticationMethodRuleAuthMethod 

type AccessApplicationPolicyNewParamsExcludeAccessAuthenticationMethodRuleAuthMethod struct {
	// The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
	AuthMethod param.Field[string] `json:"auth_method,required"`
}

func (AccessApplicationPolicyNewParamsExcludeAccessAuthenticationMethodRuleAuthMethod) MarshalJSON 

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

type AccessApplicationPolicyNewParamsExcludeAccessAzureGroupRule 

type AccessApplicationPolicyNewParamsExcludeAccessAzureGroupRule struct {
	AzureAd param.Field[AccessApplicationPolicyNewParamsExcludeAccessAzureGroupRuleAzureAd] `json:"azureAD,required"`
}

Matches an Azure group. Requires an Azure identity provider.

func (AccessApplicationPolicyNewParamsExcludeAccessAzureGroupRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsExcludeAccessAzureGroupRuleAzureAd 

type AccessApplicationPolicyNewParamsExcludeAccessAzureGroupRuleAzureAd struct {
	// The ID of an Azure group.
	ID param.Field[string] `json:"id,required"`
	// The ID of your Azure identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
}

func (AccessApplicationPolicyNewParamsExcludeAccessAzureGroupRuleAzureAd) MarshalJSON 

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

type AccessApplicationPolicyNewParamsExcludeAccessCertificateRule 

type AccessApplicationPolicyNewParamsExcludeAccessCertificateRule struct {
	Certificate param.Field[interface{}] `json:"certificate,required"`
}

Matches any valid client certificate.

func (AccessApplicationPolicyNewParamsExcludeAccessCertificateRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsExcludeAccessCountryRule 

type AccessApplicationPolicyNewParamsExcludeAccessCountryRule struct {
	Geo param.Field[AccessApplicationPolicyNewParamsExcludeAccessCountryRuleGeo] `json:"geo,required"`
}

Matches a specific country

func (AccessApplicationPolicyNewParamsExcludeAccessCountryRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsExcludeAccessCountryRuleGeo 

type AccessApplicationPolicyNewParamsExcludeAccessCountryRuleGeo struct {
	// The country code that should be matched.
	CountryCode param.Field[string] `json:"country_code,required"`
}

func (AccessApplicationPolicyNewParamsExcludeAccessCountryRuleGeo) MarshalJSON 

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

type AccessApplicationPolicyNewParamsExcludeAccessDevicePostureRule 

type AccessApplicationPolicyNewParamsExcludeAccessDevicePostureRule struct {
	DevicePosture param.Field[AccessApplicationPolicyNewParamsExcludeAccessDevicePostureRuleDevicePosture] `json:"device_posture,required"`
}

Enforces a device posture rule has run successfully

func (AccessApplicationPolicyNewParamsExcludeAccessDevicePostureRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsExcludeAccessDevicePostureRuleDevicePosture 

type AccessApplicationPolicyNewParamsExcludeAccessDevicePostureRuleDevicePosture struct {
	// The ID of a device posture integration.
	IntegrationUid param.Field[string] `json:"integration_uid,required"`
}

func (AccessApplicationPolicyNewParamsExcludeAccessDevicePostureRuleDevicePosture) MarshalJSON 

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

type AccessApplicationPolicyNewParamsExcludeAccessDomainRule 

type AccessApplicationPolicyNewParamsExcludeAccessDomainRule struct {
	EmailDomain param.Field[AccessApplicationPolicyNewParamsExcludeAccessDomainRuleEmailDomain] `json:"email_domain,required"`
}

Match an entire email domain.

func (AccessApplicationPolicyNewParamsExcludeAccessDomainRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsExcludeAccessDomainRuleEmailDomain 

type AccessApplicationPolicyNewParamsExcludeAccessDomainRuleEmailDomain struct {
	// The email domain to match.
	Domain param.Field[string] `json:"domain,required"`
}

func (AccessApplicationPolicyNewParamsExcludeAccessDomainRuleEmailDomain) MarshalJSON 

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

type AccessApplicationPolicyNewParamsExcludeAccessEmailListRule 

type AccessApplicationPolicyNewParamsExcludeAccessEmailListRule struct {
	EmailList param.Field[AccessApplicationPolicyNewParamsExcludeAccessEmailListRuleEmailList] `json:"email_list,required"`
}

Matches an email address from a list.

func (AccessApplicationPolicyNewParamsExcludeAccessEmailListRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsExcludeAccessEmailListRuleEmailList 

type AccessApplicationPolicyNewParamsExcludeAccessEmailListRuleEmailList struct {
	// The ID of a previously created email list.
	ID param.Field[string] `json:"id,required"`
}

func (AccessApplicationPolicyNewParamsExcludeAccessEmailListRuleEmailList) MarshalJSON 

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

type AccessApplicationPolicyNewParamsExcludeAccessEmailRule 

type AccessApplicationPolicyNewParamsExcludeAccessEmailRule struct {
	Email param.Field[AccessApplicationPolicyNewParamsExcludeAccessEmailRuleEmail] `json:"email,required"`
}

Matches a specific email.

func (AccessApplicationPolicyNewParamsExcludeAccessEmailRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsExcludeAccessEmailRuleEmail 

type AccessApplicationPolicyNewParamsExcludeAccessEmailRuleEmail struct {
	// The email of the user.
	Email param.Field[string] `json:"email,required" format:"email"`
}

func (AccessApplicationPolicyNewParamsExcludeAccessEmailRuleEmail) MarshalJSON 

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

type AccessApplicationPolicyNewParamsExcludeAccessEveryoneRule 

type AccessApplicationPolicyNewParamsExcludeAccessEveryoneRule struct {
	// An empty object which matches on all users.
	Everyone param.Field[interface{}] `json:"everyone,required"`
}

Matches everyone.

func (AccessApplicationPolicyNewParamsExcludeAccessEveryoneRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsExcludeAccessExternalEvaluationRule 

type AccessApplicationPolicyNewParamsExcludeAccessExternalEvaluationRule struct {
	ExternalEvaluation param.Field[AccessApplicationPolicyNewParamsExcludeAccessExternalEvaluationRuleExternalEvaluation] `json:"external_evaluation,required"`
}

Create Allow or Block policies which evaluate the user based on custom criteria.

func (AccessApplicationPolicyNewParamsExcludeAccessExternalEvaluationRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsExcludeAccessExternalEvaluationRuleExternalEvaluation 

type AccessApplicationPolicyNewParamsExcludeAccessExternalEvaluationRuleExternalEvaluation struct {
	// The API endpoint containing your business logic.
	EvaluateURL param.Field[string] `json:"evaluate_url,required"`
	// The API endpoint containing the key that Access uses to verify that the response
	// came from your API.
	KeysURL param.Field[string] `json:"keys_url,required"`
}

func (AccessApplicationPolicyNewParamsExcludeAccessExternalEvaluationRuleExternalEvaluation) MarshalJSON 

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

type AccessApplicationPolicyNewParamsExcludeAccessGitHubOrganizationRule 

type AccessApplicationPolicyNewParamsExcludeAccessGitHubOrganizationRule struct {
	GitHubOrganization param.Field[AccessApplicationPolicyNewParamsExcludeAccessGitHubOrganizationRuleGitHubOrganization] `json:"github-organization,required"`
}

Matches a Github organization. Requires a Github identity provider.

func (AccessApplicationPolicyNewParamsExcludeAccessGitHubOrganizationRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsExcludeAccessGitHubOrganizationRuleGitHubOrganization 

type AccessApplicationPolicyNewParamsExcludeAccessGitHubOrganizationRuleGitHubOrganization struct {
	// The ID of your Github identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The name of the organization.
	Name param.Field[string] `json:"name,required"`
}

func (AccessApplicationPolicyNewParamsExcludeAccessGitHubOrganizationRuleGitHubOrganization) MarshalJSON 

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

type AccessApplicationPolicyNewParamsExcludeAccessGsuiteGroupRule 

type AccessApplicationPolicyNewParamsExcludeAccessGsuiteGroupRule struct {
	Gsuite param.Field[AccessApplicationPolicyNewParamsExcludeAccessGsuiteGroupRuleGsuite] `json:"gsuite,required"`
}

Matches a group in Google Workspace. Requires a Google Workspace identity provider.

func (AccessApplicationPolicyNewParamsExcludeAccessGsuiteGroupRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsExcludeAccessGsuiteGroupRuleGsuite 

type AccessApplicationPolicyNewParamsExcludeAccessGsuiteGroupRuleGsuite struct {
	// The ID of your Google Workspace identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The email of the Google Workspace group.
	Email param.Field[string] `json:"email,required"`
}

func (AccessApplicationPolicyNewParamsExcludeAccessGsuiteGroupRuleGsuite) MarshalJSON 

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

type AccessApplicationPolicyNewParamsExcludeAccessIPListRule 

type AccessApplicationPolicyNewParamsExcludeAccessIPListRule struct {
	IPList param.Field[AccessApplicationPolicyNewParamsExcludeAccessIPListRuleIPList] `json:"ip_list,required"`
}

Matches an IP address from a list.

func (AccessApplicationPolicyNewParamsExcludeAccessIPListRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsExcludeAccessIPListRuleIPList 

type AccessApplicationPolicyNewParamsExcludeAccessIPListRuleIPList struct {
	// The ID of a previously created IP list.
	ID param.Field[string] `json:"id,required"`
}

func (AccessApplicationPolicyNewParamsExcludeAccessIPListRuleIPList) MarshalJSON 

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

type AccessApplicationPolicyNewParamsExcludeAccessIPRule 

type AccessApplicationPolicyNewParamsExcludeAccessIPRule struct {
	IP param.Field[AccessApplicationPolicyNewParamsExcludeAccessIPRuleIP] `json:"ip,required"`
}

Matches an IP address block.

func (AccessApplicationPolicyNewParamsExcludeAccessIPRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsExcludeAccessIPRuleIP 

type AccessApplicationPolicyNewParamsExcludeAccessIPRuleIP struct {
	// An IPv4 or IPv6 CIDR block.
	IP param.Field[string] `json:"ip,required"`
}

func (AccessApplicationPolicyNewParamsExcludeAccessIPRuleIP) MarshalJSON 

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

type AccessApplicationPolicyNewParamsExcludeAccessOktaGroupRule 

type AccessApplicationPolicyNewParamsExcludeAccessOktaGroupRule struct {
	Okta param.Field[AccessApplicationPolicyNewParamsExcludeAccessOktaGroupRuleOkta] `json:"okta,required"`
}

Matches an Okta group. Requires an Okta identity provider.

func (AccessApplicationPolicyNewParamsExcludeAccessOktaGroupRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsExcludeAccessOktaGroupRuleOkta 

type AccessApplicationPolicyNewParamsExcludeAccessOktaGroupRuleOkta struct {
	// The ID of your Okta identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The email of the Okta group.
	Email param.Field[string] `json:"email,required"`
}

func (AccessApplicationPolicyNewParamsExcludeAccessOktaGroupRuleOkta) MarshalJSON 

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

type AccessApplicationPolicyNewParamsExcludeAccessSamlGroupRule 

type AccessApplicationPolicyNewParamsExcludeAccessSamlGroupRule struct {
	Saml param.Field[AccessApplicationPolicyNewParamsExcludeAccessSamlGroupRuleSaml] `json:"saml,required"`
}

Matches a SAML group. Requires a SAML identity provider.

func (AccessApplicationPolicyNewParamsExcludeAccessSamlGroupRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsExcludeAccessSamlGroupRuleSaml 

type AccessApplicationPolicyNewParamsExcludeAccessSamlGroupRuleSaml struct {
	// The name of the SAML attribute.
	AttributeName param.Field[string] `json:"attribute_name,required"`
	// The SAML attribute value to look for.
	AttributeValue param.Field[string] `json:"attribute_value,required"`
}

func (AccessApplicationPolicyNewParamsExcludeAccessSamlGroupRuleSaml) MarshalJSON 

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

type AccessApplicationPolicyNewParamsExcludeAccessServiceTokenRule 

type AccessApplicationPolicyNewParamsExcludeAccessServiceTokenRule struct {
	ServiceToken param.Field[AccessApplicationPolicyNewParamsExcludeAccessServiceTokenRuleServiceToken] `json:"service_token,required"`
}

Matches a specific Access Service Token

func (AccessApplicationPolicyNewParamsExcludeAccessServiceTokenRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsExcludeAccessServiceTokenRuleServiceToken 

type AccessApplicationPolicyNewParamsExcludeAccessServiceTokenRuleServiceToken struct {
	// The ID of a Service Token.
	TokenID param.Field[string] `json:"token_id,required"`
}

func (AccessApplicationPolicyNewParamsExcludeAccessServiceTokenRuleServiceToken) MarshalJSON 

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

type AccessApplicationPolicyNewParamsInclude 

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

Matches a specific email.

Satisfied by zero_trust.AccessApplicationPolicyNewParamsIncludeAccessEmailRule, zero_trust.AccessApplicationPolicyNewParamsIncludeAccessEmailListRule, zero_trust.AccessApplicationPolicyNewParamsIncludeAccessDomainRule, zero_trust.AccessApplicationPolicyNewParamsIncludeAccessEveryoneRule, zero_trust.AccessApplicationPolicyNewParamsIncludeAccessIPRule, zero_trust.AccessApplicationPolicyNewParamsIncludeAccessIPListRule, zero_trust.AccessApplicationPolicyNewParamsIncludeAccessCertificateRule, zero_trust.AccessApplicationPolicyNewParamsIncludeAccessAccessGroupRule, zero_trust.AccessApplicationPolicyNewParamsIncludeAccessAzureGroupRule, zero_trust.AccessApplicationPolicyNewParamsIncludeAccessGitHubOrganizationRule, zero_trust.AccessApplicationPolicyNewParamsIncludeAccessGsuiteGroupRule, zero_trust.AccessApplicationPolicyNewParamsIncludeAccessOktaGroupRule, zero_trust.AccessApplicationPolicyNewParamsIncludeAccessSamlGroupRule, zero_trust.AccessApplicationPolicyNewParamsIncludeAccessServiceTokenRule, zero_trust.AccessApplicationPolicyNewParamsIncludeAccessAnyValidServiceTokenRule, zero_trust.AccessApplicationPolicyNewParamsIncludeAccessExternalEvaluationRule, zero_trust.AccessApplicationPolicyNewParamsIncludeAccessCountryRule, zero_trust.AccessApplicationPolicyNewParamsIncludeAccessAuthenticationMethodRule, zero_trust.AccessApplicationPolicyNewParamsIncludeAccessDevicePostureRule.

type AccessApplicationPolicyNewParamsIncludeAccessAccessGroupRule 

type AccessApplicationPolicyNewParamsIncludeAccessAccessGroupRule struct {
	Group param.Field[AccessApplicationPolicyNewParamsIncludeAccessAccessGroupRuleGroup] `json:"group,required"`
}

Matches an Access group.

func (AccessApplicationPolicyNewParamsIncludeAccessAccessGroupRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsIncludeAccessAccessGroupRuleGroup 

type AccessApplicationPolicyNewParamsIncludeAccessAccessGroupRuleGroup struct {
	// The ID of a previously created Access group.
	ID param.Field[string] `json:"id,required"`
}

func (AccessApplicationPolicyNewParamsIncludeAccessAccessGroupRuleGroup) MarshalJSON 

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

type AccessApplicationPolicyNewParamsIncludeAccessAnyValidServiceTokenRule 

type AccessApplicationPolicyNewParamsIncludeAccessAnyValidServiceTokenRule struct {
	// An empty object which matches on all service tokens.
	AnyValidServiceToken param.Field[interface{}] `json:"any_valid_service_token,required"`
}

Matches any valid Access Service Token

func (AccessApplicationPolicyNewParamsIncludeAccessAnyValidServiceTokenRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsIncludeAccessAuthenticationMethodRule 

type AccessApplicationPolicyNewParamsIncludeAccessAuthenticationMethodRule struct {
	AuthMethod param.Field[AccessApplicationPolicyNewParamsIncludeAccessAuthenticationMethodRuleAuthMethod] `json:"auth_method,required"`
}

Enforce different MFA options

func (AccessApplicationPolicyNewParamsIncludeAccessAuthenticationMethodRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsIncludeAccessAuthenticationMethodRuleAuthMethod 

type AccessApplicationPolicyNewParamsIncludeAccessAuthenticationMethodRuleAuthMethod struct {
	// The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
	AuthMethod param.Field[string] `json:"auth_method,required"`
}

func (AccessApplicationPolicyNewParamsIncludeAccessAuthenticationMethodRuleAuthMethod) MarshalJSON 

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

type AccessApplicationPolicyNewParamsIncludeAccessAzureGroupRule 

type AccessApplicationPolicyNewParamsIncludeAccessAzureGroupRule struct {
	AzureAd param.Field[AccessApplicationPolicyNewParamsIncludeAccessAzureGroupRuleAzureAd] `json:"azureAD,required"`
}

Matches an Azure group. Requires an Azure identity provider.

func (AccessApplicationPolicyNewParamsIncludeAccessAzureGroupRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsIncludeAccessAzureGroupRuleAzureAd 

type AccessApplicationPolicyNewParamsIncludeAccessAzureGroupRuleAzureAd struct {
	// The ID of an Azure group.
	ID param.Field[string] `json:"id,required"`
	// The ID of your Azure identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
}

func (AccessApplicationPolicyNewParamsIncludeAccessAzureGroupRuleAzureAd) MarshalJSON 

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

type AccessApplicationPolicyNewParamsIncludeAccessCertificateRule 

type AccessApplicationPolicyNewParamsIncludeAccessCertificateRule struct {
	Certificate param.Field[interface{}] `json:"certificate,required"`
}

Matches any valid client certificate.

func (AccessApplicationPolicyNewParamsIncludeAccessCertificateRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsIncludeAccessCountryRule 

type AccessApplicationPolicyNewParamsIncludeAccessCountryRule struct {
	Geo param.Field[AccessApplicationPolicyNewParamsIncludeAccessCountryRuleGeo] `json:"geo,required"`
}

Matches a specific country

func (AccessApplicationPolicyNewParamsIncludeAccessCountryRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsIncludeAccessCountryRuleGeo 

type AccessApplicationPolicyNewParamsIncludeAccessCountryRuleGeo struct {
	// The country code that should be matched.
	CountryCode param.Field[string] `json:"country_code,required"`
}

func (AccessApplicationPolicyNewParamsIncludeAccessCountryRuleGeo) MarshalJSON 

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

type AccessApplicationPolicyNewParamsIncludeAccessDevicePostureRule 

type AccessApplicationPolicyNewParamsIncludeAccessDevicePostureRule struct {
	DevicePosture param.Field[AccessApplicationPolicyNewParamsIncludeAccessDevicePostureRuleDevicePosture] `json:"device_posture,required"`
}

Enforces a device posture rule has run successfully

func (AccessApplicationPolicyNewParamsIncludeAccessDevicePostureRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsIncludeAccessDevicePostureRuleDevicePosture 

type AccessApplicationPolicyNewParamsIncludeAccessDevicePostureRuleDevicePosture struct {
	// The ID of a device posture integration.
	IntegrationUid param.Field[string] `json:"integration_uid,required"`
}

func (AccessApplicationPolicyNewParamsIncludeAccessDevicePostureRuleDevicePosture) MarshalJSON 

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

type AccessApplicationPolicyNewParamsIncludeAccessDomainRule 

type AccessApplicationPolicyNewParamsIncludeAccessDomainRule struct {
	EmailDomain param.Field[AccessApplicationPolicyNewParamsIncludeAccessDomainRuleEmailDomain] `json:"email_domain,required"`
}

Match an entire email domain.

func (AccessApplicationPolicyNewParamsIncludeAccessDomainRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsIncludeAccessDomainRuleEmailDomain 

type AccessApplicationPolicyNewParamsIncludeAccessDomainRuleEmailDomain struct {
	// The email domain to match.
	Domain param.Field[string] `json:"domain,required"`
}

func (AccessApplicationPolicyNewParamsIncludeAccessDomainRuleEmailDomain) MarshalJSON 

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

type AccessApplicationPolicyNewParamsIncludeAccessEmailListRule 

type AccessApplicationPolicyNewParamsIncludeAccessEmailListRule struct {
	EmailList param.Field[AccessApplicationPolicyNewParamsIncludeAccessEmailListRuleEmailList] `json:"email_list,required"`
}

Matches an email address from a list.

func (AccessApplicationPolicyNewParamsIncludeAccessEmailListRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsIncludeAccessEmailListRuleEmailList 

type AccessApplicationPolicyNewParamsIncludeAccessEmailListRuleEmailList struct {
	// The ID of a previously created email list.
	ID param.Field[string] `json:"id,required"`
}

func (AccessApplicationPolicyNewParamsIncludeAccessEmailListRuleEmailList) MarshalJSON 

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

type AccessApplicationPolicyNewParamsIncludeAccessEmailRule 

type AccessApplicationPolicyNewParamsIncludeAccessEmailRule struct {
	Email param.Field[AccessApplicationPolicyNewParamsIncludeAccessEmailRuleEmail] `json:"email,required"`
}

Matches a specific email.

func (AccessApplicationPolicyNewParamsIncludeAccessEmailRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsIncludeAccessEmailRuleEmail 

type AccessApplicationPolicyNewParamsIncludeAccessEmailRuleEmail struct {
	// The email of the user.
	Email param.Field[string] `json:"email,required" format:"email"`
}

func (AccessApplicationPolicyNewParamsIncludeAccessEmailRuleEmail) MarshalJSON 

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

type AccessApplicationPolicyNewParamsIncludeAccessEveryoneRule 

type AccessApplicationPolicyNewParamsIncludeAccessEveryoneRule struct {
	// An empty object which matches on all users.
	Everyone param.Field[interface{}] `json:"everyone,required"`
}

Matches everyone.

func (AccessApplicationPolicyNewParamsIncludeAccessEveryoneRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsIncludeAccessExternalEvaluationRule 

type AccessApplicationPolicyNewParamsIncludeAccessExternalEvaluationRule struct {
	ExternalEvaluation param.Field[AccessApplicationPolicyNewParamsIncludeAccessExternalEvaluationRuleExternalEvaluation] `json:"external_evaluation,required"`
}

Create Allow or Block policies which evaluate the user based on custom criteria.

func (AccessApplicationPolicyNewParamsIncludeAccessExternalEvaluationRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsIncludeAccessExternalEvaluationRuleExternalEvaluation 

type AccessApplicationPolicyNewParamsIncludeAccessExternalEvaluationRuleExternalEvaluation struct {
	// The API endpoint containing your business logic.
	EvaluateURL param.Field[string] `json:"evaluate_url,required"`
	// The API endpoint containing the key that Access uses to verify that the response
	// came from your API.
	KeysURL param.Field[string] `json:"keys_url,required"`
}

func (AccessApplicationPolicyNewParamsIncludeAccessExternalEvaluationRuleExternalEvaluation) MarshalJSON 

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

type AccessApplicationPolicyNewParamsIncludeAccessGitHubOrganizationRule 

type AccessApplicationPolicyNewParamsIncludeAccessGitHubOrganizationRule struct {
	GitHubOrganization param.Field[AccessApplicationPolicyNewParamsIncludeAccessGitHubOrganizationRuleGitHubOrganization] `json:"github-organization,required"`
}

Matches a Github organization. Requires a Github identity provider.

func (AccessApplicationPolicyNewParamsIncludeAccessGitHubOrganizationRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsIncludeAccessGitHubOrganizationRuleGitHubOrganization 

type AccessApplicationPolicyNewParamsIncludeAccessGitHubOrganizationRuleGitHubOrganization struct {
	// The ID of your Github identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The name of the organization.
	Name param.Field[string] `json:"name,required"`
}

func (AccessApplicationPolicyNewParamsIncludeAccessGitHubOrganizationRuleGitHubOrganization) MarshalJSON 

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

type AccessApplicationPolicyNewParamsIncludeAccessGsuiteGroupRule 

type AccessApplicationPolicyNewParamsIncludeAccessGsuiteGroupRule struct {
	Gsuite param.Field[AccessApplicationPolicyNewParamsIncludeAccessGsuiteGroupRuleGsuite] `json:"gsuite,required"`
}

Matches a group in Google Workspace. Requires a Google Workspace identity provider.

func (AccessApplicationPolicyNewParamsIncludeAccessGsuiteGroupRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsIncludeAccessGsuiteGroupRuleGsuite 

type AccessApplicationPolicyNewParamsIncludeAccessGsuiteGroupRuleGsuite struct {
	// The ID of your Google Workspace identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The email of the Google Workspace group.
	Email param.Field[string] `json:"email,required"`
}

func (AccessApplicationPolicyNewParamsIncludeAccessGsuiteGroupRuleGsuite) MarshalJSON 

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

type AccessApplicationPolicyNewParamsIncludeAccessIPListRule 

type AccessApplicationPolicyNewParamsIncludeAccessIPListRule struct {
	IPList param.Field[AccessApplicationPolicyNewParamsIncludeAccessIPListRuleIPList] `json:"ip_list,required"`
}

Matches an IP address from a list.

func (AccessApplicationPolicyNewParamsIncludeAccessIPListRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsIncludeAccessIPListRuleIPList 

type AccessApplicationPolicyNewParamsIncludeAccessIPListRuleIPList struct {
	// The ID of a previously created IP list.
	ID param.Field[string] `json:"id,required"`
}

func (AccessApplicationPolicyNewParamsIncludeAccessIPListRuleIPList) MarshalJSON 

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

type AccessApplicationPolicyNewParamsIncludeAccessIPRule 

type AccessApplicationPolicyNewParamsIncludeAccessIPRule struct {
	IP param.Field[AccessApplicationPolicyNewParamsIncludeAccessIPRuleIP] `json:"ip,required"`
}

Matches an IP address block.

func (AccessApplicationPolicyNewParamsIncludeAccessIPRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsIncludeAccessIPRuleIP 

type AccessApplicationPolicyNewParamsIncludeAccessIPRuleIP struct {
	// An IPv4 or IPv6 CIDR block.
	IP param.Field[string] `json:"ip,required"`
}

func (AccessApplicationPolicyNewParamsIncludeAccessIPRuleIP) MarshalJSON 

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

type AccessApplicationPolicyNewParamsIncludeAccessOktaGroupRule 

type AccessApplicationPolicyNewParamsIncludeAccessOktaGroupRule struct {
	Okta param.Field[AccessApplicationPolicyNewParamsIncludeAccessOktaGroupRuleOkta] `json:"okta,required"`
}

Matches an Okta group. Requires an Okta identity provider.

func (AccessApplicationPolicyNewParamsIncludeAccessOktaGroupRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsIncludeAccessOktaGroupRuleOkta 

type AccessApplicationPolicyNewParamsIncludeAccessOktaGroupRuleOkta struct {
	// The ID of your Okta identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The email of the Okta group.
	Email param.Field[string] `json:"email,required"`
}

func (AccessApplicationPolicyNewParamsIncludeAccessOktaGroupRuleOkta) MarshalJSON 

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

type AccessApplicationPolicyNewParamsIncludeAccessSamlGroupRule 

type AccessApplicationPolicyNewParamsIncludeAccessSamlGroupRule struct {
	Saml param.Field[AccessApplicationPolicyNewParamsIncludeAccessSamlGroupRuleSaml] `json:"saml,required"`
}

Matches a SAML group. Requires a SAML identity provider.

func (AccessApplicationPolicyNewParamsIncludeAccessSamlGroupRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsIncludeAccessSamlGroupRuleSaml 

type AccessApplicationPolicyNewParamsIncludeAccessSamlGroupRuleSaml struct {
	// The name of the SAML attribute.
	AttributeName param.Field[string] `json:"attribute_name,required"`
	// The SAML attribute value to look for.
	AttributeValue param.Field[string] `json:"attribute_value,required"`
}

func (AccessApplicationPolicyNewParamsIncludeAccessSamlGroupRuleSaml) MarshalJSON 

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

type AccessApplicationPolicyNewParamsIncludeAccessServiceTokenRule 

type AccessApplicationPolicyNewParamsIncludeAccessServiceTokenRule struct {
	ServiceToken param.Field[AccessApplicationPolicyNewParamsIncludeAccessServiceTokenRuleServiceToken] `json:"service_token,required"`
}

Matches a specific Access Service Token

func (AccessApplicationPolicyNewParamsIncludeAccessServiceTokenRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsIncludeAccessServiceTokenRuleServiceToken 

type AccessApplicationPolicyNewParamsIncludeAccessServiceTokenRuleServiceToken struct {
	// The ID of a Service Token.
	TokenID param.Field[string] `json:"token_id,required"`
}

func (AccessApplicationPolicyNewParamsIncludeAccessServiceTokenRuleServiceToken) MarshalJSON 

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

type AccessApplicationPolicyNewParamsRequire 

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

Matches a specific email.

Satisfied by zero_trust.AccessApplicationPolicyNewParamsRequireAccessEmailRule, zero_trust.AccessApplicationPolicyNewParamsRequireAccessEmailListRule, zero_trust.AccessApplicationPolicyNewParamsRequireAccessDomainRule, zero_trust.AccessApplicationPolicyNewParamsRequireAccessEveryoneRule, zero_trust.AccessApplicationPolicyNewParamsRequireAccessIPRule, zero_trust.AccessApplicationPolicyNewParamsRequireAccessIPListRule, zero_trust.AccessApplicationPolicyNewParamsRequireAccessCertificateRule, zero_trust.AccessApplicationPolicyNewParamsRequireAccessAccessGroupRule, zero_trust.AccessApplicationPolicyNewParamsRequireAccessAzureGroupRule, zero_trust.AccessApplicationPolicyNewParamsRequireAccessGitHubOrganizationRule, zero_trust.AccessApplicationPolicyNewParamsRequireAccessGsuiteGroupRule, zero_trust.AccessApplicationPolicyNewParamsRequireAccessOktaGroupRule, zero_trust.AccessApplicationPolicyNewParamsRequireAccessSamlGroupRule, zero_trust.AccessApplicationPolicyNewParamsRequireAccessServiceTokenRule, zero_trust.AccessApplicationPolicyNewParamsRequireAccessAnyValidServiceTokenRule, zero_trust.AccessApplicationPolicyNewParamsRequireAccessExternalEvaluationRule, zero_trust.AccessApplicationPolicyNewParamsRequireAccessCountryRule, zero_trust.AccessApplicationPolicyNewParamsRequireAccessAuthenticationMethodRule, zero_trust.AccessApplicationPolicyNewParamsRequireAccessDevicePostureRule.

type AccessApplicationPolicyNewParamsRequireAccessAccessGroupRule 

type AccessApplicationPolicyNewParamsRequireAccessAccessGroupRule struct {
	Group param.Field[AccessApplicationPolicyNewParamsRequireAccessAccessGroupRuleGroup] `json:"group,required"`
}

Matches an Access group.

func (AccessApplicationPolicyNewParamsRequireAccessAccessGroupRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsRequireAccessAccessGroupRuleGroup 

type AccessApplicationPolicyNewParamsRequireAccessAccessGroupRuleGroup struct {
	// The ID of a previously created Access group.
	ID param.Field[string] `json:"id,required"`
}

func (AccessApplicationPolicyNewParamsRequireAccessAccessGroupRuleGroup) MarshalJSON 

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

type AccessApplicationPolicyNewParamsRequireAccessAnyValidServiceTokenRule 

type AccessApplicationPolicyNewParamsRequireAccessAnyValidServiceTokenRule struct {
	// An empty object which matches on all service tokens.
	AnyValidServiceToken param.Field[interface{}] `json:"any_valid_service_token,required"`
}

Matches any valid Access Service Token

func (AccessApplicationPolicyNewParamsRequireAccessAnyValidServiceTokenRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsRequireAccessAuthenticationMethodRule 

type AccessApplicationPolicyNewParamsRequireAccessAuthenticationMethodRule struct {
	AuthMethod param.Field[AccessApplicationPolicyNewParamsRequireAccessAuthenticationMethodRuleAuthMethod] `json:"auth_method,required"`
}

Enforce different MFA options

func (AccessApplicationPolicyNewParamsRequireAccessAuthenticationMethodRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsRequireAccessAuthenticationMethodRuleAuthMethod 

type AccessApplicationPolicyNewParamsRequireAccessAuthenticationMethodRuleAuthMethod struct {
	// The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
	AuthMethod param.Field[string] `json:"auth_method,required"`
}

func (AccessApplicationPolicyNewParamsRequireAccessAuthenticationMethodRuleAuthMethod) MarshalJSON 

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

type AccessApplicationPolicyNewParamsRequireAccessAzureGroupRule 

type AccessApplicationPolicyNewParamsRequireAccessAzureGroupRule struct {
	AzureAd param.Field[AccessApplicationPolicyNewParamsRequireAccessAzureGroupRuleAzureAd] `json:"azureAD,required"`
}

Matches an Azure group. Requires an Azure identity provider.

func (AccessApplicationPolicyNewParamsRequireAccessAzureGroupRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsRequireAccessAzureGroupRuleAzureAd 

type AccessApplicationPolicyNewParamsRequireAccessAzureGroupRuleAzureAd struct {
	// The ID of an Azure group.
	ID param.Field[string] `json:"id,required"`
	// The ID of your Azure identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
}

func (AccessApplicationPolicyNewParamsRequireAccessAzureGroupRuleAzureAd) MarshalJSON 

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

type AccessApplicationPolicyNewParamsRequireAccessCertificateRule 

type AccessApplicationPolicyNewParamsRequireAccessCertificateRule struct {
	Certificate param.Field[interface{}] `json:"certificate,required"`
}

Matches any valid client certificate.

func (AccessApplicationPolicyNewParamsRequireAccessCertificateRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsRequireAccessCountryRule 

type AccessApplicationPolicyNewParamsRequireAccessCountryRule struct {
	Geo param.Field[AccessApplicationPolicyNewParamsRequireAccessCountryRuleGeo] `json:"geo,required"`
}

Matches a specific country

func (AccessApplicationPolicyNewParamsRequireAccessCountryRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsRequireAccessCountryRuleGeo 

type AccessApplicationPolicyNewParamsRequireAccessCountryRuleGeo struct {
	// The country code that should be matched.
	CountryCode param.Field[string] `json:"country_code,required"`
}

func (AccessApplicationPolicyNewParamsRequireAccessCountryRuleGeo) MarshalJSON 

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

type AccessApplicationPolicyNewParamsRequireAccessDevicePostureRule 

type AccessApplicationPolicyNewParamsRequireAccessDevicePostureRule struct {
	DevicePosture param.Field[AccessApplicationPolicyNewParamsRequireAccessDevicePostureRuleDevicePosture] `json:"device_posture,required"`
}

Enforces a device posture rule has run successfully

func (AccessApplicationPolicyNewParamsRequireAccessDevicePostureRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsRequireAccessDevicePostureRuleDevicePosture 

type AccessApplicationPolicyNewParamsRequireAccessDevicePostureRuleDevicePosture struct {
	// The ID of a device posture integration.
	IntegrationUid param.Field[string] `json:"integration_uid,required"`
}

func (AccessApplicationPolicyNewParamsRequireAccessDevicePostureRuleDevicePosture) MarshalJSON 

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

type AccessApplicationPolicyNewParamsRequireAccessDomainRule 

type AccessApplicationPolicyNewParamsRequireAccessDomainRule struct {
	EmailDomain param.Field[AccessApplicationPolicyNewParamsRequireAccessDomainRuleEmailDomain] `json:"email_domain,required"`
}

Match an entire email domain.

func (AccessApplicationPolicyNewParamsRequireAccessDomainRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsRequireAccessDomainRuleEmailDomain 

type AccessApplicationPolicyNewParamsRequireAccessDomainRuleEmailDomain struct {
	// The email domain to match.
	Domain param.Field[string] `json:"domain,required"`
}

func (AccessApplicationPolicyNewParamsRequireAccessDomainRuleEmailDomain) MarshalJSON 

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

type AccessApplicationPolicyNewParamsRequireAccessEmailListRule 

type AccessApplicationPolicyNewParamsRequireAccessEmailListRule struct {
	EmailList param.Field[AccessApplicationPolicyNewParamsRequireAccessEmailListRuleEmailList] `json:"email_list,required"`
}

Matches an email address from a list.

func (AccessApplicationPolicyNewParamsRequireAccessEmailListRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsRequireAccessEmailListRuleEmailList 

type AccessApplicationPolicyNewParamsRequireAccessEmailListRuleEmailList struct {
	// The ID of a previously created email list.
	ID param.Field[string] `json:"id,required"`
}

func (AccessApplicationPolicyNewParamsRequireAccessEmailListRuleEmailList) MarshalJSON 

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

type AccessApplicationPolicyNewParamsRequireAccessEmailRule 

type AccessApplicationPolicyNewParamsRequireAccessEmailRule struct {
	Email param.Field[AccessApplicationPolicyNewParamsRequireAccessEmailRuleEmail] `json:"email,required"`
}

Matches a specific email.

func (AccessApplicationPolicyNewParamsRequireAccessEmailRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsRequireAccessEmailRuleEmail 

type AccessApplicationPolicyNewParamsRequireAccessEmailRuleEmail struct {
	// The email of the user.
	Email param.Field[string] `json:"email,required" format:"email"`
}

func (AccessApplicationPolicyNewParamsRequireAccessEmailRuleEmail) MarshalJSON 

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

type AccessApplicationPolicyNewParamsRequireAccessEveryoneRule 

type AccessApplicationPolicyNewParamsRequireAccessEveryoneRule struct {
	// An empty object which matches on all users.
	Everyone param.Field[interface{}] `json:"everyone,required"`
}

Matches everyone.

func (AccessApplicationPolicyNewParamsRequireAccessEveryoneRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsRequireAccessExternalEvaluationRule 

type AccessApplicationPolicyNewParamsRequireAccessExternalEvaluationRule struct {
	ExternalEvaluation param.Field[AccessApplicationPolicyNewParamsRequireAccessExternalEvaluationRuleExternalEvaluation] `json:"external_evaluation,required"`
}

Create Allow or Block policies which evaluate the user based on custom criteria.

func (AccessApplicationPolicyNewParamsRequireAccessExternalEvaluationRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsRequireAccessExternalEvaluationRuleExternalEvaluation 

type AccessApplicationPolicyNewParamsRequireAccessExternalEvaluationRuleExternalEvaluation struct {
	// The API endpoint containing your business logic.
	EvaluateURL param.Field[string] `json:"evaluate_url,required"`
	// The API endpoint containing the key that Access uses to verify that the response
	// came from your API.
	KeysURL param.Field[string] `json:"keys_url,required"`
}

func (AccessApplicationPolicyNewParamsRequireAccessExternalEvaluationRuleExternalEvaluation) MarshalJSON 

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

type AccessApplicationPolicyNewParamsRequireAccessGitHubOrganizationRule 

type AccessApplicationPolicyNewParamsRequireAccessGitHubOrganizationRule struct {
	GitHubOrganization param.Field[AccessApplicationPolicyNewParamsRequireAccessGitHubOrganizationRuleGitHubOrganization] `json:"github-organization,required"`
}

Matches a Github organization. Requires a Github identity provider.

func (AccessApplicationPolicyNewParamsRequireAccessGitHubOrganizationRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsRequireAccessGitHubOrganizationRuleGitHubOrganization 

type AccessApplicationPolicyNewParamsRequireAccessGitHubOrganizationRuleGitHubOrganization struct {
	// The ID of your Github identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The name of the organization.
	Name param.Field[string] `json:"name,required"`
}

func (AccessApplicationPolicyNewParamsRequireAccessGitHubOrganizationRuleGitHubOrganization) MarshalJSON 

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

type AccessApplicationPolicyNewParamsRequireAccessGsuiteGroupRule 

type AccessApplicationPolicyNewParamsRequireAccessGsuiteGroupRule struct {
	Gsuite param.Field[AccessApplicationPolicyNewParamsRequireAccessGsuiteGroupRuleGsuite] `json:"gsuite,required"`
}

Matches a group in Google Workspace. Requires a Google Workspace identity provider.

func (AccessApplicationPolicyNewParamsRequireAccessGsuiteGroupRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsRequireAccessGsuiteGroupRuleGsuite 

type AccessApplicationPolicyNewParamsRequireAccessGsuiteGroupRuleGsuite struct {
	// The ID of your Google Workspace identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The email of the Google Workspace group.
	Email param.Field[string] `json:"email,required"`
}

func (AccessApplicationPolicyNewParamsRequireAccessGsuiteGroupRuleGsuite) MarshalJSON 

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

type AccessApplicationPolicyNewParamsRequireAccessIPListRule 

type AccessApplicationPolicyNewParamsRequireAccessIPListRule struct {
	IPList param.Field[AccessApplicationPolicyNewParamsRequireAccessIPListRuleIPList] `json:"ip_list,required"`
}

Matches an IP address from a list.

func (AccessApplicationPolicyNewParamsRequireAccessIPListRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsRequireAccessIPListRuleIPList 

type AccessApplicationPolicyNewParamsRequireAccessIPListRuleIPList struct {
	// The ID of a previously created IP list.
	ID param.Field[string] `json:"id,required"`
}

func (AccessApplicationPolicyNewParamsRequireAccessIPListRuleIPList) MarshalJSON 

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

type AccessApplicationPolicyNewParamsRequireAccessIPRule 

type AccessApplicationPolicyNewParamsRequireAccessIPRule struct {
	IP param.Field[AccessApplicationPolicyNewParamsRequireAccessIPRuleIP] `json:"ip,required"`
}

Matches an IP address block.

func (AccessApplicationPolicyNewParamsRequireAccessIPRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsRequireAccessIPRuleIP 

type AccessApplicationPolicyNewParamsRequireAccessIPRuleIP struct {
	// An IPv4 or IPv6 CIDR block.
	IP param.Field[string] `json:"ip,required"`
}

func (AccessApplicationPolicyNewParamsRequireAccessIPRuleIP) MarshalJSON 

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

type AccessApplicationPolicyNewParamsRequireAccessOktaGroupRule 

type AccessApplicationPolicyNewParamsRequireAccessOktaGroupRule struct {
	Okta param.Field[AccessApplicationPolicyNewParamsRequireAccessOktaGroupRuleOkta] `json:"okta,required"`
}

Matches an Okta group. Requires an Okta identity provider.

func (AccessApplicationPolicyNewParamsRequireAccessOktaGroupRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsRequireAccessOktaGroupRuleOkta 

type AccessApplicationPolicyNewParamsRequireAccessOktaGroupRuleOkta struct {
	// The ID of your Okta identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The email of the Okta group.
	Email param.Field[string] `json:"email,required"`
}

func (AccessApplicationPolicyNewParamsRequireAccessOktaGroupRuleOkta) MarshalJSON 

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

type AccessApplicationPolicyNewParamsRequireAccessSamlGroupRule 

type AccessApplicationPolicyNewParamsRequireAccessSamlGroupRule struct {
	Saml param.Field[AccessApplicationPolicyNewParamsRequireAccessSamlGroupRuleSaml] `json:"saml,required"`
}

Matches a SAML group. Requires a SAML identity provider.

func (AccessApplicationPolicyNewParamsRequireAccessSamlGroupRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsRequireAccessSamlGroupRuleSaml 

type AccessApplicationPolicyNewParamsRequireAccessSamlGroupRuleSaml struct {
	// The name of the SAML attribute.
	AttributeName param.Field[string] `json:"attribute_name,required"`
	// The SAML attribute value to look for.
	AttributeValue param.Field[string] `json:"attribute_value,required"`
}

func (AccessApplicationPolicyNewParamsRequireAccessSamlGroupRuleSaml) MarshalJSON 

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

type AccessApplicationPolicyNewParamsRequireAccessServiceTokenRule 

type AccessApplicationPolicyNewParamsRequireAccessServiceTokenRule struct {
	ServiceToken param.Field[AccessApplicationPolicyNewParamsRequireAccessServiceTokenRuleServiceToken] `json:"service_token,required"`
}

Matches a specific Access Service Token

func (AccessApplicationPolicyNewParamsRequireAccessServiceTokenRule) MarshalJSON 

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

type AccessApplicationPolicyNewParamsRequireAccessServiceTokenRuleServiceToken 

type AccessApplicationPolicyNewParamsRequireAccessServiceTokenRuleServiceToken struct {
	// The ID of a Service Token.
	TokenID param.Field[string] `json:"token_id,required"`
}

func (AccessApplicationPolicyNewParamsRequireAccessServiceTokenRuleServiceToken) MarshalJSON 

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

type AccessApplicationPolicyNewResponseEnvelope 

type AccessApplicationPolicyNewResponseEnvelope struct {
	Errors   []AccessApplicationPolicyNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessApplicationPolicyNewResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessPolicies                                       `json:"result,required"`
	// Whether the API call was successful
	Success AccessApplicationPolicyNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessApplicationPolicyNewResponseEnvelopeJSON    `json:"-"`
}

func (*AccessApplicationPolicyNewResponseEnvelope) UnmarshalJSON 

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

type AccessApplicationPolicyNewResponseEnvelopeErrors 

type AccessApplicationPolicyNewResponseEnvelopeErrors struct {
	Code    int64                                                `json:"code,required"`
	Message string                                               `json:"message,required"`
	JSON    accessApplicationPolicyNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessApplicationPolicyNewResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessApplicationPolicyNewResponseEnvelopeMessages 

type AccessApplicationPolicyNewResponseEnvelopeMessages struct {
	Code    int64                                                  `json:"code,required"`
	Message string                                                 `json:"message,required"`
	JSON    accessApplicationPolicyNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessApplicationPolicyNewResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessApplicationPolicyNewResponseEnvelopeSuccess 

type AccessApplicationPolicyNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessApplicationPolicyNewResponseEnvelopeSuccessTrue AccessApplicationPolicyNewResponseEnvelopeSuccess = true
)

type AccessApplicationPolicyService 

type AccessApplicationPolicyService struct {
	Options []option.RequestOption
}

AccessApplicationPolicyService 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 NewAccessApplicationPolicyService method instead.

func NewAccessApplicationPolicyService 

func NewAccessApplicationPolicyService(opts ...option.RequestOption) (r *AccessApplicationPolicyService)

NewAccessApplicationPolicyService 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 (*AccessApplicationPolicyService) Delete 

func (r *AccessApplicationPolicyService) Delete(ctx context.Context, uuid1 string, uuid string, body AccessApplicationPolicyDeleteParams, opts ...option.RequestOption) (res *AccessApplicationPolicyDeleteResponse, err error)

Delete an Access policy.

func (*AccessApplicationPolicyService) Get 

func (r *AccessApplicationPolicyService) Get(ctx context.Context, uuid1 string, uuid string, query AccessApplicationPolicyGetParams, opts ...option.RequestOption) (res *AccessPolicies, err error)

Fetches a single Access policy.

func (*AccessApplicationPolicyService) List 

func (r *AccessApplicationPolicyService) List(ctx context.Context, uuid string, query AccessApplicationPolicyListParams, opts ...option.RequestOption) (res *[]AccessPolicies, err error)

Lists Access policies configured for an application.

func (*AccessApplicationPolicyService) New 

func (r *AccessApplicationPolicyService) New(ctx context.Context, uuid string, params AccessApplicationPolicyNewParams, opts ...option.RequestOption) (res *AccessPolicies, err error)

Create a new Access policy for an application.

func (*AccessApplicationPolicyService) Update 

func (r *AccessApplicationPolicyService) Update(ctx context.Context, uuid1 string, uuid string, params AccessApplicationPolicyUpdateParams, opts ...option.RequestOption) (res *AccessPolicies, err error)

Update a configured Access policy.

type AccessApplicationPolicyUpdateParams 

type AccessApplicationPolicyUpdateParams struct {
	// The action Access will take if a user matches this policy.
	Decision param.Field[AccessApplicationPolicyUpdateParamsDecision] `json:"decision,required"`
	// Rules evaluated with an OR logical operator. A user needs to meet only one of
	// the Include rules.
	Include param.Field[[]AccessApplicationPolicyUpdateParamsInclude] `json:"include,required"`
	// The name of the Access policy.
	Name param.Field[string] `json:"name,required"`
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
	// Administrators who can approve a temporary authentication request.
	ApprovalGroups param.Field[[]AccessApplicationPolicyUpdateParamsApprovalGroup] `json:"approval_groups"`
	// Requires the user to request access from an administrator at the start of each
	// session.
	ApprovalRequired param.Field[bool] `json:"approval_required"`
	// Rules evaluated with a NOT logical operator. To match the policy, a user cannot
	// meet any of the Exclude rules.
	Exclude param.Field[[]AccessApplicationPolicyUpdateParamsExclude] `json:"exclude"`
	// Require this application to be served in an isolated browser for users matching
	// this policy. 'Client Web Isolation' must be on for the account in order to use
	// this feature.
	IsolationRequired param.Field[bool] `json:"isolation_required"`
	// The order of execution for this policy. Must be unique for each policy.
	Precedence param.Field[int64] `json:"precedence"`
	// A custom message that will appear on the purpose justification screen.
	PurposeJustificationPrompt param.Field[string] `json:"purpose_justification_prompt"`
	// Require users to enter a justification when they log in to the application.
	PurposeJustificationRequired param.Field[bool] `json:"purpose_justification_required"`
	// Rules evaluated with an AND logical operator. To match the policy, a user must
	// meet all of the Require rules.
	Require param.Field[[]AccessApplicationPolicyUpdateParamsRequire] `json:"require"`
	// The amount of time that tokens issued for the application will be valid. Must be
	// in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s,
	// m, h.
	SessionDuration param.Field[string] `json:"session_duration"`
}

func (AccessApplicationPolicyUpdateParams) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsApprovalGroup 

type AccessApplicationPolicyUpdateParamsApprovalGroup struct {
	// The number of approvals needed to obtain access.
	ApprovalsNeeded param.Field[float64] `json:"approvals_needed,required"`
	// A list of emails that can approve the access request.
	EmailAddresses param.Field[[]interface{}] `json:"email_addresses"`
	// The UUID of an re-usable email list.
	EmailListUUID param.Field[string] `json:"email_list_uuid"`
}

A group of email addresses that can approve a temporary authentication request.

func (AccessApplicationPolicyUpdateParamsApprovalGroup) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsDecision 

type AccessApplicationPolicyUpdateParamsDecision string

The action Access will take if a user matches this policy. 

const (
	AccessApplicationPolicyUpdateParamsDecisionAllow       AccessApplicationPolicyUpdateParamsDecision = "allow"
	AccessApplicationPolicyUpdateParamsDecisionDeny        AccessApplicationPolicyUpdateParamsDecision = "deny"
	AccessApplicationPolicyUpdateParamsDecisionNonIdentity AccessApplicationPolicyUpdateParamsDecision = "non_identity"
	AccessApplicationPolicyUpdateParamsDecisionBypass      AccessApplicationPolicyUpdateParamsDecision = "bypass"
)

type AccessApplicationPolicyUpdateParamsExclude 

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

Matches a specific email.

Satisfied by zero_trust.AccessApplicationPolicyUpdateParamsExcludeAccessEmailRule, zero_trust.AccessApplicationPolicyUpdateParamsExcludeAccessEmailListRule, zero_trust.AccessApplicationPolicyUpdateParamsExcludeAccessDomainRule, zero_trust.AccessApplicationPolicyUpdateParamsExcludeAccessEveryoneRule, zero_trust.AccessApplicationPolicyUpdateParamsExcludeAccessIPRule, zero_trust.AccessApplicationPolicyUpdateParamsExcludeAccessIPListRule, zero_trust.AccessApplicationPolicyUpdateParamsExcludeAccessCertificateRule, zero_trust.AccessApplicationPolicyUpdateParamsExcludeAccessAccessGroupRule, zero_trust.AccessApplicationPolicyUpdateParamsExcludeAccessAzureGroupRule, zero_trust.AccessApplicationPolicyUpdateParamsExcludeAccessGitHubOrganizationRule, zero_trust.AccessApplicationPolicyUpdateParamsExcludeAccessGsuiteGroupRule, zero_trust.AccessApplicationPolicyUpdateParamsExcludeAccessOktaGroupRule, zero_trust.AccessApplicationPolicyUpdateParamsExcludeAccessSamlGroupRule, zero_trust.AccessApplicationPolicyUpdateParamsExcludeAccessServiceTokenRule, zero_trust.AccessApplicationPolicyUpdateParamsExcludeAccessAnyValidServiceTokenRule, zero_trust.AccessApplicationPolicyUpdateParamsExcludeAccessExternalEvaluationRule, zero_trust.AccessApplicationPolicyUpdateParamsExcludeAccessCountryRule, zero_trust.AccessApplicationPolicyUpdateParamsExcludeAccessAuthenticationMethodRule, zero_trust.AccessApplicationPolicyUpdateParamsExcludeAccessDevicePostureRule.

type AccessApplicationPolicyUpdateParamsExcludeAccessAccessGroupRule 

type AccessApplicationPolicyUpdateParamsExcludeAccessAccessGroupRule struct {
	Group param.Field[AccessApplicationPolicyUpdateParamsExcludeAccessAccessGroupRuleGroup] `json:"group,required"`
}

Matches an Access group.

func (AccessApplicationPolicyUpdateParamsExcludeAccessAccessGroupRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsExcludeAccessAccessGroupRuleGroup 

type AccessApplicationPolicyUpdateParamsExcludeAccessAccessGroupRuleGroup struct {
	// The ID of a previously created Access group.
	ID param.Field[string] `json:"id,required"`
}

func (AccessApplicationPolicyUpdateParamsExcludeAccessAccessGroupRuleGroup) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsExcludeAccessAnyValidServiceTokenRule 

type AccessApplicationPolicyUpdateParamsExcludeAccessAnyValidServiceTokenRule struct {
	// An empty object which matches on all service tokens.
	AnyValidServiceToken param.Field[interface{}] `json:"any_valid_service_token,required"`
}

Matches any valid Access Service Token

func (AccessApplicationPolicyUpdateParamsExcludeAccessAnyValidServiceTokenRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsExcludeAccessAuthenticationMethodRule 

type AccessApplicationPolicyUpdateParamsExcludeAccessAuthenticationMethodRule struct {
	AuthMethod param.Field[AccessApplicationPolicyUpdateParamsExcludeAccessAuthenticationMethodRuleAuthMethod] `json:"auth_method,required"`
}

Enforce different MFA options

func (AccessApplicationPolicyUpdateParamsExcludeAccessAuthenticationMethodRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsExcludeAccessAuthenticationMethodRuleAuthMethod 

type AccessApplicationPolicyUpdateParamsExcludeAccessAuthenticationMethodRuleAuthMethod struct {
	// The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
	AuthMethod param.Field[string] `json:"auth_method,required"`
}

func (AccessApplicationPolicyUpdateParamsExcludeAccessAuthenticationMethodRuleAuthMethod) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsExcludeAccessAzureGroupRule 

type AccessApplicationPolicyUpdateParamsExcludeAccessAzureGroupRule struct {
	AzureAd param.Field[AccessApplicationPolicyUpdateParamsExcludeAccessAzureGroupRuleAzureAd] `json:"azureAD,required"`
}

Matches an Azure group. Requires an Azure identity provider.

func (AccessApplicationPolicyUpdateParamsExcludeAccessAzureGroupRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsExcludeAccessAzureGroupRuleAzureAd 

type AccessApplicationPolicyUpdateParamsExcludeAccessAzureGroupRuleAzureAd struct {
	// The ID of an Azure group.
	ID param.Field[string] `json:"id,required"`
	// The ID of your Azure identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
}

func (AccessApplicationPolicyUpdateParamsExcludeAccessAzureGroupRuleAzureAd) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsExcludeAccessCertificateRule 

type AccessApplicationPolicyUpdateParamsExcludeAccessCertificateRule struct {
	Certificate param.Field[interface{}] `json:"certificate,required"`
}

Matches any valid client certificate.

func (AccessApplicationPolicyUpdateParamsExcludeAccessCertificateRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsExcludeAccessCountryRule 

type AccessApplicationPolicyUpdateParamsExcludeAccessCountryRule struct {
	Geo param.Field[AccessApplicationPolicyUpdateParamsExcludeAccessCountryRuleGeo] `json:"geo,required"`
}

Matches a specific country

func (AccessApplicationPolicyUpdateParamsExcludeAccessCountryRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsExcludeAccessCountryRuleGeo 

type AccessApplicationPolicyUpdateParamsExcludeAccessCountryRuleGeo struct {
	// The country code that should be matched.
	CountryCode param.Field[string] `json:"country_code,required"`
}

func (AccessApplicationPolicyUpdateParamsExcludeAccessCountryRuleGeo) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsExcludeAccessDevicePostureRule 

type AccessApplicationPolicyUpdateParamsExcludeAccessDevicePostureRule struct {
	DevicePosture param.Field[AccessApplicationPolicyUpdateParamsExcludeAccessDevicePostureRuleDevicePosture] `json:"device_posture,required"`
}

Enforces a device posture rule has run successfully

func (AccessApplicationPolicyUpdateParamsExcludeAccessDevicePostureRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsExcludeAccessDevicePostureRuleDevicePosture 

type AccessApplicationPolicyUpdateParamsExcludeAccessDevicePostureRuleDevicePosture struct {
	// The ID of a device posture integration.
	IntegrationUid param.Field[string] `json:"integration_uid,required"`
}

func (AccessApplicationPolicyUpdateParamsExcludeAccessDevicePostureRuleDevicePosture) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsExcludeAccessDomainRule 

type AccessApplicationPolicyUpdateParamsExcludeAccessDomainRule struct {
	EmailDomain param.Field[AccessApplicationPolicyUpdateParamsExcludeAccessDomainRuleEmailDomain] `json:"email_domain,required"`
}

Match an entire email domain.

func (AccessApplicationPolicyUpdateParamsExcludeAccessDomainRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsExcludeAccessDomainRuleEmailDomain 

type AccessApplicationPolicyUpdateParamsExcludeAccessDomainRuleEmailDomain struct {
	// The email domain to match.
	Domain param.Field[string] `json:"domain,required"`
}

func (AccessApplicationPolicyUpdateParamsExcludeAccessDomainRuleEmailDomain) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsExcludeAccessEmailListRule 

type AccessApplicationPolicyUpdateParamsExcludeAccessEmailListRule struct {
	EmailList param.Field[AccessApplicationPolicyUpdateParamsExcludeAccessEmailListRuleEmailList] `json:"email_list,required"`
}

Matches an email address from a list.

func (AccessApplicationPolicyUpdateParamsExcludeAccessEmailListRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsExcludeAccessEmailListRuleEmailList 

type AccessApplicationPolicyUpdateParamsExcludeAccessEmailListRuleEmailList struct {
	// The ID of a previously created email list.
	ID param.Field[string] `json:"id,required"`
}

func (AccessApplicationPolicyUpdateParamsExcludeAccessEmailListRuleEmailList) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsExcludeAccessEmailRule 

type AccessApplicationPolicyUpdateParamsExcludeAccessEmailRule struct {
	Email param.Field[AccessApplicationPolicyUpdateParamsExcludeAccessEmailRuleEmail] `json:"email,required"`
}

Matches a specific email.

func (AccessApplicationPolicyUpdateParamsExcludeAccessEmailRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsExcludeAccessEmailRuleEmail 

type AccessApplicationPolicyUpdateParamsExcludeAccessEmailRuleEmail struct {
	// The email of the user.
	Email param.Field[string] `json:"email,required" format:"email"`
}

func (AccessApplicationPolicyUpdateParamsExcludeAccessEmailRuleEmail) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsExcludeAccessEveryoneRule 

type AccessApplicationPolicyUpdateParamsExcludeAccessEveryoneRule struct {
	// An empty object which matches on all users.
	Everyone param.Field[interface{}] `json:"everyone,required"`
}

Matches everyone.

func (AccessApplicationPolicyUpdateParamsExcludeAccessEveryoneRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsExcludeAccessExternalEvaluationRule 

type AccessApplicationPolicyUpdateParamsExcludeAccessExternalEvaluationRule struct {
	ExternalEvaluation param.Field[AccessApplicationPolicyUpdateParamsExcludeAccessExternalEvaluationRuleExternalEvaluation] `json:"external_evaluation,required"`
}

Create Allow or Block policies which evaluate the user based on custom criteria.

func (AccessApplicationPolicyUpdateParamsExcludeAccessExternalEvaluationRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsExcludeAccessExternalEvaluationRuleExternalEvaluation 

type AccessApplicationPolicyUpdateParamsExcludeAccessExternalEvaluationRuleExternalEvaluation struct {
	// The API endpoint containing your business logic.
	EvaluateURL param.Field[string] `json:"evaluate_url,required"`
	// The API endpoint containing the key that Access uses to verify that the response
	// came from your API.
	KeysURL param.Field[string] `json:"keys_url,required"`
}

func (AccessApplicationPolicyUpdateParamsExcludeAccessExternalEvaluationRuleExternalEvaluation) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsExcludeAccessGitHubOrganizationRule 

type AccessApplicationPolicyUpdateParamsExcludeAccessGitHubOrganizationRule struct {
	GitHubOrganization param.Field[AccessApplicationPolicyUpdateParamsExcludeAccessGitHubOrganizationRuleGitHubOrganization] `json:"github-organization,required"`
}

Matches a Github organization. Requires a Github identity provider.

func (AccessApplicationPolicyUpdateParamsExcludeAccessGitHubOrganizationRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsExcludeAccessGitHubOrganizationRuleGitHubOrganization 

type AccessApplicationPolicyUpdateParamsExcludeAccessGitHubOrganizationRuleGitHubOrganization struct {
	// The ID of your Github identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The name of the organization.
	Name param.Field[string] `json:"name,required"`
}

func (AccessApplicationPolicyUpdateParamsExcludeAccessGitHubOrganizationRuleGitHubOrganization) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsExcludeAccessGsuiteGroupRule 

type AccessApplicationPolicyUpdateParamsExcludeAccessGsuiteGroupRule struct {
	Gsuite param.Field[AccessApplicationPolicyUpdateParamsExcludeAccessGsuiteGroupRuleGsuite] `json:"gsuite,required"`
}

Matches a group in Google Workspace. Requires a Google Workspace identity provider.

func (AccessApplicationPolicyUpdateParamsExcludeAccessGsuiteGroupRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsExcludeAccessGsuiteGroupRuleGsuite 

type AccessApplicationPolicyUpdateParamsExcludeAccessGsuiteGroupRuleGsuite struct {
	// The ID of your Google Workspace identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The email of the Google Workspace group.
	Email param.Field[string] `json:"email,required"`
}

func (AccessApplicationPolicyUpdateParamsExcludeAccessGsuiteGroupRuleGsuite) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsExcludeAccessIPListRule 

type AccessApplicationPolicyUpdateParamsExcludeAccessIPListRule struct {
	IPList param.Field[AccessApplicationPolicyUpdateParamsExcludeAccessIPListRuleIPList] `json:"ip_list,required"`
}

Matches an IP address from a list.

func (AccessApplicationPolicyUpdateParamsExcludeAccessIPListRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsExcludeAccessIPListRuleIPList 

type AccessApplicationPolicyUpdateParamsExcludeAccessIPListRuleIPList struct {
	// The ID of a previously created IP list.
	ID param.Field[string] `json:"id,required"`
}

func (AccessApplicationPolicyUpdateParamsExcludeAccessIPListRuleIPList) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsExcludeAccessIPRule 

type AccessApplicationPolicyUpdateParamsExcludeAccessIPRule struct {
	IP param.Field[AccessApplicationPolicyUpdateParamsExcludeAccessIPRuleIP] `json:"ip,required"`
}

Matches an IP address block.

func (AccessApplicationPolicyUpdateParamsExcludeAccessIPRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsExcludeAccessIPRuleIP 

type AccessApplicationPolicyUpdateParamsExcludeAccessIPRuleIP struct {
	// An IPv4 or IPv6 CIDR block.
	IP param.Field[string] `json:"ip,required"`
}

func (AccessApplicationPolicyUpdateParamsExcludeAccessIPRuleIP) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsExcludeAccessOktaGroupRule 

type AccessApplicationPolicyUpdateParamsExcludeAccessOktaGroupRule struct {
	Okta param.Field[AccessApplicationPolicyUpdateParamsExcludeAccessOktaGroupRuleOkta] `json:"okta,required"`
}

Matches an Okta group. Requires an Okta identity provider.

func (AccessApplicationPolicyUpdateParamsExcludeAccessOktaGroupRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsExcludeAccessOktaGroupRuleOkta 

type AccessApplicationPolicyUpdateParamsExcludeAccessOktaGroupRuleOkta struct {
	// The ID of your Okta identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The email of the Okta group.
	Email param.Field[string] `json:"email,required"`
}

func (AccessApplicationPolicyUpdateParamsExcludeAccessOktaGroupRuleOkta) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsExcludeAccessSamlGroupRule 

type AccessApplicationPolicyUpdateParamsExcludeAccessSamlGroupRule struct {
	Saml param.Field[AccessApplicationPolicyUpdateParamsExcludeAccessSamlGroupRuleSaml] `json:"saml,required"`
}

Matches a SAML group. Requires a SAML identity provider.

func (AccessApplicationPolicyUpdateParamsExcludeAccessSamlGroupRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsExcludeAccessSamlGroupRuleSaml 

type AccessApplicationPolicyUpdateParamsExcludeAccessSamlGroupRuleSaml struct {
	// The name of the SAML attribute.
	AttributeName param.Field[string] `json:"attribute_name,required"`
	// The SAML attribute value to look for.
	AttributeValue param.Field[string] `json:"attribute_value,required"`
}

func (AccessApplicationPolicyUpdateParamsExcludeAccessSamlGroupRuleSaml) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsExcludeAccessServiceTokenRule 

type AccessApplicationPolicyUpdateParamsExcludeAccessServiceTokenRule struct {
	ServiceToken param.Field[AccessApplicationPolicyUpdateParamsExcludeAccessServiceTokenRuleServiceToken] `json:"service_token,required"`
}

Matches a specific Access Service Token

func (AccessApplicationPolicyUpdateParamsExcludeAccessServiceTokenRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsExcludeAccessServiceTokenRuleServiceToken 

type AccessApplicationPolicyUpdateParamsExcludeAccessServiceTokenRuleServiceToken struct {
	// The ID of a Service Token.
	TokenID param.Field[string] `json:"token_id,required"`
}

func (AccessApplicationPolicyUpdateParamsExcludeAccessServiceTokenRuleServiceToken) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsInclude 

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

Matches a specific email.

Satisfied by zero_trust.AccessApplicationPolicyUpdateParamsIncludeAccessEmailRule, zero_trust.AccessApplicationPolicyUpdateParamsIncludeAccessEmailListRule, zero_trust.AccessApplicationPolicyUpdateParamsIncludeAccessDomainRule, zero_trust.AccessApplicationPolicyUpdateParamsIncludeAccessEveryoneRule, zero_trust.AccessApplicationPolicyUpdateParamsIncludeAccessIPRule, zero_trust.AccessApplicationPolicyUpdateParamsIncludeAccessIPListRule, zero_trust.AccessApplicationPolicyUpdateParamsIncludeAccessCertificateRule, zero_trust.AccessApplicationPolicyUpdateParamsIncludeAccessAccessGroupRule, zero_trust.AccessApplicationPolicyUpdateParamsIncludeAccessAzureGroupRule, zero_trust.AccessApplicationPolicyUpdateParamsIncludeAccessGitHubOrganizationRule, zero_trust.AccessApplicationPolicyUpdateParamsIncludeAccessGsuiteGroupRule, zero_trust.AccessApplicationPolicyUpdateParamsIncludeAccessOktaGroupRule, zero_trust.AccessApplicationPolicyUpdateParamsIncludeAccessSamlGroupRule, zero_trust.AccessApplicationPolicyUpdateParamsIncludeAccessServiceTokenRule, zero_trust.AccessApplicationPolicyUpdateParamsIncludeAccessAnyValidServiceTokenRule, zero_trust.AccessApplicationPolicyUpdateParamsIncludeAccessExternalEvaluationRule, zero_trust.AccessApplicationPolicyUpdateParamsIncludeAccessCountryRule, zero_trust.AccessApplicationPolicyUpdateParamsIncludeAccessAuthenticationMethodRule, zero_trust.AccessApplicationPolicyUpdateParamsIncludeAccessDevicePostureRule.

type AccessApplicationPolicyUpdateParamsIncludeAccessAccessGroupRule 

type AccessApplicationPolicyUpdateParamsIncludeAccessAccessGroupRule struct {
	Group param.Field[AccessApplicationPolicyUpdateParamsIncludeAccessAccessGroupRuleGroup] `json:"group,required"`
}

Matches an Access group.

func (AccessApplicationPolicyUpdateParamsIncludeAccessAccessGroupRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsIncludeAccessAccessGroupRuleGroup 

type AccessApplicationPolicyUpdateParamsIncludeAccessAccessGroupRuleGroup struct {
	// The ID of a previously created Access group.
	ID param.Field[string] `json:"id,required"`
}

func (AccessApplicationPolicyUpdateParamsIncludeAccessAccessGroupRuleGroup) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsIncludeAccessAnyValidServiceTokenRule 

type AccessApplicationPolicyUpdateParamsIncludeAccessAnyValidServiceTokenRule struct {
	// An empty object which matches on all service tokens.
	AnyValidServiceToken param.Field[interface{}] `json:"any_valid_service_token,required"`
}

Matches any valid Access Service Token

func (AccessApplicationPolicyUpdateParamsIncludeAccessAnyValidServiceTokenRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsIncludeAccessAuthenticationMethodRule 

type AccessApplicationPolicyUpdateParamsIncludeAccessAuthenticationMethodRule struct {
	AuthMethod param.Field[AccessApplicationPolicyUpdateParamsIncludeAccessAuthenticationMethodRuleAuthMethod] `json:"auth_method,required"`
}

Enforce different MFA options

func (AccessApplicationPolicyUpdateParamsIncludeAccessAuthenticationMethodRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsIncludeAccessAuthenticationMethodRuleAuthMethod 

type AccessApplicationPolicyUpdateParamsIncludeAccessAuthenticationMethodRuleAuthMethod struct {
	// The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
	AuthMethod param.Field[string] `json:"auth_method,required"`
}

func (AccessApplicationPolicyUpdateParamsIncludeAccessAuthenticationMethodRuleAuthMethod) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsIncludeAccessAzureGroupRule 

type AccessApplicationPolicyUpdateParamsIncludeAccessAzureGroupRule struct {
	AzureAd param.Field[AccessApplicationPolicyUpdateParamsIncludeAccessAzureGroupRuleAzureAd] `json:"azureAD,required"`
}

Matches an Azure group. Requires an Azure identity provider.

func (AccessApplicationPolicyUpdateParamsIncludeAccessAzureGroupRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsIncludeAccessAzureGroupRuleAzureAd 

type AccessApplicationPolicyUpdateParamsIncludeAccessAzureGroupRuleAzureAd struct {
	// The ID of an Azure group.
	ID param.Field[string] `json:"id,required"`
	// The ID of your Azure identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
}

func (AccessApplicationPolicyUpdateParamsIncludeAccessAzureGroupRuleAzureAd) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsIncludeAccessCertificateRule 

type AccessApplicationPolicyUpdateParamsIncludeAccessCertificateRule struct {
	Certificate param.Field[interface{}] `json:"certificate,required"`
}

Matches any valid client certificate.

func (AccessApplicationPolicyUpdateParamsIncludeAccessCertificateRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsIncludeAccessCountryRule 

type AccessApplicationPolicyUpdateParamsIncludeAccessCountryRule struct {
	Geo param.Field[AccessApplicationPolicyUpdateParamsIncludeAccessCountryRuleGeo] `json:"geo,required"`
}

Matches a specific country

func (AccessApplicationPolicyUpdateParamsIncludeAccessCountryRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsIncludeAccessCountryRuleGeo 

type AccessApplicationPolicyUpdateParamsIncludeAccessCountryRuleGeo struct {
	// The country code that should be matched.
	CountryCode param.Field[string] `json:"country_code,required"`
}

func (AccessApplicationPolicyUpdateParamsIncludeAccessCountryRuleGeo) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsIncludeAccessDevicePostureRule 

type AccessApplicationPolicyUpdateParamsIncludeAccessDevicePostureRule struct {
	DevicePosture param.Field[AccessApplicationPolicyUpdateParamsIncludeAccessDevicePostureRuleDevicePosture] `json:"device_posture,required"`
}

Enforces a device posture rule has run successfully

func (AccessApplicationPolicyUpdateParamsIncludeAccessDevicePostureRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsIncludeAccessDevicePostureRuleDevicePosture 

type AccessApplicationPolicyUpdateParamsIncludeAccessDevicePostureRuleDevicePosture struct {
	// The ID of a device posture integration.
	IntegrationUid param.Field[string] `json:"integration_uid,required"`
}

func (AccessApplicationPolicyUpdateParamsIncludeAccessDevicePostureRuleDevicePosture) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsIncludeAccessDomainRule 

type AccessApplicationPolicyUpdateParamsIncludeAccessDomainRule struct {
	EmailDomain param.Field[AccessApplicationPolicyUpdateParamsIncludeAccessDomainRuleEmailDomain] `json:"email_domain,required"`
}

Match an entire email domain.

func (AccessApplicationPolicyUpdateParamsIncludeAccessDomainRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsIncludeAccessDomainRuleEmailDomain 

type AccessApplicationPolicyUpdateParamsIncludeAccessDomainRuleEmailDomain struct {
	// The email domain to match.
	Domain param.Field[string] `json:"domain,required"`
}

func (AccessApplicationPolicyUpdateParamsIncludeAccessDomainRuleEmailDomain) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsIncludeAccessEmailListRule 

type AccessApplicationPolicyUpdateParamsIncludeAccessEmailListRule struct {
	EmailList param.Field[AccessApplicationPolicyUpdateParamsIncludeAccessEmailListRuleEmailList] `json:"email_list,required"`
}

Matches an email address from a list.

func (AccessApplicationPolicyUpdateParamsIncludeAccessEmailListRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsIncludeAccessEmailListRuleEmailList 

type AccessApplicationPolicyUpdateParamsIncludeAccessEmailListRuleEmailList struct {
	// The ID of a previously created email list.
	ID param.Field[string] `json:"id,required"`
}

func (AccessApplicationPolicyUpdateParamsIncludeAccessEmailListRuleEmailList) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsIncludeAccessEmailRule 

type AccessApplicationPolicyUpdateParamsIncludeAccessEmailRule struct {
	Email param.Field[AccessApplicationPolicyUpdateParamsIncludeAccessEmailRuleEmail] `json:"email,required"`
}

Matches a specific email.

func (AccessApplicationPolicyUpdateParamsIncludeAccessEmailRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsIncludeAccessEmailRuleEmail 

type AccessApplicationPolicyUpdateParamsIncludeAccessEmailRuleEmail struct {
	// The email of the user.
	Email param.Field[string] `json:"email,required" format:"email"`
}

func (AccessApplicationPolicyUpdateParamsIncludeAccessEmailRuleEmail) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsIncludeAccessEveryoneRule 

type AccessApplicationPolicyUpdateParamsIncludeAccessEveryoneRule struct {
	// An empty object which matches on all users.
	Everyone param.Field[interface{}] `json:"everyone,required"`
}

Matches everyone.

func (AccessApplicationPolicyUpdateParamsIncludeAccessEveryoneRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsIncludeAccessExternalEvaluationRule 

type AccessApplicationPolicyUpdateParamsIncludeAccessExternalEvaluationRule struct {
	ExternalEvaluation param.Field[AccessApplicationPolicyUpdateParamsIncludeAccessExternalEvaluationRuleExternalEvaluation] `json:"external_evaluation,required"`
}

Create Allow or Block policies which evaluate the user based on custom criteria.

func (AccessApplicationPolicyUpdateParamsIncludeAccessExternalEvaluationRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsIncludeAccessExternalEvaluationRuleExternalEvaluation 

type AccessApplicationPolicyUpdateParamsIncludeAccessExternalEvaluationRuleExternalEvaluation struct {
	// The API endpoint containing your business logic.
	EvaluateURL param.Field[string] `json:"evaluate_url,required"`
	// The API endpoint containing the key that Access uses to verify that the response
	// came from your API.
	KeysURL param.Field[string] `json:"keys_url,required"`
}

func (AccessApplicationPolicyUpdateParamsIncludeAccessExternalEvaluationRuleExternalEvaluation) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsIncludeAccessGitHubOrganizationRule 

type AccessApplicationPolicyUpdateParamsIncludeAccessGitHubOrganizationRule struct {
	GitHubOrganization param.Field[AccessApplicationPolicyUpdateParamsIncludeAccessGitHubOrganizationRuleGitHubOrganization] `json:"github-organization,required"`
}

Matches a Github organization. Requires a Github identity provider.

func (AccessApplicationPolicyUpdateParamsIncludeAccessGitHubOrganizationRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsIncludeAccessGitHubOrganizationRuleGitHubOrganization 

type AccessApplicationPolicyUpdateParamsIncludeAccessGitHubOrganizationRuleGitHubOrganization struct {
	// The ID of your Github identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The name of the organization.
	Name param.Field[string] `json:"name,required"`
}

func (AccessApplicationPolicyUpdateParamsIncludeAccessGitHubOrganizationRuleGitHubOrganization) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsIncludeAccessGsuiteGroupRule 

type AccessApplicationPolicyUpdateParamsIncludeAccessGsuiteGroupRule struct {
	Gsuite param.Field[AccessApplicationPolicyUpdateParamsIncludeAccessGsuiteGroupRuleGsuite] `json:"gsuite,required"`
}

Matches a group in Google Workspace. Requires a Google Workspace identity provider.

func (AccessApplicationPolicyUpdateParamsIncludeAccessGsuiteGroupRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsIncludeAccessGsuiteGroupRuleGsuite 

type AccessApplicationPolicyUpdateParamsIncludeAccessGsuiteGroupRuleGsuite struct {
	// The ID of your Google Workspace identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The email of the Google Workspace group.
	Email param.Field[string] `json:"email,required"`
}

func (AccessApplicationPolicyUpdateParamsIncludeAccessGsuiteGroupRuleGsuite) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsIncludeAccessIPListRule 

type AccessApplicationPolicyUpdateParamsIncludeAccessIPListRule struct {
	IPList param.Field[AccessApplicationPolicyUpdateParamsIncludeAccessIPListRuleIPList] `json:"ip_list,required"`
}

Matches an IP address from a list.

func (AccessApplicationPolicyUpdateParamsIncludeAccessIPListRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsIncludeAccessIPListRuleIPList 

type AccessApplicationPolicyUpdateParamsIncludeAccessIPListRuleIPList struct {
	// The ID of a previously created IP list.
	ID param.Field[string] `json:"id,required"`
}

func (AccessApplicationPolicyUpdateParamsIncludeAccessIPListRuleIPList) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsIncludeAccessIPRule 

type AccessApplicationPolicyUpdateParamsIncludeAccessIPRule struct {
	IP param.Field[AccessApplicationPolicyUpdateParamsIncludeAccessIPRuleIP] `json:"ip,required"`
}

Matches an IP address block.

func (AccessApplicationPolicyUpdateParamsIncludeAccessIPRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsIncludeAccessIPRuleIP 

type AccessApplicationPolicyUpdateParamsIncludeAccessIPRuleIP struct {
	// An IPv4 or IPv6 CIDR block.
	IP param.Field[string] `json:"ip,required"`
}

func (AccessApplicationPolicyUpdateParamsIncludeAccessIPRuleIP) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsIncludeAccessOktaGroupRule 

type AccessApplicationPolicyUpdateParamsIncludeAccessOktaGroupRule struct {
	Okta param.Field[AccessApplicationPolicyUpdateParamsIncludeAccessOktaGroupRuleOkta] `json:"okta,required"`
}

Matches an Okta group. Requires an Okta identity provider.

func (AccessApplicationPolicyUpdateParamsIncludeAccessOktaGroupRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsIncludeAccessOktaGroupRuleOkta 

type AccessApplicationPolicyUpdateParamsIncludeAccessOktaGroupRuleOkta struct {
	// The ID of your Okta identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The email of the Okta group.
	Email param.Field[string] `json:"email,required"`
}

func (AccessApplicationPolicyUpdateParamsIncludeAccessOktaGroupRuleOkta) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsIncludeAccessSamlGroupRule 

type AccessApplicationPolicyUpdateParamsIncludeAccessSamlGroupRule struct {
	Saml param.Field[AccessApplicationPolicyUpdateParamsIncludeAccessSamlGroupRuleSaml] `json:"saml,required"`
}

Matches a SAML group. Requires a SAML identity provider.

func (AccessApplicationPolicyUpdateParamsIncludeAccessSamlGroupRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsIncludeAccessSamlGroupRuleSaml 

type AccessApplicationPolicyUpdateParamsIncludeAccessSamlGroupRuleSaml struct {
	// The name of the SAML attribute.
	AttributeName param.Field[string] `json:"attribute_name,required"`
	// The SAML attribute value to look for.
	AttributeValue param.Field[string] `json:"attribute_value,required"`
}

func (AccessApplicationPolicyUpdateParamsIncludeAccessSamlGroupRuleSaml) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsIncludeAccessServiceTokenRule 

type AccessApplicationPolicyUpdateParamsIncludeAccessServiceTokenRule struct {
	ServiceToken param.Field[AccessApplicationPolicyUpdateParamsIncludeAccessServiceTokenRuleServiceToken] `json:"service_token,required"`
}

Matches a specific Access Service Token

func (AccessApplicationPolicyUpdateParamsIncludeAccessServiceTokenRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsIncludeAccessServiceTokenRuleServiceToken 

type AccessApplicationPolicyUpdateParamsIncludeAccessServiceTokenRuleServiceToken struct {
	// The ID of a Service Token.
	TokenID param.Field[string] `json:"token_id,required"`
}

func (AccessApplicationPolicyUpdateParamsIncludeAccessServiceTokenRuleServiceToken) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsRequire 

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

Matches a specific email.

Satisfied by zero_trust.AccessApplicationPolicyUpdateParamsRequireAccessEmailRule, zero_trust.AccessApplicationPolicyUpdateParamsRequireAccessEmailListRule, zero_trust.AccessApplicationPolicyUpdateParamsRequireAccessDomainRule, zero_trust.AccessApplicationPolicyUpdateParamsRequireAccessEveryoneRule, zero_trust.AccessApplicationPolicyUpdateParamsRequireAccessIPRule, zero_trust.AccessApplicationPolicyUpdateParamsRequireAccessIPListRule, zero_trust.AccessApplicationPolicyUpdateParamsRequireAccessCertificateRule, zero_trust.AccessApplicationPolicyUpdateParamsRequireAccessAccessGroupRule, zero_trust.AccessApplicationPolicyUpdateParamsRequireAccessAzureGroupRule, zero_trust.AccessApplicationPolicyUpdateParamsRequireAccessGitHubOrganizationRule, zero_trust.AccessApplicationPolicyUpdateParamsRequireAccessGsuiteGroupRule, zero_trust.AccessApplicationPolicyUpdateParamsRequireAccessOktaGroupRule, zero_trust.AccessApplicationPolicyUpdateParamsRequireAccessSamlGroupRule, zero_trust.AccessApplicationPolicyUpdateParamsRequireAccessServiceTokenRule, zero_trust.AccessApplicationPolicyUpdateParamsRequireAccessAnyValidServiceTokenRule, zero_trust.AccessApplicationPolicyUpdateParamsRequireAccessExternalEvaluationRule, zero_trust.AccessApplicationPolicyUpdateParamsRequireAccessCountryRule, zero_trust.AccessApplicationPolicyUpdateParamsRequireAccessAuthenticationMethodRule, zero_trust.AccessApplicationPolicyUpdateParamsRequireAccessDevicePostureRule.

type AccessApplicationPolicyUpdateParamsRequireAccessAccessGroupRule 

type AccessApplicationPolicyUpdateParamsRequireAccessAccessGroupRule struct {
	Group param.Field[AccessApplicationPolicyUpdateParamsRequireAccessAccessGroupRuleGroup] `json:"group,required"`
}

Matches an Access group.

func (AccessApplicationPolicyUpdateParamsRequireAccessAccessGroupRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsRequireAccessAccessGroupRuleGroup 

type AccessApplicationPolicyUpdateParamsRequireAccessAccessGroupRuleGroup struct {
	// The ID of a previously created Access group.
	ID param.Field[string] `json:"id,required"`
}

func (AccessApplicationPolicyUpdateParamsRequireAccessAccessGroupRuleGroup) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsRequireAccessAnyValidServiceTokenRule 

type AccessApplicationPolicyUpdateParamsRequireAccessAnyValidServiceTokenRule struct {
	// An empty object which matches on all service tokens.
	AnyValidServiceToken param.Field[interface{}] `json:"any_valid_service_token,required"`
}

Matches any valid Access Service Token

func (AccessApplicationPolicyUpdateParamsRequireAccessAnyValidServiceTokenRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsRequireAccessAuthenticationMethodRule 

type AccessApplicationPolicyUpdateParamsRequireAccessAuthenticationMethodRule struct {
	AuthMethod param.Field[AccessApplicationPolicyUpdateParamsRequireAccessAuthenticationMethodRuleAuthMethod] `json:"auth_method,required"`
}

Enforce different MFA options

func (AccessApplicationPolicyUpdateParamsRequireAccessAuthenticationMethodRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsRequireAccessAuthenticationMethodRuleAuthMethod 

type AccessApplicationPolicyUpdateParamsRequireAccessAuthenticationMethodRuleAuthMethod struct {
	// The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
	AuthMethod param.Field[string] `json:"auth_method,required"`
}

func (AccessApplicationPolicyUpdateParamsRequireAccessAuthenticationMethodRuleAuthMethod) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsRequireAccessAzureGroupRule 

type AccessApplicationPolicyUpdateParamsRequireAccessAzureGroupRule struct {
	AzureAd param.Field[AccessApplicationPolicyUpdateParamsRequireAccessAzureGroupRuleAzureAd] `json:"azureAD,required"`
}

Matches an Azure group. Requires an Azure identity provider.

func (AccessApplicationPolicyUpdateParamsRequireAccessAzureGroupRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsRequireAccessAzureGroupRuleAzureAd 

type AccessApplicationPolicyUpdateParamsRequireAccessAzureGroupRuleAzureAd struct {
	// The ID of an Azure group.
	ID param.Field[string] `json:"id,required"`
	// The ID of your Azure identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
}

func (AccessApplicationPolicyUpdateParamsRequireAccessAzureGroupRuleAzureAd) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsRequireAccessCertificateRule 

type AccessApplicationPolicyUpdateParamsRequireAccessCertificateRule struct {
	Certificate param.Field[interface{}] `json:"certificate,required"`
}

Matches any valid client certificate.

func (AccessApplicationPolicyUpdateParamsRequireAccessCertificateRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsRequireAccessCountryRule 

type AccessApplicationPolicyUpdateParamsRequireAccessCountryRule struct {
	Geo param.Field[AccessApplicationPolicyUpdateParamsRequireAccessCountryRuleGeo] `json:"geo,required"`
}

Matches a specific country

func (AccessApplicationPolicyUpdateParamsRequireAccessCountryRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsRequireAccessCountryRuleGeo 

type AccessApplicationPolicyUpdateParamsRequireAccessCountryRuleGeo struct {
	// The country code that should be matched.
	CountryCode param.Field[string] `json:"country_code,required"`
}

func (AccessApplicationPolicyUpdateParamsRequireAccessCountryRuleGeo) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsRequireAccessDevicePostureRule 

type AccessApplicationPolicyUpdateParamsRequireAccessDevicePostureRule struct {
	DevicePosture param.Field[AccessApplicationPolicyUpdateParamsRequireAccessDevicePostureRuleDevicePosture] `json:"device_posture,required"`
}

Enforces a device posture rule has run successfully

func (AccessApplicationPolicyUpdateParamsRequireAccessDevicePostureRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsRequireAccessDevicePostureRuleDevicePosture 

type AccessApplicationPolicyUpdateParamsRequireAccessDevicePostureRuleDevicePosture struct {
	// The ID of a device posture integration.
	IntegrationUid param.Field[string] `json:"integration_uid,required"`
}

func (AccessApplicationPolicyUpdateParamsRequireAccessDevicePostureRuleDevicePosture) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsRequireAccessDomainRule 

type AccessApplicationPolicyUpdateParamsRequireAccessDomainRule struct {
	EmailDomain param.Field[AccessApplicationPolicyUpdateParamsRequireAccessDomainRuleEmailDomain] `json:"email_domain,required"`
}

Match an entire email domain.

func (AccessApplicationPolicyUpdateParamsRequireAccessDomainRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsRequireAccessDomainRuleEmailDomain 

type AccessApplicationPolicyUpdateParamsRequireAccessDomainRuleEmailDomain struct {
	// The email domain to match.
	Domain param.Field[string] `json:"domain,required"`
}

func (AccessApplicationPolicyUpdateParamsRequireAccessDomainRuleEmailDomain) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsRequireAccessEmailListRule 

type AccessApplicationPolicyUpdateParamsRequireAccessEmailListRule struct {
	EmailList param.Field[AccessApplicationPolicyUpdateParamsRequireAccessEmailListRuleEmailList] `json:"email_list,required"`
}

Matches an email address from a list.

func (AccessApplicationPolicyUpdateParamsRequireAccessEmailListRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsRequireAccessEmailListRuleEmailList 

type AccessApplicationPolicyUpdateParamsRequireAccessEmailListRuleEmailList struct {
	// The ID of a previously created email list.
	ID param.Field[string] `json:"id,required"`
}

func (AccessApplicationPolicyUpdateParamsRequireAccessEmailListRuleEmailList) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsRequireAccessEmailRule 

type AccessApplicationPolicyUpdateParamsRequireAccessEmailRule struct {
	Email param.Field[AccessApplicationPolicyUpdateParamsRequireAccessEmailRuleEmail] `json:"email,required"`
}

Matches a specific email.

func (AccessApplicationPolicyUpdateParamsRequireAccessEmailRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsRequireAccessEmailRuleEmail 

type AccessApplicationPolicyUpdateParamsRequireAccessEmailRuleEmail struct {
	// The email of the user.
	Email param.Field[string] `json:"email,required" format:"email"`
}

func (AccessApplicationPolicyUpdateParamsRequireAccessEmailRuleEmail) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsRequireAccessEveryoneRule 

type AccessApplicationPolicyUpdateParamsRequireAccessEveryoneRule struct {
	// An empty object which matches on all users.
	Everyone param.Field[interface{}] `json:"everyone,required"`
}

Matches everyone.

func (AccessApplicationPolicyUpdateParamsRequireAccessEveryoneRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsRequireAccessExternalEvaluationRule 

type AccessApplicationPolicyUpdateParamsRequireAccessExternalEvaluationRule struct {
	ExternalEvaluation param.Field[AccessApplicationPolicyUpdateParamsRequireAccessExternalEvaluationRuleExternalEvaluation] `json:"external_evaluation,required"`
}

Create Allow or Block policies which evaluate the user based on custom criteria.

func (AccessApplicationPolicyUpdateParamsRequireAccessExternalEvaluationRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsRequireAccessExternalEvaluationRuleExternalEvaluation 

type AccessApplicationPolicyUpdateParamsRequireAccessExternalEvaluationRuleExternalEvaluation struct {
	// The API endpoint containing your business logic.
	EvaluateURL param.Field[string] `json:"evaluate_url,required"`
	// The API endpoint containing the key that Access uses to verify that the response
	// came from your API.
	KeysURL param.Field[string] `json:"keys_url,required"`
}

func (AccessApplicationPolicyUpdateParamsRequireAccessExternalEvaluationRuleExternalEvaluation) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsRequireAccessGitHubOrganizationRule 

type AccessApplicationPolicyUpdateParamsRequireAccessGitHubOrganizationRule struct {
	GitHubOrganization param.Field[AccessApplicationPolicyUpdateParamsRequireAccessGitHubOrganizationRuleGitHubOrganization] `json:"github-organization,required"`
}

Matches a Github organization. Requires a Github identity provider.

func (AccessApplicationPolicyUpdateParamsRequireAccessGitHubOrganizationRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsRequireAccessGitHubOrganizationRuleGitHubOrganization 

type AccessApplicationPolicyUpdateParamsRequireAccessGitHubOrganizationRuleGitHubOrganization struct {
	// The ID of your Github identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The name of the organization.
	Name param.Field[string] `json:"name,required"`
}

func (AccessApplicationPolicyUpdateParamsRequireAccessGitHubOrganizationRuleGitHubOrganization) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsRequireAccessGsuiteGroupRule 

type AccessApplicationPolicyUpdateParamsRequireAccessGsuiteGroupRule struct {
	Gsuite param.Field[AccessApplicationPolicyUpdateParamsRequireAccessGsuiteGroupRuleGsuite] `json:"gsuite,required"`
}

Matches a group in Google Workspace. Requires a Google Workspace identity provider.

func (AccessApplicationPolicyUpdateParamsRequireAccessGsuiteGroupRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsRequireAccessGsuiteGroupRuleGsuite 

type AccessApplicationPolicyUpdateParamsRequireAccessGsuiteGroupRuleGsuite struct {
	// The ID of your Google Workspace identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The email of the Google Workspace group.
	Email param.Field[string] `json:"email,required"`
}

func (AccessApplicationPolicyUpdateParamsRequireAccessGsuiteGroupRuleGsuite) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsRequireAccessIPListRule 

type AccessApplicationPolicyUpdateParamsRequireAccessIPListRule struct {
	IPList param.Field[AccessApplicationPolicyUpdateParamsRequireAccessIPListRuleIPList] `json:"ip_list,required"`
}

Matches an IP address from a list.

func (AccessApplicationPolicyUpdateParamsRequireAccessIPListRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsRequireAccessIPListRuleIPList 

type AccessApplicationPolicyUpdateParamsRequireAccessIPListRuleIPList struct {
	// The ID of a previously created IP list.
	ID param.Field[string] `json:"id,required"`
}

func (AccessApplicationPolicyUpdateParamsRequireAccessIPListRuleIPList) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsRequireAccessIPRule 

type AccessApplicationPolicyUpdateParamsRequireAccessIPRule struct {
	IP param.Field[AccessApplicationPolicyUpdateParamsRequireAccessIPRuleIP] `json:"ip,required"`
}

Matches an IP address block.

func (AccessApplicationPolicyUpdateParamsRequireAccessIPRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsRequireAccessIPRuleIP 

type AccessApplicationPolicyUpdateParamsRequireAccessIPRuleIP struct {
	// An IPv4 or IPv6 CIDR block.
	IP param.Field[string] `json:"ip,required"`
}

func (AccessApplicationPolicyUpdateParamsRequireAccessIPRuleIP) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsRequireAccessOktaGroupRule 

type AccessApplicationPolicyUpdateParamsRequireAccessOktaGroupRule struct {
	Okta param.Field[AccessApplicationPolicyUpdateParamsRequireAccessOktaGroupRuleOkta] `json:"okta,required"`
}

Matches an Okta group. Requires an Okta identity provider.

func (AccessApplicationPolicyUpdateParamsRequireAccessOktaGroupRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsRequireAccessOktaGroupRuleOkta 

type AccessApplicationPolicyUpdateParamsRequireAccessOktaGroupRuleOkta struct {
	// The ID of your Okta identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The email of the Okta group.
	Email param.Field[string] `json:"email,required"`
}

func (AccessApplicationPolicyUpdateParamsRequireAccessOktaGroupRuleOkta) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsRequireAccessSamlGroupRule 

type AccessApplicationPolicyUpdateParamsRequireAccessSamlGroupRule struct {
	Saml param.Field[AccessApplicationPolicyUpdateParamsRequireAccessSamlGroupRuleSaml] `json:"saml,required"`
}

Matches a SAML group. Requires a SAML identity provider.

func (AccessApplicationPolicyUpdateParamsRequireAccessSamlGroupRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsRequireAccessSamlGroupRuleSaml 

type AccessApplicationPolicyUpdateParamsRequireAccessSamlGroupRuleSaml struct {
	// The name of the SAML attribute.
	AttributeName param.Field[string] `json:"attribute_name,required"`
	// The SAML attribute value to look for.
	AttributeValue param.Field[string] `json:"attribute_value,required"`
}

func (AccessApplicationPolicyUpdateParamsRequireAccessSamlGroupRuleSaml) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsRequireAccessServiceTokenRule 

type AccessApplicationPolicyUpdateParamsRequireAccessServiceTokenRule struct {
	ServiceToken param.Field[AccessApplicationPolicyUpdateParamsRequireAccessServiceTokenRuleServiceToken] `json:"service_token,required"`
}

Matches a specific Access Service Token

func (AccessApplicationPolicyUpdateParamsRequireAccessServiceTokenRule) MarshalJSON 

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

type AccessApplicationPolicyUpdateParamsRequireAccessServiceTokenRuleServiceToken 

type AccessApplicationPolicyUpdateParamsRequireAccessServiceTokenRuleServiceToken struct {
	// The ID of a Service Token.
	TokenID param.Field[string] `json:"token_id,required"`
}

func (AccessApplicationPolicyUpdateParamsRequireAccessServiceTokenRuleServiceToken) MarshalJSON 

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

type AccessApplicationPolicyUpdateResponseEnvelope 

type AccessApplicationPolicyUpdateResponseEnvelope struct {
	Errors   []AccessApplicationPolicyUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessApplicationPolicyUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessPolicies                                          `json:"result,required"`
	// Whether the API call was successful
	Success AccessApplicationPolicyUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessApplicationPolicyUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*AccessApplicationPolicyUpdateResponseEnvelope) UnmarshalJSON 

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

type AccessApplicationPolicyUpdateResponseEnvelopeErrors 

type AccessApplicationPolicyUpdateResponseEnvelopeErrors struct {
	Code    int64                                                   `json:"code,required"`
	Message string                                                  `json:"message,required"`
	JSON    accessApplicationPolicyUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessApplicationPolicyUpdateResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessApplicationPolicyUpdateResponseEnvelopeMessages 

type AccessApplicationPolicyUpdateResponseEnvelopeMessages struct {
	Code    int64                                                     `json:"code,required"`
	Message string                                                    `json:"message,required"`
	JSON    accessApplicationPolicyUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessApplicationPolicyUpdateResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessApplicationPolicyUpdateResponseEnvelopeSuccess 

type AccessApplicationPolicyUpdateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessApplicationPolicyUpdateResponseEnvelopeSuccessTrue AccessApplicationPolicyUpdateResponseEnvelopeSuccess = true
)

type AccessApplicationRevokeTokensParams 

type AccessApplicationRevokeTokensParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type AccessApplicationRevokeTokensParamsAppID 

type AccessApplicationRevokeTokensParamsAppID interface {
	ImplementsZeroTrustAccessApplicationRevokeTokensParamsAppID()
}

Identifier

Satisfied by shared.UnionString, shared.UnionString.

type AccessApplicationRevokeTokensResponse 

type AccessApplicationRevokeTokensResponse = interface{}

type AccessApplicationRevokeTokensResponseEnvelope 

type AccessApplicationRevokeTokensResponseEnvelope struct {
	Result  AccessApplicationRevokeTokensResponse                `json:"result,nullable"`
	Success AccessApplicationRevokeTokensResponseEnvelopeSuccess `json:"success"`
	JSON    accessApplicationRevokeTokensResponseEnvelopeJSON    `json:"-"`
}

func (*AccessApplicationRevokeTokensResponseEnvelope) UnmarshalJSON 

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

type AccessApplicationRevokeTokensResponseEnvelopeSuccess 

type AccessApplicationRevokeTokensResponseEnvelopeSuccess bool
const (
	AccessApplicationRevokeTokensResponseEnvelopeSuccessTrue  AccessApplicationRevokeTokensResponseEnvelopeSuccess = true
	AccessApplicationRevokeTokensResponseEnvelopeSuccessFalse AccessApplicationRevokeTokensResponseEnvelopeSuccess = false
)

type AccessApplicationService 

type AccessApplicationService struct {
	Options          []option.RequestOption
	CAs              *AccessApplicationCAService
	UserPolicyChecks *AccessApplicationUserPolicyCheckService
	Policies         *AccessApplicationPolicyService
}

AccessApplicationService 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 NewAccessApplicationService method instead.

func NewAccessApplicationService 

func NewAccessApplicationService(opts ...option.RequestOption) (r *AccessApplicationService)

NewAccessApplicationService 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 (*AccessApplicationService) Delete 

func (r *AccessApplicationService) Delete(ctx context.Context, appID AccessApplicationDeleteParamsAppID, body AccessApplicationDeleteParams, opts ...option.RequestOption) (res *AccessApplicationDeleteResponse, err error)

Deletes an application from Access.

func (*AccessApplicationService) Get 

func (r *AccessApplicationService) Get(ctx context.Context, appID AccessApplicationGetParamsAppID, query AccessApplicationGetParams, opts ...option.RequestOption) (res *AccessApps, err error)

Fetches information about an Access application.

func (*AccessApplicationService) List 

func (r *AccessApplicationService) List(ctx context.Context, query AccessApplicationListParams, opts ...option.RequestOption) (res *[]AccessApps, err error)

Lists all Access applications in an account or zone.

func (*AccessApplicationService) New 

func (r *AccessApplicationService) New(ctx context.Context, params AccessApplicationNewParams, opts ...option.RequestOption) (res *AccessApps, err error)

Adds a new application to Access.

func (*AccessApplicationService) RevokeTokens 

func (r *AccessApplicationService) RevokeTokens(ctx context.Context, appID AccessApplicationRevokeTokensParamsAppID, body AccessApplicationRevokeTokensParams, opts ...option.RequestOption) (res *AccessApplicationRevokeTokensResponse, err error)

Revokes all tokens issued for an application.

func (*AccessApplicationService) Update 

func (r *AccessApplicationService) Update(ctx context.Context, appID AccessApplicationUpdateParamsAppID, params AccessApplicationUpdateParams, opts ...option.RequestOption) (res *AccessApps, err error)

Updates an Access application.

type AccessApplicationUpdateParams 

type AccessApplicationUpdateParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
	// When set to true, users can authenticate to this application using their WARP
	// session. When set to false this application will always require direct IdP
	// authentication. This setting always overrides the organization setting for WARP
	// authentication.
	AllowAuthenticateViaWARP param.Field[bool] `json:"allow_authenticate_via_warp"`
	// The identity providers your users can select when connecting to this
	// application. Defaults to all IdPs configured in your account.
	AllowedIdps        param.Field[[]string]    `json:"allowed_idps"`
	AppLauncherVisible param.Field[interface{}] `json:"app_launcher_visible"`
	// When set to `true`, users skip the identity provider selection step during
	// login. You must specify only one identity provider in allowed_idps.
	AutoRedirectToIdentity param.Field[bool]                                     `json:"auto_redirect_to_identity"`
	CorsHeaders            param.Field[AccessApplicationUpdateParamsCorsHeaders] `json:"cors_headers"`
	// The custom error message shown to a user when they are denied access to the
	// application.
	CustomDenyMessage param.Field[string] `json:"custom_deny_message"`
	// The custom URL a user is redirected to when they are denied access to the
	// application when failing identity-based rules.
	CustomDenyURL param.Field[string] `json:"custom_deny_url"`
	// The custom URL a user is redirected to when they are denied access to the
	// application when failing non-identity rules.
	CustomNonIdentityDenyURL param.Field[string] `json:"custom_non_identity_deny_url"`
	// The custom pages that will be displayed when applicable for this application
	CustomPages param.Field[[]string] `json:"custom_pages"`
	// The URL or domain of the bookmark.
	Domain param.Field[interface{}] `json:"domain"`
	// Enables the binding cookie, which increases security against compromised
	// authorization tokens and CSRF attacks.
	EnableBindingCookie param.Field[bool] `json:"enable_binding_cookie"`
	// Enables the HttpOnly cookie attribute, which increases security against XSS
	// attacks.
	HTTPOnlyCookieAttribute param.Field[bool] `json:"http_only_cookie_attribute"`
	// The image URL for the logo shown in the App Launcher dashboard.
	LogoURL param.Field[string] `json:"logo_url"`
	// The name of the application.
	Name param.Field[string] `json:"name"`
	// Enables cookie paths to scope an application's JWT to the application path. If
	// disabled, the JWT will scope to the hostname by default
	PathCookieAttribute param.Field[bool]                                 `json:"path_cookie_attribute"`
	SaasApp             param.Field[AccessApplicationUpdateParamsSaasApp] `json:"saas_app"`
	// Sets the SameSite cookie setting, which provides increased security against CSRF
	// attacks.
	SameSiteCookieAttribute param.Field[string] `json:"same_site_cookie_attribute"`
	// List of domains that Access will secure.
	SelfHostedDomains param.Field[[]string] `json:"self_hosted_domains"`
	// Returns a 401 status code when the request is blocked by a Service Auth policy.
	ServiceAuth401Redirect param.Field[bool] `json:"service_auth_401_redirect"`
	// The amount of time that tokens issued for this application will be valid. Must
	// be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms,
	// s, m, h.
	SessionDuration param.Field[string] `json:"session_duration"`
	// Enables automatic authentication through cloudflared.
	SkipInterstitial param.Field[bool] `json:"skip_interstitial"`
	// The tags you want assigned to an application. Tags are used to filter
	// applications in the App Launcher dashboard.
	Tags param.Field[[]string] `json:"tags"`
	// The application type.
	Type param.Field[string] `json:"type"`
}

func (AccessApplicationUpdateParams) MarshalJSON 

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

type AccessApplicationUpdateParamsAppID 

type AccessApplicationUpdateParamsAppID interface {
	ImplementsZeroTrustAccessApplicationUpdateParamsAppID()
}

Identifier

Satisfied by shared.UnionString, shared.UnionString.

type AccessApplicationUpdateParamsCorsHeaders 

type AccessApplicationUpdateParamsCorsHeaders struct {
	// Allows all HTTP request headers.
	AllowAllHeaders param.Field[bool] `json:"allow_all_headers"`
	// Allows all HTTP request methods.
	AllowAllMethods param.Field[bool] `json:"allow_all_methods"`
	// Allows all origins.
	AllowAllOrigins param.Field[bool] `json:"allow_all_origins"`
	// When set to `true`, includes credentials (cookies, authorization headers, or TLS
	// client certificates) with requests.
	AllowCredentials param.Field[bool] `json:"allow_credentials"`
	// Allowed HTTP request headers.
	AllowedHeaders param.Field[[]interface{}] `json:"allowed_headers"`
	// Allowed HTTP request methods.
	AllowedMethods param.Field[[]AccessApplicationUpdateParamsCorsHeadersAllowedMethod] `json:"allowed_methods"`
	// Allowed origins.
	AllowedOrigins param.Field[[]interface{}] `json:"allowed_origins"`
	// The maximum number of seconds the results of a preflight request can be cached.
	MaxAge param.Field[float64] `json:"max_age"`
}

func (AccessApplicationUpdateParamsCorsHeaders) MarshalJSON 

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

type AccessApplicationUpdateParamsCorsHeadersAllowedMethod 

type AccessApplicationUpdateParamsCorsHeadersAllowedMethod string
const (
	AccessApplicationUpdateParamsCorsHeadersAllowedMethodGet     AccessApplicationUpdateParamsCorsHeadersAllowedMethod = "GET"
	AccessApplicationUpdateParamsCorsHeadersAllowedMethodPost    AccessApplicationUpdateParamsCorsHeadersAllowedMethod = "POST"
	AccessApplicationUpdateParamsCorsHeadersAllowedMethodHead    AccessApplicationUpdateParamsCorsHeadersAllowedMethod = "HEAD"
	AccessApplicationUpdateParamsCorsHeadersAllowedMethodPut     AccessApplicationUpdateParamsCorsHeadersAllowedMethod = "PUT"
	AccessApplicationUpdateParamsCorsHeadersAllowedMethodDelete  AccessApplicationUpdateParamsCorsHeadersAllowedMethod = "DELETE"
	AccessApplicationUpdateParamsCorsHeadersAllowedMethodConnect AccessApplicationUpdateParamsCorsHeadersAllowedMethod = "CONNECT"
	AccessApplicationUpdateParamsCorsHeadersAllowedMethodOptions AccessApplicationUpdateParamsCorsHeadersAllowedMethod = "OPTIONS"
	AccessApplicationUpdateParamsCorsHeadersAllowedMethodTrace   AccessApplicationUpdateParamsCorsHeadersAllowedMethod = "TRACE"
	AccessApplicationUpdateParamsCorsHeadersAllowedMethodPatch   AccessApplicationUpdateParamsCorsHeadersAllowedMethod = "PATCH"
)

type AccessApplicationUpdateParamsSaasApp 

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

Satisfied by zero_trust.AccessApplicationUpdateParamsSaasAppAccessSamlSaasApp, zero_trust.AccessApplicationUpdateParamsSaasAppAccessOidcSaasApp.

type AccessApplicationUpdateParamsSaasAppAccessOidcSaasApp 

type AccessApplicationUpdateParamsSaasAppAccessOidcSaasApp struct {
	// The URL where this applications tile redirects users
	AppLauncherURL param.Field[string] `json:"app_launcher_url"`
	// Identifier of the authentication protocol used for the saas app. Required for
	// OIDC.
	AuthType param.Field[AccessApplicationUpdateParamsSaasAppAccessOidcSaasAppAuthType] `json:"auth_type"`
	// The application client id
	ClientID param.Field[string] `json:"client_id"`
	// The application client secret, only returned on POST request.
	ClientSecret param.Field[string] `json:"client_secret"`
	// The OIDC flows supported by this application
	GrantTypes param.Field[[]AccessApplicationUpdateParamsSaasAppAccessOidcSaasAppGrantType] `json:"grant_types"`
	// A regex to filter Cloudflare groups returned in ID token and userinfo endpoint
	GroupFilterRegex param.Field[string] `json:"group_filter_regex"`
	// The Access public certificate that will be used to verify your identity.
	PublicKey param.Field[string] `json:"public_key"`
	// The permitted URL's for Cloudflare to return Authorization codes and Access/ID
	// tokens
	RedirectURIs param.Field[[]string] `json:"redirect_uris"`
	// Define the user information shared with access
	Scopes param.Field[[]AccessApplicationUpdateParamsSaasAppAccessOidcSaasAppScope] `json:"scopes"`
}

func (AccessApplicationUpdateParamsSaasAppAccessOidcSaasApp) MarshalJSON 

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

type AccessApplicationUpdateParamsSaasAppAccessOidcSaasAppAuthType 

type AccessApplicationUpdateParamsSaasAppAccessOidcSaasAppAuthType string

Identifier of the authentication protocol used for the saas app. Required for OIDC. 

const (
	AccessApplicationUpdateParamsSaasAppAccessOidcSaasAppAuthTypeSaml AccessApplicationUpdateParamsSaasAppAccessOidcSaasAppAuthType = "saml"
	AccessApplicationUpdateParamsSaasAppAccessOidcSaasAppAuthTypeOidc AccessApplicationUpdateParamsSaasAppAccessOidcSaasAppAuthType = "oidc"
)

type AccessApplicationUpdateParamsSaasAppAccessOidcSaasAppGrantType 

type AccessApplicationUpdateParamsSaasAppAccessOidcSaasAppGrantType string
const (
	AccessApplicationUpdateParamsSaasAppAccessOidcSaasAppGrantTypeAuthorizationCode         AccessApplicationUpdateParamsSaasAppAccessOidcSaasAppGrantType = "authorization_code"
	AccessApplicationUpdateParamsSaasAppAccessOidcSaasAppGrantTypeAuthorizationCodeWithPkce AccessApplicationUpdateParamsSaasAppAccessOidcSaasAppGrantType = "authorization_code_with_pkce"
)

type AccessApplicationUpdateParamsSaasAppAccessOidcSaasAppScope 

type AccessApplicationUpdateParamsSaasAppAccessOidcSaasAppScope string
const (
	AccessApplicationUpdateParamsSaasAppAccessOidcSaasAppScopeOpenid  AccessApplicationUpdateParamsSaasAppAccessOidcSaasAppScope = "openid"
	AccessApplicationUpdateParamsSaasAppAccessOidcSaasAppScopeGroups  AccessApplicationUpdateParamsSaasAppAccessOidcSaasAppScope = "groups"
	AccessApplicationUpdateParamsSaasAppAccessOidcSaasAppScopeEmail   AccessApplicationUpdateParamsSaasAppAccessOidcSaasAppScope = "email"
	AccessApplicationUpdateParamsSaasAppAccessOidcSaasAppScopeProfile AccessApplicationUpdateParamsSaasAppAccessOidcSaasAppScope = "profile"
)

type AccessApplicationUpdateParamsSaasAppAccessSamlSaasApp 

type AccessApplicationUpdateParamsSaasAppAccessSamlSaasApp struct {
	// Optional identifier indicating the authentication protocol used for the saas
	// app. Required for OIDC. Default if unset is "saml"
	AuthType param.Field[AccessApplicationUpdateParamsSaasAppAccessSamlSaasAppAuthType] `json:"auth_type"`
	// The service provider's endpoint that is responsible for receiving and parsing a
	// SAML assertion.
	ConsumerServiceURL param.Field[string]                                                                `json:"consumer_service_url"`
	CustomAttributes   param.Field[AccessApplicationUpdateParamsSaasAppAccessSamlSaasAppCustomAttributes] `json:"custom_attributes"`
	// The URL that the user will be redirected to after a successful login for IDP
	// initiated logins.
	DefaultRelayState param.Field[string] `json:"default_relay_state"`
	// The unique identifier for your SaaS application.
	IdpEntityID param.Field[string] `json:"idp_entity_id"`
	// The format of the name identifier sent to the SaaS application.
	NameIDFormat param.Field[AccessApplicationUpdateParamsSaasAppAccessSamlSaasAppNameIDFormat] `json:"name_id_format"`
	// A [JSONata](https://jsonata.org/) expression that transforms an application's
	// user identities into a NameID value for its SAML assertion. This expression
	// should evaluate to a singular string. The output of this expression can override
	// the `name_id_format` setting.
	NameIDTransformJsonata param.Field[string] `json:"name_id_transform_jsonata"`
	// The Access public certificate that will be used to verify your identity.
	PublicKey param.Field[string] `json:"public_key"`
	// A globally unique name for an identity or service provider.
	SpEntityID param.Field[string] `json:"sp_entity_id"`
	// The endpoint where your SaaS application will send login requests.
	SSOEndpoint param.Field[string] `json:"sso_endpoint"`
}

func (AccessApplicationUpdateParamsSaasAppAccessSamlSaasApp) MarshalJSON 

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

type AccessApplicationUpdateParamsSaasAppAccessSamlSaasAppAuthType 

type AccessApplicationUpdateParamsSaasAppAccessSamlSaasAppAuthType string

Optional identifier indicating the authentication protocol used for the saas app. Required for OIDC. Default if unset is "saml" 

const (
	AccessApplicationUpdateParamsSaasAppAccessSamlSaasAppAuthTypeSaml AccessApplicationUpdateParamsSaasAppAccessSamlSaasAppAuthType = "saml"
	AccessApplicationUpdateParamsSaasAppAccessSamlSaasAppAuthTypeOidc AccessApplicationUpdateParamsSaasAppAccessSamlSaasAppAuthType = "oidc"
)

type AccessApplicationUpdateParamsSaasAppAccessSamlSaasAppCustomAttributes 

type AccessApplicationUpdateParamsSaasAppAccessSamlSaasAppCustomAttributes struct {
	// The name of the attribute.
	Name param.Field[string] `json:"name"`
	// A globally unique name for an identity or service provider.
	NameFormat param.Field[AccessApplicationUpdateParamsSaasAppAccessSamlSaasAppCustomAttributesNameFormat] `json:"name_format"`
	Source     param.Field[AccessApplicationUpdateParamsSaasAppAccessSamlSaasAppCustomAttributesSource]     `json:"source"`
}

func (AccessApplicationUpdateParamsSaasAppAccessSamlSaasAppCustomAttributes) MarshalJSON 

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

type AccessApplicationUpdateParamsSaasAppAccessSamlSaasAppCustomAttributesNameFormat 

type AccessApplicationUpdateParamsSaasAppAccessSamlSaasAppCustomAttributesNameFormat string

A globally unique name for an identity or service provider. 

const (
	AccessApplicationUpdateParamsSaasAppAccessSamlSaasAppCustomAttributesNameFormatUrnOasisNamesTcSaml2_0AttrnameFormatUnspecified AccessApplicationUpdateParamsSaasAppAccessSamlSaasAppCustomAttributesNameFormat = "urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified"
	AccessApplicationUpdateParamsSaasAppAccessSamlSaasAppCustomAttributesNameFormatUrnOasisNamesTcSaml2_0AttrnameFormatBasic       AccessApplicationUpdateParamsSaasAppAccessSamlSaasAppCustomAttributesNameFormat = "urn:oasis:names:tc:SAML:2.0:attrname-format:basic"
	AccessApplicationUpdateParamsSaasAppAccessSamlSaasAppCustomAttributesNameFormatUrnOasisNamesTcSaml2_0AttrnameFormatURI         AccessApplicationUpdateParamsSaasAppAccessSamlSaasAppCustomAttributesNameFormat = "urn:oasis:names:tc:SAML:2.0:attrname-format:uri"
)

type AccessApplicationUpdateParamsSaasAppAccessSamlSaasAppCustomAttributesSource 

type AccessApplicationUpdateParamsSaasAppAccessSamlSaasAppCustomAttributesSource struct {
	// The name of the IdP attribute.
	Name param.Field[string] `json:"name"`
}

func (AccessApplicationUpdateParamsSaasAppAccessSamlSaasAppCustomAttributesSource) MarshalJSON 

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

type AccessApplicationUpdateParamsSaasAppAccessSamlSaasAppNameIDFormat 

type AccessApplicationUpdateParamsSaasAppAccessSamlSaasAppNameIDFormat string

The format of the name identifier sent to the SaaS application. 

const (
	AccessApplicationUpdateParamsSaasAppAccessSamlSaasAppNameIDFormatID    AccessApplicationUpdateParamsSaasAppAccessSamlSaasAppNameIDFormat = "id"
	AccessApplicationUpdateParamsSaasAppAccessSamlSaasAppNameIDFormatEmail AccessApplicationUpdateParamsSaasAppAccessSamlSaasAppNameIDFormat = "email"
)

type AccessApplicationUpdateResponseEnvelope 

type AccessApplicationUpdateResponseEnvelope struct {
	Errors   []AccessApplicationUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessApplicationUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessApps                                        `json:"result,required"`
	// Whether the API call was successful
	Success AccessApplicationUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessApplicationUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*AccessApplicationUpdateResponseEnvelope) UnmarshalJSON 

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

type AccessApplicationUpdateResponseEnvelopeErrors 

type AccessApplicationUpdateResponseEnvelopeErrors struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    accessApplicationUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessApplicationUpdateResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessApplicationUpdateResponseEnvelopeMessages 

type AccessApplicationUpdateResponseEnvelopeMessages struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    accessApplicationUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessApplicationUpdateResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessApplicationUpdateResponseEnvelopeSuccess 

type AccessApplicationUpdateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessApplicationUpdateResponseEnvelopeSuccessTrue AccessApplicationUpdateResponseEnvelopeSuccess = true
)

type AccessApplicationUserPolicyCheckListParams 

type AccessApplicationUserPolicyCheckListParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type AccessApplicationUserPolicyCheckListParamsAppID 

type AccessApplicationUserPolicyCheckListParamsAppID interface {
	ImplementsZeroTrustAccessApplicationUserPolicyCheckListParamsAppID()
}

Identifier

Satisfied by shared.UnionString, shared.UnionString.

type AccessApplicationUserPolicyCheckListResponse 

type AccessApplicationUserPolicyCheckListResponse struct {
	AppState     AccessApplicationUserPolicyCheckListResponseAppState     `json:"app_state"`
	UserIdentity AccessApplicationUserPolicyCheckListResponseUserIdentity `json:"user_identity"`
	JSON         accessApplicationUserPolicyCheckListResponseJSON         `json:"-"`
}

func (*AccessApplicationUserPolicyCheckListResponse) UnmarshalJSON 

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

type AccessApplicationUserPolicyCheckListResponseAppState 

type AccessApplicationUserPolicyCheckListResponseAppState struct {
	// UUID
	AppUid   string                                                   `json:"app_uid"`
	Aud      string                                                   `json:"aud"`
	Hostname string                                                   `json:"hostname"`
	Name     string                                                   `json:"name"`
	Policies []interface{}                                            `json:"policies"`
	Status   string                                                   `json:"status"`
	JSON     accessApplicationUserPolicyCheckListResponseAppStateJSON `json:"-"`
}

func (*AccessApplicationUserPolicyCheckListResponseAppState) UnmarshalJSON 

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

type AccessApplicationUserPolicyCheckListResponseEnvelope 

type AccessApplicationUserPolicyCheckListResponseEnvelope struct {
	Errors   []AccessApplicationUserPolicyCheckListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessApplicationUserPolicyCheckListResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessApplicationUserPolicyCheckListResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success AccessApplicationUserPolicyCheckListResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessApplicationUserPolicyCheckListResponseEnvelopeJSON    `json:"-"`
}

func (*AccessApplicationUserPolicyCheckListResponseEnvelope) UnmarshalJSON 

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

type AccessApplicationUserPolicyCheckListResponseEnvelopeErrors 

type AccessApplicationUserPolicyCheckListResponseEnvelopeErrors struct {
	Code    int64                                                          `json:"code,required"`
	Message string                                                         `json:"message,required"`
	JSON    accessApplicationUserPolicyCheckListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessApplicationUserPolicyCheckListResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessApplicationUserPolicyCheckListResponseEnvelopeMessages 

type AccessApplicationUserPolicyCheckListResponseEnvelopeMessages struct {
	Code    int64                                                            `json:"code,required"`
	Message string                                                           `json:"message,required"`
	JSON    accessApplicationUserPolicyCheckListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessApplicationUserPolicyCheckListResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessApplicationUserPolicyCheckListResponseEnvelopeSuccess 

type AccessApplicationUserPolicyCheckListResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessApplicationUserPolicyCheckListResponseEnvelopeSuccessTrue AccessApplicationUserPolicyCheckListResponseEnvelopeSuccess = true
)

type AccessApplicationUserPolicyCheckListResponseUserIdentity 

type AccessApplicationUserPolicyCheckListResponseUserIdentity struct {
	ID             string                                                      `json:"id"`
	AccountID      string                                                      `json:"account_id"`
	DeviceSessions interface{}                                                 `json:"device_sessions"`
	Email          string                                                      `json:"email"`
	Geo            AccessApplicationUserPolicyCheckListResponseUserIdentityGeo `json:"geo"`
	Iat            int64                                                       `json:"iat"`
	IsGateway      bool                                                        `json:"is_gateway"`
	IsWARP         bool                                                        `json:"is_warp"`
	Name           string                                                      `json:"name"`
	// UUID
	UserUUID string                                                       `json:"user_uuid"`
	Version  int64                                                        `json:"version"`
	JSON     accessApplicationUserPolicyCheckListResponseUserIdentityJSON `json:"-"`
}

func (*AccessApplicationUserPolicyCheckListResponseUserIdentity) UnmarshalJSON 

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

type AccessApplicationUserPolicyCheckListResponseUserIdentityGeo 

type AccessApplicationUserPolicyCheckListResponseUserIdentityGeo struct {
	Country string                                                          `json:"country"`
	JSON    accessApplicationUserPolicyCheckListResponseUserIdentityGeoJSON `json:"-"`
}

func (*AccessApplicationUserPolicyCheckListResponseUserIdentityGeo) UnmarshalJSON 

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

type AccessApplicationUserPolicyCheckService 

type AccessApplicationUserPolicyCheckService struct {
	Options []option.RequestOption
}

AccessApplicationUserPolicyCheckService 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 NewAccessApplicationUserPolicyCheckService method instead.

func NewAccessApplicationUserPolicyCheckService 

func NewAccessApplicationUserPolicyCheckService(opts ...option.RequestOption) (r *AccessApplicationUserPolicyCheckService)

NewAccessApplicationUserPolicyCheckService 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 (*AccessApplicationUserPolicyCheckService) List 

func (r *AccessApplicationUserPolicyCheckService) List(ctx context.Context, appID AccessApplicationUserPolicyCheckListParamsAppID, query AccessApplicationUserPolicyCheckListParams, opts ...option.RequestOption) (res *AccessApplicationUserPolicyCheckListResponse, err error)

Tests if a specific user has permission to access an application.

type AccessApps 

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

Union satisfied by zero_trust.AccessAppsSelfHostedApplication, zero_trust.AccessAppsSaaSApplication, zero_trust.AccessAppsBrowserSSHApplication, zero_trust.AccessAppsBrowserVncApplication, zero_trust.AccessAppsAppLauncherApplication, zero_trust.AccessAppsDeviceEnrollmentPermissionsApplication, zero_trust.AccessAppsBrowserIsolationPermissionsApplication or zero_trust.AccessAppsBookmarkApplication.

type AccessAppsAppLauncherApplication 

type AccessAppsAppLauncherApplication struct {
	// The application type.
	Type AccessAppsAppLauncherApplicationType `json:"type,required"`
	// UUID
	ID string `json:"id"`
	// The identity providers your users can select when connecting to this
	// application. Defaults to all IdPs configured in your account.
	AllowedIdps []string `json:"allowed_idps"`
	// Audience tag.
	Aud string `json:"aud"`
	// When set to `true`, users skip the identity provider selection step during
	// login. You must specify only one identity provider in allowed_idps.
	AutoRedirectToIdentity bool      `json:"auto_redirect_to_identity"`
	CreatedAt              time.Time `json:"created_at" format:"date-time"`
	// The primary hostname and path that Access will secure. If the app is visible in
	// the App Launcher dashboard, this is the domain that will be displayed.
	Domain string `json:"domain"`
	// The name of the application.
	Name string `json:"name"`
	// The amount of time that tokens issued for this application will be valid. Must
	// be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms,
	// s, m, h.
	SessionDuration string                               `json:"session_duration"`
	UpdatedAt       time.Time                            `json:"updated_at" format:"date-time"`
	JSON            accessAppsAppLauncherApplicationJSON `json:"-"`
}

func (*AccessAppsAppLauncherApplication) UnmarshalJSON 

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

type AccessAppsAppLauncherApplicationType 

type AccessAppsAppLauncherApplicationType string

The application type. 

const (
	AccessAppsAppLauncherApplicationTypeSelfHosted  AccessAppsAppLauncherApplicationType = "self_hosted"
	AccessAppsAppLauncherApplicationTypeSaas        AccessAppsAppLauncherApplicationType = "saas"
	AccessAppsAppLauncherApplicationTypeSSH         AccessAppsAppLauncherApplicationType = "ssh"
	AccessAppsAppLauncherApplicationTypeVnc         AccessAppsAppLauncherApplicationType = "vnc"
	AccessAppsAppLauncherApplicationTypeAppLauncher AccessAppsAppLauncherApplicationType = "app_launcher"
	AccessAppsAppLauncherApplicationTypeWARP        AccessAppsAppLauncherApplicationType = "warp"
	AccessAppsAppLauncherApplicationTypeBiso        AccessAppsAppLauncherApplicationType = "biso"
	AccessAppsAppLauncherApplicationTypeBookmark    AccessAppsAppLauncherApplicationType = "bookmark"
	AccessAppsAppLauncherApplicationTypeDashSSO     AccessAppsAppLauncherApplicationType = "dash_sso"
)

type AccessAppsBookmarkApplication 

type AccessAppsBookmarkApplication struct {
	// UUID
	ID                 string      `json:"id"`
	AppLauncherVisible interface{} `json:"app_launcher_visible"`
	// Audience tag.
	Aud       string    `json:"aud"`
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// The URL or domain of the bookmark.
	Domain interface{} `json:"domain"`
	// The image URL for the logo shown in the App Launcher dashboard.
	LogoURL string `json:"logo_url"`
	// The name of the application.
	Name string `json:"name"`
	// The tags you want assigned to an application. Tags are used to filter
	// applications in the App Launcher dashboard.
	Tags []string `json:"tags"`
	// The application type.
	Type      string                            `json:"type"`
	UpdatedAt time.Time                         `json:"updated_at" format:"date-time"`
	JSON      accessAppsBookmarkApplicationJSON `json:"-"`
}

func (*AccessAppsBookmarkApplication) UnmarshalJSON 

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

type AccessAppsBrowserIsolationPermissionsApplication 

type AccessAppsBrowserIsolationPermissionsApplication struct {
	// The application type.
	Type AccessAppsBrowserIsolationPermissionsApplicationType `json:"type,required"`
	// UUID
	ID string `json:"id"`
	// The identity providers your users can select when connecting to this
	// application. Defaults to all IdPs configured in your account.
	AllowedIdps []string `json:"allowed_idps"`
	// Audience tag.
	Aud string `json:"aud"`
	// When set to `true`, users skip the identity provider selection step during
	// login. You must specify only one identity provider in allowed_idps.
	AutoRedirectToIdentity bool      `json:"auto_redirect_to_identity"`
	CreatedAt              time.Time `json:"created_at" format:"date-time"`
	// The primary hostname and path that Access will secure. If the app is visible in
	// the App Launcher dashboard, this is the domain that will be displayed.
	Domain string `json:"domain"`
	// The name of the application.
	Name string `json:"name"`
	// The amount of time that tokens issued for this application will be valid. Must
	// be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms,
	// s, m, h.
	SessionDuration string                                               `json:"session_duration"`
	UpdatedAt       time.Time                                            `json:"updated_at" format:"date-time"`
	JSON            accessAppsBrowserIsolationPermissionsApplicationJSON `json:"-"`
}

func (*AccessAppsBrowserIsolationPermissionsApplication) UnmarshalJSON 

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

type AccessAppsBrowserIsolationPermissionsApplicationType 

type AccessAppsBrowserIsolationPermissionsApplicationType string

The application type. 

const (
	AccessAppsBrowserIsolationPermissionsApplicationTypeSelfHosted  AccessAppsBrowserIsolationPermissionsApplicationType = "self_hosted"
	AccessAppsBrowserIsolationPermissionsApplicationTypeSaas        AccessAppsBrowserIsolationPermissionsApplicationType = "saas"
	AccessAppsBrowserIsolationPermissionsApplicationTypeSSH         AccessAppsBrowserIsolationPermissionsApplicationType = "ssh"
	AccessAppsBrowserIsolationPermissionsApplicationTypeVnc         AccessAppsBrowserIsolationPermissionsApplicationType = "vnc"
	AccessAppsBrowserIsolationPermissionsApplicationTypeAppLauncher AccessAppsBrowserIsolationPermissionsApplicationType = "app_launcher"
	AccessAppsBrowserIsolationPermissionsApplicationTypeWARP        AccessAppsBrowserIsolationPermissionsApplicationType = "warp"
	AccessAppsBrowserIsolationPermissionsApplicationTypeBiso        AccessAppsBrowserIsolationPermissionsApplicationType = "biso"
	AccessAppsBrowserIsolationPermissionsApplicationTypeBookmark    AccessAppsBrowserIsolationPermissionsApplicationType = "bookmark"
	AccessAppsBrowserIsolationPermissionsApplicationTypeDashSSO     AccessAppsBrowserIsolationPermissionsApplicationType = "dash_sso"
)

type AccessAppsBrowserSSHApplication 

type AccessAppsBrowserSSHApplication struct {
	// The primary hostname and path that Access will secure. If the app is visible in
	// the App Launcher dashboard, this is the domain that will be displayed.
	Domain string `json:"domain,required"`
	// The application type.
	Type string `json:"type,required"`
	// UUID
	ID string `json:"id"`
	// When set to true, users can authenticate to this application using their WARP
	// session. When set to false this application will always require direct IdP
	// authentication. This setting always overrides the organization setting for WARP
	// authentication.
	AllowAuthenticateViaWARP bool `json:"allow_authenticate_via_warp"`
	// The identity providers your users can select when connecting to this
	// application. Defaults to all IdPs configured in your account.
	AllowedIdps []string `json:"allowed_idps"`
	// Displays the application in the App Launcher.
	AppLauncherVisible bool `json:"app_launcher_visible"`
	// Audience tag.
	Aud string `json:"aud"`
	// When set to `true`, users skip the identity provider selection step during
	// login. You must specify only one identity provider in allowed_idps.
	AutoRedirectToIdentity bool                                       `json:"auto_redirect_to_identity"`
	CorsHeaders            AccessAppsBrowserSSHApplicationCorsHeaders `json:"cors_headers"`
	CreatedAt              time.Time                                  `json:"created_at" format:"date-time"`
	// The custom error message shown to a user when they are denied access to the
	// application.
	CustomDenyMessage string `json:"custom_deny_message"`
	// The custom URL a user is redirected to when they are denied access to the
	// application when failing identity-based rules.
	CustomDenyURL string `json:"custom_deny_url"`
	// The custom URL a user is redirected to when they are denied access to the
	// application when failing non-identity rules.
	CustomNonIdentityDenyURL string `json:"custom_non_identity_deny_url"`
	// The custom pages that will be displayed when applicable for this application
	CustomPages []string `json:"custom_pages"`
	// Enables the binding cookie, which increases security against compromised
	// authorization tokens and CSRF attacks.
	EnableBindingCookie bool `json:"enable_binding_cookie"`
	// Enables the HttpOnly cookie attribute, which increases security against XSS
	// attacks.
	HTTPOnlyCookieAttribute bool `json:"http_only_cookie_attribute"`
	// The image URL for the logo shown in the App Launcher dashboard.
	LogoURL string `json:"logo_url"`
	// The name of the application.
	Name string `json:"name"`
	// Enables cookie paths to scope an application's JWT to the application path. If
	// disabled, the JWT will scope to the hostname by default
	PathCookieAttribute bool `json:"path_cookie_attribute"`
	// Sets the SameSite cookie setting, which provides increased security against CSRF
	// attacks.
	SameSiteCookieAttribute string `json:"same_site_cookie_attribute"`
	// List of domains that Access will secure.
	SelfHostedDomains []string `json:"self_hosted_domains"`
	// Returns a 401 status code when the request is blocked by a Service Auth policy.
	ServiceAuth401Redirect bool `json:"service_auth_401_redirect"`
	// The amount of time that tokens issued for this application will be valid. Must
	// be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms,
	// s, m, h.
	SessionDuration string `json:"session_duration"`
	// Enables automatic authentication through cloudflared.
	SkipInterstitial bool `json:"skip_interstitial"`
	// The tags you want assigned to an application. Tags are used to filter
	// applications in the App Launcher dashboard.
	Tags      []string                            `json:"tags"`
	UpdatedAt time.Time                           `json:"updated_at" format:"date-time"`
	JSON      accessAppsBrowserSSHApplicationJSON `json:"-"`
}

func (*AccessAppsBrowserSSHApplication) UnmarshalJSON 

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

type AccessAppsBrowserSSHApplicationCorsHeaders 

type AccessAppsBrowserSSHApplicationCorsHeaders struct {
	// Allows all HTTP request headers.
	AllowAllHeaders bool `json:"allow_all_headers"`
	// Allows all HTTP request methods.
	AllowAllMethods bool `json:"allow_all_methods"`
	// Allows all origins.
	AllowAllOrigins bool `json:"allow_all_origins"`
	// When set to `true`, includes credentials (cookies, authorization headers, or TLS
	// client certificates) with requests.
	AllowCredentials bool `json:"allow_credentials"`
	// Allowed HTTP request headers.
	AllowedHeaders []interface{} `json:"allowed_headers"`
	// Allowed HTTP request methods.
	AllowedMethods []AccessAppsBrowserSSHApplicationCorsHeadersAllowedMethod `json:"allowed_methods"`
	// Allowed origins.
	AllowedOrigins []interface{} `json:"allowed_origins"`
	// The maximum number of seconds the results of a preflight request can be cached.
	MaxAge float64                                        `json:"max_age"`
	JSON   accessAppsBrowserSSHApplicationCorsHeadersJSON `json:"-"`
}

func (*AccessAppsBrowserSSHApplicationCorsHeaders) UnmarshalJSON 

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

type AccessAppsBrowserSSHApplicationCorsHeadersAllowedMethod 

type AccessAppsBrowserSSHApplicationCorsHeadersAllowedMethod string
const (
	AccessAppsBrowserSSHApplicationCorsHeadersAllowedMethodGet     AccessAppsBrowserSSHApplicationCorsHeadersAllowedMethod = "GET"
	AccessAppsBrowserSSHApplicationCorsHeadersAllowedMethodPost    AccessAppsBrowserSSHApplicationCorsHeadersAllowedMethod = "POST"
	AccessAppsBrowserSSHApplicationCorsHeadersAllowedMethodHead    AccessAppsBrowserSSHApplicationCorsHeadersAllowedMethod = "HEAD"
	AccessAppsBrowserSSHApplicationCorsHeadersAllowedMethodPut     AccessAppsBrowserSSHApplicationCorsHeadersAllowedMethod = "PUT"
	AccessAppsBrowserSSHApplicationCorsHeadersAllowedMethodDelete  AccessAppsBrowserSSHApplicationCorsHeadersAllowedMethod = "DELETE"
	AccessAppsBrowserSSHApplicationCorsHeadersAllowedMethodConnect AccessAppsBrowserSSHApplicationCorsHeadersAllowedMethod = "CONNECT"
	AccessAppsBrowserSSHApplicationCorsHeadersAllowedMethodOptions AccessAppsBrowserSSHApplicationCorsHeadersAllowedMethod = "OPTIONS"
	AccessAppsBrowserSSHApplicationCorsHeadersAllowedMethodTrace   AccessAppsBrowserSSHApplicationCorsHeadersAllowedMethod = "TRACE"
	AccessAppsBrowserSSHApplicationCorsHeadersAllowedMethodPatch   AccessAppsBrowserSSHApplicationCorsHeadersAllowedMethod = "PATCH"
)

type AccessAppsBrowserVncApplication 

type AccessAppsBrowserVncApplication struct {
	// The primary hostname and path that Access will secure. If the app is visible in
	// the App Launcher dashboard, this is the domain that will be displayed.
	Domain string `json:"domain,required"`
	// The application type.
	Type string `json:"type,required"`
	// UUID
	ID string `json:"id"`
	// When set to true, users can authenticate to this application using their WARP
	// session. When set to false this application will always require direct IdP
	// authentication. This setting always overrides the organization setting for WARP
	// authentication.
	AllowAuthenticateViaWARP bool `json:"allow_authenticate_via_warp"`
	// The identity providers your users can select when connecting to this
	// application. Defaults to all IdPs configured in your account.
	AllowedIdps []string `json:"allowed_idps"`
	// Displays the application in the App Launcher.
	AppLauncherVisible bool `json:"app_launcher_visible"`
	// Audience tag.
	Aud string `json:"aud"`
	// When set to `true`, users skip the identity provider selection step during
	// login. You must specify only one identity provider in allowed_idps.
	AutoRedirectToIdentity bool                                       `json:"auto_redirect_to_identity"`
	CorsHeaders            AccessAppsBrowserVncApplicationCorsHeaders `json:"cors_headers"`
	CreatedAt              time.Time                                  `json:"created_at" format:"date-time"`
	// The custom error message shown to a user when they are denied access to the
	// application.
	CustomDenyMessage string `json:"custom_deny_message"`
	// The custom URL a user is redirected to when they are denied access to the
	// application when failing identity-based rules.
	CustomDenyURL string `json:"custom_deny_url"`
	// The custom URL a user is redirected to when they are denied access to the
	// application when failing non-identity rules.
	CustomNonIdentityDenyURL string `json:"custom_non_identity_deny_url"`
	// The custom pages that will be displayed when applicable for this application
	CustomPages []string `json:"custom_pages"`
	// Enables the binding cookie, which increases security against compromised
	// authorization tokens and CSRF attacks.
	EnableBindingCookie bool `json:"enable_binding_cookie"`
	// Enables the HttpOnly cookie attribute, which increases security against XSS
	// attacks.
	HTTPOnlyCookieAttribute bool `json:"http_only_cookie_attribute"`
	// The image URL for the logo shown in the App Launcher dashboard.
	LogoURL string `json:"logo_url"`
	// The name of the application.
	Name string `json:"name"`
	// Enables cookie paths to scope an application's JWT to the application path. If
	// disabled, the JWT will scope to the hostname by default
	PathCookieAttribute bool `json:"path_cookie_attribute"`
	// Sets the SameSite cookie setting, which provides increased security against CSRF
	// attacks.
	SameSiteCookieAttribute string `json:"same_site_cookie_attribute"`
	// List of domains that Access will secure.
	SelfHostedDomains []string `json:"self_hosted_domains"`
	// Returns a 401 status code when the request is blocked by a Service Auth policy.
	ServiceAuth401Redirect bool `json:"service_auth_401_redirect"`
	// The amount of time that tokens issued for this application will be valid. Must
	// be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms,
	// s, m, h.
	SessionDuration string `json:"session_duration"`
	// Enables automatic authentication through cloudflared.
	SkipInterstitial bool `json:"skip_interstitial"`
	// The tags you want assigned to an application. Tags are used to filter
	// applications in the App Launcher dashboard.
	Tags      []string                            `json:"tags"`
	UpdatedAt time.Time                           `json:"updated_at" format:"date-time"`
	JSON      accessAppsBrowserVncApplicationJSON `json:"-"`
}

func (*AccessAppsBrowserVncApplication) UnmarshalJSON 

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

type AccessAppsBrowserVncApplicationCorsHeaders 

type AccessAppsBrowserVncApplicationCorsHeaders struct {
	// Allows all HTTP request headers.
	AllowAllHeaders bool `json:"allow_all_headers"`
	// Allows all HTTP request methods.
	AllowAllMethods bool `json:"allow_all_methods"`
	// Allows all origins.
	AllowAllOrigins bool `json:"allow_all_origins"`
	// When set to `true`, includes credentials (cookies, authorization headers, or TLS
	// client certificates) with requests.
	AllowCredentials bool `json:"allow_credentials"`
	// Allowed HTTP request headers.
	AllowedHeaders []interface{} `json:"allowed_headers"`
	// Allowed HTTP request methods.
	AllowedMethods []AccessAppsBrowserVncApplicationCorsHeadersAllowedMethod `json:"allowed_methods"`
	// Allowed origins.
	AllowedOrigins []interface{} `json:"allowed_origins"`
	// The maximum number of seconds the results of a preflight request can be cached.
	MaxAge float64                                        `json:"max_age"`
	JSON   accessAppsBrowserVncApplicationCorsHeadersJSON `json:"-"`
}

func (*AccessAppsBrowserVncApplicationCorsHeaders) UnmarshalJSON 

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

type AccessAppsBrowserVncApplicationCorsHeadersAllowedMethod 

type AccessAppsBrowserVncApplicationCorsHeadersAllowedMethod string
const (
	AccessAppsBrowserVncApplicationCorsHeadersAllowedMethodGet     AccessAppsBrowserVncApplicationCorsHeadersAllowedMethod = "GET"
	AccessAppsBrowserVncApplicationCorsHeadersAllowedMethodPost    AccessAppsBrowserVncApplicationCorsHeadersAllowedMethod = "POST"
	AccessAppsBrowserVncApplicationCorsHeadersAllowedMethodHead    AccessAppsBrowserVncApplicationCorsHeadersAllowedMethod = "HEAD"
	AccessAppsBrowserVncApplicationCorsHeadersAllowedMethodPut     AccessAppsBrowserVncApplicationCorsHeadersAllowedMethod = "PUT"
	AccessAppsBrowserVncApplicationCorsHeadersAllowedMethodDelete  AccessAppsBrowserVncApplicationCorsHeadersAllowedMethod = "DELETE"
	AccessAppsBrowserVncApplicationCorsHeadersAllowedMethodConnect AccessAppsBrowserVncApplicationCorsHeadersAllowedMethod = "CONNECT"
	AccessAppsBrowserVncApplicationCorsHeadersAllowedMethodOptions AccessAppsBrowserVncApplicationCorsHeadersAllowedMethod = "OPTIONS"
	AccessAppsBrowserVncApplicationCorsHeadersAllowedMethodTrace   AccessAppsBrowserVncApplicationCorsHeadersAllowedMethod = "TRACE"
	AccessAppsBrowserVncApplicationCorsHeadersAllowedMethodPatch   AccessAppsBrowserVncApplicationCorsHeadersAllowedMethod = "PATCH"
)

type AccessAppsDeviceEnrollmentPermissionsApplication 

type AccessAppsDeviceEnrollmentPermissionsApplication struct {
	// The application type.
	Type AccessAppsDeviceEnrollmentPermissionsApplicationType `json:"type,required"`
	// UUID
	ID string `json:"id"`
	// The identity providers your users can select when connecting to this
	// application. Defaults to all IdPs configured in your account.
	AllowedIdps []string `json:"allowed_idps"`
	// Audience tag.
	Aud string `json:"aud"`
	// When set to `true`, users skip the identity provider selection step during
	// login. You must specify only one identity provider in allowed_idps.
	AutoRedirectToIdentity bool      `json:"auto_redirect_to_identity"`
	CreatedAt              time.Time `json:"created_at" format:"date-time"`
	// The primary hostname and path that Access will secure. If the app is visible in
	// the App Launcher dashboard, this is the domain that will be displayed.
	Domain string `json:"domain"`
	// The name of the application.
	Name string `json:"name"`
	// The amount of time that tokens issued for this application will be valid. Must
	// be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms,
	// s, m, h.
	SessionDuration string                                               `json:"session_duration"`
	UpdatedAt       time.Time                                            `json:"updated_at" format:"date-time"`
	JSON            accessAppsDeviceEnrollmentPermissionsApplicationJSON `json:"-"`
}

func (*AccessAppsDeviceEnrollmentPermissionsApplication) UnmarshalJSON 

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

type AccessAppsDeviceEnrollmentPermissionsApplicationType 

type AccessAppsDeviceEnrollmentPermissionsApplicationType string

The application type. 

const (
	AccessAppsDeviceEnrollmentPermissionsApplicationTypeSelfHosted  AccessAppsDeviceEnrollmentPermissionsApplicationType = "self_hosted"
	AccessAppsDeviceEnrollmentPermissionsApplicationTypeSaas        AccessAppsDeviceEnrollmentPermissionsApplicationType = "saas"
	AccessAppsDeviceEnrollmentPermissionsApplicationTypeSSH         AccessAppsDeviceEnrollmentPermissionsApplicationType = "ssh"
	AccessAppsDeviceEnrollmentPermissionsApplicationTypeVnc         AccessAppsDeviceEnrollmentPermissionsApplicationType = "vnc"
	AccessAppsDeviceEnrollmentPermissionsApplicationTypeAppLauncher AccessAppsDeviceEnrollmentPermissionsApplicationType = "app_launcher"
	AccessAppsDeviceEnrollmentPermissionsApplicationTypeWARP        AccessAppsDeviceEnrollmentPermissionsApplicationType = "warp"
	AccessAppsDeviceEnrollmentPermissionsApplicationTypeBiso        AccessAppsDeviceEnrollmentPermissionsApplicationType = "biso"
	AccessAppsDeviceEnrollmentPermissionsApplicationTypeBookmark    AccessAppsDeviceEnrollmentPermissionsApplicationType = "bookmark"
	AccessAppsDeviceEnrollmentPermissionsApplicationTypeDashSSO     AccessAppsDeviceEnrollmentPermissionsApplicationType = "dash_sso"
)

type AccessAppsSaaSApplication 

type AccessAppsSaaSApplication struct {
	// UUID
	ID string `json:"id"`
	// The identity providers your users can select when connecting to this
	// application. Defaults to all IdPs configured in your account.
	AllowedIdps []string `json:"allowed_idps"`
	// Displays the application in the App Launcher.
	AppLauncherVisible bool `json:"app_launcher_visible"`
	// Audience tag.
	Aud string `json:"aud"`
	// When set to `true`, users skip the identity provider selection step during
	// login. You must specify only one identity provider in allowed_idps.
	AutoRedirectToIdentity bool      `json:"auto_redirect_to_identity"`
	CreatedAt              time.Time `json:"created_at" format:"date-time"`
	// The custom pages that will be displayed when applicable for this application
	CustomPages []string `json:"custom_pages"`
	// The image URL for the logo shown in the App Launcher dashboard.
	LogoURL string `json:"logo_url"`
	// The name of the application.
	Name    string                           `json:"name"`
	SaasApp AccessAppsSaaSApplicationSaasApp `json:"saas_app"`
	// The tags you want assigned to an application. Tags are used to filter
	// applications in the App Launcher dashboard.
	Tags []string `json:"tags"`
	// The application type.
	Type      string                        `json:"type"`
	UpdatedAt time.Time                     `json:"updated_at" format:"date-time"`
	JSON      accessAppsSaaSApplicationJSON `json:"-"`
}

func (*AccessAppsSaaSApplication) UnmarshalJSON 

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

type AccessAppsSaaSApplicationSaasApp 

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

Union satisfied by zero_trust.AccessAppsSaaSApplicationSaasAppAccessSamlSaasApp or zero_trust.AccessAppsSaaSApplicationSaasAppAccessOidcSaasApp.

type AccessAppsSaaSApplicationSaasAppAccessOidcSaasApp 

type AccessAppsSaaSApplicationSaasAppAccessOidcSaasApp struct {
	// The URL where this applications tile redirects users
	AppLauncherURL string `json:"app_launcher_url"`
	// Identifier of the authentication protocol used for the saas app. Required for
	// OIDC.
	AuthType AccessAppsSaaSApplicationSaasAppAccessOidcSaasAppAuthType `json:"auth_type"`
	// The application client id
	ClientID string `json:"client_id"`
	// The application client secret, only returned on POST request.
	ClientSecret string    `json:"client_secret"`
	CreatedAt    time.Time `json:"created_at" format:"date-time"`
	// The OIDC flows supported by this application
	GrantTypes []AccessAppsSaaSApplicationSaasAppAccessOidcSaasAppGrantType `json:"grant_types"`
	// A regex to filter Cloudflare groups returned in ID token and userinfo endpoint
	GroupFilterRegex string `json:"group_filter_regex"`
	// The Access public certificate that will be used to verify your identity.
	PublicKey string `json:"public_key"`
	// The permitted URL's for Cloudflare to return Authorization codes and Access/ID
	// tokens
	RedirectURIs []string `json:"redirect_uris"`
	// Define the user information shared with access
	Scopes    []AccessAppsSaaSApplicationSaasAppAccessOidcSaasAppScope `json:"scopes"`
	UpdatedAt time.Time                                                `json:"updated_at" format:"date-time"`
	JSON      accessAppsSaaSApplicationSaasAppAccessOidcSaasAppJSON    `json:"-"`
}

func (*AccessAppsSaaSApplicationSaasAppAccessOidcSaasApp) UnmarshalJSON 

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

type AccessAppsSaaSApplicationSaasAppAccessOidcSaasAppAuthType 

type AccessAppsSaaSApplicationSaasAppAccessOidcSaasAppAuthType string

Identifier of the authentication protocol used for the saas app. Required for OIDC. 

const (
	AccessAppsSaaSApplicationSaasAppAccessOidcSaasAppAuthTypeSaml AccessAppsSaaSApplicationSaasAppAccessOidcSaasAppAuthType = "saml"
	AccessAppsSaaSApplicationSaasAppAccessOidcSaasAppAuthTypeOidc AccessAppsSaaSApplicationSaasAppAccessOidcSaasAppAuthType = "oidc"
)

type AccessAppsSaaSApplicationSaasAppAccessOidcSaasAppGrantType 

type AccessAppsSaaSApplicationSaasAppAccessOidcSaasAppGrantType string
const (
	AccessAppsSaaSApplicationSaasAppAccessOidcSaasAppGrantTypeAuthorizationCode         AccessAppsSaaSApplicationSaasAppAccessOidcSaasAppGrantType = "authorization_code"
	AccessAppsSaaSApplicationSaasAppAccessOidcSaasAppGrantTypeAuthorizationCodeWithPkce AccessAppsSaaSApplicationSaasAppAccessOidcSaasAppGrantType = "authorization_code_with_pkce"
)

type AccessAppsSaaSApplicationSaasAppAccessOidcSaasAppScope 

type AccessAppsSaaSApplicationSaasAppAccessOidcSaasAppScope string
const (
	AccessAppsSaaSApplicationSaasAppAccessOidcSaasAppScopeOpenid  AccessAppsSaaSApplicationSaasAppAccessOidcSaasAppScope = "openid"
	AccessAppsSaaSApplicationSaasAppAccessOidcSaasAppScopeGroups  AccessAppsSaaSApplicationSaasAppAccessOidcSaasAppScope = "groups"
	AccessAppsSaaSApplicationSaasAppAccessOidcSaasAppScopeEmail   AccessAppsSaaSApplicationSaasAppAccessOidcSaasAppScope = "email"
	AccessAppsSaaSApplicationSaasAppAccessOidcSaasAppScopeProfile AccessAppsSaaSApplicationSaasAppAccessOidcSaasAppScope = "profile"
)

type AccessAppsSaaSApplicationSaasAppAccessSamlSaasApp 

type AccessAppsSaaSApplicationSaasAppAccessSamlSaasApp struct {
	// Optional identifier indicating the authentication protocol used for the saas
	// app. Required for OIDC. Default if unset is "saml"
	AuthType AccessAppsSaaSApplicationSaasAppAccessSamlSaasAppAuthType `json:"auth_type"`
	// The service provider's endpoint that is responsible for receiving and parsing a
	// SAML assertion.
	ConsumerServiceURL string                                                            `json:"consumer_service_url"`
	CreatedAt          time.Time                                                         `json:"created_at" format:"date-time"`
	CustomAttributes   AccessAppsSaaSApplicationSaasAppAccessSamlSaasAppCustomAttributes `json:"custom_attributes"`
	// The URL that the user will be redirected to after a successful login for IDP
	// initiated logins.
	DefaultRelayState string `json:"default_relay_state"`
	// The unique identifier for your SaaS application.
	IdpEntityID string `json:"idp_entity_id"`
	// The format of the name identifier sent to the SaaS application.
	NameIDFormat AccessAppsSaaSApplicationSaasAppAccessSamlSaasAppNameIDFormat `json:"name_id_format"`
	// A [JSONata](https://jsonata.org/) expression that transforms an application's
	// user identities into a NameID value for its SAML assertion. This expression
	// should evaluate to a singular string. The output of this expression can override
	// the `name_id_format` setting.
	NameIDTransformJsonata string `json:"name_id_transform_jsonata"`
	// The Access public certificate that will be used to verify your identity.
	PublicKey string `json:"public_key"`
	// A globally unique name for an identity or service provider.
	SpEntityID string `json:"sp_entity_id"`
	// The endpoint where your SaaS application will send login requests.
	SSOEndpoint string                                                `json:"sso_endpoint"`
	UpdatedAt   time.Time                                             `json:"updated_at" format:"date-time"`
	JSON        accessAppsSaaSApplicationSaasAppAccessSamlSaasAppJSON `json:"-"`
}

func (*AccessAppsSaaSApplicationSaasAppAccessSamlSaasApp) UnmarshalJSON 

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

type AccessAppsSaaSApplicationSaasAppAccessSamlSaasAppAuthType 

type AccessAppsSaaSApplicationSaasAppAccessSamlSaasAppAuthType string

Optional identifier indicating the authentication protocol used for the saas app. Required for OIDC. Default if unset is "saml" 

const (
	AccessAppsSaaSApplicationSaasAppAccessSamlSaasAppAuthTypeSaml AccessAppsSaaSApplicationSaasAppAccessSamlSaasAppAuthType = "saml"
	AccessAppsSaaSApplicationSaasAppAccessSamlSaasAppAuthTypeOidc AccessAppsSaaSApplicationSaasAppAccessSamlSaasAppAuthType = "oidc"
)

type AccessAppsSaaSApplicationSaasAppAccessSamlSaasAppCustomAttributes 

type AccessAppsSaaSApplicationSaasAppAccessSamlSaasAppCustomAttributes struct {
	// The name of the attribute.
	Name string `json:"name"`
	// A globally unique name for an identity or service provider.
	NameFormat AccessAppsSaaSApplicationSaasAppAccessSamlSaasAppCustomAttributesNameFormat `json:"name_format"`
	Source     AccessAppsSaaSApplicationSaasAppAccessSamlSaasAppCustomAttributesSource     `json:"source"`
	JSON       accessAppsSaaSApplicationSaasAppAccessSamlSaasAppCustomAttributesJSON       `json:"-"`
}

func (*AccessAppsSaaSApplicationSaasAppAccessSamlSaasAppCustomAttributes) UnmarshalJSON 

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

type AccessAppsSaaSApplicationSaasAppAccessSamlSaasAppCustomAttributesNameFormat 

type AccessAppsSaaSApplicationSaasAppAccessSamlSaasAppCustomAttributesNameFormat string

A globally unique name for an identity or service provider. 

const (
	AccessAppsSaaSApplicationSaasAppAccessSamlSaasAppCustomAttributesNameFormatUrnOasisNamesTcSaml2_0AttrnameFormatUnspecified AccessAppsSaaSApplicationSaasAppAccessSamlSaasAppCustomAttributesNameFormat = "urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified"
	AccessAppsSaaSApplicationSaasAppAccessSamlSaasAppCustomAttributesNameFormatUrnOasisNamesTcSaml2_0AttrnameFormatBasic       AccessAppsSaaSApplicationSaasAppAccessSamlSaasAppCustomAttributesNameFormat = "urn:oasis:names:tc:SAML:2.0:attrname-format:basic"
	AccessAppsSaaSApplicationSaasAppAccessSamlSaasAppCustomAttributesNameFormatUrnOasisNamesTcSaml2_0AttrnameFormatURI         AccessAppsSaaSApplicationSaasAppAccessSamlSaasAppCustomAttributesNameFormat = "urn:oasis:names:tc:SAML:2.0:attrname-format:uri"
)

type AccessAppsSaaSApplicationSaasAppAccessSamlSaasAppCustomAttributesSource 

type AccessAppsSaaSApplicationSaasAppAccessSamlSaasAppCustomAttributesSource struct {
	// The name of the IdP attribute.
	Name string                                                                      `json:"name"`
	JSON accessAppsSaaSApplicationSaasAppAccessSamlSaasAppCustomAttributesSourceJSON `json:"-"`
}

func (*AccessAppsSaaSApplicationSaasAppAccessSamlSaasAppCustomAttributesSource) UnmarshalJSON 

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

type AccessAppsSaaSApplicationSaasAppAccessSamlSaasAppNameIDFormat 

type AccessAppsSaaSApplicationSaasAppAccessSamlSaasAppNameIDFormat string

The format of the name identifier sent to the SaaS application. 

const (
	AccessAppsSaaSApplicationSaasAppAccessSamlSaasAppNameIDFormatID    AccessAppsSaaSApplicationSaasAppAccessSamlSaasAppNameIDFormat = "id"
	AccessAppsSaaSApplicationSaasAppAccessSamlSaasAppNameIDFormatEmail AccessAppsSaaSApplicationSaasAppAccessSamlSaasAppNameIDFormat = "email"
)

type AccessAppsSelfHostedApplication 

type AccessAppsSelfHostedApplication struct {
	// The primary hostname and path that Access will secure. If the app is visible in
	// the App Launcher dashboard, this is the domain that will be displayed.
	Domain string `json:"domain,required"`
	// The application type.
	Type string `json:"type,required"`
	// UUID
	ID string `json:"id"`
	// When set to true, users can authenticate to this application using their WARP
	// session. When set to false this application will always require direct IdP
	// authentication. This setting always overrides the organization setting for WARP
	// authentication.
	AllowAuthenticateViaWARP bool `json:"allow_authenticate_via_warp"`
	// The identity providers your users can select when connecting to this
	// application. Defaults to all IdPs configured in your account.
	AllowedIdps []string `json:"allowed_idps"`
	// Displays the application in the App Launcher.
	AppLauncherVisible bool `json:"app_launcher_visible"`
	// Audience tag.
	Aud string `json:"aud"`
	// When set to `true`, users skip the identity provider selection step during
	// login. You must specify only one identity provider in allowed_idps.
	AutoRedirectToIdentity bool                                       `json:"auto_redirect_to_identity"`
	CorsHeaders            AccessAppsSelfHostedApplicationCorsHeaders `json:"cors_headers"`
	CreatedAt              time.Time                                  `json:"created_at" format:"date-time"`
	// The custom error message shown to a user when they are denied access to the
	// application.
	CustomDenyMessage string `json:"custom_deny_message"`
	// The custom URL a user is redirected to when they are denied access to the
	// application when failing identity-based rules.
	CustomDenyURL string `json:"custom_deny_url"`
	// The custom URL a user is redirected to when they are denied access to the
	// application when failing non-identity rules.
	CustomNonIdentityDenyURL string `json:"custom_non_identity_deny_url"`
	// The custom pages that will be displayed when applicable for this application
	CustomPages []string `json:"custom_pages"`
	// Enables the binding cookie, which increases security against compromised
	// authorization tokens and CSRF attacks.
	EnableBindingCookie bool `json:"enable_binding_cookie"`
	// Enables the HttpOnly cookie attribute, which increases security against XSS
	// attacks.
	HTTPOnlyCookieAttribute bool `json:"http_only_cookie_attribute"`
	// The image URL for the logo shown in the App Launcher dashboard.
	LogoURL string `json:"logo_url"`
	// The name of the application.
	Name string `json:"name"`
	// Enables cookie paths to scope an application's JWT to the application path. If
	// disabled, the JWT will scope to the hostname by default
	PathCookieAttribute bool `json:"path_cookie_attribute"`
	// Sets the SameSite cookie setting, which provides increased security against CSRF
	// attacks.
	SameSiteCookieAttribute string `json:"same_site_cookie_attribute"`
	// List of domains that Access will secure.
	SelfHostedDomains []string `json:"self_hosted_domains"`
	// Returns a 401 status code when the request is blocked by a Service Auth policy.
	ServiceAuth401Redirect bool `json:"service_auth_401_redirect"`
	// The amount of time that tokens issued for this application will be valid. Must
	// be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms,
	// s, m, h.
	SessionDuration string `json:"session_duration"`
	// Enables automatic authentication through cloudflared.
	SkipInterstitial bool `json:"skip_interstitial"`
	// The tags you want assigned to an application. Tags are used to filter
	// applications in the App Launcher dashboard.
	Tags      []string                            `json:"tags"`
	UpdatedAt time.Time                           `json:"updated_at" format:"date-time"`
	JSON      accessAppsSelfHostedApplicationJSON `json:"-"`
}

func (*AccessAppsSelfHostedApplication) UnmarshalJSON 

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

type AccessAppsSelfHostedApplicationCorsHeaders 

type AccessAppsSelfHostedApplicationCorsHeaders struct {
	// Allows all HTTP request headers.
	AllowAllHeaders bool `json:"allow_all_headers"`
	// Allows all HTTP request methods.
	AllowAllMethods bool `json:"allow_all_methods"`
	// Allows all origins.
	AllowAllOrigins bool `json:"allow_all_origins"`
	// When set to `true`, includes credentials (cookies, authorization headers, or TLS
	// client certificates) with requests.
	AllowCredentials bool `json:"allow_credentials"`
	// Allowed HTTP request headers.
	AllowedHeaders []interface{} `json:"allowed_headers"`
	// Allowed HTTP request methods.
	AllowedMethods []AccessAppsSelfHostedApplicationCorsHeadersAllowedMethod `json:"allowed_methods"`
	// Allowed origins.
	AllowedOrigins []interface{} `json:"allowed_origins"`
	// The maximum number of seconds the results of a preflight request can be cached.
	MaxAge float64                                        `json:"max_age"`
	JSON   accessAppsSelfHostedApplicationCorsHeadersJSON `json:"-"`
}

func (*AccessAppsSelfHostedApplicationCorsHeaders) UnmarshalJSON 

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

type AccessAppsSelfHostedApplicationCorsHeadersAllowedMethod 

type AccessAppsSelfHostedApplicationCorsHeadersAllowedMethod string
const (
	AccessAppsSelfHostedApplicationCorsHeadersAllowedMethodGet     AccessAppsSelfHostedApplicationCorsHeadersAllowedMethod = "GET"
	AccessAppsSelfHostedApplicationCorsHeadersAllowedMethodPost    AccessAppsSelfHostedApplicationCorsHeadersAllowedMethod = "POST"
	AccessAppsSelfHostedApplicationCorsHeadersAllowedMethodHead    AccessAppsSelfHostedApplicationCorsHeadersAllowedMethod = "HEAD"
	AccessAppsSelfHostedApplicationCorsHeadersAllowedMethodPut     AccessAppsSelfHostedApplicationCorsHeadersAllowedMethod = "PUT"
	AccessAppsSelfHostedApplicationCorsHeadersAllowedMethodDelete  AccessAppsSelfHostedApplicationCorsHeadersAllowedMethod = "DELETE"
	AccessAppsSelfHostedApplicationCorsHeadersAllowedMethodConnect AccessAppsSelfHostedApplicationCorsHeadersAllowedMethod = "CONNECT"
	AccessAppsSelfHostedApplicationCorsHeadersAllowedMethodOptions AccessAppsSelfHostedApplicationCorsHeadersAllowedMethod = "OPTIONS"
	AccessAppsSelfHostedApplicationCorsHeadersAllowedMethodTrace   AccessAppsSelfHostedApplicationCorsHeadersAllowedMethod = "TRACE"
	AccessAppsSelfHostedApplicationCorsHeadersAllowedMethodPatch   AccessAppsSelfHostedApplicationCorsHeadersAllowedMethod = "PATCH"
)

type AccessBookmarkDeleteResponse 

type AccessBookmarkDeleteResponse struct {
	// UUID
	ID   string                           `json:"id"`
	JSON accessBookmarkDeleteResponseJSON `json:"-"`
}

func (*AccessBookmarkDeleteResponse) UnmarshalJSON 

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

type AccessBookmarkDeleteResponseEnvelope 

type AccessBookmarkDeleteResponseEnvelope struct {
	Errors   []AccessBookmarkDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessBookmarkDeleteResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessBookmarkDeleteResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success AccessBookmarkDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessBookmarkDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*AccessBookmarkDeleteResponseEnvelope) UnmarshalJSON 

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

type AccessBookmarkDeleteResponseEnvelopeErrors 

type AccessBookmarkDeleteResponseEnvelopeErrors struct {
	Code    int64                                          `json:"code,required"`
	Message string                                         `json:"message,required"`
	JSON    accessBookmarkDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessBookmarkDeleteResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessBookmarkDeleteResponseEnvelopeMessages 

type AccessBookmarkDeleteResponseEnvelopeMessages struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    accessBookmarkDeleteResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessBookmarkDeleteResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessBookmarkDeleteResponseEnvelopeSuccess 

type AccessBookmarkDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessBookmarkDeleteResponseEnvelopeSuccessTrue AccessBookmarkDeleteResponseEnvelopeSuccess = true
)

type AccessBookmarkGetResponseEnvelope 

type AccessBookmarkGetResponseEnvelope struct {
	Errors   []AccessBookmarkGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessBookmarkGetResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessBookmarks                             `json:"result,required"`
	// Whether the API call was successful
	Success AccessBookmarkGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessBookmarkGetResponseEnvelopeJSON    `json:"-"`
}

func (*AccessBookmarkGetResponseEnvelope) UnmarshalJSON 

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

type AccessBookmarkGetResponseEnvelopeErrors 

type AccessBookmarkGetResponseEnvelopeErrors struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    accessBookmarkGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessBookmarkGetResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessBookmarkGetResponseEnvelopeMessages 

type AccessBookmarkGetResponseEnvelopeMessages struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    accessBookmarkGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessBookmarkGetResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessBookmarkGetResponseEnvelopeSuccess 

type AccessBookmarkGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessBookmarkGetResponseEnvelopeSuccessTrue AccessBookmarkGetResponseEnvelopeSuccess = true
)

type AccessBookmarkListResponseEnvelope 

type AccessBookmarkListResponseEnvelope struct {
	Errors   []AccessBookmarkListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessBookmarkListResponseEnvelopeMessages `json:"messages,required"`
	Result   []AccessBookmarks                            `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    AccessBookmarkListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo AccessBookmarkListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       accessBookmarkListResponseEnvelopeJSON       `json:"-"`
}

func (*AccessBookmarkListResponseEnvelope) UnmarshalJSON 

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

type AccessBookmarkListResponseEnvelopeErrors 

type AccessBookmarkListResponseEnvelopeErrors struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    accessBookmarkListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessBookmarkListResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessBookmarkListResponseEnvelopeMessages 

type AccessBookmarkListResponseEnvelopeMessages struct {
	Code    int64                                          `json:"code,required"`
	Message string                                         `json:"message,required"`
	JSON    accessBookmarkListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessBookmarkListResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessBookmarkListResponseEnvelopeResultInfo 

type AccessBookmarkListResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                          `json:"total_count"`
	JSON       accessBookmarkListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*AccessBookmarkListResponseEnvelopeResultInfo) UnmarshalJSON 

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

type AccessBookmarkListResponseEnvelopeSuccess 

type AccessBookmarkListResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessBookmarkListResponseEnvelopeSuccessTrue AccessBookmarkListResponseEnvelopeSuccess = true
)

type AccessBookmarkNewResponseEnvelope 

type AccessBookmarkNewResponseEnvelope struct {
	Errors   []AccessBookmarkNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessBookmarkNewResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessBookmarks                             `json:"result,required"`
	// Whether the API call was successful
	Success AccessBookmarkNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessBookmarkNewResponseEnvelopeJSON    `json:"-"`
}

func (*AccessBookmarkNewResponseEnvelope) UnmarshalJSON 

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

type AccessBookmarkNewResponseEnvelopeErrors 

type AccessBookmarkNewResponseEnvelopeErrors struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    accessBookmarkNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessBookmarkNewResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessBookmarkNewResponseEnvelopeMessages 

type AccessBookmarkNewResponseEnvelopeMessages struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    accessBookmarkNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessBookmarkNewResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessBookmarkNewResponseEnvelopeSuccess 

type AccessBookmarkNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessBookmarkNewResponseEnvelopeSuccessTrue AccessBookmarkNewResponseEnvelopeSuccess = true
)

type AccessBookmarkService 

type AccessBookmarkService struct {
	Options []option.RequestOption
}

AccessBookmarkService 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 NewAccessBookmarkService method instead.

func NewAccessBookmarkService 

func NewAccessBookmarkService(opts ...option.RequestOption) (r *AccessBookmarkService)

NewAccessBookmarkService 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 (*AccessBookmarkService) Delete 

func (r *AccessBookmarkService) Delete(ctx context.Context, identifier interface{}, uuid string, opts ...option.RequestOption) (res *AccessBookmarkDeleteResponse, err error)

Deletes a Bookmark application.

func (*AccessBookmarkService) Get 

func (r *AccessBookmarkService) Get(ctx context.Context, identifier interface{}, uuid string, opts ...option.RequestOption) (res *AccessBookmarks, err error)

Fetches a single Bookmark application.

func (*AccessBookmarkService) List 

func (r *AccessBookmarkService) List(ctx context.Context, identifier interface{}, opts ...option.RequestOption) (res *[]AccessBookmarks, err error)

Lists Bookmark applications.

func (*AccessBookmarkService) New 

func (r *AccessBookmarkService) New(ctx context.Context, identifier interface{}, uuid string, opts ...option.RequestOption) (res *AccessBookmarks, err error)

Create a new Bookmark application.

func (*AccessBookmarkService) Update 

func (r *AccessBookmarkService) Update(ctx context.Context, identifier interface{}, uuid string, opts ...option.RequestOption) (res *AccessBookmarks, err error)

Updates a configured Bookmark application.

type AccessBookmarkUpdateResponseEnvelope 

type AccessBookmarkUpdateResponseEnvelope struct {
	Errors   []AccessBookmarkUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessBookmarkUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessBookmarks                                `json:"result,required"`
	// Whether the API call was successful
	Success AccessBookmarkUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessBookmarkUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*AccessBookmarkUpdateResponseEnvelope) UnmarshalJSON 

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

type AccessBookmarkUpdateResponseEnvelopeErrors 

type AccessBookmarkUpdateResponseEnvelopeErrors struct {
	Code    int64                                          `json:"code,required"`
	Message string                                         `json:"message,required"`
	JSON    accessBookmarkUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessBookmarkUpdateResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessBookmarkUpdateResponseEnvelopeMessages 

type AccessBookmarkUpdateResponseEnvelopeMessages struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    accessBookmarkUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessBookmarkUpdateResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessBookmarkUpdateResponseEnvelopeSuccess 

type AccessBookmarkUpdateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessBookmarkUpdateResponseEnvelopeSuccessTrue AccessBookmarkUpdateResponseEnvelopeSuccess = true
)

type AccessBookmarks 

type AccessBookmarks struct {
	// The unique identifier for the Bookmark application.
	ID interface{} `json:"id"`
	// Displays the application in the App Launcher.
	AppLauncherVisible bool      `json:"app_launcher_visible"`
	CreatedAt          time.Time `json:"created_at" format:"date-time"`
	// The domain of the Bookmark application.
	Domain string `json:"domain"`
	// The image URL for the logo shown in the App Launcher dashboard.
	LogoURL string `json:"logo_url"`
	// The name of the Bookmark application.
	Name      string              `json:"name"`
	UpdatedAt time.Time           `json:"updated_at" format:"date-time"`
	JSON      accessBookmarksJSON `json:"-"`
}

func (*AccessBookmarks) UnmarshalJSON 

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

type AccessCA 

type AccessCA struct {
	// The ID of the CA.
	ID string `json:"id"`
	// The Application Audience (AUD) tag. Identifies the application associated with
	// the CA.
	Aud string `json:"aud"`
	// The public key to add to your SSH server configuration.
	PublicKey string       `json:"public_key"`
	JSON      accessCAJSON `json:"-"`
}

func (*AccessCA) UnmarshalJSON 

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

type AccessCertificateDeleteParams 

type AccessCertificateDeleteParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type AccessCertificateDeleteResponse 

type AccessCertificateDeleteResponse struct {
	// UUID
	ID   string                              `json:"id"`
	JSON accessCertificateDeleteResponseJSON `json:"-"`
}

func (*AccessCertificateDeleteResponse) UnmarshalJSON 

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

type AccessCertificateDeleteResponseEnvelope 

type AccessCertificateDeleteResponseEnvelope struct {
	Errors   []AccessCertificateDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessCertificateDeleteResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessCertificateDeleteResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success AccessCertificateDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessCertificateDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*AccessCertificateDeleteResponseEnvelope) UnmarshalJSON 

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

type AccessCertificateDeleteResponseEnvelopeErrors 

type AccessCertificateDeleteResponseEnvelopeErrors struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    accessCertificateDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessCertificateDeleteResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessCertificateDeleteResponseEnvelopeMessages 

type AccessCertificateDeleteResponseEnvelopeMessages struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    accessCertificateDeleteResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessCertificateDeleteResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessCertificateDeleteResponseEnvelopeSuccess 

type AccessCertificateDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessCertificateDeleteResponseEnvelopeSuccessTrue AccessCertificateDeleteResponseEnvelopeSuccess = true
)

type AccessCertificateGetParams 

type AccessCertificateGetParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type AccessCertificateGetResponseEnvelope 

type AccessCertificateGetResponseEnvelope struct {
	Errors   []AccessCertificateGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessCertificateGetResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessCertificates                             `json:"result,required"`
	// Whether the API call was successful
	Success AccessCertificateGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessCertificateGetResponseEnvelopeJSON    `json:"-"`
}

func (*AccessCertificateGetResponseEnvelope) UnmarshalJSON 

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

type AccessCertificateGetResponseEnvelopeErrors 

type AccessCertificateGetResponseEnvelopeErrors struct {
	Code    int64                                          `json:"code,required"`
	Message string                                         `json:"message,required"`
	JSON    accessCertificateGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessCertificateGetResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessCertificateGetResponseEnvelopeMessages 

type AccessCertificateGetResponseEnvelopeMessages struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    accessCertificateGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessCertificateGetResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessCertificateGetResponseEnvelopeSuccess 

type AccessCertificateGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessCertificateGetResponseEnvelopeSuccessTrue AccessCertificateGetResponseEnvelopeSuccess = true
)

type AccessCertificateListParams 

type AccessCertificateListParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type AccessCertificateListResponseEnvelope 

type AccessCertificateListResponseEnvelope struct {
	Errors   []AccessCertificateListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessCertificateListResponseEnvelopeMessages `json:"messages,required"`
	Result   []AccessCertificates                            `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    AccessCertificateListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo AccessCertificateListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       accessCertificateListResponseEnvelopeJSON       `json:"-"`
}

func (*AccessCertificateListResponseEnvelope) UnmarshalJSON 

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

type AccessCertificateListResponseEnvelopeErrors 

type AccessCertificateListResponseEnvelopeErrors struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    accessCertificateListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessCertificateListResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessCertificateListResponseEnvelopeMessages 

type AccessCertificateListResponseEnvelopeMessages struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    accessCertificateListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessCertificateListResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessCertificateListResponseEnvelopeResultInfo 

type AccessCertificateListResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                             `json:"total_count"`
	JSON       accessCertificateListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*AccessCertificateListResponseEnvelopeResultInfo) UnmarshalJSON 

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

type AccessCertificateListResponseEnvelopeSuccess 

type AccessCertificateListResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessCertificateListResponseEnvelopeSuccessTrue AccessCertificateListResponseEnvelopeSuccess = true
)

type AccessCertificateNewParams 

type AccessCertificateNewParams struct {
	// The certificate content.
	Certificate param.Field[string] `json:"certificate,required"`
	// The name of the certificate.
	Name param.Field[string] `json:"name,required"`
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
	// The hostnames of the applications that will use this certificate.
	AssociatedHostnames param.Field[[]string] `json:"associated_hostnames"`
}

func (AccessCertificateNewParams) MarshalJSON 

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

type AccessCertificateNewResponseEnvelope 

type AccessCertificateNewResponseEnvelope struct {
	Errors   []AccessCertificateNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessCertificateNewResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessCertificates                             `json:"result,required"`
	// Whether the API call was successful
	Success AccessCertificateNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessCertificateNewResponseEnvelopeJSON    `json:"-"`
}

func (*AccessCertificateNewResponseEnvelope) UnmarshalJSON 

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

type AccessCertificateNewResponseEnvelopeErrors 

type AccessCertificateNewResponseEnvelopeErrors struct {
	Code    int64                                          `json:"code,required"`
	Message string                                         `json:"message,required"`
	JSON    accessCertificateNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessCertificateNewResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessCertificateNewResponseEnvelopeMessages 

type AccessCertificateNewResponseEnvelopeMessages struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    accessCertificateNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessCertificateNewResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessCertificateNewResponseEnvelopeSuccess 

type AccessCertificateNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessCertificateNewResponseEnvelopeSuccessTrue AccessCertificateNewResponseEnvelopeSuccess = true
)

type AccessCertificateService 

type AccessCertificateService struct {
	Options  []option.RequestOption
	Settings *AccessCertificateSettingService
}

AccessCertificateService 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 NewAccessCertificateService method instead.

func NewAccessCertificateService 

func NewAccessCertificateService(opts ...option.RequestOption) (r *AccessCertificateService)

NewAccessCertificateService 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 (*AccessCertificateService) Delete 

func (r *AccessCertificateService) Delete(ctx context.Context, uuid string, body AccessCertificateDeleteParams, opts ...option.RequestOption) (res *AccessCertificateDeleteResponse, err error)

Deletes an mTLS certificate.

func (*AccessCertificateService) Get 

func (r *AccessCertificateService) Get(ctx context.Context, uuid string, query AccessCertificateGetParams, opts ...option.RequestOption) (res *AccessCertificates, err error)

Fetches a single mTLS certificate.

func (*AccessCertificateService) List 

func (r *AccessCertificateService) List(ctx context.Context, query AccessCertificateListParams, opts ...option.RequestOption) (res *[]AccessCertificates, err error)

Lists all mTLS root certificates.

func (*AccessCertificateService) New 

func (r *AccessCertificateService) New(ctx context.Context, params AccessCertificateNewParams, opts ...option.RequestOption) (res *AccessCertificates, err error)

Adds a new mTLS root certificate to Access.

func (*AccessCertificateService) Update 

func (r *AccessCertificateService) Update(ctx context.Context, uuid string, params AccessCertificateUpdateParams, opts ...option.RequestOption) (res *AccessCertificates, err error)

Updates a configured mTLS certificate.

type AccessCertificateSettingListParams 

type AccessCertificateSettingListParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type AccessCertificateSettingListResponseEnvelope 

type AccessCertificateSettingListResponseEnvelope struct {
	Errors   []AccessCertificateSettingListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessCertificateSettingListResponseEnvelopeMessages `json:"messages,required"`
	Result   []AccessSettings                                       `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    AccessCertificateSettingListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo AccessCertificateSettingListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       accessCertificateSettingListResponseEnvelopeJSON       `json:"-"`
}

func (*AccessCertificateSettingListResponseEnvelope) UnmarshalJSON 

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

type AccessCertificateSettingListResponseEnvelopeErrors 

type AccessCertificateSettingListResponseEnvelopeErrors struct {
	Code    int64                                                  `json:"code,required"`
	Message string                                                 `json:"message,required"`
	JSON    accessCertificateSettingListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessCertificateSettingListResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessCertificateSettingListResponseEnvelopeMessages 

type AccessCertificateSettingListResponseEnvelopeMessages struct {
	Code    int64                                                    `json:"code,required"`
	Message string                                                   `json:"message,required"`
	JSON    accessCertificateSettingListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessCertificateSettingListResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessCertificateSettingListResponseEnvelopeResultInfo 

type AccessCertificateSettingListResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                                    `json:"total_count"`
	JSON       accessCertificateSettingListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*AccessCertificateSettingListResponseEnvelopeResultInfo) UnmarshalJSON 

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

type AccessCertificateSettingListResponseEnvelopeSuccess 

type AccessCertificateSettingListResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessCertificateSettingListResponseEnvelopeSuccessTrue AccessCertificateSettingListResponseEnvelopeSuccess = true
)

type AccessCertificateSettingService 

type AccessCertificateSettingService struct {
	Options []option.RequestOption
}

AccessCertificateSettingService 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 NewAccessCertificateSettingService method instead.

func NewAccessCertificateSettingService 

func NewAccessCertificateSettingService(opts ...option.RequestOption) (r *AccessCertificateSettingService)

NewAccessCertificateSettingService 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 (*AccessCertificateSettingService) List 

func (r *AccessCertificateSettingService) List(ctx context.Context, query AccessCertificateSettingListParams, opts ...option.RequestOption) (res *[]AccessSettings, err error)

List all mTLS hostname settings for this account or zone.

func (*AccessCertificateSettingService) Update 

func (r *AccessCertificateSettingService) Update(ctx context.Context, params AccessCertificateSettingUpdateParams, opts ...option.RequestOption) (res *[]AccessSettings, err error)

Updates an mTLS certificate's hostname settings.

type AccessCertificateSettingUpdateParams 

type AccessCertificateSettingUpdateParams struct {
	Settings param.Field[[]AccessSettingsParam] `json:"settings,required"`
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

func (AccessCertificateSettingUpdateParams) MarshalJSON 

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

type AccessCertificateSettingUpdateResponseEnvelope 

type AccessCertificateSettingUpdateResponseEnvelope struct {
	Errors   []AccessCertificateSettingUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessCertificateSettingUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   []AccessSettings                                         `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    AccessCertificateSettingUpdateResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo AccessCertificateSettingUpdateResponseEnvelopeResultInfo `json:"result_info"`
	JSON       accessCertificateSettingUpdateResponseEnvelopeJSON       `json:"-"`
}

func (*AccessCertificateSettingUpdateResponseEnvelope) UnmarshalJSON 

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

type AccessCertificateSettingUpdateResponseEnvelopeErrors 

type AccessCertificateSettingUpdateResponseEnvelopeErrors struct {
	Code    int64                                                    `json:"code,required"`
	Message string                                                   `json:"message,required"`
	JSON    accessCertificateSettingUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessCertificateSettingUpdateResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessCertificateSettingUpdateResponseEnvelopeMessages 

type AccessCertificateSettingUpdateResponseEnvelopeMessages struct {
	Code    int64                                                      `json:"code,required"`
	Message string                                                     `json:"message,required"`
	JSON    accessCertificateSettingUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessCertificateSettingUpdateResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessCertificateSettingUpdateResponseEnvelopeResultInfo 

type AccessCertificateSettingUpdateResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                                      `json:"total_count"`
	JSON       accessCertificateSettingUpdateResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*AccessCertificateSettingUpdateResponseEnvelopeResultInfo) UnmarshalJSON 

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

type AccessCertificateSettingUpdateResponseEnvelopeSuccess 

type AccessCertificateSettingUpdateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessCertificateSettingUpdateResponseEnvelopeSuccessTrue AccessCertificateSettingUpdateResponseEnvelopeSuccess = true
)

type AccessCertificateUpdateParams 

type AccessCertificateUpdateParams struct {
	// The hostnames of the applications that will use this certificate.
	AssociatedHostnames param.Field[[]string] `json:"associated_hostnames,required"`
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
	// The name of the certificate.
	Name param.Field[string] `json:"name"`
}

func (AccessCertificateUpdateParams) MarshalJSON 

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

type AccessCertificateUpdateResponseEnvelope 

type AccessCertificateUpdateResponseEnvelope struct {
	Errors   []AccessCertificateUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessCertificateUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessCertificates                                `json:"result,required"`
	// Whether the API call was successful
	Success AccessCertificateUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessCertificateUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*AccessCertificateUpdateResponseEnvelope) UnmarshalJSON 

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

type AccessCertificateUpdateResponseEnvelopeErrors 

type AccessCertificateUpdateResponseEnvelopeErrors struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    accessCertificateUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessCertificateUpdateResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessCertificateUpdateResponseEnvelopeMessages 

type AccessCertificateUpdateResponseEnvelopeMessages struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    accessCertificateUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessCertificateUpdateResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessCertificateUpdateResponseEnvelopeSuccess 

type AccessCertificateUpdateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessCertificateUpdateResponseEnvelopeSuccessTrue AccessCertificateUpdateResponseEnvelopeSuccess = true
)

type AccessCertificates 

type AccessCertificates struct {
	// The ID of the application that will use this certificate.
	ID interface{} `json:"id"`
	// The hostnames of the applications that will use this certificate.
	AssociatedHostnames []string  `json:"associated_hostnames"`
	CreatedAt           time.Time `json:"created_at" format:"date-time"`
	ExpiresOn           time.Time `json:"expires_on" format:"date-time"`
	// The MD5 fingerprint of the certificate.
	Fingerprint string `json:"fingerprint"`
	// The name of the certificate.
	Name      string                 `json:"name"`
	UpdatedAt time.Time              `json:"updated_at" format:"date-time"`
	JSON      accessCertificatesJSON `json:"-"`
}

func (*AccessCertificates) UnmarshalJSON 

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

type AccessCustomPage 

type AccessCustomPage struct {
	// Custom page HTML.
	CustomHTML string `json:"custom_html,required"`
	// Custom page name.
	Name string `json:"name,required"`
	// Custom page type.
	Type AccessCustomPageType `json:"type,required"`
	// Number of apps the custom page is assigned to.
	AppCount  int64     `json:"app_count"`
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// UUID
	Uid       string               `json:"uid"`
	UpdatedAt time.Time            `json:"updated_at" format:"date-time"`
	JSON      accessCustomPageJSON `json:"-"`
}

func (*AccessCustomPage) UnmarshalJSON 

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

type AccessCustomPageDeleteResponse 

type AccessCustomPageDeleteResponse struct {
	// UUID
	ID   string                             `json:"id"`
	JSON accessCustomPageDeleteResponseJSON `json:"-"`
}

func (*AccessCustomPageDeleteResponse) UnmarshalJSON 

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

type AccessCustomPageDeleteResponseEnvelope 

type AccessCustomPageDeleteResponseEnvelope struct {
	Errors   []AccessCustomPageDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessCustomPageDeleteResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessCustomPageDeleteResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success AccessCustomPageDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessCustomPageDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*AccessCustomPageDeleteResponseEnvelope) UnmarshalJSON 

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

type AccessCustomPageDeleteResponseEnvelopeErrors 

type AccessCustomPageDeleteResponseEnvelopeErrors struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    accessCustomPageDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessCustomPageDeleteResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessCustomPageDeleteResponseEnvelopeMessages 

type AccessCustomPageDeleteResponseEnvelopeMessages struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    accessCustomPageDeleteResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessCustomPageDeleteResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessCustomPageDeleteResponseEnvelopeSuccess 

type AccessCustomPageDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessCustomPageDeleteResponseEnvelopeSuccessTrue AccessCustomPageDeleteResponseEnvelopeSuccess = true
)

type AccessCustomPageGetResponseEnvelope 

type AccessCustomPageGetResponseEnvelope struct {
	Errors   []AccessCustomPageGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessCustomPageGetResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessCustomPage                              `json:"result,required"`
	// Whether the API call was successful
	Success AccessCustomPageGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessCustomPageGetResponseEnvelopeJSON    `json:"-"`
}

func (*AccessCustomPageGetResponseEnvelope) UnmarshalJSON 

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

type AccessCustomPageGetResponseEnvelopeErrors 

type AccessCustomPageGetResponseEnvelopeErrors struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    accessCustomPageGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessCustomPageGetResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessCustomPageGetResponseEnvelopeMessages 

type AccessCustomPageGetResponseEnvelopeMessages struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    accessCustomPageGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessCustomPageGetResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessCustomPageGetResponseEnvelopeSuccess 

type AccessCustomPageGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessCustomPageGetResponseEnvelopeSuccessTrue AccessCustomPageGetResponseEnvelopeSuccess = true
)

type AccessCustomPageListResponseEnvelope 

type AccessCustomPageListResponseEnvelope struct {
	Errors   []AccessCustomPageListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessCustomPageListResponseEnvelopeMessages `json:"messages,required"`
	Result   []AccessCustomPageWithoutHTML                  `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    AccessCustomPageListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo AccessCustomPageListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       accessCustomPageListResponseEnvelopeJSON       `json:"-"`
}

func (*AccessCustomPageListResponseEnvelope) UnmarshalJSON 

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

type AccessCustomPageListResponseEnvelopeErrors 

type AccessCustomPageListResponseEnvelopeErrors struct {
	Code    int64                                          `json:"code,required"`
	Message string                                         `json:"message,required"`
	JSON    accessCustomPageListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessCustomPageListResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessCustomPageListResponseEnvelopeMessages 

type AccessCustomPageListResponseEnvelopeMessages struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    accessCustomPageListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessCustomPageListResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessCustomPageListResponseEnvelopeResultInfo 

type AccessCustomPageListResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                            `json:"total_count"`
	JSON       accessCustomPageListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*AccessCustomPageListResponseEnvelopeResultInfo) UnmarshalJSON 

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

type AccessCustomPageListResponseEnvelopeSuccess 

type AccessCustomPageListResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessCustomPageListResponseEnvelopeSuccessTrue AccessCustomPageListResponseEnvelopeSuccess = true
)

type AccessCustomPageNewParams 

type AccessCustomPageNewParams struct {
	// Custom page HTML.
	CustomHTML param.Field[string] `json:"custom_html,required"`
	// Custom page name.
	Name param.Field[string] `json:"name,required"`
	// Custom page type.
	Type param.Field[AccessCustomPageNewParamsType] `json:"type,required"`
	// Number of apps the custom page is assigned to.
	AppCount param.Field[int64] `json:"app_count"`
}

func (AccessCustomPageNewParams) MarshalJSON 

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

type AccessCustomPageNewParamsType 

type AccessCustomPageNewParamsType string

Custom page type. 

const (
	AccessCustomPageNewParamsTypeIdentityDenied AccessCustomPageNewParamsType = "identity_denied"
	AccessCustomPageNewParamsTypeForbidden      AccessCustomPageNewParamsType = "forbidden"
)

type AccessCustomPageNewResponseEnvelope 

type AccessCustomPageNewResponseEnvelope struct {
	Errors   []AccessCustomPageNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessCustomPageNewResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessCustomPageWithoutHTML                   `json:"result,required"`
	// Whether the API call was successful
	Success AccessCustomPageNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessCustomPageNewResponseEnvelopeJSON    `json:"-"`
}

func (*AccessCustomPageNewResponseEnvelope) UnmarshalJSON 

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

type AccessCustomPageNewResponseEnvelopeErrors 

type AccessCustomPageNewResponseEnvelopeErrors struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    accessCustomPageNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessCustomPageNewResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessCustomPageNewResponseEnvelopeMessages 

type AccessCustomPageNewResponseEnvelopeMessages struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    accessCustomPageNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessCustomPageNewResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessCustomPageNewResponseEnvelopeSuccess 

type AccessCustomPageNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessCustomPageNewResponseEnvelopeSuccessTrue AccessCustomPageNewResponseEnvelopeSuccess = true
)

type AccessCustomPageService 

type AccessCustomPageService struct {
	Options []option.RequestOption
}

AccessCustomPageService 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 NewAccessCustomPageService method instead.

func NewAccessCustomPageService 

func NewAccessCustomPageService(opts ...option.RequestOption) (r *AccessCustomPageService)

NewAccessCustomPageService 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 (*AccessCustomPageService) Delete 

func (r *AccessCustomPageService) Delete(ctx context.Context, identifier string, uuid string, opts ...option.RequestOption) (res *AccessCustomPageDeleteResponse, err error)

Delete a custom page

func (*AccessCustomPageService) Get 

func (r *AccessCustomPageService) Get(ctx context.Context, identifier string, uuid string, opts ...option.RequestOption) (res *AccessCustomPage, err error)

Fetches a custom page and also returns its HTML.

func (*AccessCustomPageService) List 

func (r *AccessCustomPageService) List(ctx context.Context, identifier string, opts ...option.RequestOption) (res *[]AccessCustomPageWithoutHTML, err error)

List custom pages

func (*AccessCustomPageService) New 

func (r *AccessCustomPageService) New(ctx context.Context, identifier string, body AccessCustomPageNewParams, opts ...option.RequestOption) (res *AccessCustomPageWithoutHTML, err error)

Create a custom page

func (*AccessCustomPageService) Update 

func (r *AccessCustomPageService) Update(ctx context.Context, identifier string, uuid string, body AccessCustomPageUpdateParams, opts ...option.RequestOption) (res *AccessCustomPageWithoutHTML, err error)

Update a custom page

type AccessCustomPageType 

type AccessCustomPageType string

Custom page type. 

const (
	AccessCustomPageTypeIdentityDenied AccessCustomPageType = "identity_denied"
	AccessCustomPageTypeForbidden      AccessCustomPageType = "forbidden"
)

type AccessCustomPageUpdateParams 

type AccessCustomPageUpdateParams struct {
	// Custom page HTML.
	CustomHTML param.Field[string] `json:"custom_html,required"`
	// Custom page name.
	Name param.Field[string] `json:"name,required"`
	// Custom page type.
	Type param.Field[AccessCustomPageUpdateParamsType] `json:"type,required"`
	// Number of apps the custom page is assigned to.
	AppCount param.Field[int64] `json:"app_count"`
}

func (AccessCustomPageUpdateParams) MarshalJSON 

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

type AccessCustomPageUpdateParamsType 

type AccessCustomPageUpdateParamsType string

Custom page type. 

const (
	AccessCustomPageUpdateParamsTypeIdentityDenied AccessCustomPageUpdateParamsType = "identity_denied"
	AccessCustomPageUpdateParamsTypeForbidden      AccessCustomPageUpdateParamsType = "forbidden"
)

type AccessCustomPageUpdateResponseEnvelope 

type AccessCustomPageUpdateResponseEnvelope struct {
	Errors   []AccessCustomPageUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessCustomPageUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessCustomPageWithoutHTML                      `json:"result,required"`
	// Whether the API call was successful
	Success AccessCustomPageUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessCustomPageUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*AccessCustomPageUpdateResponseEnvelope) UnmarshalJSON 

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

type AccessCustomPageUpdateResponseEnvelopeErrors 

type AccessCustomPageUpdateResponseEnvelopeErrors struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    accessCustomPageUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessCustomPageUpdateResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessCustomPageUpdateResponseEnvelopeMessages 

type AccessCustomPageUpdateResponseEnvelopeMessages struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    accessCustomPageUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessCustomPageUpdateResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessCustomPageUpdateResponseEnvelopeSuccess 

type AccessCustomPageUpdateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessCustomPageUpdateResponseEnvelopeSuccessTrue AccessCustomPageUpdateResponseEnvelopeSuccess = true
)

type AccessCustomPageWithoutHTML 

type AccessCustomPageWithoutHTML struct {
	// Custom page name.
	Name string `json:"name,required"`
	// Custom page type.
	Type AccessCustomPageWithoutHTMLType `json:"type,required"`
	// Number of apps the custom page is assigned to.
	AppCount  int64     `json:"app_count"`
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// UUID
	Uid       string                          `json:"uid"`
	UpdatedAt time.Time                       `json:"updated_at" format:"date-time"`
	JSON      accessCustomPageWithoutHTMLJSON `json:"-"`
}

func (*AccessCustomPageWithoutHTML) UnmarshalJSON 

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

type AccessCustomPageWithoutHTMLType 

type AccessCustomPageWithoutHTMLType string

Custom page type. 

const (
	AccessCustomPageWithoutHTMLTypeIdentityDenied AccessCustomPageWithoutHTMLType = "identity_denied"
	AccessCustomPageWithoutHTMLTypeForbidden      AccessCustomPageWithoutHTMLType = "forbidden"
)

type AccessGroupDeleteParams 

type AccessGroupDeleteParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type AccessGroupDeleteResponse 

type AccessGroupDeleteResponse struct {
	// UUID
	ID   string                        `json:"id"`
	JSON accessGroupDeleteResponseJSON `json:"-"`
}

func (*AccessGroupDeleteResponse) UnmarshalJSON 

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

type AccessGroupDeleteResponseEnvelope 

type AccessGroupDeleteResponseEnvelope struct {
	Errors   []AccessGroupDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessGroupDeleteResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessGroupDeleteResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success AccessGroupDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessGroupDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*AccessGroupDeleteResponseEnvelope) UnmarshalJSON 

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

type AccessGroupDeleteResponseEnvelopeErrors 

type AccessGroupDeleteResponseEnvelopeErrors struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    accessGroupDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessGroupDeleteResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessGroupDeleteResponseEnvelopeMessages 

type AccessGroupDeleteResponseEnvelopeMessages struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    accessGroupDeleteResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessGroupDeleteResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessGroupDeleteResponseEnvelopeSuccess 

type AccessGroupDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessGroupDeleteResponseEnvelopeSuccessTrue AccessGroupDeleteResponseEnvelopeSuccess = true
)

type AccessGroupGetParams 

type AccessGroupGetParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type AccessGroupGetResponseEnvelope 

type AccessGroupGetResponseEnvelope struct {
	Errors   []AccessGroupGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessGroupGetResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessGroups                             `json:"result,required"`
	// Whether the API call was successful
	Success AccessGroupGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessGroupGetResponseEnvelopeJSON    `json:"-"`
}

func (*AccessGroupGetResponseEnvelope) UnmarshalJSON 

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

type AccessGroupGetResponseEnvelopeErrors 

type AccessGroupGetResponseEnvelopeErrors struct {
	Code    int64                                    `json:"code,required"`
	Message string                                   `json:"message,required"`
	JSON    accessGroupGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessGroupGetResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessGroupGetResponseEnvelopeMessages 

type AccessGroupGetResponseEnvelopeMessages struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    accessGroupGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessGroupGetResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessGroupGetResponseEnvelopeSuccess 

type AccessGroupGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessGroupGetResponseEnvelopeSuccessTrue AccessGroupGetResponseEnvelopeSuccess = true
)

type AccessGroupListParams 

type AccessGroupListParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type AccessGroupListResponseEnvelope 

type AccessGroupListResponseEnvelope struct {
	Errors   []AccessGroupListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessGroupListResponseEnvelopeMessages `json:"messages,required"`
	Result   []AccessGroups                            `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    AccessGroupListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo AccessGroupListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       accessGroupListResponseEnvelopeJSON       `json:"-"`
}

func (*AccessGroupListResponseEnvelope) UnmarshalJSON 

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

type AccessGroupListResponseEnvelopeErrors 

type AccessGroupListResponseEnvelopeErrors struct {
	Code    int64                                     `json:"code,required"`
	Message string                                    `json:"message,required"`
	JSON    accessGroupListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessGroupListResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessGroupListResponseEnvelopeMessages 

type AccessGroupListResponseEnvelopeMessages struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    accessGroupListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessGroupListResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessGroupListResponseEnvelopeResultInfo 

type AccessGroupListResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                       `json:"total_count"`
	JSON       accessGroupListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*AccessGroupListResponseEnvelopeResultInfo) UnmarshalJSON 

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

type AccessGroupListResponseEnvelopeSuccess 

type AccessGroupListResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessGroupListResponseEnvelopeSuccessTrue AccessGroupListResponseEnvelopeSuccess = true
)

type AccessGroupNewParams 

type AccessGroupNewParams struct {
	// Rules evaluated with an OR logical operator. A user needs to meet only one of
	// the Include rules.
	Include param.Field[[]AccessGroupNewParamsInclude] `json:"include,required"`
	// The name of the Access group.
	Name param.Field[string] `json:"name,required"`
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
	// Rules evaluated with a NOT logical operator. To match a policy, a user cannot
	// meet any of the Exclude rules.
	Exclude param.Field[[]AccessGroupNewParamsExclude] `json:"exclude"`
	// Whether this is the default group
	IsDefault param.Field[bool] `json:"is_default"`
	// Rules evaluated with an AND logical operator. To match a policy, a user must
	// meet all of the Require rules.
	Require param.Field[[]AccessGroupNewParamsRequire] `json:"require"`
}

func (AccessGroupNewParams) MarshalJSON 

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

type AccessGroupNewParamsExclude 

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

Matches a specific email.

Satisfied by zero_trust.AccessGroupNewParamsExcludeAccessEmailRule, zero_trust.AccessGroupNewParamsExcludeAccessEmailListRule, zero_trust.AccessGroupNewParamsExcludeAccessDomainRule, zero_trust.AccessGroupNewParamsExcludeAccessEveryoneRule, zero_trust.AccessGroupNewParamsExcludeAccessIPRule, zero_trust.AccessGroupNewParamsExcludeAccessIPListRule, zero_trust.AccessGroupNewParamsExcludeAccessCertificateRule, zero_trust.AccessGroupNewParamsExcludeAccessAccessGroupRule, zero_trust.AccessGroupNewParamsExcludeAccessAzureGroupRule, zero_trust.AccessGroupNewParamsExcludeAccessGitHubOrganizationRule, zero_trust.AccessGroupNewParamsExcludeAccessGsuiteGroupRule, zero_trust.AccessGroupNewParamsExcludeAccessOktaGroupRule, zero_trust.AccessGroupNewParamsExcludeAccessSamlGroupRule, zero_trust.AccessGroupNewParamsExcludeAccessServiceTokenRule, zero_trust.AccessGroupNewParamsExcludeAccessAnyValidServiceTokenRule, zero_trust.AccessGroupNewParamsExcludeAccessExternalEvaluationRule, zero_trust.AccessGroupNewParamsExcludeAccessCountryRule, zero_trust.AccessGroupNewParamsExcludeAccessAuthenticationMethodRule, zero_trust.AccessGroupNewParamsExcludeAccessDevicePostureRule.

type AccessGroupNewParamsExcludeAccessAccessGroupRule 

type AccessGroupNewParamsExcludeAccessAccessGroupRule struct {
	Group param.Field[AccessGroupNewParamsExcludeAccessAccessGroupRuleGroup] `json:"group,required"`
}

Matches an Access group.

func (AccessGroupNewParamsExcludeAccessAccessGroupRule) MarshalJSON 

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

type AccessGroupNewParamsExcludeAccessAccessGroupRuleGroup 

type AccessGroupNewParamsExcludeAccessAccessGroupRuleGroup struct {
	// The ID of a previously created Access group.
	ID param.Field[string] `json:"id,required"`
}

func (AccessGroupNewParamsExcludeAccessAccessGroupRuleGroup) MarshalJSON 

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

type AccessGroupNewParamsExcludeAccessAnyValidServiceTokenRule 

type AccessGroupNewParamsExcludeAccessAnyValidServiceTokenRule struct {
	// An empty object which matches on all service tokens.
	AnyValidServiceToken param.Field[interface{}] `json:"any_valid_service_token,required"`
}

Matches any valid Access Service Token

func (AccessGroupNewParamsExcludeAccessAnyValidServiceTokenRule) MarshalJSON 

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

type AccessGroupNewParamsExcludeAccessAuthenticationMethodRule 

type AccessGroupNewParamsExcludeAccessAuthenticationMethodRule struct {
	AuthMethod param.Field[AccessGroupNewParamsExcludeAccessAuthenticationMethodRuleAuthMethod] `json:"auth_method,required"`
}

Enforce different MFA options

func (AccessGroupNewParamsExcludeAccessAuthenticationMethodRule) MarshalJSON 

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

type AccessGroupNewParamsExcludeAccessAuthenticationMethodRuleAuthMethod 

type AccessGroupNewParamsExcludeAccessAuthenticationMethodRuleAuthMethod struct {
	// The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
	AuthMethod param.Field[string] `json:"auth_method,required"`
}

func (AccessGroupNewParamsExcludeAccessAuthenticationMethodRuleAuthMethod) MarshalJSON 

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

type AccessGroupNewParamsExcludeAccessAzureGroupRule 

type AccessGroupNewParamsExcludeAccessAzureGroupRule struct {
	AzureAd param.Field[AccessGroupNewParamsExcludeAccessAzureGroupRuleAzureAd] `json:"azureAD,required"`
}

Matches an Azure group. Requires an Azure identity provider.

func (AccessGroupNewParamsExcludeAccessAzureGroupRule) MarshalJSON 

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

type AccessGroupNewParamsExcludeAccessAzureGroupRuleAzureAd 

type AccessGroupNewParamsExcludeAccessAzureGroupRuleAzureAd struct {
	// The ID of an Azure group.
	ID param.Field[string] `json:"id,required"`
	// The ID of your Azure identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
}

func (AccessGroupNewParamsExcludeAccessAzureGroupRuleAzureAd) MarshalJSON 

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

type AccessGroupNewParamsExcludeAccessCertificateRule 

type AccessGroupNewParamsExcludeAccessCertificateRule struct {
	Certificate param.Field[interface{}] `json:"certificate,required"`
}

Matches any valid client certificate.

func (AccessGroupNewParamsExcludeAccessCertificateRule) MarshalJSON 

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

type AccessGroupNewParamsExcludeAccessCountryRule 

type AccessGroupNewParamsExcludeAccessCountryRule struct {
	Geo param.Field[AccessGroupNewParamsExcludeAccessCountryRuleGeo] `json:"geo,required"`
}

Matches a specific country

func (AccessGroupNewParamsExcludeAccessCountryRule) MarshalJSON 

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

type AccessGroupNewParamsExcludeAccessCountryRuleGeo 

type AccessGroupNewParamsExcludeAccessCountryRuleGeo struct {
	// The country code that should be matched.
	CountryCode param.Field[string] `json:"country_code,required"`
}

func (AccessGroupNewParamsExcludeAccessCountryRuleGeo) MarshalJSON 

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

type AccessGroupNewParamsExcludeAccessDevicePostureRule 

type AccessGroupNewParamsExcludeAccessDevicePostureRule struct {
	DevicePosture param.Field[AccessGroupNewParamsExcludeAccessDevicePostureRuleDevicePosture] `json:"device_posture,required"`
}

Enforces a device posture rule has run successfully

func (AccessGroupNewParamsExcludeAccessDevicePostureRule) MarshalJSON 

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

type AccessGroupNewParamsExcludeAccessDevicePostureRuleDevicePosture 

type AccessGroupNewParamsExcludeAccessDevicePostureRuleDevicePosture struct {
	// The ID of a device posture integration.
	IntegrationUid param.Field[string] `json:"integration_uid,required"`
}

func (AccessGroupNewParamsExcludeAccessDevicePostureRuleDevicePosture) MarshalJSON 

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

type AccessGroupNewParamsExcludeAccessDomainRule 

type AccessGroupNewParamsExcludeAccessDomainRule struct {
	EmailDomain param.Field[AccessGroupNewParamsExcludeAccessDomainRuleEmailDomain] `json:"email_domain,required"`
}

Match an entire email domain.

func (AccessGroupNewParamsExcludeAccessDomainRule) MarshalJSON 

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

type AccessGroupNewParamsExcludeAccessDomainRuleEmailDomain 

type AccessGroupNewParamsExcludeAccessDomainRuleEmailDomain struct {
	// The email domain to match.
	Domain param.Field[string] `json:"domain,required"`
}

func (AccessGroupNewParamsExcludeAccessDomainRuleEmailDomain) MarshalJSON 

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

type AccessGroupNewParamsExcludeAccessEmailListRule 

type AccessGroupNewParamsExcludeAccessEmailListRule struct {
	EmailList param.Field[AccessGroupNewParamsExcludeAccessEmailListRuleEmailList] `json:"email_list,required"`
}

Matches an email address from a list.

func (AccessGroupNewParamsExcludeAccessEmailListRule) MarshalJSON 

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

type AccessGroupNewParamsExcludeAccessEmailListRuleEmailList 

type AccessGroupNewParamsExcludeAccessEmailListRuleEmailList struct {
	// The ID of a previously created email list.
	ID param.Field[string] `json:"id,required"`
}

func (AccessGroupNewParamsExcludeAccessEmailListRuleEmailList) MarshalJSON 

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

type AccessGroupNewParamsExcludeAccessEmailRule 

type AccessGroupNewParamsExcludeAccessEmailRule struct {
	Email param.Field[AccessGroupNewParamsExcludeAccessEmailRuleEmail] `json:"email,required"`
}

Matches a specific email.

func (AccessGroupNewParamsExcludeAccessEmailRule) MarshalJSON 

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

type AccessGroupNewParamsExcludeAccessEmailRuleEmail 

type AccessGroupNewParamsExcludeAccessEmailRuleEmail struct {
	// The email of the user.
	Email param.Field[string] `json:"email,required" format:"email"`
}

func (AccessGroupNewParamsExcludeAccessEmailRuleEmail) MarshalJSON 

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

type AccessGroupNewParamsExcludeAccessEveryoneRule 

type AccessGroupNewParamsExcludeAccessEveryoneRule struct {
	// An empty object which matches on all users.
	Everyone param.Field[interface{}] `json:"everyone,required"`
}

Matches everyone.

func (AccessGroupNewParamsExcludeAccessEveryoneRule) MarshalJSON 

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

type AccessGroupNewParamsExcludeAccessExternalEvaluationRule 

type AccessGroupNewParamsExcludeAccessExternalEvaluationRule struct {
	ExternalEvaluation param.Field[AccessGroupNewParamsExcludeAccessExternalEvaluationRuleExternalEvaluation] `json:"external_evaluation,required"`
}

Create Allow or Block policies which evaluate the user based on custom criteria.

func (AccessGroupNewParamsExcludeAccessExternalEvaluationRule) MarshalJSON 

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

type AccessGroupNewParamsExcludeAccessExternalEvaluationRuleExternalEvaluation 

type AccessGroupNewParamsExcludeAccessExternalEvaluationRuleExternalEvaluation struct {
	// The API endpoint containing your business logic.
	EvaluateURL param.Field[string] `json:"evaluate_url,required"`
	// The API endpoint containing the key that Access uses to verify that the response
	// came from your API.
	KeysURL param.Field[string] `json:"keys_url,required"`
}

func (AccessGroupNewParamsExcludeAccessExternalEvaluationRuleExternalEvaluation) MarshalJSON 

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

type AccessGroupNewParamsExcludeAccessGitHubOrganizationRule 

type AccessGroupNewParamsExcludeAccessGitHubOrganizationRule struct {
	GitHubOrganization param.Field[AccessGroupNewParamsExcludeAccessGitHubOrganizationRuleGitHubOrganization] `json:"github-organization,required"`
}

Matches a Github organization. Requires a Github identity provider.

func (AccessGroupNewParamsExcludeAccessGitHubOrganizationRule) MarshalJSON 

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

type AccessGroupNewParamsExcludeAccessGitHubOrganizationRuleGitHubOrganization 

type AccessGroupNewParamsExcludeAccessGitHubOrganizationRuleGitHubOrganization struct {
	// The ID of your Github identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The name of the organization.
	Name param.Field[string] `json:"name,required"`
}

func (AccessGroupNewParamsExcludeAccessGitHubOrganizationRuleGitHubOrganization) MarshalJSON 

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

type AccessGroupNewParamsExcludeAccessGsuiteGroupRule 

type AccessGroupNewParamsExcludeAccessGsuiteGroupRule struct {
	Gsuite param.Field[AccessGroupNewParamsExcludeAccessGsuiteGroupRuleGsuite] `json:"gsuite,required"`
}

Matches a group in Google Workspace. Requires a Google Workspace identity provider.

func (AccessGroupNewParamsExcludeAccessGsuiteGroupRule) MarshalJSON 

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

type AccessGroupNewParamsExcludeAccessGsuiteGroupRuleGsuite 

type AccessGroupNewParamsExcludeAccessGsuiteGroupRuleGsuite struct {
	// The ID of your Google Workspace identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The email of the Google Workspace group.
	Email param.Field[string] `json:"email,required"`
}

func (AccessGroupNewParamsExcludeAccessGsuiteGroupRuleGsuite) MarshalJSON 

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

type AccessGroupNewParamsExcludeAccessIPListRule 

type AccessGroupNewParamsExcludeAccessIPListRule struct {
	IPList param.Field[AccessGroupNewParamsExcludeAccessIPListRuleIPList] `json:"ip_list,required"`
}

Matches an IP address from a list.

func (AccessGroupNewParamsExcludeAccessIPListRule) MarshalJSON 

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

type AccessGroupNewParamsExcludeAccessIPListRuleIPList 

type AccessGroupNewParamsExcludeAccessIPListRuleIPList struct {
	// The ID of a previously created IP list.
	ID param.Field[string] `json:"id,required"`
}

func (AccessGroupNewParamsExcludeAccessIPListRuleIPList) MarshalJSON 

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

type AccessGroupNewParamsExcludeAccessIPRule 

type AccessGroupNewParamsExcludeAccessIPRule struct {
	IP param.Field[AccessGroupNewParamsExcludeAccessIPRuleIP] `json:"ip,required"`
}

Matches an IP address block.

func (AccessGroupNewParamsExcludeAccessIPRule) MarshalJSON 

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

type AccessGroupNewParamsExcludeAccessIPRuleIP 

type AccessGroupNewParamsExcludeAccessIPRuleIP struct {
	// An IPv4 or IPv6 CIDR block.
	IP param.Field[string] `json:"ip,required"`
}

func (AccessGroupNewParamsExcludeAccessIPRuleIP) MarshalJSON 

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

type AccessGroupNewParamsExcludeAccessOktaGroupRule 

type AccessGroupNewParamsExcludeAccessOktaGroupRule struct {
	Okta param.Field[AccessGroupNewParamsExcludeAccessOktaGroupRuleOkta] `json:"okta,required"`
}

Matches an Okta group. Requires an Okta identity provider.

func (AccessGroupNewParamsExcludeAccessOktaGroupRule) MarshalJSON 

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

type AccessGroupNewParamsExcludeAccessOktaGroupRuleOkta 

type AccessGroupNewParamsExcludeAccessOktaGroupRuleOkta struct {
	// The ID of your Okta identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The email of the Okta group.
	Email param.Field[string] `json:"email,required"`
}

func (AccessGroupNewParamsExcludeAccessOktaGroupRuleOkta) MarshalJSON 

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

type AccessGroupNewParamsExcludeAccessSamlGroupRule 

type AccessGroupNewParamsExcludeAccessSamlGroupRule struct {
	Saml param.Field[AccessGroupNewParamsExcludeAccessSamlGroupRuleSaml] `json:"saml,required"`
}

Matches a SAML group. Requires a SAML identity provider.

func (AccessGroupNewParamsExcludeAccessSamlGroupRule) MarshalJSON 

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

type AccessGroupNewParamsExcludeAccessSamlGroupRuleSaml 

type AccessGroupNewParamsExcludeAccessSamlGroupRuleSaml struct {
	// The name of the SAML attribute.
	AttributeName param.Field[string] `json:"attribute_name,required"`
	// The SAML attribute value to look for.
	AttributeValue param.Field[string] `json:"attribute_value,required"`
}

func (AccessGroupNewParamsExcludeAccessSamlGroupRuleSaml) MarshalJSON 

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

type AccessGroupNewParamsExcludeAccessServiceTokenRule 

type AccessGroupNewParamsExcludeAccessServiceTokenRule struct {
	ServiceToken param.Field[AccessGroupNewParamsExcludeAccessServiceTokenRuleServiceToken] `json:"service_token,required"`
}

Matches a specific Access Service Token

func (AccessGroupNewParamsExcludeAccessServiceTokenRule) MarshalJSON 

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

type AccessGroupNewParamsExcludeAccessServiceTokenRuleServiceToken 

type AccessGroupNewParamsExcludeAccessServiceTokenRuleServiceToken struct {
	// The ID of a Service Token.
	TokenID param.Field[string] `json:"token_id,required"`
}

func (AccessGroupNewParamsExcludeAccessServiceTokenRuleServiceToken) MarshalJSON 

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

type AccessGroupNewParamsInclude 

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

Matches a specific email.

Satisfied by zero_trust.AccessGroupNewParamsIncludeAccessEmailRule, zero_trust.AccessGroupNewParamsIncludeAccessEmailListRule, zero_trust.AccessGroupNewParamsIncludeAccessDomainRule, zero_trust.AccessGroupNewParamsIncludeAccessEveryoneRule, zero_trust.AccessGroupNewParamsIncludeAccessIPRule, zero_trust.AccessGroupNewParamsIncludeAccessIPListRule, zero_trust.AccessGroupNewParamsIncludeAccessCertificateRule, zero_trust.AccessGroupNewParamsIncludeAccessAccessGroupRule, zero_trust.AccessGroupNewParamsIncludeAccessAzureGroupRule, zero_trust.AccessGroupNewParamsIncludeAccessGitHubOrganizationRule, zero_trust.AccessGroupNewParamsIncludeAccessGsuiteGroupRule, zero_trust.AccessGroupNewParamsIncludeAccessOktaGroupRule, zero_trust.AccessGroupNewParamsIncludeAccessSamlGroupRule, zero_trust.AccessGroupNewParamsIncludeAccessServiceTokenRule, zero_trust.AccessGroupNewParamsIncludeAccessAnyValidServiceTokenRule, zero_trust.AccessGroupNewParamsIncludeAccessExternalEvaluationRule, zero_trust.AccessGroupNewParamsIncludeAccessCountryRule, zero_trust.AccessGroupNewParamsIncludeAccessAuthenticationMethodRule, zero_trust.AccessGroupNewParamsIncludeAccessDevicePostureRule.

type AccessGroupNewParamsIncludeAccessAccessGroupRule 

type AccessGroupNewParamsIncludeAccessAccessGroupRule struct {
	Group param.Field[AccessGroupNewParamsIncludeAccessAccessGroupRuleGroup] `json:"group,required"`
}

Matches an Access group.

func (AccessGroupNewParamsIncludeAccessAccessGroupRule) MarshalJSON 

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

type AccessGroupNewParamsIncludeAccessAccessGroupRuleGroup 

type AccessGroupNewParamsIncludeAccessAccessGroupRuleGroup struct {
	// The ID of a previously created Access group.
	ID param.Field[string] `json:"id,required"`
}

func (AccessGroupNewParamsIncludeAccessAccessGroupRuleGroup) MarshalJSON 

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

type AccessGroupNewParamsIncludeAccessAnyValidServiceTokenRule 

type AccessGroupNewParamsIncludeAccessAnyValidServiceTokenRule struct {
	// An empty object which matches on all service tokens.
	AnyValidServiceToken param.Field[interface{}] `json:"any_valid_service_token,required"`
}

Matches any valid Access Service Token

func (AccessGroupNewParamsIncludeAccessAnyValidServiceTokenRule) MarshalJSON 

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

type AccessGroupNewParamsIncludeAccessAuthenticationMethodRule 

type AccessGroupNewParamsIncludeAccessAuthenticationMethodRule struct {
	AuthMethod param.Field[AccessGroupNewParamsIncludeAccessAuthenticationMethodRuleAuthMethod] `json:"auth_method,required"`
}

Enforce different MFA options

func (AccessGroupNewParamsIncludeAccessAuthenticationMethodRule) MarshalJSON 

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

type AccessGroupNewParamsIncludeAccessAuthenticationMethodRuleAuthMethod 

type AccessGroupNewParamsIncludeAccessAuthenticationMethodRuleAuthMethod struct {
	// The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
	AuthMethod param.Field[string] `json:"auth_method,required"`
}

func (AccessGroupNewParamsIncludeAccessAuthenticationMethodRuleAuthMethod) MarshalJSON 

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

type AccessGroupNewParamsIncludeAccessAzureGroupRule 

type AccessGroupNewParamsIncludeAccessAzureGroupRule struct {
	AzureAd param.Field[AccessGroupNewParamsIncludeAccessAzureGroupRuleAzureAd] `json:"azureAD,required"`
}

Matches an Azure group. Requires an Azure identity provider.

func (AccessGroupNewParamsIncludeAccessAzureGroupRule) MarshalJSON 

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

type AccessGroupNewParamsIncludeAccessAzureGroupRuleAzureAd 

type AccessGroupNewParamsIncludeAccessAzureGroupRuleAzureAd struct {
	// The ID of an Azure group.
	ID param.Field[string] `json:"id,required"`
	// The ID of your Azure identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
}

func (AccessGroupNewParamsIncludeAccessAzureGroupRuleAzureAd) MarshalJSON 

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

type AccessGroupNewParamsIncludeAccessCertificateRule 

type AccessGroupNewParamsIncludeAccessCertificateRule struct {
	Certificate param.Field[interface{}] `json:"certificate,required"`
}

Matches any valid client certificate.

func (AccessGroupNewParamsIncludeAccessCertificateRule) MarshalJSON 

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

type AccessGroupNewParamsIncludeAccessCountryRule 

type AccessGroupNewParamsIncludeAccessCountryRule struct {
	Geo param.Field[AccessGroupNewParamsIncludeAccessCountryRuleGeo] `json:"geo,required"`
}

Matches a specific country

func (AccessGroupNewParamsIncludeAccessCountryRule) MarshalJSON 

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

type AccessGroupNewParamsIncludeAccessCountryRuleGeo 

type AccessGroupNewParamsIncludeAccessCountryRuleGeo struct {
	// The country code that should be matched.
	CountryCode param.Field[string] `json:"country_code,required"`
}

func (AccessGroupNewParamsIncludeAccessCountryRuleGeo) MarshalJSON 

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

type AccessGroupNewParamsIncludeAccessDevicePostureRule 

type AccessGroupNewParamsIncludeAccessDevicePostureRule struct {
	DevicePosture param.Field[AccessGroupNewParamsIncludeAccessDevicePostureRuleDevicePosture] `json:"device_posture,required"`
}

Enforces a device posture rule has run successfully

func (AccessGroupNewParamsIncludeAccessDevicePostureRule) MarshalJSON 

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

type AccessGroupNewParamsIncludeAccessDevicePostureRuleDevicePosture 

type AccessGroupNewParamsIncludeAccessDevicePostureRuleDevicePosture struct {
	// The ID of a device posture integration.
	IntegrationUid param.Field[string] `json:"integration_uid,required"`
}

func (AccessGroupNewParamsIncludeAccessDevicePostureRuleDevicePosture) MarshalJSON 

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

type AccessGroupNewParamsIncludeAccessDomainRule 

type AccessGroupNewParamsIncludeAccessDomainRule struct {
	EmailDomain param.Field[AccessGroupNewParamsIncludeAccessDomainRuleEmailDomain] `json:"email_domain,required"`
}

Match an entire email domain.

func (AccessGroupNewParamsIncludeAccessDomainRule) MarshalJSON 

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

type AccessGroupNewParamsIncludeAccessDomainRuleEmailDomain 

type AccessGroupNewParamsIncludeAccessDomainRuleEmailDomain struct {
	// The email domain to match.
	Domain param.Field[string] `json:"domain,required"`
}

func (AccessGroupNewParamsIncludeAccessDomainRuleEmailDomain) MarshalJSON 

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

type AccessGroupNewParamsIncludeAccessEmailListRule 

type AccessGroupNewParamsIncludeAccessEmailListRule struct {
	EmailList param.Field[AccessGroupNewParamsIncludeAccessEmailListRuleEmailList] `json:"email_list,required"`
}

Matches an email address from a list.

func (AccessGroupNewParamsIncludeAccessEmailListRule) MarshalJSON 

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

type AccessGroupNewParamsIncludeAccessEmailListRuleEmailList 

type AccessGroupNewParamsIncludeAccessEmailListRuleEmailList struct {
	// The ID of a previously created email list.
	ID param.Field[string] `json:"id,required"`
}

func (AccessGroupNewParamsIncludeAccessEmailListRuleEmailList) MarshalJSON 

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

type AccessGroupNewParamsIncludeAccessEmailRule 

type AccessGroupNewParamsIncludeAccessEmailRule struct {
	Email param.Field[AccessGroupNewParamsIncludeAccessEmailRuleEmail] `json:"email,required"`
}

Matches a specific email.

func (AccessGroupNewParamsIncludeAccessEmailRule) MarshalJSON 

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

type AccessGroupNewParamsIncludeAccessEmailRuleEmail 

type AccessGroupNewParamsIncludeAccessEmailRuleEmail struct {
	// The email of the user.
	Email param.Field[string] `json:"email,required" format:"email"`
}

func (AccessGroupNewParamsIncludeAccessEmailRuleEmail) MarshalJSON 

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

type AccessGroupNewParamsIncludeAccessEveryoneRule 

type AccessGroupNewParamsIncludeAccessEveryoneRule struct {
	// An empty object which matches on all users.
	Everyone param.Field[interface{}] `json:"everyone,required"`
}

Matches everyone.

func (AccessGroupNewParamsIncludeAccessEveryoneRule) MarshalJSON 

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

type AccessGroupNewParamsIncludeAccessExternalEvaluationRule 

type AccessGroupNewParamsIncludeAccessExternalEvaluationRule struct {
	ExternalEvaluation param.Field[AccessGroupNewParamsIncludeAccessExternalEvaluationRuleExternalEvaluation] `json:"external_evaluation,required"`
}

Create Allow or Block policies which evaluate the user based on custom criteria.

func (AccessGroupNewParamsIncludeAccessExternalEvaluationRule) MarshalJSON 

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

type AccessGroupNewParamsIncludeAccessExternalEvaluationRuleExternalEvaluation 

type AccessGroupNewParamsIncludeAccessExternalEvaluationRuleExternalEvaluation struct {
	// The API endpoint containing your business logic.
	EvaluateURL param.Field[string] `json:"evaluate_url,required"`
	// The API endpoint containing the key that Access uses to verify that the response
	// came from your API.
	KeysURL param.Field[string] `json:"keys_url,required"`
}

func (AccessGroupNewParamsIncludeAccessExternalEvaluationRuleExternalEvaluation) MarshalJSON 

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

type AccessGroupNewParamsIncludeAccessGitHubOrganizationRule 

type AccessGroupNewParamsIncludeAccessGitHubOrganizationRule struct {
	GitHubOrganization param.Field[AccessGroupNewParamsIncludeAccessGitHubOrganizationRuleGitHubOrganization] `json:"github-organization,required"`
}

Matches a Github organization. Requires a Github identity provider.

func (AccessGroupNewParamsIncludeAccessGitHubOrganizationRule) MarshalJSON 

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

type AccessGroupNewParamsIncludeAccessGitHubOrganizationRuleGitHubOrganization 

type AccessGroupNewParamsIncludeAccessGitHubOrganizationRuleGitHubOrganization struct {
	// The ID of your Github identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The name of the organization.
	Name param.Field[string] `json:"name,required"`
}

func (AccessGroupNewParamsIncludeAccessGitHubOrganizationRuleGitHubOrganization) MarshalJSON 

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

type AccessGroupNewParamsIncludeAccessGsuiteGroupRule 

type AccessGroupNewParamsIncludeAccessGsuiteGroupRule struct {
	Gsuite param.Field[AccessGroupNewParamsIncludeAccessGsuiteGroupRuleGsuite] `json:"gsuite,required"`
}

Matches a group in Google Workspace. Requires a Google Workspace identity provider.

func (AccessGroupNewParamsIncludeAccessGsuiteGroupRule) MarshalJSON 

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

type AccessGroupNewParamsIncludeAccessGsuiteGroupRuleGsuite 

type AccessGroupNewParamsIncludeAccessGsuiteGroupRuleGsuite struct {
	// The ID of your Google Workspace identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The email of the Google Workspace group.
	Email param.Field[string] `json:"email,required"`
}

func (AccessGroupNewParamsIncludeAccessGsuiteGroupRuleGsuite) MarshalJSON 

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

type AccessGroupNewParamsIncludeAccessIPListRule 

type AccessGroupNewParamsIncludeAccessIPListRule struct {
	IPList param.Field[AccessGroupNewParamsIncludeAccessIPListRuleIPList] `json:"ip_list,required"`
}

Matches an IP address from a list.

func (AccessGroupNewParamsIncludeAccessIPListRule) MarshalJSON 

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

type AccessGroupNewParamsIncludeAccessIPListRuleIPList 

type AccessGroupNewParamsIncludeAccessIPListRuleIPList struct {
	// The ID of a previously created IP list.
	ID param.Field[string] `json:"id,required"`
}

func (AccessGroupNewParamsIncludeAccessIPListRuleIPList) MarshalJSON 

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

type AccessGroupNewParamsIncludeAccessIPRule 

type AccessGroupNewParamsIncludeAccessIPRule struct {
	IP param.Field[AccessGroupNewParamsIncludeAccessIPRuleIP] `json:"ip,required"`
}

Matches an IP address block.

func (AccessGroupNewParamsIncludeAccessIPRule) MarshalJSON 

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

type AccessGroupNewParamsIncludeAccessIPRuleIP 

type AccessGroupNewParamsIncludeAccessIPRuleIP struct {
	// An IPv4 or IPv6 CIDR block.
	IP param.Field[string] `json:"ip,required"`
}

func (AccessGroupNewParamsIncludeAccessIPRuleIP) MarshalJSON 

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

type AccessGroupNewParamsIncludeAccessOktaGroupRule 

type AccessGroupNewParamsIncludeAccessOktaGroupRule struct {
	Okta param.Field[AccessGroupNewParamsIncludeAccessOktaGroupRuleOkta] `json:"okta,required"`
}

Matches an Okta group. Requires an Okta identity provider.

func (AccessGroupNewParamsIncludeAccessOktaGroupRule) MarshalJSON 

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

type AccessGroupNewParamsIncludeAccessOktaGroupRuleOkta 

type AccessGroupNewParamsIncludeAccessOktaGroupRuleOkta struct {
	// The ID of your Okta identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The email of the Okta group.
	Email param.Field[string] `json:"email,required"`
}

func (AccessGroupNewParamsIncludeAccessOktaGroupRuleOkta) MarshalJSON 

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

type AccessGroupNewParamsIncludeAccessSamlGroupRule 

type AccessGroupNewParamsIncludeAccessSamlGroupRule struct {
	Saml param.Field[AccessGroupNewParamsIncludeAccessSamlGroupRuleSaml] `json:"saml,required"`
}

Matches a SAML group. Requires a SAML identity provider.

func (AccessGroupNewParamsIncludeAccessSamlGroupRule) MarshalJSON 

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

type AccessGroupNewParamsIncludeAccessSamlGroupRuleSaml 

type AccessGroupNewParamsIncludeAccessSamlGroupRuleSaml struct {
	// The name of the SAML attribute.
	AttributeName param.Field[string] `json:"attribute_name,required"`
	// The SAML attribute value to look for.
	AttributeValue param.Field[string] `json:"attribute_value,required"`
}

func (AccessGroupNewParamsIncludeAccessSamlGroupRuleSaml) MarshalJSON 

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

type AccessGroupNewParamsIncludeAccessServiceTokenRule 

type AccessGroupNewParamsIncludeAccessServiceTokenRule struct {
	ServiceToken param.Field[AccessGroupNewParamsIncludeAccessServiceTokenRuleServiceToken] `json:"service_token,required"`
}

Matches a specific Access Service Token

func (AccessGroupNewParamsIncludeAccessServiceTokenRule) MarshalJSON 

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

type AccessGroupNewParamsIncludeAccessServiceTokenRuleServiceToken 

type AccessGroupNewParamsIncludeAccessServiceTokenRuleServiceToken struct {
	// The ID of a Service Token.
	TokenID param.Field[string] `json:"token_id,required"`
}

func (AccessGroupNewParamsIncludeAccessServiceTokenRuleServiceToken) MarshalJSON 

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

type AccessGroupNewParamsRequire 

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

Matches a specific email.

Satisfied by zero_trust.AccessGroupNewParamsRequireAccessEmailRule, zero_trust.AccessGroupNewParamsRequireAccessEmailListRule, zero_trust.AccessGroupNewParamsRequireAccessDomainRule, zero_trust.AccessGroupNewParamsRequireAccessEveryoneRule, zero_trust.AccessGroupNewParamsRequireAccessIPRule, zero_trust.AccessGroupNewParamsRequireAccessIPListRule, zero_trust.AccessGroupNewParamsRequireAccessCertificateRule, zero_trust.AccessGroupNewParamsRequireAccessAccessGroupRule, zero_trust.AccessGroupNewParamsRequireAccessAzureGroupRule, zero_trust.AccessGroupNewParamsRequireAccessGitHubOrganizationRule, zero_trust.AccessGroupNewParamsRequireAccessGsuiteGroupRule, zero_trust.AccessGroupNewParamsRequireAccessOktaGroupRule, zero_trust.AccessGroupNewParamsRequireAccessSamlGroupRule, zero_trust.AccessGroupNewParamsRequireAccessServiceTokenRule, zero_trust.AccessGroupNewParamsRequireAccessAnyValidServiceTokenRule, zero_trust.AccessGroupNewParamsRequireAccessExternalEvaluationRule, zero_trust.AccessGroupNewParamsRequireAccessCountryRule, zero_trust.AccessGroupNewParamsRequireAccessAuthenticationMethodRule, zero_trust.AccessGroupNewParamsRequireAccessDevicePostureRule.

type AccessGroupNewParamsRequireAccessAccessGroupRule 

type AccessGroupNewParamsRequireAccessAccessGroupRule struct {
	Group param.Field[AccessGroupNewParamsRequireAccessAccessGroupRuleGroup] `json:"group,required"`
}

Matches an Access group.

func (AccessGroupNewParamsRequireAccessAccessGroupRule) MarshalJSON 

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

type AccessGroupNewParamsRequireAccessAccessGroupRuleGroup 

type AccessGroupNewParamsRequireAccessAccessGroupRuleGroup struct {
	// The ID of a previously created Access group.
	ID param.Field[string] `json:"id,required"`
}

func (AccessGroupNewParamsRequireAccessAccessGroupRuleGroup) MarshalJSON 

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

type AccessGroupNewParamsRequireAccessAnyValidServiceTokenRule 

type AccessGroupNewParamsRequireAccessAnyValidServiceTokenRule struct {
	// An empty object which matches on all service tokens.
	AnyValidServiceToken param.Field[interface{}] `json:"any_valid_service_token,required"`
}

Matches any valid Access Service Token

func (AccessGroupNewParamsRequireAccessAnyValidServiceTokenRule) MarshalJSON 

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

type AccessGroupNewParamsRequireAccessAuthenticationMethodRule 

type AccessGroupNewParamsRequireAccessAuthenticationMethodRule struct {
	AuthMethod param.Field[AccessGroupNewParamsRequireAccessAuthenticationMethodRuleAuthMethod] `json:"auth_method,required"`
}

Enforce different MFA options

func (AccessGroupNewParamsRequireAccessAuthenticationMethodRule) MarshalJSON 

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

type AccessGroupNewParamsRequireAccessAuthenticationMethodRuleAuthMethod 

type AccessGroupNewParamsRequireAccessAuthenticationMethodRuleAuthMethod struct {
	// The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
	AuthMethod param.Field[string] `json:"auth_method,required"`
}

func (AccessGroupNewParamsRequireAccessAuthenticationMethodRuleAuthMethod) MarshalJSON 

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

type AccessGroupNewParamsRequireAccessAzureGroupRule 

type AccessGroupNewParamsRequireAccessAzureGroupRule struct {
	AzureAd param.Field[AccessGroupNewParamsRequireAccessAzureGroupRuleAzureAd] `json:"azureAD,required"`
}

Matches an Azure group. Requires an Azure identity provider.

func (AccessGroupNewParamsRequireAccessAzureGroupRule) MarshalJSON 

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

type AccessGroupNewParamsRequireAccessAzureGroupRuleAzureAd 

type AccessGroupNewParamsRequireAccessAzureGroupRuleAzureAd struct {
	// The ID of an Azure group.
	ID param.Field[string] `json:"id,required"`
	// The ID of your Azure identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
}

func (AccessGroupNewParamsRequireAccessAzureGroupRuleAzureAd) MarshalJSON 

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

type AccessGroupNewParamsRequireAccessCertificateRule 

type AccessGroupNewParamsRequireAccessCertificateRule struct {
	Certificate param.Field[interface{}] `json:"certificate,required"`
}

Matches any valid client certificate.

func (AccessGroupNewParamsRequireAccessCertificateRule) MarshalJSON 

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

type AccessGroupNewParamsRequireAccessCountryRule 

type AccessGroupNewParamsRequireAccessCountryRule struct {
	Geo param.Field[AccessGroupNewParamsRequireAccessCountryRuleGeo] `json:"geo,required"`
}

Matches a specific country

func (AccessGroupNewParamsRequireAccessCountryRule) MarshalJSON 

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

type AccessGroupNewParamsRequireAccessCountryRuleGeo 

type AccessGroupNewParamsRequireAccessCountryRuleGeo struct {
	// The country code that should be matched.
	CountryCode param.Field[string] `json:"country_code,required"`
}

func (AccessGroupNewParamsRequireAccessCountryRuleGeo) MarshalJSON 

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

type AccessGroupNewParamsRequireAccessDevicePostureRule 

type AccessGroupNewParamsRequireAccessDevicePostureRule struct {
	DevicePosture param.Field[AccessGroupNewParamsRequireAccessDevicePostureRuleDevicePosture] `json:"device_posture,required"`
}

Enforces a device posture rule has run successfully

func (AccessGroupNewParamsRequireAccessDevicePostureRule) MarshalJSON 

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

type AccessGroupNewParamsRequireAccessDevicePostureRuleDevicePosture 

type AccessGroupNewParamsRequireAccessDevicePostureRuleDevicePosture struct {
	// The ID of a device posture integration.
	IntegrationUid param.Field[string] `json:"integration_uid,required"`
}

func (AccessGroupNewParamsRequireAccessDevicePostureRuleDevicePosture) MarshalJSON 

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

type AccessGroupNewParamsRequireAccessDomainRule 

type AccessGroupNewParamsRequireAccessDomainRule struct {
	EmailDomain param.Field[AccessGroupNewParamsRequireAccessDomainRuleEmailDomain] `json:"email_domain,required"`
}

Match an entire email domain.

func (AccessGroupNewParamsRequireAccessDomainRule) MarshalJSON 

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

type AccessGroupNewParamsRequireAccessDomainRuleEmailDomain 

type AccessGroupNewParamsRequireAccessDomainRuleEmailDomain struct {
	// The email domain to match.
	Domain param.Field[string] `json:"domain,required"`
}

func (AccessGroupNewParamsRequireAccessDomainRuleEmailDomain) MarshalJSON 

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

type AccessGroupNewParamsRequireAccessEmailListRule 

type AccessGroupNewParamsRequireAccessEmailListRule struct {
	EmailList param.Field[AccessGroupNewParamsRequireAccessEmailListRuleEmailList] `json:"email_list,required"`
}

Matches an email address from a list.

func (AccessGroupNewParamsRequireAccessEmailListRule) MarshalJSON 

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

type AccessGroupNewParamsRequireAccessEmailListRuleEmailList 

type AccessGroupNewParamsRequireAccessEmailListRuleEmailList struct {
	// The ID of a previously created email list.
	ID param.Field[string] `json:"id,required"`
}

func (AccessGroupNewParamsRequireAccessEmailListRuleEmailList) MarshalJSON 

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

type AccessGroupNewParamsRequireAccessEmailRule 

type AccessGroupNewParamsRequireAccessEmailRule struct {
	Email param.Field[AccessGroupNewParamsRequireAccessEmailRuleEmail] `json:"email,required"`
}

Matches a specific email.

func (AccessGroupNewParamsRequireAccessEmailRule) MarshalJSON 

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

type AccessGroupNewParamsRequireAccessEmailRuleEmail 

type AccessGroupNewParamsRequireAccessEmailRuleEmail struct {
	// The email of the user.
	Email param.Field[string] `json:"email,required" format:"email"`
}

func (AccessGroupNewParamsRequireAccessEmailRuleEmail) MarshalJSON 

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

type AccessGroupNewParamsRequireAccessEveryoneRule 

type AccessGroupNewParamsRequireAccessEveryoneRule struct {
	// An empty object which matches on all users.
	Everyone param.Field[interface{}] `json:"everyone,required"`
}

Matches everyone.

func (AccessGroupNewParamsRequireAccessEveryoneRule) MarshalJSON 

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

type AccessGroupNewParamsRequireAccessExternalEvaluationRule 

type AccessGroupNewParamsRequireAccessExternalEvaluationRule struct {
	ExternalEvaluation param.Field[AccessGroupNewParamsRequireAccessExternalEvaluationRuleExternalEvaluation] `json:"external_evaluation,required"`
}

Create Allow or Block policies which evaluate the user based on custom criteria.

func (AccessGroupNewParamsRequireAccessExternalEvaluationRule) MarshalJSON 

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

type AccessGroupNewParamsRequireAccessExternalEvaluationRuleExternalEvaluation 

type AccessGroupNewParamsRequireAccessExternalEvaluationRuleExternalEvaluation struct {
	// The API endpoint containing your business logic.
	EvaluateURL param.Field[string] `json:"evaluate_url,required"`
	// The API endpoint containing the key that Access uses to verify that the response
	// came from your API.
	KeysURL param.Field[string] `json:"keys_url,required"`
}

func (AccessGroupNewParamsRequireAccessExternalEvaluationRuleExternalEvaluation) MarshalJSON 

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

type AccessGroupNewParamsRequireAccessGitHubOrganizationRule 

type AccessGroupNewParamsRequireAccessGitHubOrganizationRule struct {
	GitHubOrganization param.Field[AccessGroupNewParamsRequireAccessGitHubOrganizationRuleGitHubOrganization] `json:"github-organization,required"`
}

Matches a Github organization. Requires a Github identity provider.

func (AccessGroupNewParamsRequireAccessGitHubOrganizationRule) MarshalJSON 

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

type AccessGroupNewParamsRequireAccessGitHubOrganizationRuleGitHubOrganization 

type AccessGroupNewParamsRequireAccessGitHubOrganizationRuleGitHubOrganization struct {
	// The ID of your Github identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The name of the organization.
	Name param.Field[string] `json:"name,required"`
}

func (AccessGroupNewParamsRequireAccessGitHubOrganizationRuleGitHubOrganization) MarshalJSON 

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

type AccessGroupNewParamsRequireAccessGsuiteGroupRule 

type AccessGroupNewParamsRequireAccessGsuiteGroupRule struct {
	Gsuite param.Field[AccessGroupNewParamsRequireAccessGsuiteGroupRuleGsuite] `json:"gsuite,required"`
}

Matches a group in Google Workspace. Requires a Google Workspace identity provider.

func (AccessGroupNewParamsRequireAccessGsuiteGroupRule) MarshalJSON 

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

type AccessGroupNewParamsRequireAccessGsuiteGroupRuleGsuite 

type AccessGroupNewParamsRequireAccessGsuiteGroupRuleGsuite struct {
	// The ID of your Google Workspace identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The email of the Google Workspace group.
	Email param.Field[string] `json:"email,required"`
}

func (AccessGroupNewParamsRequireAccessGsuiteGroupRuleGsuite) MarshalJSON 

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

type AccessGroupNewParamsRequireAccessIPListRule 

type AccessGroupNewParamsRequireAccessIPListRule struct {
	IPList param.Field[AccessGroupNewParamsRequireAccessIPListRuleIPList] `json:"ip_list,required"`
}

Matches an IP address from a list.

func (AccessGroupNewParamsRequireAccessIPListRule) MarshalJSON 

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

type AccessGroupNewParamsRequireAccessIPListRuleIPList 

type AccessGroupNewParamsRequireAccessIPListRuleIPList struct {
	// The ID of a previously created IP list.
	ID param.Field[string] `json:"id,required"`
}

func (AccessGroupNewParamsRequireAccessIPListRuleIPList) MarshalJSON 

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

type AccessGroupNewParamsRequireAccessIPRule 

type AccessGroupNewParamsRequireAccessIPRule struct {
	IP param.Field[AccessGroupNewParamsRequireAccessIPRuleIP] `json:"ip,required"`
}

Matches an IP address block.

func (AccessGroupNewParamsRequireAccessIPRule) MarshalJSON 

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

type AccessGroupNewParamsRequireAccessIPRuleIP 

type AccessGroupNewParamsRequireAccessIPRuleIP struct {
	// An IPv4 or IPv6 CIDR block.
	IP param.Field[string] `json:"ip,required"`
}

func (AccessGroupNewParamsRequireAccessIPRuleIP) MarshalJSON 

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

type AccessGroupNewParamsRequireAccessOktaGroupRule 

type AccessGroupNewParamsRequireAccessOktaGroupRule struct {
	Okta param.Field[AccessGroupNewParamsRequireAccessOktaGroupRuleOkta] `json:"okta,required"`
}

Matches an Okta group. Requires an Okta identity provider.

func (AccessGroupNewParamsRequireAccessOktaGroupRule) MarshalJSON 

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

type AccessGroupNewParamsRequireAccessOktaGroupRuleOkta 

type AccessGroupNewParamsRequireAccessOktaGroupRuleOkta struct {
	// The ID of your Okta identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The email of the Okta group.
	Email param.Field[string] `json:"email,required"`
}

func (AccessGroupNewParamsRequireAccessOktaGroupRuleOkta) MarshalJSON 

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

type AccessGroupNewParamsRequireAccessSamlGroupRule 

type AccessGroupNewParamsRequireAccessSamlGroupRule struct {
	Saml param.Field[AccessGroupNewParamsRequireAccessSamlGroupRuleSaml] `json:"saml,required"`
}

Matches a SAML group. Requires a SAML identity provider.

func (AccessGroupNewParamsRequireAccessSamlGroupRule) MarshalJSON 

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

type AccessGroupNewParamsRequireAccessSamlGroupRuleSaml 

type AccessGroupNewParamsRequireAccessSamlGroupRuleSaml struct {
	// The name of the SAML attribute.
	AttributeName param.Field[string] `json:"attribute_name,required"`
	// The SAML attribute value to look for.
	AttributeValue param.Field[string] `json:"attribute_value,required"`
}

func (AccessGroupNewParamsRequireAccessSamlGroupRuleSaml) MarshalJSON 

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

type AccessGroupNewParamsRequireAccessServiceTokenRule 

type AccessGroupNewParamsRequireAccessServiceTokenRule struct {
	ServiceToken param.Field[AccessGroupNewParamsRequireAccessServiceTokenRuleServiceToken] `json:"service_token,required"`
}

Matches a specific Access Service Token

func (AccessGroupNewParamsRequireAccessServiceTokenRule) MarshalJSON 

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

type AccessGroupNewParamsRequireAccessServiceTokenRuleServiceToken 

type AccessGroupNewParamsRequireAccessServiceTokenRuleServiceToken struct {
	// The ID of a Service Token.
	TokenID param.Field[string] `json:"token_id,required"`
}

func (AccessGroupNewParamsRequireAccessServiceTokenRuleServiceToken) MarshalJSON 

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

type AccessGroupNewResponseEnvelope 

type AccessGroupNewResponseEnvelope struct {
	Errors   []AccessGroupNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessGroupNewResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessGroups                             `json:"result,required"`
	// Whether the API call was successful
	Success AccessGroupNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessGroupNewResponseEnvelopeJSON    `json:"-"`
}

func (*AccessGroupNewResponseEnvelope) UnmarshalJSON 

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

type AccessGroupNewResponseEnvelopeErrors 

type AccessGroupNewResponseEnvelopeErrors struct {
	Code    int64                                    `json:"code,required"`
	Message string                                   `json:"message,required"`
	JSON    accessGroupNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessGroupNewResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessGroupNewResponseEnvelopeMessages 

type AccessGroupNewResponseEnvelopeMessages struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    accessGroupNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessGroupNewResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessGroupNewResponseEnvelopeSuccess 

type AccessGroupNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessGroupNewResponseEnvelopeSuccessTrue AccessGroupNewResponseEnvelopeSuccess = true
)

type AccessGroupService 

type AccessGroupService struct {
	Options []option.RequestOption
}

AccessGroupService 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 NewAccessGroupService method instead.

func NewAccessGroupService 

func NewAccessGroupService(opts ...option.RequestOption) (r *AccessGroupService)

NewAccessGroupService 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 (*AccessGroupService) Delete 

func (r *AccessGroupService) Delete(ctx context.Context, uuid string, body AccessGroupDeleteParams, opts ...option.RequestOption) (res *AccessGroupDeleteResponse, err error)

Deletes an Access group.

func (*AccessGroupService) Get 

func (r *AccessGroupService) Get(ctx context.Context, uuid string, query AccessGroupGetParams, opts ...option.RequestOption) (res *AccessGroups, err error)

Fetches a single Access group.

func (*AccessGroupService) List 

func (r *AccessGroupService) List(ctx context.Context, query AccessGroupListParams, opts ...option.RequestOption) (res *[]AccessGroups, err error)

Lists all Access groups.

func (*AccessGroupService) New 

func (r *AccessGroupService) New(ctx context.Context, params AccessGroupNewParams, opts ...option.RequestOption) (res *AccessGroups, err error)

Creates a new Access group.

func (*AccessGroupService) Update 

func (r *AccessGroupService) Update(ctx context.Context, uuid string, params AccessGroupUpdateParams, opts ...option.RequestOption) (res *AccessGroups, err error)

Updates a configured Access group.

type AccessGroupUpdateParams 

type AccessGroupUpdateParams struct {
	// Rules evaluated with an OR logical operator. A user needs to meet only one of
	// the Include rules.
	Include param.Field[[]AccessGroupUpdateParamsInclude] `json:"include,required"`
	// The name of the Access group.
	Name param.Field[string] `json:"name,required"`
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
	// Rules evaluated with a NOT logical operator. To match a policy, a user cannot
	// meet any of the Exclude rules.
	Exclude param.Field[[]AccessGroupUpdateParamsExclude] `json:"exclude"`
	// Whether this is the default group
	IsDefault param.Field[bool] `json:"is_default"`
	// Rules evaluated with an AND logical operator. To match a policy, a user must
	// meet all of the Require rules.
	Require param.Field[[]AccessGroupUpdateParamsRequire] `json:"require"`
}

func (AccessGroupUpdateParams) MarshalJSON 

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

type AccessGroupUpdateParamsExclude 

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

Matches a specific email.

Satisfied by zero_trust.AccessGroupUpdateParamsExcludeAccessEmailRule, zero_trust.AccessGroupUpdateParamsExcludeAccessEmailListRule, zero_trust.AccessGroupUpdateParamsExcludeAccessDomainRule, zero_trust.AccessGroupUpdateParamsExcludeAccessEveryoneRule, zero_trust.AccessGroupUpdateParamsExcludeAccessIPRule, zero_trust.AccessGroupUpdateParamsExcludeAccessIPListRule, zero_trust.AccessGroupUpdateParamsExcludeAccessCertificateRule, zero_trust.AccessGroupUpdateParamsExcludeAccessAccessGroupRule, zero_trust.AccessGroupUpdateParamsExcludeAccessAzureGroupRule, zero_trust.AccessGroupUpdateParamsExcludeAccessGitHubOrganizationRule, zero_trust.AccessGroupUpdateParamsExcludeAccessGsuiteGroupRule, zero_trust.AccessGroupUpdateParamsExcludeAccessOktaGroupRule, zero_trust.AccessGroupUpdateParamsExcludeAccessSamlGroupRule, zero_trust.AccessGroupUpdateParamsExcludeAccessServiceTokenRule, zero_trust.AccessGroupUpdateParamsExcludeAccessAnyValidServiceTokenRule, zero_trust.AccessGroupUpdateParamsExcludeAccessExternalEvaluationRule, zero_trust.AccessGroupUpdateParamsExcludeAccessCountryRule, zero_trust.AccessGroupUpdateParamsExcludeAccessAuthenticationMethodRule, zero_trust.AccessGroupUpdateParamsExcludeAccessDevicePostureRule.

type AccessGroupUpdateParamsExcludeAccessAccessGroupRule 

type AccessGroupUpdateParamsExcludeAccessAccessGroupRule struct {
	Group param.Field[AccessGroupUpdateParamsExcludeAccessAccessGroupRuleGroup] `json:"group,required"`
}

Matches an Access group.

func (AccessGroupUpdateParamsExcludeAccessAccessGroupRule) MarshalJSON 

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

type AccessGroupUpdateParamsExcludeAccessAccessGroupRuleGroup 

type AccessGroupUpdateParamsExcludeAccessAccessGroupRuleGroup struct {
	// The ID of a previously created Access group.
	ID param.Field[string] `json:"id,required"`
}

func (AccessGroupUpdateParamsExcludeAccessAccessGroupRuleGroup) MarshalJSON 

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

type AccessGroupUpdateParamsExcludeAccessAnyValidServiceTokenRule 

type AccessGroupUpdateParamsExcludeAccessAnyValidServiceTokenRule struct {
	// An empty object which matches on all service tokens.
	AnyValidServiceToken param.Field[interface{}] `json:"any_valid_service_token,required"`
}

Matches any valid Access Service Token

func (AccessGroupUpdateParamsExcludeAccessAnyValidServiceTokenRule) MarshalJSON 

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

type AccessGroupUpdateParamsExcludeAccessAuthenticationMethodRule 

type AccessGroupUpdateParamsExcludeAccessAuthenticationMethodRule struct {
	AuthMethod param.Field[AccessGroupUpdateParamsExcludeAccessAuthenticationMethodRuleAuthMethod] `json:"auth_method,required"`
}

Enforce different MFA options

func (AccessGroupUpdateParamsExcludeAccessAuthenticationMethodRule) MarshalJSON 

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

type AccessGroupUpdateParamsExcludeAccessAuthenticationMethodRuleAuthMethod 

type AccessGroupUpdateParamsExcludeAccessAuthenticationMethodRuleAuthMethod struct {
	// The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
	AuthMethod param.Field[string] `json:"auth_method,required"`
}

func (AccessGroupUpdateParamsExcludeAccessAuthenticationMethodRuleAuthMethod) MarshalJSON 

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

type AccessGroupUpdateParamsExcludeAccessAzureGroupRule 

type AccessGroupUpdateParamsExcludeAccessAzureGroupRule struct {
	AzureAd param.Field[AccessGroupUpdateParamsExcludeAccessAzureGroupRuleAzureAd] `json:"azureAD,required"`
}

Matches an Azure group. Requires an Azure identity provider.

func (AccessGroupUpdateParamsExcludeAccessAzureGroupRule) MarshalJSON 

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

type AccessGroupUpdateParamsExcludeAccessAzureGroupRuleAzureAd 

type AccessGroupUpdateParamsExcludeAccessAzureGroupRuleAzureAd struct {
	// The ID of an Azure group.
	ID param.Field[string] `json:"id,required"`
	// The ID of your Azure identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
}

func (AccessGroupUpdateParamsExcludeAccessAzureGroupRuleAzureAd) MarshalJSON 

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

type AccessGroupUpdateParamsExcludeAccessCertificateRule 

type AccessGroupUpdateParamsExcludeAccessCertificateRule struct {
	Certificate param.Field[interface{}] `json:"certificate,required"`
}

Matches any valid client certificate.

func (AccessGroupUpdateParamsExcludeAccessCertificateRule) MarshalJSON 

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

type AccessGroupUpdateParamsExcludeAccessCountryRule 

type AccessGroupUpdateParamsExcludeAccessCountryRule struct {
	Geo param.Field[AccessGroupUpdateParamsExcludeAccessCountryRuleGeo] `json:"geo,required"`
}

Matches a specific country

func (AccessGroupUpdateParamsExcludeAccessCountryRule) MarshalJSON 

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

type AccessGroupUpdateParamsExcludeAccessCountryRuleGeo 

type AccessGroupUpdateParamsExcludeAccessCountryRuleGeo struct {
	// The country code that should be matched.
	CountryCode param.Field[string] `json:"country_code,required"`
}

func (AccessGroupUpdateParamsExcludeAccessCountryRuleGeo) MarshalJSON 

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

type AccessGroupUpdateParamsExcludeAccessDevicePostureRule 

type AccessGroupUpdateParamsExcludeAccessDevicePostureRule struct {
	DevicePosture param.Field[AccessGroupUpdateParamsExcludeAccessDevicePostureRuleDevicePosture] `json:"device_posture,required"`
}

Enforces a device posture rule has run successfully

func (AccessGroupUpdateParamsExcludeAccessDevicePostureRule) MarshalJSON 

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

type AccessGroupUpdateParamsExcludeAccessDevicePostureRuleDevicePosture 

type AccessGroupUpdateParamsExcludeAccessDevicePostureRuleDevicePosture struct {
	// The ID of a device posture integration.
	IntegrationUid param.Field[string] `json:"integration_uid,required"`
}

func (AccessGroupUpdateParamsExcludeAccessDevicePostureRuleDevicePosture) MarshalJSON 

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

type AccessGroupUpdateParamsExcludeAccessDomainRule 

type AccessGroupUpdateParamsExcludeAccessDomainRule struct {
	EmailDomain param.Field[AccessGroupUpdateParamsExcludeAccessDomainRuleEmailDomain] `json:"email_domain,required"`
}

Match an entire email domain.

func (AccessGroupUpdateParamsExcludeAccessDomainRule) MarshalJSON 

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

type AccessGroupUpdateParamsExcludeAccessDomainRuleEmailDomain 

type AccessGroupUpdateParamsExcludeAccessDomainRuleEmailDomain struct {
	// The email domain to match.
	Domain param.Field[string] `json:"domain,required"`
}

func (AccessGroupUpdateParamsExcludeAccessDomainRuleEmailDomain) MarshalJSON 

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

type AccessGroupUpdateParamsExcludeAccessEmailListRule 

type AccessGroupUpdateParamsExcludeAccessEmailListRule struct {
	EmailList param.Field[AccessGroupUpdateParamsExcludeAccessEmailListRuleEmailList] `json:"email_list,required"`
}

Matches an email address from a list.

func (AccessGroupUpdateParamsExcludeAccessEmailListRule) MarshalJSON 

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

type AccessGroupUpdateParamsExcludeAccessEmailListRuleEmailList 

type AccessGroupUpdateParamsExcludeAccessEmailListRuleEmailList struct {
	// The ID of a previously created email list.
	ID param.Field[string] `json:"id,required"`
}

func (AccessGroupUpdateParamsExcludeAccessEmailListRuleEmailList) MarshalJSON 

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

type AccessGroupUpdateParamsExcludeAccessEmailRule 

type AccessGroupUpdateParamsExcludeAccessEmailRule struct {
	Email param.Field[AccessGroupUpdateParamsExcludeAccessEmailRuleEmail] `json:"email,required"`
}

Matches a specific email.

func (AccessGroupUpdateParamsExcludeAccessEmailRule) MarshalJSON 

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

type AccessGroupUpdateParamsExcludeAccessEmailRuleEmail 

type AccessGroupUpdateParamsExcludeAccessEmailRuleEmail struct {
	// The email of the user.
	Email param.Field[string] `json:"email,required" format:"email"`
}

func (AccessGroupUpdateParamsExcludeAccessEmailRuleEmail) MarshalJSON 

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

type AccessGroupUpdateParamsExcludeAccessEveryoneRule 

type AccessGroupUpdateParamsExcludeAccessEveryoneRule struct {
	// An empty object which matches on all users.
	Everyone param.Field[interface{}] `json:"everyone,required"`
}

Matches everyone.

func (AccessGroupUpdateParamsExcludeAccessEveryoneRule) MarshalJSON 

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

type AccessGroupUpdateParamsExcludeAccessExternalEvaluationRule 

type AccessGroupUpdateParamsExcludeAccessExternalEvaluationRule struct {
	ExternalEvaluation param.Field[AccessGroupUpdateParamsExcludeAccessExternalEvaluationRuleExternalEvaluation] `json:"external_evaluation,required"`
}

Create Allow or Block policies which evaluate the user based on custom criteria.

func (AccessGroupUpdateParamsExcludeAccessExternalEvaluationRule) MarshalJSON 

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

type AccessGroupUpdateParamsExcludeAccessExternalEvaluationRuleExternalEvaluation 

type AccessGroupUpdateParamsExcludeAccessExternalEvaluationRuleExternalEvaluation struct {
	// The API endpoint containing your business logic.
	EvaluateURL param.Field[string] `json:"evaluate_url,required"`
	// The API endpoint containing the key that Access uses to verify that the response
	// came from your API.
	KeysURL param.Field[string] `json:"keys_url,required"`
}

func (AccessGroupUpdateParamsExcludeAccessExternalEvaluationRuleExternalEvaluation) MarshalJSON 

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

type AccessGroupUpdateParamsExcludeAccessGitHubOrganizationRule 

type AccessGroupUpdateParamsExcludeAccessGitHubOrganizationRule struct {
	GitHubOrganization param.Field[AccessGroupUpdateParamsExcludeAccessGitHubOrganizationRuleGitHubOrganization] `json:"github-organization,required"`
}

Matches a Github organization. Requires a Github identity provider.

func (AccessGroupUpdateParamsExcludeAccessGitHubOrganizationRule) MarshalJSON 

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

type AccessGroupUpdateParamsExcludeAccessGitHubOrganizationRuleGitHubOrganization 

type AccessGroupUpdateParamsExcludeAccessGitHubOrganizationRuleGitHubOrganization struct {
	// The ID of your Github identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The name of the organization.
	Name param.Field[string] `json:"name,required"`
}

func (AccessGroupUpdateParamsExcludeAccessGitHubOrganizationRuleGitHubOrganization) MarshalJSON 

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

type AccessGroupUpdateParamsExcludeAccessGsuiteGroupRule 

type AccessGroupUpdateParamsExcludeAccessGsuiteGroupRule struct {
	Gsuite param.Field[AccessGroupUpdateParamsExcludeAccessGsuiteGroupRuleGsuite] `json:"gsuite,required"`
}

Matches a group in Google Workspace. Requires a Google Workspace identity provider.

func (AccessGroupUpdateParamsExcludeAccessGsuiteGroupRule) MarshalJSON 

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

type AccessGroupUpdateParamsExcludeAccessGsuiteGroupRuleGsuite 

type AccessGroupUpdateParamsExcludeAccessGsuiteGroupRuleGsuite struct {
	// The ID of your Google Workspace identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The email of the Google Workspace group.
	Email param.Field[string] `json:"email,required"`
}

func (AccessGroupUpdateParamsExcludeAccessGsuiteGroupRuleGsuite) MarshalJSON 

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

type AccessGroupUpdateParamsExcludeAccessIPListRule 

type AccessGroupUpdateParamsExcludeAccessIPListRule struct {
	IPList param.Field[AccessGroupUpdateParamsExcludeAccessIPListRuleIPList] `json:"ip_list,required"`
}

Matches an IP address from a list.

func (AccessGroupUpdateParamsExcludeAccessIPListRule) MarshalJSON 

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

type AccessGroupUpdateParamsExcludeAccessIPListRuleIPList 

type AccessGroupUpdateParamsExcludeAccessIPListRuleIPList struct {
	// The ID of a previously created IP list.
	ID param.Field[string] `json:"id,required"`
}

func (AccessGroupUpdateParamsExcludeAccessIPListRuleIPList) MarshalJSON 

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

type AccessGroupUpdateParamsExcludeAccessIPRule 

type AccessGroupUpdateParamsExcludeAccessIPRule struct {
	IP param.Field[AccessGroupUpdateParamsExcludeAccessIPRuleIP] `json:"ip,required"`
}

Matches an IP address block.

func (AccessGroupUpdateParamsExcludeAccessIPRule) MarshalJSON 

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

type AccessGroupUpdateParamsExcludeAccessIPRuleIP 

type AccessGroupUpdateParamsExcludeAccessIPRuleIP struct {
	// An IPv4 or IPv6 CIDR block.
	IP param.Field[string] `json:"ip,required"`
}

func (AccessGroupUpdateParamsExcludeAccessIPRuleIP) MarshalJSON 

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

type AccessGroupUpdateParamsExcludeAccessOktaGroupRule 

type AccessGroupUpdateParamsExcludeAccessOktaGroupRule struct {
	Okta param.Field[AccessGroupUpdateParamsExcludeAccessOktaGroupRuleOkta] `json:"okta,required"`
}

Matches an Okta group. Requires an Okta identity provider.

func (AccessGroupUpdateParamsExcludeAccessOktaGroupRule) MarshalJSON 

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

type AccessGroupUpdateParamsExcludeAccessOktaGroupRuleOkta 

type AccessGroupUpdateParamsExcludeAccessOktaGroupRuleOkta struct {
	// The ID of your Okta identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The email of the Okta group.
	Email param.Field[string] `json:"email,required"`
}

func (AccessGroupUpdateParamsExcludeAccessOktaGroupRuleOkta) MarshalJSON 

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

type AccessGroupUpdateParamsExcludeAccessSamlGroupRule 

type AccessGroupUpdateParamsExcludeAccessSamlGroupRule struct {
	Saml param.Field[AccessGroupUpdateParamsExcludeAccessSamlGroupRuleSaml] `json:"saml,required"`
}

Matches a SAML group. Requires a SAML identity provider.

func (AccessGroupUpdateParamsExcludeAccessSamlGroupRule) MarshalJSON 

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

type AccessGroupUpdateParamsExcludeAccessSamlGroupRuleSaml 

type AccessGroupUpdateParamsExcludeAccessSamlGroupRuleSaml struct {
	// The name of the SAML attribute.
	AttributeName param.Field[string] `json:"attribute_name,required"`
	// The SAML attribute value to look for.
	AttributeValue param.Field[string] `json:"attribute_value,required"`
}

func (AccessGroupUpdateParamsExcludeAccessSamlGroupRuleSaml) MarshalJSON 

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

type AccessGroupUpdateParamsExcludeAccessServiceTokenRule 

type AccessGroupUpdateParamsExcludeAccessServiceTokenRule struct {
	ServiceToken param.Field[AccessGroupUpdateParamsExcludeAccessServiceTokenRuleServiceToken] `json:"service_token,required"`
}

Matches a specific Access Service Token

func (AccessGroupUpdateParamsExcludeAccessServiceTokenRule) MarshalJSON 

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

type AccessGroupUpdateParamsExcludeAccessServiceTokenRuleServiceToken 

type AccessGroupUpdateParamsExcludeAccessServiceTokenRuleServiceToken struct {
	// The ID of a Service Token.
	TokenID param.Field[string] `json:"token_id,required"`
}

func (AccessGroupUpdateParamsExcludeAccessServiceTokenRuleServiceToken) MarshalJSON 

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

type AccessGroupUpdateParamsInclude 

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

Matches a specific email.

Satisfied by zero_trust.AccessGroupUpdateParamsIncludeAccessEmailRule, zero_trust.AccessGroupUpdateParamsIncludeAccessEmailListRule, zero_trust.AccessGroupUpdateParamsIncludeAccessDomainRule, zero_trust.AccessGroupUpdateParamsIncludeAccessEveryoneRule, zero_trust.AccessGroupUpdateParamsIncludeAccessIPRule, zero_trust.AccessGroupUpdateParamsIncludeAccessIPListRule, zero_trust.AccessGroupUpdateParamsIncludeAccessCertificateRule, zero_trust.AccessGroupUpdateParamsIncludeAccessAccessGroupRule, zero_trust.AccessGroupUpdateParamsIncludeAccessAzureGroupRule, zero_trust.AccessGroupUpdateParamsIncludeAccessGitHubOrganizationRule, zero_trust.AccessGroupUpdateParamsIncludeAccessGsuiteGroupRule, zero_trust.AccessGroupUpdateParamsIncludeAccessOktaGroupRule, zero_trust.AccessGroupUpdateParamsIncludeAccessSamlGroupRule, zero_trust.AccessGroupUpdateParamsIncludeAccessServiceTokenRule, zero_trust.AccessGroupUpdateParamsIncludeAccessAnyValidServiceTokenRule, zero_trust.AccessGroupUpdateParamsIncludeAccessExternalEvaluationRule, zero_trust.AccessGroupUpdateParamsIncludeAccessCountryRule, zero_trust.AccessGroupUpdateParamsIncludeAccessAuthenticationMethodRule, zero_trust.AccessGroupUpdateParamsIncludeAccessDevicePostureRule.

type AccessGroupUpdateParamsIncludeAccessAccessGroupRule 

type AccessGroupUpdateParamsIncludeAccessAccessGroupRule struct {
	Group param.Field[AccessGroupUpdateParamsIncludeAccessAccessGroupRuleGroup] `json:"group,required"`
}

Matches an Access group.

func (AccessGroupUpdateParamsIncludeAccessAccessGroupRule) MarshalJSON 

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

type AccessGroupUpdateParamsIncludeAccessAccessGroupRuleGroup 

type AccessGroupUpdateParamsIncludeAccessAccessGroupRuleGroup struct {
	// The ID of a previously created Access group.
	ID param.Field[string] `json:"id,required"`
}

func (AccessGroupUpdateParamsIncludeAccessAccessGroupRuleGroup) MarshalJSON 

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

type AccessGroupUpdateParamsIncludeAccessAnyValidServiceTokenRule 

type AccessGroupUpdateParamsIncludeAccessAnyValidServiceTokenRule struct {
	// An empty object which matches on all service tokens.
	AnyValidServiceToken param.Field[interface{}] `json:"any_valid_service_token,required"`
}

Matches any valid Access Service Token

func (AccessGroupUpdateParamsIncludeAccessAnyValidServiceTokenRule) MarshalJSON 

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

type AccessGroupUpdateParamsIncludeAccessAuthenticationMethodRule 

type AccessGroupUpdateParamsIncludeAccessAuthenticationMethodRule struct {
	AuthMethod param.Field[AccessGroupUpdateParamsIncludeAccessAuthenticationMethodRuleAuthMethod] `json:"auth_method,required"`
}

Enforce different MFA options

func (AccessGroupUpdateParamsIncludeAccessAuthenticationMethodRule) MarshalJSON 

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

type AccessGroupUpdateParamsIncludeAccessAuthenticationMethodRuleAuthMethod 

type AccessGroupUpdateParamsIncludeAccessAuthenticationMethodRuleAuthMethod struct {
	// The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
	AuthMethod param.Field[string] `json:"auth_method,required"`
}

func (AccessGroupUpdateParamsIncludeAccessAuthenticationMethodRuleAuthMethod) MarshalJSON 

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

type AccessGroupUpdateParamsIncludeAccessAzureGroupRule 

type AccessGroupUpdateParamsIncludeAccessAzureGroupRule struct {
	AzureAd param.Field[AccessGroupUpdateParamsIncludeAccessAzureGroupRuleAzureAd] `json:"azureAD,required"`
}

Matches an Azure group. Requires an Azure identity provider.

func (AccessGroupUpdateParamsIncludeAccessAzureGroupRule) MarshalJSON 

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

type AccessGroupUpdateParamsIncludeAccessAzureGroupRuleAzureAd 

type AccessGroupUpdateParamsIncludeAccessAzureGroupRuleAzureAd struct {
	// The ID of an Azure group.
	ID param.Field[string] `json:"id,required"`
	// The ID of your Azure identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
}

func (AccessGroupUpdateParamsIncludeAccessAzureGroupRuleAzureAd) MarshalJSON 

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

type AccessGroupUpdateParamsIncludeAccessCertificateRule 

type AccessGroupUpdateParamsIncludeAccessCertificateRule struct {
	Certificate param.Field[interface{}] `json:"certificate,required"`
}

Matches any valid client certificate.

func (AccessGroupUpdateParamsIncludeAccessCertificateRule) MarshalJSON 

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

type AccessGroupUpdateParamsIncludeAccessCountryRule 

type AccessGroupUpdateParamsIncludeAccessCountryRule struct {
	Geo param.Field[AccessGroupUpdateParamsIncludeAccessCountryRuleGeo] `json:"geo,required"`
}

Matches a specific country

func (AccessGroupUpdateParamsIncludeAccessCountryRule) MarshalJSON 

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

type AccessGroupUpdateParamsIncludeAccessCountryRuleGeo 

type AccessGroupUpdateParamsIncludeAccessCountryRuleGeo struct {
	// The country code that should be matched.
	CountryCode param.Field[string] `json:"country_code,required"`
}

func (AccessGroupUpdateParamsIncludeAccessCountryRuleGeo) MarshalJSON 

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

type AccessGroupUpdateParamsIncludeAccessDevicePostureRule 

type AccessGroupUpdateParamsIncludeAccessDevicePostureRule struct {
	DevicePosture param.Field[AccessGroupUpdateParamsIncludeAccessDevicePostureRuleDevicePosture] `json:"device_posture,required"`
}

Enforces a device posture rule has run successfully

func (AccessGroupUpdateParamsIncludeAccessDevicePostureRule) MarshalJSON 

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

type AccessGroupUpdateParamsIncludeAccessDevicePostureRuleDevicePosture 

type AccessGroupUpdateParamsIncludeAccessDevicePostureRuleDevicePosture struct {
	// The ID of a device posture integration.
	IntegrationUid param.Field[string] `json:"integration_uid,required"`
}

func (AccessGroupUpdateParamsIncludeAccessDevicePostureRuleDevicePosture) MarshalJSON 

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

type AccessGroupUpdateParamsIncludeAccessDomainRule 

type AccessGroupUpdateParamsIncludeAccessDomainRule struct {
	EmailDomain param.Field[AccessGroupUpdateParamsIncludeAccessDomainRuleEmailDomain] `json:"email_domain,required"`
}

Match an entire email domain.

func (AccessGroupUpdateParamsIncludeAccessDomainRule) MarshalJSON 

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

type AccessGroupUpdateParamsIncludeAccessDomainRuleEmailDomain 

type AccessGroupUpdateParamsIncludeAccessDomainRuleEmailDomain struct {
	// The email domain to match.
	Domain param.Field[string] `json:"domain,required"`
}

func (AccessGroupUpdateParamsIncludeAccessDomainRuleEmailDomain) MarshalJSON 

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

type AccessGroupUpdateParamsIncludeAccessEmailListRule 

type AccessGroupUpdateParamsIncludeAccessEmailListRule struct {
	EmailList param.Field[AccessGroupUpdateParamsIncludeAccessEmailListRuleEmailList] `json:"email_list,required"`
}

Matches an email address from a list.

func (AccessGroupUpdateParamsIncludeAccessEmailListRule) MarshalJSON 

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

type AccessGroupUpdateParamsIncludeAccessEmailListRuleEmailList 

type AccessGroupUpdateParamsIncludeAccessEmailListRuleEmailList struct {
	// The ID of a previously created email list.
	ID param.Field[string] `json:"id,required"`
}

func (AccessGroupUpdateParamsIncludeAccessEmailListRuleEmailList) MarshalJSON 

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

type AccessGroupUpdateParamsIncludeAccessEmailRule 

type AccessGroupUpdateParamsIncludeAccessEmailRule struct {
	Email param.Field[AccessGroupUpdateParamsIncludeAccessEmailRuleEmail] `json:"email,required"`
}

Matches a specific email.

func (AccessGroupUpdateParamsIncludeAccessEmailRule) MarshalJSON 

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

type AccessGroupUpdateParamsIncludeAccessEmailRuleEmail 

type AccessGroupUpdateParamsIncludeAccessEmailRuleEmail struct {
	// The email of the user.
	Email param.Field[string] `json:"email,required" format:"email"`
}

func (AccessGroupUpdateParamsIncludeAccessEmailRuleEmail) MarshalJSON 

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

type AccessGroupUpdateParamsIncludeAccessEveryoneRule 

type AccessGroupUpdateParamsIncludeAccessEveryoneRule struct {
	// An empty object which matches on all users.
	Everyone param.Field[interface{}] `json:"everyone,required"`
}

Matches everyone.

func (AccessGroupUpdateParamsIncludeAccessEveryoneRule) MarshalJSON 

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

type AccessGroupUpdateParamsIncludeAccessExternalEvaluationRule 

type AccessGroupUpdateParamsIncludeAccessExternalEvaluationRule struct {
	ExternalEvaluation param.Field[AccessGroupUpdateParamsIncludeAccessExternalEvaluationRuleExternalEvaluation] `json:"external_evaluation,required"`
}

Create Allow or Block policies which evaluate the user based on custom criteria.

func (AccessGroupUpdateParamsIncludeAccessExternalEvaluationRule) MarshalJSON 

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

type AccessGroupUpdateParamsIncludeAccessExternalEvaluationRuleExternalEvaluation 

type AccessGroupUpdateParamsIncludeAccessExternalEvaluationRuleExternalEvaluation struct {
	// The API endpoint containing your business logic.
	EvaluateURL param.Field[string] `json:"evaluate_url,required"`
	// The API endpoint containing the key that Access uses to verify that the response
	// came from your API.
	KeysURL param.Field[string] `json:"keys_url,required"`
}

func (AccessGroupUpdateParamsIncludeAccessExternalEvaluationRuleExternalEvaluation) MarshalJSON 

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

type AccessGroupUpdateParamsIncludeAccessGitHubOrganizationRule 

type AccessGroupUpdateParamsIncludeAccessGitHubOrganizationRule struct {
	GitHubOrganization param.Field[AccessGroupUpdateParamsIncludeAccessGitHubOrganizationRuleGitHubOrganization] `json:"github-organization,required"`
}

Matches a Github organization. Requires a Github identity provider.

func (AccessGroupUpdateParamsIncludeAccessGitHubOrganizationRule) MarshalJSON 

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

type AccessGroupUpdateParamsIncludeAccessGitHubOrganizationRuleGitHubOrganization 

type AccessGroupUpdateParamsIncludeAccessGitHubOrganizationRuleGitHubOrganization struct {
	// The ID of your Github identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The name of the organization.
	Name param.Field[string] `json:"name,required"`
}

func (AccessGroupUpdateParamsIncludeAccessGitHubOrganizationRuleGitHubOrganization) MarshalJSON 

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

type AccessGroupUpdateParamsIncludeAccessGsuiteGroupRule 

type AccessGroupUpdateParamsIncludeAccessGsuiteGroupRule struct {
	Gsuite param.Field[AccessGroupUpdateParamsIncludeAccessGsuiteGroupRuleGsuite] `json:"gsuite,required"`
}

Matches a group in Google Workspace. Requires a Google Workspace identity provider.

func (AccessGroupUpdateParamsIncludeAccessGsuiteGroupRule) MarshalJSON 

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

type AccessGroupUpdateParamsIncludeAccessGsuiteGroupRuleGsuite 

type AccessGroupUpdateParamsIncludeAccessGsuiteGroupRuleGsuite struct {
	// The ID of your Google Workspace identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The email of the Google Workspace group.
	Email param.Field[string] `json:"email,required"`
}

func (AccessGroupUpdateParamsIncludeAccessGsuiteGroupRuleGsuite) MarshalJSON 

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

type AccessGroupUpdateParamsIncludeAccessIPListRule 

type AccessGroupUpdateParamsIncludeAccessIPListRule struct {
	IPList param.Field[AccessGroupUpdateParamsIncludeAccessIPListRuleIPList] `json:"ip_list,required"`
}

Matches an IP address from a list.

func (AccessGroupUpdateParamsIncludeAccessIPListRule) MarshalJSON 

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

type AccessGroupUpdateParamsIncludeAccessIPListRuleIPList 

type AccessGroupUpdateParamsIncludeAccessIPListRuleIPList struct {
	// The ID of a previously created IP list.
	ID param.Field[string] `json:"id,required"`
}

func (AccessGroupUpdateParamsIncludeAccessIPListRuleIPList) MarshalJSON 

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

type AccessGroupUpdateParamsIncludeAccessIPRule 

type AccessGroupUpdateParamsIncludeAccessIPRule struct {
	IP param.Field[AccessGroupUpdateParamsIncludeAccessIPRuleIP] `json:"ip,required"`
}

Matches an IP address block.

func (AccessGroupUpdateParamsIncludeAccessIPRule) MarshalJSON 

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

type AccessGroupUpdateParamsIncludeAccessIPRuleIP 

type AccessGroupUpdateParamsIncludeAccessIPRuleIP struct {
	// An IPv4 or IPv6 CIDR block.
	IP param.Field[string] `json:"ip,required"`
}

func (AccessGroupUpdateParamsIncludeAccessIPRuleIP) MarshalJSON 

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

type AccessGroupUpdateParamsIncludeAccessOktaGroupRule 

type AccessGroupUpdateParamsIncludeAccessOktaGroupRule struct {
	Okta param.Field[AccessGroupUpdateParamsIncludeAccessOktaGroupRuleOkta] `json:"okta,required"`
}

Matches an Okta group. Requires an Okta identity provider.

func (AccessGroupUpdateParamsIncludeAccessOktaGroupRule) MarshalJSON 

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

type AccessGroupUpdateParamsIncludeAccessOktaGroupRuleOkta 

type AccessGroupUpdateParamsIncludeAccessOktaGroupRuleOkta struct {
	// The ID of your Okta identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The email of the Okta group.
	Email param.Field[string] `json:"email,required"`
}

func (AccessGroupUpdateParamsIncludeAccessOktaGroupRuleOkta) MarshalJSON 

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

type AccessGroupUpdateParamsIncludeAccessSamlGroupRule 

type AccessGroupUpdateParamsIncludeAccessSamlGroupRule struct {
	Saml param.Field[AccessGroupUpdateParamsIncludeAccessSamlGroupRuleSaml] `json:"saml,required"`
}

Matches a SAML group. Requires a SAML identity provider.

func (AccessGroupUpdateParamsIncludeAccessSamlGroupRule) MarshalJSON 

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

type AccessGroupUpdateParamsIncludeAccessSamlGroupRuleSaml 

type AccessGroupUpdateParamsIncludeAccessSamlGroupRuleSaml struct {
	// The name of the SAML attribute.
	AttributeName param.Field[string] `json:"attribute_name,required"`
	// The SAML attribute value to look for.
	AttributeValue param.Field[string] `json:"attribute_value,required"`
}

func (AccessGroupUpdateParamsIncludeAccessSamlGroupRuleSaml) MarshalJSON 

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

type AccessGroupUpdateParamsIncludeAccessServiceTokenRule 

type AccessGroupUpdateParamsIncludeAccessServiceTokenRule struct {
	ServiceToken param.Field[AccessGroupUpdateParamsIncludeAccessServiceTokenRuleServiceToken] `json:"service_token,required"`
}

Matches a specific Access Service Token

func (AccessGroupUpdateParamsIncludeAccessServiceTokenRule) MarshalJSON 

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

type AccessGroupUpdateParamsIncludeAccessServiceTokenRuleServiceToken 

type AccessGroupUpdateParamsIncludeAccessServiceTokenRuleServiceToken struct {
	// The ID of a Service Token.
	TokenID param.Field[string] `json:"token_id,required"`
}

func (AccessGroupUpdateParamsIncludeAccessServiceTokenRuleServiceToken) MarshalJSON 

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

type AccessGroupUpdateParamsRequire 

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

Matches a specific email.

Satisfied by zero_trust.AccessGroupUpdateParamsRequireAccessEmailRule, zero_trust.AccessGroupUpdateParamsRequireAccessEmailListRule, zero_trust.AccessGroupUpdateParamsRequireAccessDomainRule, zero_trust.AccessGroupUpdateParamsRequireAccessEveryoneRule, zero_trust.AccessGroupUpdateParamsRequireAccessIPRule, zero_trust.AccessGroupUpdateParamsRequireAccessIPListRule, zero_trust.AccessGroupUpdateParamsRequireAccessCertificateRule, zero_trust.AccessGroupUpdateParamsRequireAccessAccessGroupRule, zero_trust.AccessGroupUpdateParamsRequireAccessAzureGroupRule, zero_trust.AccessGroupUpdateParamsRequireAccessGitHubOrganizationRule, zero_trust.AccessGroupUpdateParamsRequireAccessGsuiteGroupRule, zero_trust.AccessGroupUpdateParamsRequireAccessOktaGroupRule, zero_trust.AccessGroupUpdateParamsRequireAccessSamlGroupRule, zero_trust.AccessGroupUpdateParamsRequireAccessServiceTokenRule, zero_trust.AccessGroupUpdateParamsRequireAccessAnyValidServiceTokenRule, zero_trust.AccessGroupUpdateParamsRequireAccessExternalEvaluationRule, zero_trust.AccessGroupUpdateParamsRequireAccessCountryRule, zero_trust.AccessGroupUpdateParamsRequireAccessAuthenticationMethodRule, zero_trust.AccessGroupUpdateParamsRequireAccessDevicePostureRule.

type AccessGroupUpdateParamsRequireAccessAccessGroupRule 

type AccessGroupUpdateParamsRequireAccessAccessGroupRule struct {
	Group param.Field[AccessGroupUpdateParamsRequireAccessAccessGroupRuleGroup] `json:"group,required"`
}

Matches an Access group.

func (AccessGroupUpdateParamsRequireAccessAccessGroupRule) MarshalJSON 

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

type AccessGroupUpdateParamsRequireAccessAccessGroupRuleGroup 

type AccessGroupUpdateParamsRequireAccessAccessGroupRuleGroup struct {
	// The ID of a previously created Access group.
	ID param.Field[string] `json:"id,required"`
}

func (AccessGroupUpdateParamsRequireAccessAccessGroupRuleGroup) MarshalJSON 

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

type AccessGroupUpdateParamsRequireAccessAnyValidServiceTokenRule 

type AccessGroupUpdateParamsRequireAccessAnyValidServiceTokenRule struct {
	// An empty object which matches on all service tokens.
	AnyValidServiceToken param.Field[interface{}] `json:"any_valid_service_token,required"`
}

Matches any valid Access Service Token

func (AccessGroupUpdateParamsRequireAccessAnyValidServiceTokenRule) MarshalJSON 

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

type AccessGroupUpdateParamsRequireAccessAuthenticationMethodRule 

type AccessGroupUpdateParamsRequireAccessAuthenticationMethodRule struct {
	AuthMethod param.Field[AccessGroupUpdateParamsRequireAccessAuthenticationMethodRuleAuthMethod] `json:"auth_method,required"`
}

Enforce different MFA options

func (AccessGroupUpdateParamsRequireAccessAuthenticationMethodRule) MarshalJSON 

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

type AccessGroupUpdateParamsRequireAccessAuthenticationMethodRuleAuthMethod 

type AccessGroupUpdateParamsRequireAccessAuthenticationMethodRuleAuthMethod struct {
	// The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
	AuthMethod param.Field[string] `json:"auth_method,required"`
}

func (AccessGroupUpdateParamsRequireAccessAuthenticationMethodRuleAuthMethod) MarshalJSON 

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

type AccessGroupUpdateParamsRequireAccessAzureGroupRule 

type AccessGroupUpdateParamsRequireAccessAzureGroupRule struct {
	AzureAd param.Field[AccessGroupUpdateParamsRequireAccessAzureGroupRuleAzureAd] `json:"azureAD,required"`
}

Matches an Azure group. Requires an Azure identity provider.

func (AccessGroupUpdateParamsRequireAccessAzureGroupRule) MarshalJSON 

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

type AccessGroupUpdateParamsRequireAccessAzureGroupRuleAzureAd 

type AccessGroupUpdateParamsRequireAccessAzureGroupRuleAzureAd struct {
	// The ID of an Azure group.
	ID param.Field[string] `json:"id,required"`
	// The ID of your Azure identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
}

func (AccessGroupUpdateParamsRequireAccessAzureGroupRuleAzureAd) MarshalJSON 

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

type AccessGroupUpdateParamsRequireAccessCertificateRule 

type AccessGroupUpdateParamsRequireAccessCertificateRule struct {
	Certificate param.Field[interface{}] `json:"certificate,required"`
}

Matches any valid client certificate.

func (AccessGroupUpdateParamsRequireAccessCertificateRule) MarshalJSON 

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

type AccessGroupUpdateParamsRequireAccessCountryRule 

type AccessGroupUpdateParamsRequireAccessCountryRule struct {
	Geo param.Field[AccessGroupUpdateParamsRequireAccessCountryRuleGeo] `json:"geo,required"`
}

Matches a specific country

func (AccessGroupUpdateParamsRequireAccessCountryRule) MarshalJSON 

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

type AccessGroupUpdateParamsRequireAccessCountryRuleGeo 

type AccessGroupUpdateParamsRequireAccessCountryRuleGeo struct {
	// The country code that should be matched.
	CountryCode param.Field[string] `json:"country_code,required"`
}

func (AccessGroupUpdateParamsRequireAccessCountryRuleGeo) MarshalJSON 

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

type AccessGroupUpdateParamsRequireAccessDevicePostureRule 

type AccessGroupUpdateParamsRequireAccessDevicePostureRule struct {
	DevicePosture param.Field[AccessGroupUpdateParamsRequireAccessDevicePostureRuleDevicePosture] `json:"device_posture,required"`
}

Enforces a device posture rule has run successfully

func (AccessGroupUpdateParamsRequireAccessDevicePostureRule) MarshalJSON 

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

type AccessGroupUpdateParamsRequireAccessDevicePostureRuleDevicePosture 

type AccessGroupUpdateParamsRequireAccessDevicePostureRuleDevicePosture struct {
	// The ID of a device posture integration.
	IntegrationUid param.Field[string] `json:"integration_uid,required"`
}

func (AccessGroupUpdateParamsRequireAccessDevicePostureRuleDevicePosture) MarshalJSON 

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

type AccessGroupUpdateParamsRequireAccessDomainRule 

type AccessGroupUpdateParamsRequireAccessDomainRule struct {
	EmailDomain param.Field[AccessGroupUpdateParamsRequireAccessDomainRuleEmailDomain] `json:"email_domain,required"`
}

Match an entire email domain.

func (AccessGroupUpdateParamsRequireAccessDomainRule) MarshalJSON 

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

type AccessGroupUpdateParamsRequireAccessDomainRuleEmailDomain 

type AccessGroupUpdateParamsRequireAccessDomainRuleEmailDomain struct {
	// The email domain to match.
	Domain param.Field[string] `json:"domain,required"`
}

func (AccessGroupUpdateParamsRequireAccessDomainRuleEmailDomain) MarshalJSON 

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

type AccessGroupUpdateParamsRequireAccessEmailListRule 

type AccessGroupUpdateParamsRequireAccessEmailListRule struct {
	EmailList param.Field[AccessGroupUpdateParamsRequireAccessEmailListRuleEmailList] `json:"email_list,required"`
}

Matches an email address from a list.

func (AccessGroupUpdateParamsRequireAccessEmailListRule) MarshalJSON 

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

type AccessGroupUpdateParamsRequireAccessEmailListRuleEmailList 

type AccessGroupUpdateParamsRequireAccessEmailListRuleEmailList struct {
	// The ID of a previously created email list.
	ID param.Field[string] `json:"id,required"`
}

func (AccessGroupUpdateParamsRequireAccessEmailListRuleEmailList) MarshalJSON 

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

type AccessGroupUpdateParamsRequireAccessEmailRule 

type AccessGroupUpdateParamsRequireAccessEmailRule struct {
	Email param.Field[AccessGroupUpdateParamsRequireAccessEmailRuleEmail] `json:"email,required"`
}

Matches a specific email.

func (AccessGroupUpdateParamsRequireAccessEmailRule) MarshalJSON 

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

type AccessGroupUpdateParamsRequireAccessEmailRuleEmail 

type AccessGroupUpdateParamsRequireAccessEmailRuleEmail struct {
	// The email of the user.
	Email param.Field[string] `json:"email,required" format:"email"`
}

func (AccessGroupUpdateParamsRequireAccessEmailRuleEmail) MarshalJSON 

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

type AccessGroupUpdateParamsRequireAccessEveryoneRule 

type AccessGroupUpdateParamsRequireAccessEveryoneRule struct {
	// An empty object which matches on all users.
	Everyone param.Field[interface{}] `json:"everyone,required"`
}

Matches everyone.

func (AccessGroupUpdateParamsRequireAccessEveryoneRule) MarshalJSON 

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

type AccessGroupUpdateParamsRequireAccessExternalEvaluationRule 

type AccessGroupUpdateParamsRequireAccessExternalEvaluationRule struct {
	ExternalEvaluation param.Field[AccessGroupUpdateParamsRequireAccessExternalEvaluationRuleExternalEvaluation] `json:"external_evaluation,required"`
}

Create Allow or Block policies which evaluate the user based on custom criteria.

func (AccessGroupUpdateParamsRequireAccessExternalEvaluationRule) MarshalJSON 

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

type AccessGroupUpdateParamsRequireAccessExternalEvaluationRuleExternalEvaluation 

type AccessGroupUpdateParamsRequireAccessExternalEvaluationRuleExternalEvaluation struct {
	// The API endpoint containing your business logic.
	EvaluateURL param.Field[string] `json:"evaluate_url,required"`
	// The API endpoint containing the key that Access uses to verify that the response
	// came from your API.
	KeysURL param.Field[string] `json:"keys_url,required"`
}

func (AccessGroupUpdateParamsRequireAccessExternalEvaluationRuleExternalEvaluation) MarshalJSON 

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

type AccessGroupUpdateParamsRequireAccessGitHubOrganizationRule 

type AccessGroupUpdateParamsRequireAccessGitHubOrganizationRule struct {
	GitHubOrganization param.Field[AccessGroupUpdateParamsRequireAccessGitHubOrganizationRuleGitHubOrganization] `json:"github-organization,required"`
}

Matches a Github organization. Requires a Github identity provider.

func (AccessGroupUpdateParamsRequireAccessGitHubOrganizationRule) MarshalJSON 

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

type AccessGroupUpdateParamsRequireAccessGitHubOrganizationRuleGitHubOrganization 

type AccessGroupUpdateParamsRequireAccessGitHubOrganizationRuleGitHubOrganization struct {
	// The ID of your Github identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The name of the organization.
	Name param.Field[string] `json:"name,required"`
}

func (AccessGroupUpdateParamsRequireAccessGitHubOrganizationRuleGitHubOrganization) MarshalJSON 

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

type AccessGroupUpdateParamsRequireAccessGsuiteGroupRule 

type AccessGroupUpdateParamsRequireAccessGsuiteGroupRule struct {
	Gsuite param.Field[AccessGroupUpdateParamsRequireAccessGsuiteGroupRuleGsuite] `json:"gsuite,required"`
}

Matches a group in Google Workspace. Requires a Google Workspace identity provider.

func (AccessGroupUpdateParamsRequireAccessGsuiteGroupRule) MarshalJSON 

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

type AccessGroupUpdateParamsRequireAccessGsuiteGroupRuleGsuite 

type AccessGroupUpdateParamsRequireAccessGsuiteGroupRuleGsuite struct {
	// The ID of your Google Workspace identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The email of the Google Workspace group.
	Email param.Field[string] `json:"email,required"`
}

func (AccessGroupUpdateParamsRequireAccessGsuiteGroupRuleGsuite) MarshalJSON 

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

type AccessGroupUpdateParamsRequireAccessIPListRule 

type AccessGroupUpdateParamsRequireAccessIPListRule struct {
	IPList param.Field[AccessGroupUpdateParamsRequireAccessIPListRuleIPList] `json:"ip_list,required"`
}

Matches an IP address from a list.

func (AccessGroupUpdateParamsRequireAccessIPListRule) MarshalJSON 

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

type AccessGroupUpdateParamsRequireAccessIPListRuleIPList 

type AccessGroupUpdateParamsRequireAccessIPListRuleIPList struct {
	// The ID of a previously created IP list.
	ID param.Field[string] `json:"id,required"`
}

func (AccessGroupUpdateParamsRequireAccessIPListRuleIPList) MarshalJSON 

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

type AccessGroupUpdateParamsRequireAccessIPRule 

type AccessGroupUpdateParamsRequireAccessIPRule struct {
	IP param.Field[AccessGroupUpdateParamsRequireAccessIPRuleIP] `json:"ip,required"`
}

Matches an IP address block.

func (AccessGroupUpdateParamsRequireAccessIPRule) MarshalJSON 

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

type AccessGroupUpdateParamsRequireAccessIPRuleIP 

type AccessGroupUpdateParamsRequireAccessIPRuleIP struct {
	// An IPv4 or IPv6 CIDR block.
	IP param.Field[string] `json:"ip,required"`
}

func (AccessGroupUpdateParamsRequireAccessIPRuleIP) MarshalJSON 

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

type AccessGroupUpdateParamsRequireAccessOktaGroupRule 

type AccessGroupUpdateParamsRequireAccessOktaGroupRule struct {
	Okta param.Field[AccessGroupUpdateParamsRequireAccessOktaGroupRuleOkta] `json:"okta,required"`
}

Matches an Okta group. Requires an Okta identity provider.

func (AccessGroupUpdateParamsRequireAccessOktaGroupRule) MarshalJSON 

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

type AccessGroupUpdateParamsRequireAccessOktaGroupRuleOkta 

type AccessGroupUpdateParamsRequireAccessOktaGroupRuleOkta struct {
	// The ID of your Okta identity provider.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The email of the Okta group.
	Email param.Field[string] `json:"email,required"`
}

func (AccessGroupUpdateParamsRequireAccessOktaGroupRuleOkta) MarshalJSON 

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

type AccessGroupUpdateParamsRequireAccessSamlGroupRule 

type AccessGroupUpdateParamsRequireAccessSamlGroupRule struct {
	Saml param.Field[AccessGroupUpdateParamsRequireAccessSamlGroupRuleSaml] `json:"saml,required"`
}

Matches a SAML group. Requires a SAML identity provider.

func (AccessGroupUpdateParamsRequireAccessSamlGroupRule) MarshalJSON 

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

type AccessGroupUpdateParamsRequireAccessSamlGroupRuleSaml 

type AccessGroupUpdateParamsRequireAccessSamlGroupRuleSaml struct {
	// The name of the SAML attribute.
	AttributeName param.Field[string] `json:"attribute_name,required"`
	// The SAML attribute value to look for.
	AttributeValue param.Field[string] `json:"attribute_value,required"`
}

func (AccessGroupUpdateParamsRequireAccessSamlGroupRuleSaml) MarshalJSON 

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

type AccessGroupUpdateParamsRequireAccessServiceTokenRule 

type AccessGroupUpdateParamsRequireAccessServiceTokenRule struct {
	ServiceToken param.Field[AccessGroupUpdateParamsRequireAccessServiceTokenRuleServiceToken] `json:"service_token,required"`
}

Matches a specific Access Service Token

func (AccessGroupUpdateParamsRequireAccessServiceTokenRule) MarshalJSON 

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

type AccessGroupUpdateParamsRequireAccessServiceTokenRuleServiceToken 

type AccessGroupUpdateParamsRequireAccessServiceTokenRuleServiceToken struct {
	// The ID of a Service Token.
	TokenID param.Field[string] `json:"token_id,required"`
}

func (AccessGroupUpdateParamsRequireAccessServiceTokenRuleServiceToken) MarshalJSON 

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

type AccessGroupUpdateResponseEnvelope 

type AccessGroupUpdateResponseEnvelope struct {
	Errors   []AccessGroupUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessGroupUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessGroups                                `json:"result,required"`
	// Whether the API call was successful
	Success AccessGroupUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessGroupUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*AccessGroupUpdateResponseEnvelope) UnmarshalJSON 

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

type AccessGroupUpdateResponseEnvelopeErrors 

type AccessGroupUpdateResponseEnvelopeErrors struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    accessGroupUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessGroupUpdateResponseEnvelopeErrors) UnmarshalJSON 

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

type AccessGroupUpdateResponseEnvelopeMessages 

type AccessGroupUpdateResponseEnvelopeMessages struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    accessGroupUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessGroupUpdateResponseEnvelopeMessages) UnmarshalJSON 

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

type AccessGroupUpdateResponseEnvelopeSuccess 

type AccessGroupUpdateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessGroupUpdateResponseEnvelopeSuccessTrue AccessGroupUpdateResponseEnvelopeSuccess = true
)

type AccessGroups 

type AccessGroups struct {
	// UUID
	ID        string    `json:"id"`
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Rules evaluated with a NOT logical operator. To match a policy, a user cannot
	// meet any of the Exclude rules.
	Exclude []AccessGroupsExclude `json:"exclude"`
	// Rules evaluated with an OR logical operator. A user needs to meet only one of
	// the Include rules.
	Include []AccessGroupsInclude `json:"include"`
	// Rules evaluated with an AND logical operator. To match a policy, a user must
	// meet all of the Require rules.
	IsDefault []AccessGroupsIsDefault `json:"is_default"`
	// The name of the Access group.
	Name string `json:"name"`
	// Rules evaluated with an AND logical operator. To match a policy, a user must
	// meet all of the Require rules.
	Require   []AccessGroupsRequire `json:"require"`
	UpdatedAt time.Time             `json:"updated_at" format:"date-time"`
	JSON      accessGroupsJSON      `json:"-"`
}

func (*AccessGroups) UnmarshalJSON 

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

type AccessGroupsExclude 

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

Matches a specific email.

Union satisfied by zero_trust.AccessGroupsExcludeAccessEmailRule, zero_trust.AccessGroupsExcludeAccessEmailListRule, zero_trust.AccessGroupsExcludeAccessDomainRule, zero_trust.AccessGroupsExcludeAccessEveryoneRule, zero_trust.AccessGroupsExcludeAccessIPRule, zero_trust.AccessGroupsExcludeAccessIPListRule, zero_trust.AccessGroupsExcludeAccessCertificateRule, zero_trust.AccessGroupsExcludeAccessAccessGroupRule, zero_trust.AccessGroupsExcludeAccessAzureGroupRule, zero_trust.AccessGroupsExcludeAccessGitHubOrganizationRule, zero_trust.AccessGroupsExcludeAccessGsuiteGroupRule, zero_trust.AccessGroupsExcludeAccessOktaGroupRule, zero_trust.AccessGroupsExcludeAccessSamlGroupRule, zero_trust.AccessGroupsExcludeAccessServiceTokenRule, zero_trust.AccessGroupsExcludeAccessAnyValidServiceTokenRule, zero_trust.AccessGroupsExcludeAccessExternalEvaluationRule, zero_trust.AccessGroupsExcludeAccessCountryRule, zero_trust.AccessGroupsExcludeAccessAuthenticationMethodRule or zero_trust.AccessGroupsExcludeAccessDevicePostureRule.

type AccessGroupsExcludeAccessAccessGroupRule 

type AccessGroupsExcludeAccessAccessGroupRule struct {
	Group AccessGroupsExcludeAccessAccessGroupRuleGroup `json:"group,required"`
	JSON  accessGroupsExcludeAccessAccessGroupRuleJSON  `json:"-"`
}

Matches an Access group.

func (*AccessGroupsExcludeAccessAccessGroupRule) UnmarshalJSON 

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

type AccessGroupsExcludeAccessAccessGroupRuleGroup 

type AccessGroupsExcludeAccessAccessGroupRuleGroup struct {
	// The ID of a previously created Access group.
	ID   string                                            `json:"id,required"`
	JSON accessGroupsExcludeAccessAccessGroupRuleGroupJSON `json:"-"`
}

func (*AccessGroupsExcludeAccessAccessGroupRuleGroup) UnmarshalJSON 

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

type AccessGroupsExcludeAccessAnyValidServiceTokenRule 

type AccessGroupsExcludeAccessAnyValidServiceTokenRule struct {
	// An empty object which matches on all service tokens.
	AnyValidServiceToken interface{}                                           `json:"any_valid_service_token,required"`
	JSON                 accessGroupsExcludeAccessAnyValidServiceTokenRuleJSON `json:"-"`
}

Matches any valid Access Service Token

func (*AccessGroupsExcludeAccessAnyValidServiceTokenRule) UnmarshalJSON 

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

type AccessGroupsExcludeAccessAuthenticationMethodRule 

type AccessGroupsExcludeAccessAuthenticationMethodRule struct {
	AuthMethod AccessGroupsExcludeAccessAuthenticationMethodRuleAuthMethod `json:"auth_method,required"`
	JSON       accessGroupsExcludeAccessAuthenticationMethodRuleJSON       `json:"-"`
}

Enforce different MFA options

func (*AccessGroupsExcludeAccessAuthenticationMethodRule) UnmarshalJSON 

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

type AccessGroupsExcludeAccessAuthenticationMethodRuleAuthMethod 

type AccessGroupsExcludeAccessAuthenticationMethodRuleAuthMethod struct {
	// The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
	AuthMethod string                                                          `json:"auth_method,required"`
	JSON       accessGroupsExcludeAccessAuthenticationMethodRuleAuthMethodJSON `json:"-"`
}

func (*AccessGroupsExcludeAccessAuthenticationMethodRuleAuthMethod) UnmarshalJSON 

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

type AccessGroupsExcludeAccessAzureGroupRule 

type AccessGroupsExcludeAccessAzureGroupRule struct {
	AzureAd AccessGroupsExcludeAccessAzureGroupRuleAzureAd `json:"azureAD,required"`
	JSON    accessGroupsExcludeAccessAzureGroupRuleJSON    `json:"-"`
}

Matches an Azure group. Requires an Azure identity provider.

func (*AccessGroupsExcludeAccessAzureGroupRule) UnmarshalJSON 

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

type AccessGroupsExcludeAccessAzureGroupRuleAzureAd 

type AccessGroupsExcludeAccessAzureGroupRuleAzureAd struct {
	// The ID of an Azure group.
	ID string `json:"id,required"`
	// The ID of your Azure identity provider.
	ConnectionID string                                             `json:"connection_id,required"`
	JSON         accessGroupsExcludeAccessAzureGroupRuleAzureAdJSON `json:"-"`
}

func (*AccessGroupsExcludeAccessAzureGroupRuleAzureAd) UnmarshalJSON 

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

type AccessGroupsExcludeAccessCertificateRule 

type AccessGroupsExcludeAccessCertificateRule struct {
	Certificate interface{}                                  `json:"certificate,required"`
	JSON        accessGroupsExcludeAccessCertificateRuleJSON `json:"-"`
}

Matches any valid client certificate.

func (*AccessGroupsExcludeAccessCertificateRule) UnmarshalJSON 

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

type AccessGroupsExcludeAccessCountryRule 

type AccessGroupsExcludeAccessCountryRule struct {
	Geo  AccessGroupsExcludeAccessCountryRuleGeo  `json:"geo,required"`
	JSON accessGroupsExcludeAccessCountryRuleJSON `json:"-"`
}

Matches a specific country

func (*AccessGroupsExcludeAccessCountryRule) UnmarshalJSON 

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

type AccessGroupsExcludeAccessCountryRuleGeo 

type AccessGroupsExcludeAccessCountryRuleGeo struct {
	// The country code that should be matched.
	CountryCode string                                      `json:"country_code,required"`
	JSON        accessGroupsExcludeAccessCountryRuleGeoJSON `json:"-"`
}

func (*AccessGroupsExcludeAccessCountryRuleGeo) UnmarshalJSON 

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

type AccessGroupsExcludeAccessDevicePostureRule 

type AccessGroupsExcludeAccessDevicePostureRule struct {
	DevicePosture AccessGroupsExcludeAccessDevicePostureRuleDevicePosture `json:"device_posture,required"`
	JSON          accessGroupsExcludeAccessDevicePostureRuleJSON          `json:"-"`
}

Enforces a device posture rule has run successfully

func (*AccessGroupsExcludeAccessDevicePostureRule) UnmarshalJSON 

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

type AccessGroupsExcludeAccessDevicePostureRuleDevicePosture 

type AccessGroupsExcludeAccessDevicePostureRuleDevicePosture struct {
	// The ID of a device posture integration.
	IntegrationUid string                                                      `json:"integration_uid,required"`
	JSON           accessGroupsExcludeAccessDevicePostureRuleDevicePostureJSON `json:"-"`
}

func (*AccessGroupsExcludeAccessDevicePostureRuleDevicePosture) UnmarshalJSON 

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

type AccessGroupsExcludeAccessDomainRule 

type AccessGroupsExcludeAccessDomainRule struct {
	EmailDomain AccessGroupsExcludeAccessDomainRuleEmailDomain `json:"email_domain,required"`
	JSON        accessGroupsExcludeAccessDomainRuleJSON        `json:"-"`
}

Match an entire email domain.

func (*AccessGroupsExcludeAccessDomainRule) UnmarshalJSON 

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

type AccessGroupsExcludeAccessDomainRuleEmailDomain 

type AccessGroupsExcludeAccessDomainRuleEmailDomain struct {
	// The email domain to match.
	Domain string                                             `json:"domain,required"`
	JSON   accessGroupsExcludeAccessDomainRuleEmailDomainJSON `json:"-"`
}

func (*AccessGroupsExcludeAccessDomainRuleEmailDomain) UnmarshalJSON 

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

type AccessGroupsExcludeAccessEmailListRule 

type AccessGroupsExcludeAccessEmailListRule struct {
	EmailList AccessGroupsExcludeAccessEmailListRuleEmailList `json:"email_list,required"`
	JSON      accessGroupsExcludeAccessEmailListRuleJSON      `json:"-"`
}

Matches an email address from a list.

func (*AccessGroupsExcludeAccessEmailListRule) UnmarshalJSON 

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

type AccessGroupsExcludeAccessEmailListRuleEmailList 

type AccessGroupsExcludeAccessEmailListRuleEmailList struct {
	// The ID of a previously created email list.
	ID   string                                              `json:"id,required"`
	JSON accessGroupsExcludeAccessEmailListRuleEmailListJSON `json:"-"`
}

func (*AccessGroupsExcludeAccessEmailListRuleEmailList) UnmarshalJSON 

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

type AccessGroupsExcludeAccessEmailRule 

type AccessGroupsExcludeAccessEmailRule struct {
	Email AccessGroupsExcludeAccessEmailRuleEmail `json:"email,required"`
	JSON  accessGroupsExcludeAccessEmailRuleJSON  `json:"-"`
}

Matches a specific email.

func (*AccessGroupsExcludeAccessEmailRule) UnmarshalJSON 

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

type AccessGroupsExcludeAccessEmailRuleEmail 

type AccessGroupsExcludeAccessEmailRuleEmail struct {
	// The email of the user.
	Email string                                      `json:"email,required" format:"email"`
	JSON  accessGroupsExcludeAccessEmailRuleEmailJSON `json:"-"`
}

func (*AccessGroupsExcludeAccessEmailRuleEmail) UnmarshalJSON 

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

type AccessGroupsExcludeAccessEveryoneRule 

type AccessGroupsExcludeAccessEveryoneRule struct {
	// An empty object which matches on all users.
	Everyone interface{}                               `json:"everyone,required"`
	JSON     accessGroupsExcludeAccessEveryoneRuleJSON `json:"-"`
}

Matches everyone.

func (*AccessGroupsExcludeAccessEveryoneRule) UnmarshalJSON 

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

type AccessGroupsExcludeAccessExternalEvaluationRule 

type AccessGroupsExcludeAccessExternalEvaluationRule struct {
	ExternalEvaluation AccessGroupsExcludeAccessExternalEvaluationRuleExternalEvaluation `json:"external_evaluation,required"`
	JSON               accessGroupsExcludeAccessExternalEvaluationRuleJSON               `json:"-"`
}

Create Allow or Block policies which evaluate the user based on custom criteria.

func (*AccessGroupsExcludeAccessExternalEvaluationRule) UnmarshalJSON 

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

type AccessGroupsExcludeAccessExternalEvaluationRuleExternalEvaluation 

type AccessGroupsExcludeAccessExternalEvaluationRuleExternalEvaluation struct {
	// The API endpoint containing your business logic.
	EvaluateURL string `json:"evaluate_url,required"`
	// The API endpoint containing the key that Access uses to verify that the response
	// came from your API.
	KeysURL string                                                                `json:"keys_url,required"`
	JSON    accessGroupsExcludeAccessExternalEvaluationRuleExternalEvaluationJSON `json:"-"`
}

func (*AccessGroupsExcludeAccessExternalEvaluationRuleExternalEvaluation) UnmarshalJSON 

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

type AccessGroupsExcludeAccessGitHubOrganizationRule 

type AccessGroupsExcludeAccessGitHubOrganizationRule struct {
	GitHubOrganization AccessGroupsExcludeAccessGitHubOrganizationRuleGitHubOrganization `json:"github-organization,required"`
	JSON               accessGroupsExcludeAccessGitHubOrganizationRuleJSON               `json:"-"`
}

Matches a Github organization. Requires a Github identity provider.

func (*AccessGroupsExcludeAccessGitHubOrganizationRule) UnmarshalJSON 

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

type AccessGroupsExcludeAccessGitHubOrganizationRuleGitHubOrganization 

type AccessGroupsExcludeAccessGitHubOrganizationRuleGitHubOrganization struct {
	// The ID of your Github identity provider.
	ConnectionID string `json:"connection_id,required"`
	// The name of the organization.
	Name string                                                                `json:"name,required"`
	JSON accessGroupsExcludeAccessGitHubOrganizationRuleGitHubOrganizationJSON `json:"-"`
}

func (*AccessGroupsExcludeAccessGitHubOrganizationRuleGitHubOrganization) UnmarshalJSON 

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

type AccessGroupsExcludeAccessGsuiteGroupRule 

type AccessGroupsExcludeAccessGsuiteGroupRule struct {
	Gsuite AccessGroupsExcludeAccessGsuiteGroupRuleGsuite `json:"gsuite,required"`
	JSON   accessGroupsExcludeAccessGsuiteGroupRuleJSON   `json:"-"`
}

Matches a group in Google Workspace. Requires a Google Workspace identity provider.

func (*AccessGroupsExcludeAccessGsuiteGroupRule) UnmarshalJSON 

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

type AccessGroupsExcludeAccessGsuiteGroupRuleGsuite 

type AccessGroupsExcludeAccessGsuiteGroupRuleGsuite struct {
	// The ID of your Google Workspace identity provider.
	ConnectionID string `json:"connection_id,required"`
	// The email of the Google Workspace group.
	Email string                                             `json:"email,required"`
	JSON  accessGroupsExcludeAccessGsuiteGroupRuleGsuiteJSON `json:"-"`
}

func (*AccessGroupsExcludeAccessGsuiteGroupRuleGsuite) UnmarshalJSON 

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

type AccessGroupsExcludeAccessIPListRule 

type AccessGroupsExcludeAccessIPListRule struct {
	IPList AccessGroupsExcludeAccessIPListRuleIPList `json:"ip_list,required"`
	JSON   accessGroupsExcludeAccessIPListRuleJSON   `json:"-"`
}

Matches an IP address from a list.

func (*AccessGroupsExcludeAccessIPListRule) UnmarshalJSON 

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

type AccessGroupsExcludeAccessIPListRuleIPList 

type AccessGroupsExcludeAccessIPListRuleIPList struct {
	// The ID of a previously created IP list.
	ID   string                                        `json:"id,required"`
	JSON accessGroupsExcludeAccessIPListRuleIPListJSON `json:"-"`
}

func (*AccessGroupsExcludeAccessIPListRuleIPList) UnmarshalJSON 

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

type AccessGroupsExcludeAccessIPRule 

type AccessGroupsExcludeAccessIPRule struct {
	IP   AccessGroupsExcludeAccessIPRuleIP   `json:"ip,required"`
	JSON accessGroupsExcludeAccessIPRuleJSON `json:"-"`
}

Matches an IP address block.

func (*AccessGroupsExcludeAccessIPRule) UnmarshalJSON 

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

type AccessGroupsExcludeAccessIPRuleIP 

type AccessGroupsExcludeAccessIPRuleIP struct {
	// An IPv4 or IPv6 CIDR block.
	IP   string                                `json:"ip,required"`
	JSON accessGroupsExcludeAccessIPRuleIPJSON `json:"-"`
}

func (*AccessGroupsExcludeAccessIPRuleIP) UnmarshalJSON 

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

type AccessGroupsExcludeAccessOktaGroupRule 

type AccessGroupsExcludeAccessOktaGroupRule struct {
	Okta AccessGroupsExcludeAccessOktaGroupRuleOkta `json:"okta,required"`
	JSON accessGroupsExcludeAccessOktaGroupRuleJSON `json:"-"`
}

Matches an Okta group. Requires an Okta identity provider.

func (*AccessGroupsExcludeAccessOktaGroupRule) UnmarshalJSON 

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

type AccessGroupsExcludeAccessOktaGroupRuleOkta 

type AccessGroupsExcludeAccessOktaGroupRuleOkta struct {
	// The ID of your Okta identity provider.
	ConnectionID string `json:"connection_id,required"`
	// The email of the Okta group.
	Email string                                         `json:"email,required"`
	JSON  accessGroupsExcludeAccessOktaGroupRuleOktaJSON `json:"-"`
}

func (*AccessGroupsExcludeAccessOktaGroupRuleOkta) UnmarshalJSON 

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

type AccessGroupsExcludeAccessSamlGroupRule 

type AccessGroupsExcludeAccessSamlGroupRule struct {
	Saml AccessGroupsExcludeAccessSamlGroupRuleSaml `json:"saml,required"`
	JSON accessGroupsExcludeAccessSamlGroupRuleJSON `json:"-"`
}

Matches a SAML group. Requires a SAML identity provider.

func (*AccessGroupsExcludeAccessSamlGroupRule) UnmarshalJSON 

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

type AccessGroupsExcludeAccessSamlGroupRuleSaml 

type AccessGroupsExcludeAccessSamlGroupRuleSaml struct {
	// The name of the SAML attribute.
	AttributeName string `json:"attribute_name,required"`
	// The SAML attribute value to look for.
	AttributeValue string                                         `json:"attribute_value,required"`
	JSON           accessGroupsExcludeAccessSamlGroupRuleSamlJSON `json:"-"`
}

func (*AccessGroupsExcludeAccessSamlGroupRuleSaml) UnmarshalJSON 

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

type AccessGroupsExcludeAccessServiceTokenRule 

type AccessGroupsExcludeAccessServiceTokenRule struct {
	ServiceToken AccessGroupsExcludeAccessServiceTokenRuleServiceToken `json:"service_token,required"`
	JSON         accessGroupsExcludeAccessServiceTokenRuleJSON         `json:"-"`
}

Matches a specific Access Service Token

func (*AccessGroupsExcludeAccessServiceTokenRule) UnmarshalJSON 

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

type AccessGroupsExcludeAccessServiceTokenRuleServiceToken 

type AccessGroupsExcludeAccessServiceTokenRuleServiceToken struct {
	// The ID of a Service Token.
	TokenID string                                                    `json:"token_id,required"`
	JSON    accessGroupsExcludeAccessServiceTokenRuleServiceTokenJSON `json:"-"`
}

func (*AccessGroupsExcludeAccessServiceTokenRuleServiceToken) UnmarshalJSON 

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

type AccessGroupsInclude 

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

Matches a specific email.

Union satisfied by zero_trust.AccessGroupsIncludeAccessEmailRule, zero_trust.AccessGroupsIncludeAccessEmailListRule, zero_trust.AccessGroupsIncludeAccessDomainRule, zero_trust.AccessGroupsIncludeAccessEveryoneRule, zero_trust.AccessGroupsIncludeAccessIPRule, zero_trust.AccessGroupsIncludeAccessIPListRule, zero_trust.AccessGroupsIncludeAccessCertificateRule, zero_trust.AccessGroupsIncludeAccessAccessGroupRule, zero_trust.AccessGroupsIncludeAccessAzureGroupRule, zero_trust.AccessGroupsIncludeAccessGitHubOrganizationRule, zero_trust.AccessGroupsIncludeAccessGsuiteGroupRule, zero_trust.AccessGroupsIncludeAccessOktaGroupRule, zero_trust.AccessGroupsIncludeAccessSamlGroupRule, zero_trust.AccessGroupsIncludeAccessServiceTokenRule, zero_trust.AccessGroupsIncludeAccessAnyValidServiceTokenRule, zero_trust.AccessGroupsIncludeAccessExternalEvaluationRule, zero_trust.AccessGroupsIncludeAccessCountryRule, zero_trust.AccessGroupsIncludeAccessAuthenticationMethodRule or zero_trust.AccessGroupsIncludeAccessDevicePostureRule.

type AccessGroupsIncludeAccessAccessGroupRule 

type AccessGroupsIncludeAccessAccessGroupRule struct {
	Group AccessGroupsIncludeAccessAccessGroupRuleGroup `json:"group,required"`
	JSON  accessGroupsIncludeAccessAccessGroupRuleJSON  `json:"-"`
}

Matches an Access group.

func (*AccessGroupsIncludeAccessAccessGroupRule) UnmarshalJSON 

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

type AccessGroupsIncludeAccessAccessGroupRuleGroup 

type AccessGroupsIncludeAccessAccessGroupRuleGroup struct {
	// The ID of a previously created Access group.
	ID   string                                            `json:"id,required"`
	JSON accessGroupsIncludeAccessAccessGroupRuleGroupJSON `json:"-"`
}

func (*AccessGroupsIncludeAccessAccessGroupRuleGroup) UnmarshalJSON 

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

type AccessGroupsIncludeAccessAnyValidServiceTokenRule 

type AccessGroupsIncludeAccessAnyValidServiceTokenRule struct {
	// An empty object which matches on all service tokens.
	AnyValidServiceToken interface{}                                           `json:"any_valid_service_token,required"`
	JSON                 accessGroupsIncludeAccessAnyValidServiceTokenRuleJSON `json:"-"`
}

Matches any valid Access Service Token

func (*AccessGroupsIncludeAccessAnyValidServiceTokenRule) UnmarshalJSON 

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

type AccessGroupsIncludeAccessAuthenticationMethodRule 

type AccessGroupsIncludeAccessAuthenticationMethodRule struct {
	AuthMethod AccessGroupsIncludeAccessAuthenticationMethodRuleAuthMethod `json:"auth_method,required"`
	JSON       accessGroupsIncludeAccessAuthenticationMethodRuleJSON       `json:"-"`
}

Enforce different MFA options

func (*AccessGroupsIncludeAccessAuthenticationMethodRule) UnmarshalJSON 

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

type AccessGroupsIncludeAccessAuthenticationMethodRuleAuthMethod 

type AccessGroupsIncludeAccessAuthenticationMethodRuleAuthMethod struct {
	// The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
	AuthMethod string                                                          `json:"auth_method,required"`
	JSON       accessGroupsIncludeAccessAuthenticationMethodRuleAuthMethodJSON `json:"-"`
}

func (*AccessGroupsIncludeAccessAuthenticationMethodRuleAuthMethod) UnmarshalJSON 

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

type AccessGroupsIncludeAccessAzureGroupRule 

type AccessGroupsIncludeAccessAzureGroupRule struct {
	AzureAd AccessGroupsIncludeAccessAzureGroupRuleAzureAd `json:"azureAD,required"`
	JSON    accessGroupsIncludeAccessAzureGroupRuleJSON    `json:"-"`
}

Matches an Azure group. Requires an Azure identity provider.

func (*AccessGroupsIncludeAccessAzureGroupRule) UnmarshalJSON 

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

type AccessGroupsIncludeAccessAzureGroupRuleAzureAd 

type AccessGroupsIncludeAccessAzureGroupRuleAzureAd struct {
	// The ID of an Azure group.
	ID string `json:"id,required"`
	// The ID of your Azure identity provider.
	ConnectionID string                                             `json:"connection_id,required"`
	JSON         accessGroupsIncludeAccessAzureGroupRuleAzureAdJSON `json:"-"`
}

func (*AccessGroupsIncludeAccessAzureGroupRuleAzureAd) UnmarshalJSON 

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

type AccessGroupsIncludeAccessCertificateRule 

type AccessGroupsIncludeAccessCertificateRule struct {
	Certificate interface{}                                  `json:"certificate,required"`
	JSON        accessGroupsIncludeAccessCertificateRuleJSON `json:"-"`
}

Matches any valid client certificate.

func (*AccessGroupsIncludeAccessCertificateRule) UnmarshalJSON 

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

type AccessGroupsIncludeAccessCountryRule 

type AccessGroupsIncludeAccessCountryRule struct {
	Geo  AccessGroupsIncludeAccessCountryRuleGeo  `json:"geo,required"`
	JSON accessGroupsIncludeAccessCountryRuleJSON `json:"-"`
}

Matches a specific country

func (*AccessGroupsIncludeAccessCountryRule) UnmarshalJSON 

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

type AccessGroupsIncludeAccessCountryRuleGeo 

type AccessGroupsIncludeAccessCountryRuleGeo struct {
	// The country code that should be matched.
	CountryCode string                                      `json:"country_code,required"`
	JSON        accessGroupsIncludeAccessCountryRuleGeoJSON `json:"-"`
}

func (*AccessGroupsIncludeAccessCountryRuleGeo) UnmarshalJSON 

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

type AccessGroupsIncludeAccessDevicePostureRule 

type AccessGroupsIncludeAccessDevicePostureRule struct {
	DevicePosture AccessGroupsIncludeAccessDevicePostureRuleDevicePosture `json:"device_posture,required"`
	JSON          accessGroupsIncludeAccessDevicePostureRuleJSON          `json:"-"`
}

Enforces a device posture rule has run successfully

func (*AccessGroupsIncludeAccessDevicePostureRule) UnmarshalJSON 

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

type AccessGroupsIncludeAccessDevicePostureRuleDevicePosture 

type AccessGroupsIncludeAccessDevicePostureRuleDevicePosture struct {
	// The ID of a device posture integration.
	IntegrationUid string                                                      `json:"integration_uid,required"`
	JSON           accessGroupsIncludeAccessDevicePostureRuleDevicePostureJSON `json:"-"`
}

func (*AccessGroupsIncludeAccessDevicePostureRuleDevicePosture) UnmarshalJSON 

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

type AccessGroupsIncludeAccessDomainRule 

type AccessGroupsIncludeAccessDomainRule struct {
	EmailDomain AccessGroupsIncludeAccessDomainRuleEmailDomain `json:"email_domain,required"`
	JSON        accessGroupsIncludeAccessDomainRuleJSON        `json:"-"`
}

Match an entire email domain.

func (*AccessGroupsIncludeAccessDomainRule) UnmarshalJSON 

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

type AccessGroupsIncludeAccessDomainRuleEmailDomain 

type AccessGroupsIncludeAccessDomainRuleEmailDomain struct {
	// The email domain to match.
	Domain string                                             `json:"domain,required"`
	JSON   accessGroupsIncludeAccessDomainRuleEmailDomainJSON `json:"-"`
}

func (*AccessGroupsIncludeAccessDomainRuleEmailDomain) UnmarshalJSON 

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

type AccessGroupsIncludeAccessEmailListRule 

type AccessGroupsIncludeAccessEmailListRule struct {
	EmailList AccessGroupsIncludeAccessEmailListRuleEmailList `json:"email_list,required"`
	JSON      accessGroupsIncludeAccessEmailListRuleJSON      `json:"-"`
}

Matches an email address from a list.

func (*AccessGroupsIncludeAccessEmailListRule) UnmarshalJSON 

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

type AccessGroupsIncludeAccessEmailListRuleEmailList 

type AccessGroupsIncludeAccessEmailListRuleEmailList struct {
	// The ID of a previously created email list.
	ID   string                                              `json:"id,required"`
	JSON accessGroupsIncludeAccessEmailListRuleEmailListJSON `json:"-"`
}

func (*AccessGroupsIncludeAccessEmailListRuleEmailList) UnmarshalJSON 

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

type AccessGroupsIncludeAccessEmailRule 

type AccessGroupsIncludeAccessEmailRule struct {
	Email AccessGroupsIncludeAccessEmailRuleEmail `json:"email,required"`
	JSON  accessGroupsIncludeAccessEmailRuleJSON  `json:"-"`
}

Matches a specific email.

func (*AccessGroupsIncludeAccessEmailRule) UnmarshalJSON 

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

type AccessGroupsIncludeAccessEmailRuleEmail 

type AccessGroupsIncludeAccessEmailRuleEmail struct {
	// The email of the user.
	Email string                                      `json:"email,required" format:"email"`
	JSON  accessGroupsIncludeAccessEmailRuleEmailJSON `json:"-"`
}

func (*AccessGroupsIncludeAccessEmailRuleEmail) UnmarshalJSON 

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

type AccessGroupsIncludeAccessEveryoneRule 

type AccessGroupsIncludeAccessEveryoneRule struct {
	// An empty object which matches on all users.
	Everyone interface{}                               `json:"everyone,required"`
	JSON     accessGroupsIncludeAccessEveryoneRuleJSON `json:"-"`
}

Matches everyone.

func (*AccessGroupsIncludeAccessEveryoneRule) UnmarshalJSON 

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

type AccessGroupsIncludeAccessExternalEvaluationRule 

type AccessGroupsIncludeAccessExternalEvaluationRule struct {
	ExternalEvaluation AccessGroupsIncludeAccessExternalEvaluationRuleExternalEvaluation `json:"external_evaluation,required"`
	JSON               accessGroupsIncludeAccessExternalEvaluationRuleJSON               `json:"-"`
}

Create Allow or Block policies which evaluate the user based on custom criteria.

func (*AccessGroupsIncludeAccessExternalEvaluationRule) UnmarshalJSON 

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

type AccessGroupsIncludeAccessExternalEvaluationRuleExternalEvaluation 

type AccessGroupsIncludeAccessExternalEvaluationRuleExternalEvaluation struct {
	// The API endpoint containing your business logic.
	EvaluateURL string `json:"evaluate_url,required"`
	// The API endpoint containing the key that Access uses to verify that the response
	// came from your API.
	KeysURL string                                                                `json:"keys_url,required"`
	JSON    accessGroupsIncludeAccessExternalEvaluationRuleExternalEvaluationJSON `json:"-"`
}

func (*AccessGroupsIncludeAccessExternalEvaluationRuleExternalEvaluation) UnmarshalJSON 

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

type AccessGroupsIncludeAccessGitHubOrganizationRule 

type AccessGroupsIncludeAccessGitHubOrganizationRule struct {
	GitHubOrganization AccessGroupsIncludeAccessGitHubOrganizationRuleGitHubOrganization `json:"github-organization,required"`
	JSON               accessGroupsIncludeAccessGitHubOrganizationRuleJSON               `json:"-"`
}

Matches a Github organization. Requires a Github identity provider.

func (*AccessGroupsIncludeAccessGitHubOrganizationRule) UnmarshalJSON 

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

type AccessGroupsIncludeAccessGitHubOrganizationRuleGitHubOrganization 

type AccessGroupsIncludeAccessGitHubOrganizationRuleGitHubOrganization struct {
	// The ID of your Github identity provider.
	ConnectionID string `json:"connection_id,required"`
	// The name of the organization.
	Name string                                                                `json:"name,required"`
	JSON accessGroupsIncludeAccessGitHubOrganizationRuleGitHubOrganizationJSON `json:"-"`
}

func (*AccessGroupsIncludeAccessGitHubOrganizationRuleGitHubOrganization) UnmarshalJSON 

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

type AccessGroupsIncludeAccessGsuiteGroupRule 

type AccessGroupsIncludeAccessGsuiteGroupRule struct {
	Gsuite AccessGroupsIncludeAccessGsuiteGroupRuleGsuite `json:"gsuite,required"`
	JSON   accessGroupsIncludeAccessGsuiteGroupRuleJSON   `json:"-"`
}

Matches a group in Google Workspace. Requires a Google Workspace identity provider.

func (*AccessGroupsIncludeAccessGsuiteGroupRule) UnmarshalJSON 

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

type AccessGroupsIncludeAccessGsuiteGroupRuleGsuite 

type AccessGroupsIncludeAccessGsuiteGroupRuleGsuite struct {
	// The ID of your Google Workspace identity provider.
	ConnectionID string `json:"connection_id,required"`
	// The email of the Google Workspace group.
	Email string                                             `json:"email,required"`
	JSON  accessGroupsIncludeAccessGsuiteGroupRuleGsuiteJSON `json:"-"`
}

func (*AccessGroupsIncludeAccessGsuiteGroupRuleGsuite) UnmarshalJSON 

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

type AccessGroupsIncludeAccessIPListRule 

type AccessGroupsIncludeAccessIPListRule struct {
	IPList AccessGroupsIncludeAccessIPListRuleIPList `json:"ip_list,required"`
	JSON   accessGroupsIncludeAccessIPListRuleJSON   `json:"-"`
}

Matches an IP address from a list.

func (*AccessGroupsIncludeAccessIPListRule) UnmarshalJSON 

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

type AccessGroupsIncludeAccessIPListRuleIPList 

type AccessGroupsIncludeAccessIPListRuleIPList struct {
	// The ID of a previously created IP list.
	ID   string                                        `json:"id,required"`
	JSON accessGroupsIncludeAccessIPListRuleIPListJSON `json:"-"`
}

func (*AccessGroupsIncludeAccessIPListRuleIPList) UnmarshalJSON 

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

type AccessGroupsIncludeAccessIPRule 

type AccessGroupsIncludeAccessIPRule struct {
	IP   AccessGroupsIncludeAccessIPRuleIP   `json:"ip,required"`
	JSON accessGroupsIncludeAccessIPRuleJSON `json:"-"`
}

Matches an IP address block.

func (*AccessGroupsIncludeAccessIPRule) UnmarshalJSON 

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

type AccessGroupsIncludeAccessIPRuleIP 

type AccessGroupsIncludeAccessIPRuleIP struct {
	// An IPv4 or IPv6 CIDR block.
	IP   string                                `json:"ip,required"`
	JSON accessGroupsIncludeAccessIPRuleIPJSON `json:"-"`
}

func (*AccessGroupsIncludeAccessIPRuleIP) UnmarshalJSON 

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

type AccessGroupsIncludeAccessOktaGroupRule 

type AccessGroupsIncludeAccessOktaGroupRule struct {
	Okta AccessGroupsIncludeAccessOktaGroupRuleOkta `json:"okta,required"`
	JSON accessGroupsIncludeAccessOktaGroupRuleJSON `json:"-"`
}

Matches an Okta group. Requires an Okta identity provider.

func (*AccessGroupsIncludeAccessOktaGroupRule) UnmarshalJSON 

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

type AccessGroupsIncludeAccessOktaGroupRuleOkta 

type AccessGroupsIncludeAccessOktaGroupRuleOkta struct {
	// The ID of your Okta identity provider.
	ConnectionID string `json:"connection_id,required"`
	// The email of the Okta group.
	Email string                                         `json:"email,required"`
	JSON  accessGroupsIncludeAccessOktaGroupRuleOktaJSON `json:"-"`
}

func (*AccessGroupsIncludeAccessOktaGroupRuleOkta) UnmarshalJSON 

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

type AccessGroupsIncludeAccessSamlGroupRule 

type AccessGroupsIncludeAccessSamlGroupRule struct {
	Saml AccessGroupsIncludeAccessSamlGroupRuleSaml `json:"saml,required"`
	JSON accessGroupsIncludeAccessSamlGroupRuleJSON `json:"-"`
}

Matches a SAML group. Requires a SAML identity provider.

func (*AccessGroupsIncludeAccessSamlGroupRule) UnmarshalJSON 

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

type AccessGroupsIncludeAccessSamlGroupRuleSaml 

type AccessGroupsIncludeAccessSamlGroupRuleSaml struct {
	// The name of the SAML attribute.
	AttributeName string `json:"attribute_name,required"`
	// The SAML attribute value to look for.
	AttributeValue string                                         `json:"attribute_value,required"`
	JSON           accessGroupsIncludeAccessSamlGroupRuleSamlJSON `json:"-"`
}

func (*AccessGroupsIncludeAccessSamlGroupRuleSaml) UnmarshalJSON 

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

type AccessGroupsIncludeAccessServiceTokenRule 

type AccessGroupsIncludeAccessServiceTokenRule struct {
	ServiceToken AccessGroupsIncludeAccessServiceTokenRuleServiceToken `json:"service_token,required"`
	JSON         accessGroupsIncludeAccessServiceTokenRuleJSON         `json:"-"`
}

Matches a specific Access Service Token

func (*AccessGroupsIncludeAccessServiceTokenRule) UnmarshalJSON 

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

type AccessGroupsIncludeAccessServiceTokenRuleServiceToken 

type AccessGroupsIncludeAccessServiceTokenRuleServiceToken struct {
	// The ID of a Service Token.
	TokenID string                                                    `json:"token_id,required"`
	JSON    accessGroupsIncludeAccessServiceTokenRuleServiceTokenJSON `json:"-"`
}

func (*AccessGroupsIncludeAccessServiceTokenRuleServiceToken) UnmarshalJSON 

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

type AccessGroupsIsDefault 

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

Matches a specific email.

Union satisfied by zero_trust.AccessGroupsIsDefaultAccessEmailRule, zero_trust.AccessGroupsIsDefaultAccessEmailListRule, zero_trust.AccessGroupsIsDefaultAccessDomainRule, zero_trust.AccessGroupsIsDefaultAccessEveryoneRule, zero_trust.AccessGroupsIsDefaultAccessIPRule, zero_trust.AccessGroupsIsDefaultAccessIPListRule, zero_trust.AccessGroupsIsDefaultAccessCertificateRule, zero_trust.AccessGroupsIsDefaultAccessAccessGroupRule, zero_trust.AccessGroupsIsDefaultAccessAzureGroupRule, zero_trust.AccessGroupsIsDefaultAccessGitHubOrganizationRule, zero_trust.AccessGroupsIsDefaultAccessGsuiteGroupRule, zero_trust.AccessGroupsIsDefaultAccessOktaGroupRule, zero_trust.AccessGroupsIsDefaultAccessSamlGroupRule, zero_trust.AccessGroupsIsDefaultAccessServiceTokenRule, zero_trust.AccessGroupsIsDefaultAccessAnyValidServiceTokenRule, zero_trust.AccessGroupsIsDefaultAccessExternalEvaluationRule, zero_trust.AccessGroupsIsDefaultAccessCountryRule, zero_trust.AccessGroupsIsDefaultAccessAuthenticationMethodRule or zero_trust.AccessGroupsIsDefaultAccessDevicePostureRule.

type AccessGroupsIsDefaultAccessAccessGroupRule 

type AccessGroupsIsDefaultAccessAccessGroupRule struct {
	Group AccessGroupsIsDefaultAccessAccessGroupRuleGroup `json:"group,required"`
	JSON  accessGroupsIsDefaultAccessAccessGroupRuleJSON  `json:"-"`
}

Matches an Access group.

func (*AccessGroupsIsDefaultAccessAccessGroupRule) UnmarshalJSON 

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

type AccessGroupsIsDefaultAccessAccessGroupRuleGroup 

type AccessGroupsIsDefaultAccessAccessGroupRuleGroup struct {
	// The ID of a previously created Access group.
	ID   string                                              `json:"id,required"`
	JSON accessGroupsIsDefaultAccessAccessGroupRuleGroupJSON `json:"-"`
}

func (*AccessGroupsIsDefaultAccessAccessGroupRuleGroup) UnmarshalJSON 

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

type AccessGroupsIsDefaultAccessAnyValidServiceTokenRule 

type AccessGroupsIsDefaultAccessAnyValidServiceTokenRule struct {
	// An empty object which matches on all service tokens.
	AnyValidServiceToken interface{}                                             `json:"any_valid_service_token,required"`
	JSON                 accessGroupsIsDefaultAccessAnyValidServiceTokenRuleJSON `json:"-"`
}

Matches any valid Access Service Token

func (*AccessGroupsIsDefaultAccessAnyValidServiceTokenRule) UnmarshalJSON 

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

type AccessGroupsIsDefaultAccessAuthenticationMethodRule 

type AccessGroupsIsDefaultAccessAuthenticationMethodRule struct {
	AuthMethod AccessGroupsIsDefaultAccessAuthenticationMethodRuleAuthMethod `json:"auth_method,required"`
	JSON       accessGroupsIsDefaultAccessAuthenticationMethodRuleJSON       `json:"-"`
}

Enforce different MFA options

func (*AccessGroupsIsDefaultAccessAuthenticationMethodRule) UnmarshalJSON 

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

type AccessGroupsIsDefaultAccessAuthenticationMethodRuleAuthMethod 

type AccessGroupsIsDefaultAccessAuthenticationMethodRuleAuthMethod struct {
	// The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
	AuthMethod string                                                            `json:"auth_method,required"`
	JSON       accessGroupsIsDefaultAccessAuthenticationMethodRuleAuthMethodJSON `json:"-"`
}

func (*AccessGroupsIsDefaultAccessAuthenticationMethodRuleAuthMethod) UnmarshalJSON 

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

type AccessGroupsIsDefaultAccessAzureGroupRule 

type AccessGroupsIsDefaultAccessAzureGroupRule struct {
	AzureAd AccessGroupsIsDefaultAccessAzureGroupRuleAzureAd `json:"azureAD,required"`
	JSON    accessGroupsIsDefaultAccessAzureGroupRuleJSON    `json:"-"`
}

Matches an Azure group. Requires an Azure identity provider.

func (*AccessGroupsIsDefaultAccessAzureGroupRule) UnmarshalJSON 

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

type AccessGroupsIsDefaultAccessAzureGroupRuleAzureAd 

type AccessGroupsIsDefaultAccessAzureGroupRuleAzureAd struct {
	// The ID of an Azure group.
	ID string `json:"id,required"`
	// The ID of your Azure identity provider.
	ConnectionID string                                               `json:"connection_id,required"`
	JSON         accessGroupsIsDefaultAccessAzureGroupRuleAzureAdJSON `json:"-"`
}

func (*AccessGroupsIsDefaultAccessAzureGroupRuleAzureAd) UnmarshalJSON 

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

type AccessGroupsIsDefaultAccessCertificateRule 

type AccessGroupsIsDefaultAccessCertificateRule struct {
	Certificate interface{}                                    `json:"certificate,required"`
	JSON        accessGroupsIsDefaultAccessCertificateRuleJSON `json:"-"`
}

Matches any valid client certificate.

func (*AccessGroupsIsDefaultAccessCertificateRule) UnmarshalJSON 

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

type AccessGroupsIsDefaultAccessCountryRule 

type AccessGroupsIsDefaultAccessCountryRule struct {
	Geo  AccessGroupsIsDefaultAccessCountryRuleGeo  `json:"geo,required"`
	JSON accessGroupsIsDefaultAccessCountryRuleJSON `json:"-"`
}

Matches a specific country

func (*AccessGroupsIsDefaultAccessCountryRule) UnmarshalJSON 

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

type AccessGroupsIsDefaultAccessCountryRuleGeo 

type AccessGroupsIsDefaultAccessCountryRuleGeo struct {
	// The country code that should be matched.
	CountryCode string                                        `json:"country_code,required"`
	JSON        accessGroupsIsDefaultAccessCountryRuleGeoJSON `json:"-"`
}

func (*AccessGroupsIsDefaultAccessCountryRuleGeo) UnmarshalJSON 

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

type AccessGroupsIsDefaultAccessDevicePostureRule 

type AccessGroupsIsDefaultAccessDevicePostureRule struct {
	DevicePosture AccessGroupsIsDefaultAccessDevicePostureRuleDevicePosture `json:"device_posture,required"`
	JSON          accessGroupsIsDefaultAccessDevicePostureRuleJSON          `json:"-"`
}

Enforces a device posture rule has run successfully

func (*AccessGroupsIsDefaultAccessDevicePostureRule) UnmarshalJSON 

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

type AccessGroupsIsDefaultAccessDevicePostureRuleDevicePosture 

type AccessGroupsIsDefaultAccessDevicePostureRuleDevicePosture struct {
	// The ID of a device posture integration.
	IntegrationUid string                                                        `json:"integration_uid,required"`
	JSON           accessGroupsIsDefaultAccessDevicePostureRuleDevicePostureJSON `json:"-"`
}

func (*AccessGroupsIsDefaultAccessDevicePostureRuleDevicePosture) UnmarshalJSON 

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

type AccessGroupsIsDefaultAccessDomainRule 

type AccessGroupsIsDefaultAccessDomainRule struct {
	EmailDomain AccessGroupsIsDefaultAccessDomainRuleEmailDomain `json:"email_domain,required"`
	JSON        accessGroupsIsDefaultAccessDomainRuleJSON        `json:"-"`
}

Match an entire email domain.

func (*AccessGroupsIsDefaultAccessDomainRule) UnmarshalJSON 

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

type AccessGroupsIsDefaultAccessDomainRuleEmailDomain 

type AccessGroupsIsDefaultAccessDomainRuleEmailDomain struct {
	// The email domain to match.
	Domain string                                               `json:"domain,required"`
	JSON   accessGroupsIsDefaultAccessDomainRuleEmailDomainJSON `json:"-"`
}

func (*AccessGroupsIsDefaultAccessDomainRuleEmailDomain) UnmarshalJSON 

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

type AccessGroupsIsDefaultAccessEmailListRule 

type AccessGroupsIsDefaultAccessEmailListRule struct {
	EmailList AccessGroupsIsDefaultAccessEmailListRuleEmailList `json:"email_list,required"`
	JSON      accessGroupsIsDefaultAccessEmailListRuleJSON      `json:"-"`
}

Matches an email address from a list.

func (*AccessGroupsIsDefaultAccessEmailListRule) UnmarshalJSON 

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

type AccessGroupsIsDefaultAccessEmailListRuleEmailList 

type AccessGroupsIsDefaultAccessEmailListRuleEmailList struct {
	// The ID of a previously created email list.
	ID   string                                                `json:"id,required"`
	JSON accessGroupsIsDefaultAccessEmailListRuleEmailListJSON `json:"-"`
}

func (*AccessGroupsIsDefaultAccessEmailListRuleEmailList) UnmarshalJSON 

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

type AccessGroupsIsDefaultAccessEmailRule 

type AccessGroupsIsDefaultAccessEmailRule struct {
	Email AccessGroupsIsDefaultAccessEmailRuleEmail `json:"email,required"`
	JSON  accessGroupsIsDefaultAccessEmailRuleJSON  `json:"-"`
}

Matches a specific email.

func (*AccessGroupsIsDefaultAccessEmailRule) UnmarshalJSON 

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

type AccessGroupsIsDefaultAccessEmailRuleEmail 

type AccessGroupsIsDefaultAccessEmailRuleEmail struct {
	// The email of the user.
	Email string                                        `json:"email,required" format:"email"`
	JSON  accessGroupsIsDefaultAccessEmailRuleEmailJSON `json:"-"`
}

func (*AccessGroupsIsDefaultAccessEmailRuleEmail) UnmarshalJSON 

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

type AccessGroupsIsDefaultAccessEveryoneRule 

type AccessGroupsIsDefaultAccessEveryoneRule struct {
	// An empty object which matches on all users.
	Everyone interface{}                                 `json:"everyone,required"`
	JSON     accessGroupsIsDefaultAccessEveryoneRuleJSON `json:"-"`
}

Matches everyone.

func (*AccessGroupsIsDefaultAccessEveryoneRule) UnmarshalJSON 

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

type AccessGroupsIsDefaultAccessExternalEvaluationRule 

type AccessGroupsIsDefaultAccessExternalEvaluationRule struct {
	ExternalEvaluation AccessGroupsIsDefaultAccessExternalEvaluationRuleExternalEvaluation `json:"external_evaluation,required"`
	JSON               accessGroupsIsDefaultAccessExternalEvaluationRuleJSON               `json:"-"`
}

Create Allow or Block policies which evaluate the user based on custom criteria.

func (*AccessGroupsIsDefaultAccessExternalEvaluationRule) UnmarshalJSON 

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

type AccessGroupsIsDefaultAccessExternalEvaluationRuleExternalEvaluation 

type AccessGroupsIsDefaultAccessExternalEvaluationRuleExternalEvaluation struct {
	// The API endpoint containing your business logic.
	EvaluateURL string `json:"evaluate_url,required"`
	// The API endpoint containing the key that Access uses to verify that the response
	// came from your API.
	KeysURL string                                                                  `json:"keys_url,required"`
	JSON    accessGroupsIsDefaultAccessExternalEvaluationRuleExternalEvaluationJSON `json:"-"`
}

func (*AccessGroupsIsDefaultAccessExternalEvaluationRuleExternalEvaluation) UnmarshalJSON 

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

type AccessGroupsIsDefaultAccessGitHubOrganizationRule 

type AccessGroupsIsDefaultAccessGitHubOrganizationRule struct {
	GitHubOrganization AccessGroupsIsDefaultAccessGitHubOrganizationRuleGitHubOrganization `json:"github-organization,required"`
	JSON               accessGroupsIsDefaultAccessGitHubOrganizationRuleJSON               `json:"-"`
}

Matches a Github organization. Requires a Github identity provider.

func (*AccessGroupsIsDefaultAccessGitHubOrganizationRule) UnmarshalJSON 

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

type AccessGroupsIsDefaultAccessGitHubOrganizationRuleGitHubOrganization 

type AccessGroupsIsDefaultAccessGitHubOrganizationRuleGitHubOrganization struct {
	// The ID of your Github identity provider.
	ConnectionID string `json:"connection_id,required"`
	// The name of the organization.
	Name string                                                                  `json:"name,required"`
	JSON accessGroupsIsDefaultAccessGitHubOrganizationRuleGitHubOrganizationJSON `json:"-"`
}

func (*AccessGroupsIsDefaultAccessGitHubOrganizationRuleGitHubOrganization) UnmarshalJSON 

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

type AccessGroupsIsDefaultAccessGsuiteGroupRule 

type AccessGroupsIsDefaultAccessGsuiteGroupRule struct {
	Gsuite AccessGroupsIsDefaultAccessGsuiteGroupRuleGsuite `json:"gsuite,required"`
	JSON   accessGroupsIsDefaultAccessGsuiteGroupRuleJSON   `json:"-"`
}

Matches a group in Google Workspace. Requires a Google Workspace identity provider.

func (*AccessGroupsIsDefaultAccessGsuiteGroupRule) UnmarshalJSON 

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

type AccessGroupsIsDefaultAccessGsuiteGroupRuleGsuite 

type AccessGroupsIsDefaultAccessGsuiteGroupRuleGsuite struct {
	// The ID of your Google Workspace identity provider.
	ConnectionID string `json:"connection_id,required"`
	// The email of the Google Workspace group.
	Email string                                               `json:"email,required"`
	JSON  accessGroupsIsDefaultAccessGsuiteGroupRuleGsuiteJSON `json:"-"`
}

func (*AccessGroupsIsDefaultAccessGsuiteGroupRuleGsuite) UnmarshalJSON 

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

type AccessGroupsIsDefaultAccessIPListRule 

type AccessGroupsIsDefaultAccessIPListRule struct {
	IPList AccessGroupsIsDefaultAccessIPListRuleIPList `json:"ip_list,required"`
	JSON   accessGroupsIsDefaultAccessIPListRuleJSON   `json:"-"`
}

Matches an IP address from a list.

func (*AccessGroupsIsDefaultAccessIPListRule) UnmarshalJSON 

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

type AccessGroupsIsDefaultAccessIPListRuleIPList 

type AccessGroupsIsDefaultAccessIPListRuleIPList struct {
	// The ID of a previously created IP list.
	ID   string                                          `json:"id,required"`
	JSON accessGroupsIsDefaultAccessIPListRuleIPListJSON `json:"-"`
}

func (*AccessGroupsIsDefaultAccessIPListRuleIPList) UnmarshalJSON 

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

type AccessGroupsIsDefaultAccessIPRule 

type AccessGroupsIsDefaultAccessIPRule struct {
	IP   AccessGroupsIsDefaultAccessIPRuleIP   `json:"ip,required"`
	JSON accessGroupsIsDefaultAccessIPRuleJSON `json:"-"`
}

Matches an IP address block.

func (*AccessGroupsIsDefaultAccessIPRule) UnmarshalJSON 

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

type AccessGroupsIsDefaultAccessIPRuleIP 

type AccessGroupsIsDefaultAccessIPRuleIP struct {
	// An IPv4 or IPv6 CIDR block.
	IP   string                                  `json:"ip,required"`
	JSON accessGroupsIsDefaultAccessIPRuleIPJSON `json:"-"`
}

func (*AccessGroupsIsDefaultAccessIPRuleIP) UnmarshalJSON 

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

type AccessGroupsIsDefaultAccessOktaGroupRule 

type AccessGroupsIsDefaultAccessOktaGroupRule struct {
	Okta AccessGroupsIsDefaultAccessOktaGroupRuleOkta `json:"okta,required"`
	JSON accessGroupsIsDefaultAccessOktaGroupRuleJSON `json:"-"`
}

Matches an Okta group. Requires an Okta identity provider.

func (*AccessGroupsIsDefaultAccessOktaGroupRule) UnmarshalJSON 

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

type AccessGroupsIsDefaultAccessOktaGroupRuleOkta 

type AccessGroupsIsDefaultAccessOktaGroupRuleOkta struct {
	// The ID of your Okta identity provider.
	ConnectionID string `json:"connection_id,required"`
	// The email of the Okta group.
	Email string                                           `json:"email,required"`
	JSON  accessGroupsIsDefaultAccessOktaGroupRuleOktaJSON `json:"-"`
}

func (*AccessGroupsIsDefaultAccessOktaGroupRuleOkta) UnmarshalJSON 

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

type AccessGroupsIsDefaultAccessSamlGroupRule 

type AccessGroupsIsDefaultAccessSamlGroupRule struct {
	Saml AccessGroupsIsDefaultAccessSamlGroupRuleSaml `json:"saml,required"`
	JSON accessGroupsIsDefaultAccessSamlGroupRuleJSON `json:"-"`
}

Matches a SAML group. Requires a SAML identity provider.

func (*AccessGroupsIsDefaultAccessSamlGroupRule) UnmarshalJSON 

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

type AccessGroupsIsDefaultAccessSamlGroupRuleSaml 

type AccessGroupsIsDefaultAccessSamlGroupRuleSaml struct {
	// The name of the SAML attribute.
	AttributeName string `json:"attribute_name,required"`
	// The SAML attribute value to look for.
	AttributeValue string                                           `json:"attribute_value,required"`
	JSON           accessGroupsIsDefaultAccessSamlGroupRuleSamlJSON `json:"-"`
}

func (*AccessGroupsIsDefaultAccessSamlGroupRuleSaml) UnmarshalJSON 

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

type AccessGroupsIsDefaultAccessServiceTokenRule 

type AccessGroupsIsDefaultAccessServiceTokenRule struct {
	ServiceToken AccessGroupsIsDefaultAccessServiceTokenRuleServiceToken `json:"service_token,required"`
	JSON         accessGroupsIsDefaultAccessServiceTokenRuleJSON         `json:"-"`
}

Matches a specific Access Service Token

func (*AccessGroupsIsDefaultAccessServiceTokenRule) UnmarshalJSON 

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

type AccessGroupsIsDefaultAccessServiceTokenRuleServiceToken 

type AccessGroupsIsDefaultAccessServiceTokenRuleServiceToken struct {
	// The ID of a Service Token.
	TokenID string                                                      `json:"token_id,required"`
	JSON    accessGroupsIsDefaultAccessServiceTokenRuleServiceTokenJSON `json:"-"`
}

func (*AccessGroupsIsDefaultAccessServiceTokenRuleServiceToken) UnmarshalJSON 

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

type AccessGroupsRequire 

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

Matches a specific email.

Union satisfied by zero_trust.AccessGroupsRequireAccessEmailRule, zero_trust.AccessGroupsRequireAccessEmailListRule, zero_trust.AccessGroupsRequireAccessDomainRule, zero_trust.AccessGroupsRequireAccessEveryoneRule, zero_trust.AccessGroupsRequireAccessIPRule, zero_trust.AccessGroupsRequireAccessIPListRule, zero_trust.AccessGroupsRequireAccessCertificateRule, zero_trust.AccessGroupsRequireAccessAccessGroupRule, zero_trust.AccessGroupsRequireAccessAzureGroupRule, zero_trust.AccessGroupsRequireAccessGitHubOrganizationRule, zero_trust.AccessGroupsRequireAccessGsuiteGroupRule, zero_trust.AccessGroupsRequireAccessOktaGroupRule, zero_trust.AccessGroupsRequireAccessSamlGroupRule, zero_trust.AccessGroupsRequireAccessServiceTokenRule, zero_trust.AccessGroupsRequireAccessAnyValidServiceTokenRule, zero_trust.AccessGroupsRequireAccessExternalEvaluationRule, zero_trust.AccessGroupsRequireAccessCountryRule, zero_trust.AccessGroupsRequireAccessAuthenticationMethodRule or zero_trust.AccessGroupsRequireAccessDevicePostureRule.

type AccessGroupsRequireAccessAccessGroupRule 

type AccessGroupsRequireAccessAccessGroupRule struct {
	Group AccessGroupsRequireAccessAccessGroupRuleGroup `json:"group,required"`
	JSON  accessGroupsRequireAccessAccessGroupRuleJSON  `json:"-"`
}

Matches an Access group.

func (*AccessGroupsRequireAccessAccessGroupRule) UnmarshalJSON 

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

type AccessGroupsRequireAccessAccessGroupRuleGroup 

type AccessGroupsRequireAccessAccessGroupRuleGroup struct {
	// The ID of a previously created Access group.
	ID   string                                            `json:"id,required"`
	JSON accessGroupsRequireAccessAccessGroupRuleGroupJSON `json:"-"`
}

func (*AccessGroupsRequireAccessAccessGroupRuleGroup) UnmarshalJSON 

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

type AccessGroupsRequireAccessAnyValidServiceTokenRule 

type AccessGroupsRequireAccessAnyValidServiceTokenRule struct {
	// An empty object which matches on all service tokens.
	AnyValidServiceToken interface{}                                           `json:"any_valid_service_token,required"`
	JSON                 accessGroupsRequireAccessAnyValidServiceTokenRuleJSON `json:"-"`
}

Matches any valid Access Service Token

func (*AccessGroupsRequireAccessAnyValidServiceTokenRule) UnmarshalJSON 

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

type AccessGroupsRequireAccessAuthenticationMethodRule 

type AccessGroupsRequireAccessAuthenticationMethodRule struct {
	AuthMethod AccessGroupsRequireAccessAuthenticationMethodRuleAuthMethod `json:"auth_method,required"`
	JSON       accessGroupsRequireAccessAuthenticationMethodRuleJSON       `json:"-"`
}

Enforce different MFA options

func (*AccessGroupsRequireAccessAuthenticationMethodRule) UnmarshalJSON 

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

type AccessGroupsRequireAccessAuthenticationMethodRuleAuthMethod 

type AccessGroupsRequireAccessAuthenticationMethodRuleAuthMethod struct {
	// The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
	AuthMethod string                                                          `json:"auth_method,required"`
	JSON       accessGroupsRequireAccessAuthenticationMethodRuleAuthMethodJSON `json:"-"`
}

func (*AccessGroupsRequireAccessAuthenticationMethodRuleAuthMethod) UnmarshalJSON 

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

type AccessGroupsRequireAccessAzureGroupRule 

type AccessGroupsRequireAccessAzureGroupRule struct {
	AzureAd AccessGroupsRequireAccessAzureGroupRuleAzureAd `json:"azureAD,required"`
	JSON    accessGroupsRequireAccessAzureGroupRuleJSON    `json:"-"`
}

Matches an Azure group. Requires an Azure identity provider.

func (*AccessGroupsRequireAccessAzureGroupRule) UnmarshalJSON 

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

type AccessGroupsRequireAccessAzureGroupRuleAzureAd 

type AccessGroupsRequireAccessAzureGroupRuleAzureAd struct {
	// The ID of an Azure group.
	ID string `json:"id,required"`
	// The ID of your Azure identity provider.
	ConnectionID string                                             `json:"connection_id,required"`
	JSON         accessGroupsRequireAccessAzureGroupRuleAzureAdJSON `json:"-"`
}

func (*AccessGroupsRequireAccessAzureGroupRuleAzureAd) UnmarshalJSON 

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

type AccessGroupsRequireAccessCertificateRule 

type AccessGroupsRequireAccessCertificateRule struct {
	Certificate interface{}                                  `json:"certificate,required"`
	JSON        accessGroupsRequireAccessCertificateRuleJSON `json:"-"`
}

Matches any valid client certificate.

func (*AccessGroupsRequireAccessCertificateRule) UnmarshalJSON 

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

type AccessGroupsRequireAccessCountryRule 

type AccessGroupsRequireAccessCountryRule struct {
	Geo  AccessGroupsRequireAccessCountryRuleGeo  `json:"geo,required"`
	JSON accessGroupsRequireAccessCountryRuleJSON `json:"-"`
}

Matches a specific country

func (*AccessGroupsRequireAccessCountryRule) UnmarshalJSON 

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

type AccessGroupsRequireAccessCountryRuleGeo 

type AccessGroupsRequireAccessCountryRuleGeo struct {
	// The country code that should be matched.
	CountryCode string                                      `json:"country_code,required"`
	JSON        accessGroupsRequireAccessCountryRuleGeoJSON `json:"-"`
}

func (*AccessGroupsRequireAccessCountryRuleGeo) UnmarshalJSON 

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

type AccessGroupsRequireAccessDevicePostureRule 

type AccessGroupsRequireAccessDevicePostureRule struct {
	DevicePosture AccessGroupsRequireAccessDevicePostureRuleDevicePosture `json:"device_posture,required"`
	JSON          accessGroupsRequireAccessDevicePostureRuleJSON          `json:"-"`
}

Enforces a device posture rule has run successfully

func (*AccessGroupsRequireAccessDevicePostureRule) UnmarshalJSON 

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

type AccessGroupsRequireAccessDevicePostureRuleDevicePosture 

type AccessGroupsRequireAccessDevicePostureRuleDevicePosture struct {
	// The ID of a device posture integration.
	IntegrationUid string                                                      `json:"integration_uid,required"`
	JSON           accessGroupsRequireAccessDevicePostureRuleDevicePostureJSON `json:"-"`
}

func (*AccessGroupsRequireAccessDevicePostureRuleDevicePosture) UnmarshalJSON 

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

type AccessGroupsRequireAccessDomainRule 

type AccessGroupsRequireAccessDomainRule struct {
	EmailDomain AccessGroupsRequireAccessDomainRuleEmailDomain `json:"email_domain,required"`
	JSON        accessGroupsRequireAccessDomainRuleJSON        `json:"-"`
}

Match an entire email domain.

func (*AccessGroupsRequireAccessDomainRule) UnmarshalJSON 

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

type AccessGroupsRequireAccessDomainRuleEmailDomain 

type AccessGroupsRequireAccessDomainRuleEmailDomain struct {
	// The email domain to match.
	Domain string                                             `json:"domain,required"`
	JSON   accessGroupsRequireAccessDomainRuleEmailDomainJSON `json:"-"`
}

func (*AccessGroupsRequireAccessDomainRuleEmailDomain) UnmarshalJSON 

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

type AccessGroupsRequireAccessEmailListRule 

type AccessGroupsRequireAccessEmailListRule struct {
	EmailList AccessGroupsRequireAccessEmailListRuleEmailList `json:"email_list,required"`
	JSON      accessGroupsRequireAccessEmailListRuleJSON      `json:"-"`
}

Matches an email address from a list.

func (*AccessGroupsRequireAccessEmailListRule) UnmarshalJSON 

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

type AccessGroupsRequireAccessEmailListRuleEmailList 

type AccessGroupsRequireAccessEmailListRuleEmailList struct {
	// The ID of a previously created email list.
	ID   string                                              `json:"id,required"`
	JSON accessGroupsRequireAccessEmailListRuleEmailListJSON `json:"-"`
}

func (*AccessGroupsRequireAccessEmailListRuleEmailList) UnmarshalJSON 

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

type AccessGroupsRequireAccessEmailRule 

type AccessGroupsRequireAccessEmailRule struct {
	Email AccessGroupsRequireAccessEmailRuleEmail `json:"email,required"`
	JSON  accessGroupsRequireAccessEmailRuleJSON  `json:"-"`
}

Matches a specific email.

func (*AccessGroupsRequireAccessEmailRule) UnmarshalJSON 

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

type AccessGroupsRequireAccessEmailRuleEmail 

type AccessGroupsRequireAccessEmailRuleEmail struct {
	// The email of the user.
	Email string                                      `json:"email,required" format:"email"`
	JSON  accessGroupsRequireAccessEmailRuleEmailJSON `json:"-"`
}

func (*AccessGroupsRequireAccessEmailRuleEmail) UnmarshalJSON 

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

type AccessGroupsRequireAccessEveryoneRule 

type AccessGroupsRequireAccessEveryoneRule struct {
	// An empty object which matches on all users.
	Everyone interface{}                               `json:"everyone,required"`
	JSON     accessGroupsRequireAccessEveryoneRuleJSON `json:"-"`
}

Matches everyone.

func (*AccessGroupsRequireAccessEveryoneRule) UnmarshalJSON 

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

type AccessGroupsRequireAccessExternalEvaluationRule 

type AccessGroupsRequireAccessExternalEvaluationRule struct {
	ExternalEvaluation AccessGroupsRequireAccessExternalEvaluationRuleExternalEvaluation `json:"external_evaluation,required"`
	JSON               accessGroupsRequireAccessExternalEvaluationRuleJSON               `json:"-"`
}

Create Allow or Block policies which evaluate the user based on custom criteria.

func (*AccessGroupsRequireAccessExternalEvaluationRule) UnmarshalJSON 

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

type AccessGroupsRequireAccessExternalEvaluationRuleExternalEvaluation 

type AccessGroupsRequireAccessExternalEvaluationRuleExternalEvaluation struct {
	// The API endpoint containing your business logic.
	EvaluateURL string `json:"evaluate_url,required"`
	// The API endpoint containing the key that Access uses to verify that the response
	// came from your API.
	KeysURL string                                                                `json:"keys_url,required"`
	JSON    accessGroupsRequireAccessExternalEvaluationRuleExternalEvaluationJSON `json:"-"`
}

func (*AccessGroupsRequireAccessExternalEvaluationRuleExternalEvaluation) UnmarshalJSON 

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

type AccessGroupsRequireAccessGitHubOrganizationRule 

type AccessGroupsRequireAccessGitHubOrganizationRule struct {
	GitHubOrganization AccessGroupsRequireAccessGitHubOrganizationRuleGitHubOrganization `json:"github-organization,required"`
	JSON               accessGroupsRequireAccessGitHubOrganizationRuleJSON               `json:"-"`
}

Matches a Github organization. Requires a Github identity provider.

func (*AccessGroupsRequireAccessGitHubOrganizationRule) UnmarshalJSON 

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

type AccessGroupsRequireAccessGitHubOrganizationRuleGitHubOrganization 

type AccessGroupsRequireAccessGitHubOrganizationRuleGitHubOrganization struct {
	// The ID of your Github identity provider.
	ConnectionID string `json:"connection_id,required"`
	// The name of the organization.
	Name string                                                                `json:"name,required"`
	JSON accessGroupsRequireAccessGitHubOrganizationRuleGitHubOrganizationJSON `json:"-"`
}

func (*AccessGroupsRequireAccessGitHubOrganizationRuleGitHubOrganization) UnmarshalJSON 

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

type AccessGroupsRequireAccessGsuiteGroupRule 

type AccessGroupsRequireAccessGsuiteGroupRule struct {
	Gsuite AccessGroupsRequireAccessGsuiteGroupRuleGsuite `json:"gsuite,required"`
	JSON   accessGroupsRequireAccessGsuiteGroupRuleJSON   `json:"-"`
}

Matches a group in Google Workspace. Requires a Google Workspace identity provider.

func (*AccessGroupsRequireAccessGsuiteGroupRule) UnmarshalJSON 

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

type AccessGroupsRequireAccessGsuiteGroupRuleGsuite 

type AccessGroupsRequireAccessGsuiteGroupRuleGsuite struct {
	// The ID of your Google Workspace identity provider.
	ConnectionID string `json:"connection_id,required"`
	// The email of the Google Workspace group.
	Email string                                             `json:"email,required"`
	JSON  accessGroupsRequireAccessGsuiteGroupRuleGsuiteJSON `json:"-"`
}

func (*AccessGroupsRequireAccessGsuiteGroupRuleGsuite) UnmarshalJSON 

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

type AccessGroupsRequireAccessIPListRule 

type AccessGroupsRequireAccessIPListRule struct {
	IPList AccessGroupsRequireAccessIPListRuleIPList `json:"ip_list,required"`
	JSON   accessGroupsRequireAccessIPListRuleJSON   `json:"-"`
}

Matches an IP address from a list.

func (*AccessGroupsRequireAccessIPListRule) UnmarshalJSON 

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

type AccessGroupsRequireAccessIPListRuleIPList 

type AccessGroupsRequireAccessIPListRuleIPList struct {
	// The ID of a previously created IP list.
	ID   string                                        `json:"id,required"`
	JSON accessGroupsRequireAccessIPListRuleIPListJSON `json:"-"`
}

func (*AccessGroupsRequireAccessIPListRuleIPList) UnmarshalJSON 

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

type AccessGroupsRequireAccessIPRule 

type AccessGroupsRequireAccessIPRule struct {
	IP   AccessGroupsRequireAccessIPRuleIP   `json:"ip,required"`
	JSON accessGroupsRequireAccessIPRuleJSON `json:"-"`
}

Matches an IP address block.

func (*AccessGroupsRequireAccessIPRule) UnmarshalJSON 

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

type AccessGroupsRequireAccessIPRuleIP 

type AccessGroupsRequireAccessIPRuleIP struct {
	// An IPv4 or IPv6 CIDR block.
	IP   string                                `json:"ip,required"`
	JSON accessGroupsRequireAccessIPRuleIPJSON `json:"-"`
}

func (*AccessGroupsRequireAccessIPRuleIP) UnmarshalJSON 

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

type AccessGroupsRequireAccessOktaGroupRule 

type AccessGroupsRequireAccessOktaGroupRule struct {
	Okta AccessGroupsRequireAccessOktaGroupRuleOkta `json:"okta,required"`
	JSON accessGroupsRequireAccessOktaGroupRuleJSON `json:"-"`
}

Matches an Okta group. Requires an Okta identity provider.

func (*AccessGroupsRequireAccessOktaGroupRule) UnmarshalJSON 

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

type AccessGroupsRequireAccessOktaGroupRuleOkta 

type AccessGroupsRequireAccessOktaGroupRuleOkta struct {
	// The ID of your Okta identity provider.
	ConnectionID string `json:"connection_id,required"`
	// The email of the Okta group.
	Email string                                         `json:"email,required"`
	JSON  accessGroupsRequireAccessOktaGroupRuleOktaJSON `json:"-"`
}

func (*AccessGroupsRequireAccessOktaGroupRuleOkta) UnmarshalJSON 

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

type AccessGroupsRequireAccessSamlGroupRule 

type AccessGroupsRequireAccessSamlGroupRule struct {
	Saml AccessGroupsRequireAccessSamlGroupRuleSaml `json:"saml,required"`
	JSON accessGroupsRequireAccessSamlGroupRuleJSON `json:"-"`
}

Matches a SAML group. Requires a SAML identity provider.

func (*AccessGroupsRequireAccessSamlGroupRule) UnmarshalJSON 

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

type AccessGroupsRequireAccessSamlGroupRuleSaml 

type AccessGroupsRequireAccessSamlGroupRuleSaml struct {
	// The name of the SAML attribute.
	AttributeName string `json:"attribute_name,required"`
	// The SAML attribute value to look for.
	AttributeValue string                                         `json:"attribute_value,required"`
	JSON           accessGroupsRequireAccessSamlGroupRuleSamlJSON `json:"-"`
}

func (*AccessGroupsRequireAccessSamlGroupRuleSaml) UnmarshalJSON 

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

type AccessGroupsRequireAccessServiceTokenRule 

type AccessGroupsRequireAccessServiceTokenRule struct {
	ServiceToken AccessGroupsRequireAccessServiceTokenRuleServiceToken `json:"service_token,required"`
	JSON         accessGroupsRequireAccessServiceTokenRuleJSON         `json:"-"`
}

Matches a specific Access Service Token

func (*AccessGroupsRequireAccessServiceTokenRule) UnmarshalJSON 

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

type AccessGroupsRequireAccessServiceTokenRuleServiceToken 

type AccessGroupsRequireAccessServiceTokenRuleServiceToken struct {
	// The ID of a Service Token.
	TokenID string                                                    `json:"token_id,required"`
	JSON    accessGroupsRequireAccessServiceTokenRuleServiceTokenJSON `json:"-"`
}

func (*AccessGroupsRequireAccessServiceTokenRuleServiceToken) UnmarshalJSON 

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

type AccessIdentity 

type AccessIdentity struct {
	AccountID          string                                 `json:"account_id"`
	AuthStatus         string                                 `json:"auth_status"`
	CommonName         string                                 `json:"common_name"`
	DeviceID           string                                 `json:"device_id"`
	DeviceSessions     map[string]AccessIdentityDeviceSession `json:"device_sessions"`
	DevicePosture      map[string]AccessIdentityDevicePosture `json:"devicePosture"`
	Email              string                                 `json:"email"`
	Geo                AccessIdentityGeo                      `json:"geo"`
	Iat                float64                                `json:"iat"`
	Idp                AccessIdentityIdp                      `json:"idp"`
	IP                 string                                 `json:"ip"`
	IsGateway          bool                                   `json:"is_gateway"`
	IsWARP             bool                                   `json:"is_warp"`
	MTLSAuth           AccessIdentityMTLSAuth                 `json:"mtls_auth"`
	ServiceTokenID     string                                 `json:"service_token_id"`
	ServiceTokenStatus bool                                   `json:"service_token_status"`
	UserUUID           string                                 `json:"user_uuid"`
	Version            float64                                `json:"version"`
	JSON               accessIdentityJSON                     `json:"-"`
}

func (*AccessIdentity) UnmarshalJSON 

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

type AccessIdentityDevicePosture 

type AccessIdentityDevicePosture struct {
	ID          string                           `json:"id"`
	Check       AccessIdentityDevicePostureCheck `json:"check"`
	Data        interface{}                      `json:"data"`
	Description string                           `json:"description"`
	Error       string                           `json:"error"`
	RuleName    string                           `json:"rule_name"`
	Success     bool                             `json:"success"`
	Timestamp   string                           `json:"timestamp"`
	Type        string                           `json:"type"`
	JSON        accessIdentityDevicePostureJSON  `json:"-"`
}

func (*AccessIdentityDevicePosture) UnmarshalJSON 

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

type AccessIdentityDevicePostureCheck 

type AccessIdentityDevicePostureCheck struct {
	Exists bool                                 `json:"exists"`
	Path   string                               `json:"path"`
	JSON   accessIdentityDevicePostureCheckJSON `json:"-"`
}

func (*AccessIdentityDevicePostureCheck) UnmarshalJSON 

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

type AccessIdentityDeviceSession 

type AccessIdentityDeviceSession struct {
	LastAuthenticated float64                         `json:"last_authenticated"`
	JSON              accessIdentityDeviceSessionJSON `json:"-"`
}

func (*AccessIdentityDeviceSession) UnmarshalJSON 

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

type AccessIdentityGeo 

type AccessIdentityGeo struct {
	Country string                `json:"country"`
	JSON    accessIdentityGeoJSON `json:"-"`
}

func (*AccessIdentityGeo) UnmarshalJSON 

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

type AccessIdentityIdp 

type AccessIdentityIdp struct {
	ID   string                `json:"id"`
	Type string                `json:"type"`
	JSON accessIdentityIdpJSON `json:"-"`
}

func (*AccessIdentityIdp) UnmarshalJSON 

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

type AccessIdentityMTLSAuth 

type AccessIdentityMTLSAuth struct {
	AuthStatus    string                     `json:"auth_status"`
	CertIssuerDn  string                     `json:"cert_issuer_dn"`
	CertIssuerSki string                     `json:"cert_issuer_ski"`
	CertPresented bool                       `json:"cert_presented"`
	CertSerial    string                     `json:"cert_serial"`
	JSON          accessIdentityMTLSAuthJSON `json:"-"`
}

func (*AccessIdentityMTLSAuth) UnmarshalJSON 

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

type AccessIdentityProviders 

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

Union satisfied by zero_trust.AccessIdentityProvidersAccessAzureAd, zero_trust.AccessIdentityProvidersAccessCentrify, zero_trust.AccessIdentityProvidersAccessFacebook, zero_trust.AccessIdentityProvidersAccessGitHub, zero_trust.AccessIdentityProvidersAccessGoogle, zero_trust.AccessIdentityProvidersAccessGoogleApps, zero_trust.AccessIdentityProvidersAccessLinkedin, zero_trust.AccessIdentityProvidersAccessOidc, zero_trust.AccessIdentityProvidersAccessOkta, zero_trust.AccessIdentityProvidersAccessOnelogin, zero_trust.AccessIdentityProvidersAccessPingone, zero_trust.AccessIdentityProvidersAccessSaml, zero_trust.AccessIdentityProvidersAccessYandex or zero_trust.AccessIdentityProvidersAccessOnetimepin.

type AccessIdentityProvidersAccessAzureAd 

type AccessIdentityProvidersAccessAzureAd struct {
	// The configuration parameters for the identity provider. To view the required
	// parameters for a specific provider, refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Config AccessIdentityProvidersAccessAzureAdConfig `json:"config,required"`
	// The name of the identity provider, shown to users on the login page.
	Name string `json:"name,required"`
	// The type of identity provider. To determine the value for a specific provider,
	// refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Type AccessIdentityProvidersAccessAzureAdType `json:"type,required"`
	// UUID
	ID string `json:"id"`
	// The configuration settings for enabling a System for Cross-Domain Identity
	// Management (SCIM) with the identity provider.
	ScimConfig AccessIdentityProvidersAccessAzureAdScimConfig `json:"scim_config"`
	JSON       accessIdentityProvidersAccessAzureAdJSON       `json:"-"`
}

func (*AccessIdentityProvidersAccessAzureAd) UnmarshalJSON 

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

type AccessIdentityProvidersAccessAzureAdConfig 

type AccessIdentityProvidersAccessAzureAdConfig struct {
	// Custom claims
	Claims []string `json:"claims"`
	// Your OAuth Client ID
	ClientID string `json:"client_id"`
	// Your OAuth Client Secret
	ClientSecret string `json:"client_secret"`
	// Should Cloudflare try to load authentication contexts from your account
	ConditionalAccessEnabled bool `json:"conditional_access_enabled"`
	// Your Azure directory uuid
	DirectoryID string `json:"directory_id"`
	// The claim name for email in the id_token response.
	EmailClaimName string `json:"email_claim_name"`
	// Indicates the type of user interaction that is required. prompt=login forces the
	// user to enter their credentials on that request, negating single-sign on.
	// prompt=none is the opposite. It ensures that the user isn't presented with any
	// interactive prompt. If the request can't be completed silently by using
	// single-sign on, the Microsoft identity platform returns an interaction_required
	// error. prompt=select_account interrupts single sign-on providing account
	// selection experience listing all the accounts either in session or any
	// remembered account or an option to choose to use a different account altogether.
	Prompt AccessIdentityProvidersAccessAzureAdConfigPrompt `json:"prompt"`
	// Should Cloudflare try to load groups from your account
	SupportGroups bool                                           `json:"support_groups"`
	JSON          accessIdentityProvidersAccessAzureAdConfigJSON `json:"-"`
}

The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).

func (*AccessIdentityProvidersAccessAzureAdConfig) UnmarshalJSON 

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

type AccessIdentityProvidersAccessAzureAdConfigPrompt 

type AccessIdentityProvidersAccessAzureAdConfigPrompt string

Indicates the type of user interaction that is required. prompt=login forces the user to enter their credentials on that request, negating single-sign on. prompt=none is the opposite. It ensures that the user isn't presented with any interactive prompt. If the request can't be completed silently by using single-sign on, the Microsoft identity platform returns an interaction_required error. prompt=select_account interrupts single sign-on providing account selection experience listing all the accounts either in session or any remembered account or an option to choose to use a different account altogether. 

const (
	AccessIdentityProvidersAccessAzureAdConfigPromptLogin         AccessIdentityProvidersAccessAzureAdConfigPrompt = "login"
	AccessIdentityProvidersAccessAzureAdConfigPromptSelectAccount AccessIdentityProvidersAccessAzureAdConfigPrompt = "select_account"
	AccessIdentityProvidersAccessAzureAdConfigPromptNone          AccessIdentityProvidersAccessAzureAdConfigPrompt = "none"
)

type AccessIdentityProvidersAccessAzureAdScimConfig 

type AccessIdentityProvidersAccessAzureAdScimConfig struct {
	// A flag to enable or disable SCIM for the identity provider.
	Enabled bool `json:"enabled"`
	// A flag to revoke a user's session in Access and force a reauthentication on the
	// user's Gateway session when they have been added or removed from a group in the
	// Identity Provider.
	GroupMemberDeprovision bool `json:"group_member_deprovision"`
	// A flag to remove a user's seat in Zero Trust when they have been deprovisioned
	// in the Identity Provider. This cannot be enabled unless user_deprovision is also
	// enabled.
	SeatDeprovision bool `json:"seat_deprovision"`
	// A read-only token generated when the SCIM integration is enabled for the first
	// time. It is redacted on subsequent requests. If you lose this you will need to
	// refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.
	Secret string `json:"secret"`
	// A flag to enable revoking a user's session in Access and Gateway when they have
	// been deprovisioned in the Identity Provider.
	UserDeprovision bool                                               `json:"user_deprovision"`
	JSON            accessIdentityProvidersAccessAzureAdScimConfigJSON `json:"-"`
}

The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.

func (*AccessIdentityProvidersAccessAzureAdScimConfig) UnmarshalJSON 

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

type AccessIdentityProvidersAccessAzureAdType 

type AccessIdentityProvidersAccessAzureAdType string

The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). 

const (
	AccessIdentityProvidersAccessAzureAdTypeOnetimepin AccessIdentityProvidersAccessAzureAdType = "onetimepin"
	AccessIdentityProvidersAccessAzureAdTypeAzureAd    AccessIdentityProvidersAccessAzureAdType = "azureAD"
	AccessIdentityProvidersAccessAzureAdTypeSaml       AccessIdentityProvidersAccessAzureAdType = "saml"
	AccessIdentityProvidersAccessAzureAdTypeCentrify   AccessIdentityProvidersAccessAzureAdType = "centrify"
	AccessIdentityProvidersAccessAzureAdTypeFacebook   AccessIdentityProvidersAccessAzureAdType = "facebook"
	AccessIdentityProvidersAccessAzureAdTypeGitHub     AccessIdentityProvidersAccessAzureAdType = "github"
	AccessIdentityProvidersAccessAzureAdTypeGoogleApps AccessIdentityProvidersAccessAzureAdType = "google-apps"
	AccessIdentityProvidersAccessAzureAdTypeGoogle     AccessIdentityProvidersAccessAzureAdType = "google"
	AccessIdentityProvidersAccessAzureAdTypeLinkedin   AccessIdentityProvidersAccessAzureAdType = "linkedin"
	AccessIdentityProvidersAccessAzureAdTypeOidc       AccessIdentityProvidersAccessAzureAdType = "oidc"
	AccessIdentityProvidersAccessAzureAdTypeOkta       AccessIdentityProvidersAccessAzureAdType = "okta"
	AccessIdentityProvidersAccessAzureAdTypeOnelogin   AccessIdentityProvidersAccessAzureAdType = "onelogin"
	AccessIdentityProvidersAccessAzureAdTypePingone    AccessIdentityProvidersAccessAzureAdType = "pingone"
	AccessIdentityProvidersAccessAzureAdTypeYandex     AccessIdentityProvidersAccessAzureAdType = "yandex"
)

type AccessIdentityProvidersAccessCentrify 

type AccessIdentityProvidersAccessCentrify struct {
	// The configuration parameters for the identity provider. To view the required
	// parameters for a specific provider, refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Config AccessIdentityProvidersAccessCentrifyConfig `json:"config,required"`
	// The name of the identity provider, shown to users on the login page.
	Name string `json:"name,required"`
	// The type of identity provider. To determine the value for a specific provider,
	// refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Type AccessIdentityProvidersAccessCentrifyType `json:"type,required"`
	// UUID
	ID string `json:"id"`
	// The configuration settings for enabling a System for Cross-Domain Identity
	// Management (SCIM) with the identity provider.
	ScimConfig AccessIdentityProvidersAccessCentrifyScimConfig `json:"scim_config"`
	JSON       accessIdentityProvidersAccessCentrifyJSON       `json:"-"`
}

func (*AccessIdentityProvidersAccessCentrify) UnmarshalJSON 

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

type AccessIdentityProvidersAccessCentrifyConfig 

type AccessIdentityProvidersAccessCentrifyConfig struct {
	// Your centrify account url
	CentrifyAccount string `json:"centrify_account"`
	// Your centrify app id
	CentrifyAppID string `json:"centrify_app_id"`
	// Custom claims
	Claims []string `json:"claims"`
	// Your OAuth Client ID
	ClientID string `json:"client_id"`
	// Your OAuth Client Secret
	ClientSecret string `json:"client_secret"`
	// The claim name for email in the id_token response.
	EmailClaimName string                                          `json:"email_claim_name"`
	JSON           accessIdentityProvidersAccessCentrifyConfigJSON `json:"-"`
}

The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).

func (*AccessIdentityProvidersAccessCentrifyConfig) UnmarshalJSON 

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

type AccessIdentityProvidersAccessCentrifyScimConfig 

type AccessIdentityProvidersAccessCentrifyScimConfig struct {
	// A flag to enable or disable SCIM for the identity provider.
	Enabled bool `json:"enabled"`
	// A flag to revoke a user's session in Access and force a reauthentication on the
	// user's Gateway session when they have been added or removed from a group in the
	// Identity Provider.
	GroupMemberDeprovision bool `json:"group_member_deprovision"`
	// A flag to remove a user's seat in Zero Trust when they have been deprovisioned
	// in the Identity Provider. This cannot be enabled unless user_deprovision is also
	// enabled.
	SeatDeprovision bool `json:"seat_deprovision"`
	// A read-only token generated when the SCIM integration is enabled for the first
	// time. It is redacted on subsequent requests. If you lose this you will need to
	// refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.
	Secret string `json:"secret"`
	// A flag to enable revoking a user's session in Access and Gateway when they have
	// been deprovisioned in the Identity Provider.
	UserDeprovision bool                                                `json:"user_deprovision"`
	JSON            accessIdentityProvidersAccessCentrifyScimConfigJSON `json:"-"`
}

The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.

func (*AccessIdentityProvidersAccessCentrifyScimConfig) UnmarshalJSON 

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

type AccessIdentityProvidersAccessCentrifyType 

type AccessIdentityProvidersAccessCentrifyType string

The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). 

const (
	AccessIdentityProvidersAccessCentrifyTypeOnetimepin AccessIdentityProvidersAccessCentrifyType = "onetimepin"
	AccessIdentityProvidersAccessCentrifyTypeAzureAd    AccessIdentityProvidersAccessCentrifyType = "azureAD"
	AccessIdentityProvidersAccessCentrifyTypeSaml       AccessIdentityProvidersAccessCentrifyType = "saml"
	AccessIdentityProvidersAccessCentrifyTypeCentrify   AccessIdentityProvidersAccessCentrifyType = "centrify"
	AccessIdentityProvidersAccessCentrifyTypeFacebook   AccessIdentityProvidersAccessCentrifyType = "facebook"
	AccessIdentityProvidersAccessCentrifyTypeGitHub     AccessIdentityProvidersAccessCentrifyType = "github"
	AccessIdentityProvidersAccessCentrifyTypeGoogleApps AccessIdentityProvidersAccessCentrifyType = "google-apps"
	AccessIdentityProvidersAccessCentrifyTypeGoogle     AccessIdentityProvidersAccessCentrifyType = "google"
	AccessIdentityProvidersAccessCentrifyTypeLinkedin   AccessIdentityProvidersAccessCentrifyType = "linkedin"
	AccessIdentityProvidersAccessCentrifyTypeOidc       AccessIdentityProvidersAccessCentrifyType = "oidc"
	AccessIdentityProvidersAccessCentrifyTypeOkta       AccessIdentityProvidersAccessCentrifyType = "okta"
	AccessIdentityProvidersAccessCentrifyTypeOnelogin   AccessIdentityProvidersAccessCentrifyType = "onelogin"
	AccessIdentityProvidersAccessCentrifyTypePingone    AccessIdentityProvidersAccessCentrifyType = "pingone"
	AccessIdentityProvidersAccessCentrifyTypeYandex     AccessIdentityProvidersAccessCentrifyType = "yandex"
)

type AccessIdentityProvidersAccessFacebook 

type AccessIdentityProvidersAccessFacebook struct {
	// The configuration parameters for the identity provider. To view the required
	// parameters for a specific provider, refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Config AccessIdentityProvidersAccessFacebookConfig `json:"config,required"`
	// The name of the identity provider, shown to users on the login page.
	Name string `json:"name,required"`
	// The type of identity provider. To determine the value for a specific provider,
	// refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Type AccessIdentityProvidersAccessFacebookType `json:"type,required"`
	// UUID
	ID string `json:"id"`
	// The configuration settings for enabling a System for Cross-Domain Identity
	// Management (SCIM) with the identity provider.
	ScimConfig AccessIdentityProvidersAccessFacebookScimConfig `json:"scim_config"`
	JSON       accessIdentityProvidersAccessFacebookJSON       `json:"-"`
}

func (*AccessIdentityProvidersAccessFacebook) UnmarshalJSON 

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

type AccessIdentityProvidersAccessFacebookConfig 

type AccessIdentityProvidersAccessFacebookConfig struct {
	// Your OAuth Client ID
	ClientID string `json:"client_id"`
	// Your OAuth Client Secret
	ClientSecret string                                          `json:"client_secret"`
	JSON         accessIdentityProvidersAccessFacebookConfigJSON `json:"-"`
}

The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).

func (*AccessIdentityProvidersAccessFacebookConfig) UnmarshalJSON 

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

type AccessIdentityProvidersAccessFacebookScimConfig 

type AccessIdentityProvidersAccessFacebookScimConfig struct {
	// A flag to enable or disable SCIM for the identity provider.
	Enabled bool `json:"enabled"`
	// A flag to revoke a user's session in Access and force a reauthentication on the
	// user's Gateway session when they have been added or removed from a group in the
	// Identity Provider.
	GroupMemberDeprovision bool `json:"group_member_deprovision"`
	// A flag to remove a user's seat in Zero Trust when they have been deprovisioned
	// in the Identity Provider. This cannot be enabled unless user_deprovision is also
	// enabled.
	SeatDeprovision bool `json:"seat_deprovision"`
	// A read-only token generated when the SCIM integration is enabled for the first
	// time. It is redacted on subsequent requests. If you lose this you will need to
	// refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.
	Secret string `json:"secret"`
	// A flag to enable revoking a user's session in Access and Gateway when they have
	// been deprovisioned in the Identity Provider.
	UserDeprovision bool                                                `json:"user_deprovision"`
	JSON            accessIdentityProvidersAccessFacebookScimConfigJSON `json:"-"`
}

The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.

func (*AccessIdentityProvidersAccessFacebookScimConfig) UnmarshalJSON 

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

type AccessIdentityProvidersAccessFacebookType 

type AccessIdentityProvidersAccessFacebookType string

The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). 

const (
	AccessIdentityProvidersAccessFacebookTypeOnetimepin AccessIdentityProvidersAccessFacebookType = "onetimepin"
	AccessIdentityProvidersAccessFacebookTypeAzureAd    AccessIdentityProvidersAccessFacebookType = "azureAD"
	AccessIdentityProvidersAccessFacebookTypeSaml       AccessIdentityProvidersAccessFacebookType = "saml"
	AccessIdentityProvidersAccessFacebookTypeCentrify   AccessIdentityProvidersAccessFacebookType = "centrify"
	AccessIdentityProvidersAccessFacebookTypeFacebook   AccessIdentityProvidersAccessFacebookType = "facebook"
	AccessIdentityProvidersAccessFacebookTypeGitHub     AccessIdentityProvidersAccessFacebookType = "github"
	AccessIdentityProvidersAccessFacebookTypeGoogleApps AccessIdentityProvidersAccessFacebookType = "google-apps"
	AccessIdentityProvidersAccessFacebookTypeGoogle     AccessIdentityProvidersAccessFacebookType = "google"
	AccessIdentityProvidersAccessFacebookTypeLinkedin   AccessIdentityProvidersAccessFacebookType = "linkedin"
	AccessIdentityProvidersAccessFacebookTypeOidc       AccessIdentityProvidersAccessFacebookType = "oidc"
	AccessIdentityProvidersAccessFacebookTypeOkta       AccessIdentityProvidersAccessFacebookType = "okta"
	AccessIdentityProvidersAccessFacebookTypeOnelogin   AccessIdentityProvidersAccessFacebookType = "onelogin"
	AccessIdentityProvidersAccessFacebookTypePingone    AccessIdentityProvidersAccessFacebookType = "pingone"
	AccessIdentityProvidersAccessFacebookTypeYandex     AccessIdentityProvidersAccessFacebookType = "yandex"
)

type AccessIdentityProvidersAccessGitHub 

type AccessIdentityProvidersAccessGitHub struct {
	// The configuration parameters for the identity provider. To view the required
	// parameters for a specific provider, refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Config AccessIdentityProvidersAccessGitHubConfig `json:"config,required"`
	// The name of the identity provider, shown to users on the login page.
	Name string `json:"name,required"`
	// The type of identity provider. To determine the value for a specific provider,
	// refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Type AccessIdentityProvidersAccessGitHubType `json:"type,required"`
	// UUID
	ID string `json:"id"`
	// The configuration settings for enabling a System for Cross-Domain Identity
	// Management (SCIM) with the identity provider.
	ScimConfig AccessIdentityProvidersAccessGitHubScimConfig `json:"scim_config"`
	JSON       accessIdentityProvidersAccessGitHubJSON       `json:"-"`
}

func (*AccessIdentityProvidersAccessGitHub) UnmarshalJSON 

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

type AccessIdentityProvidersAccessGitHubConfig 

type AccessIdentityProvidersAccessGitHubConfig struct {
	// Your OAuth Client ID
	ClientID string `json:"client_id"`
	// Your OAuth Client Secret
	ClientSecret string                                        `json:"client_secret"`
	JSON         accessIdentityProvidersAccessGitHubConfigJSON `json:"-"`
}

The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).

func (*AccessIdentityProvidersAccessGitHubConfig) UnmarshalJSON 

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

type AccessIdentityProvidersAccessGitHubScimConfig 

type AccessIdentityProvidersAccessGitHubScimConfig struct {
	// A flag to enable or disable SCIM for the identity provider.
	Enabled bool `json:"enabled"`
	// A flag to revoke a user's session in Access and force a reauthentication on the
	// user's Gateway session when they have been added or removed from a group in the
	// Identity Provider.
	GroupMemberDeprovision bool `json:"group_member_deprovision"`
	// A flag to remove a user's seat in Zero Trust when they have been deprovisioned
	// in the Identity Provider. This cannot be enabled unless user_deprovision is also
	// enabled.
	SeatDeprovision bool `json:"seat_deprovision"`
	// A read-only token generated when the SCIM integration is enabled for the first
	// time. It is redacted on subsequent requests. If you lose this you will need to
	// refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.
	Secret string `json:"secret"`
	// A flag to enable revoking a user's session in Access and Gateway when they have
	// been deprovisioned in the Identity Provider.
	UserDeprovision bool                                              `json:"user_deprovision"`
	JSON            accessIdentityProvidersAccessGitHubScimConfigJSON `json:"-"`
}

The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.

func (*AccessIdentityProvidersAccessGitHubScimConfig) UnmarshalJSON 

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

type AccessIdentityProvidersAccessGitHubType 

type AccessIdentityProvidersAccessGitHubType string

The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). 

const (
	AccessIdentityProvidersAccessGitHubTypeOnetimepin AccessIdentityProvidersAccessGitHubType = "onetimepin"
	AccessIdentityProvidersAccessGitHubTypeAzureAd    AccessIdentityProvidersAccessGitHubType = "azureAD"
	AccessIdentityProvidersAccessGitHubTypeSaml       AccessIdentityProvidersAccessGitHubType = "saml"
	AccessIdentityProvidersAccessGitHubTypeCentrify   AccessIdentityProvidersAccessGitHubType = "centrify"
	AccessIdentityProvidersAccessGitHubTypeFacebook   AccessIdentityProvidersAccessGitHubType = "facebook"
	AccessIdentityProvidersAccessGitHubTypeGitHub     AccessIdentityProvidersAccessGitHubType = "github"
	AccessIdentityProvidersAccessGitHubTypeGoogleApps AccessIdentityProvidersAccessGitHubType = "google-apps"
	AccessIdentityProvidersAccessGitHubTypeGoogle     AccessIdentityProvidersAccessGitHubType = "google"
	AccessIdentityProvidersAccessGitHubTypeLinkedin   AccessIdentityProvidersAccessGitHubType = "linkedin"
	AccessIdentityProvidersAccessGitHubTypeOidc       AccessIdentityProvidersAccessGitHubType = "oidc"
	AccessIdentityProvidersAccessGitHubTypeOkta       AccessIdentityProvidersAccessGitHubType = "okta"
	AccessIdentityProvidersAccessGitHubTypeOnelogin   AccessIdentityProvidersAccessGitHubType = "onelogin"
	AccessIdentityProvidersAccessGitHubTypePingone    AccessIdentityProvidersAccessGitHubType = "pingone"
	AccessIdentityProvidersAccessGitHubTypeYandex     AccessIdentityProvidersAccessGitHubType = "yandex"
)

type AccessIdentityProvidersAccessGoogle 

type AccessIdentityProvidersAccessGoogle struct {
	// The configuration parameters for the identity provider. To view the required
	// parameters for a specific provider, refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Config AccessIdentityProvidersAccessGoogleConfig `json:"config,required"`
	// The name of the identity provider, shown to users on the login page.
	Name string `json:"name,required"`
	// The type of identity provider. To determine the value for a specific provider,
	// refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Type AccessIdentityProvidersAccessGoogleType `json:"type,required"`
	// UUID
	ID string `json:"id"`
	// The configuration settings for enabling a System for Cross-Domain Identity
	// Management (SCIM) with the identity provider.
	ScimConfig AccessIdentityProvidersAccessGoogleScimConfig `json:"scim_config"`
	JSON       accessIdentityProvidersAccessGoogleJSON       `json:"-"`
}

func (*AccessIdentityProvidersAccessGoogle) UnmarshalJSON 

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

type AccessIdentityProvidersAccessGoogleApps 

type AccessIdentityProvidersAccessGoogleApps struct {
	// The configuration parameters for the identity provider. To view the required
	// parameters for a specific provider, refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Config AccessIdentityProvidersAccessGoogleAppsConfig `json:"config,required"`
	// The name of the identity provider, shown to users on the login page.
	Name string `json:"name,required"`
	// The type of identity provider. To determine the value for a specific provider,
	// refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Type AccessIdentityProvidersAccessGoogleAppsType `json:"type,required"`
	// UUID
	ID string `json:"id"`
	// The configuration settings for enabling a System for Cross-Domain Identity
	// Management (SCIM) with the identity provider.
	ScimConfig AccessIdentityProvidersAccessGoogleAppsScimConfig `json:"scim_config"`
	JSON       accessIdentityProvidersAccessGoogleAppsJSON       `json:"-"`
}

func (*AccessIdentityProvidersAccessGoogleApps) UnmarshalJSON 

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

type AccessIdentityProvidersAccessGoogleAppsConfig 

type AccessIdentityProvidersAccessGoogleAppsConfig struct {
	// Your companies TLD
	AppsDomain string `json:"apps_domain"`
	// Custom claims
	Claims []string `json:"claims"`
	// Your OAuth Client ID
	ClientID string `json:"client_id"`
	// Your OAuth Client Secret
	ClientSecret string `json:"client_secret"`
	// The claim name for email in the id_token response.
	EmailClaimName string                                            `json:"email_claim_name"`
	JSON           accessIdentityProvidersAccessGoogleAppsConfigJSON `json:"-"`
}

The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).

func (*AccessIdentityProvidersAccessGoogleAppsConfig) UnmarshalJSON 

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

type AccessIdentityProvidersAccessGoogleAppsScimConfig 

type AccessIdentityProvidersAccessGoogleAppsScimConfig struct {
	// A flag to enable or disable SCIM for the identity provider.
	Enabled bool `json:"enabled"`
	// A flag to revoke a user's session in Access and force a reauthentication on the
	// user's Gateway session when they have been added or removed from a group in the
	// Identity Provider.
	GroupMemberDeprovision bool `json:"group_member_deprovision"`
	// A flag to remove a user's seat in Zero Trust when they have been deprovisioned
	// in the Identity Provider. This cannot be enabled unless user_deprovision is also
	// enabled.
	SeatDeprovision bool `json:"seat_deprovision"`
	// A read-only token generated when the SCIM integration is enabled for the first
	// time. It is redacted on subsequent requests. If you lose this you will need to
	// refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.
	Secret string `json:"secret"`
	// A flag to enable revoking a user's session in Access and Gateway when they have
	// been deprovisioned in the Identity Provider.
	UserDeprovision bool                                                  `json:"user_deprovision"`
	JSON            accessIdentityProvidersAccessGoogleAppsScimConfigJSON `json:"-"`
}

The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.

func (*AccessIdentityProvidersAccessGoogleAppsScimConfig) UnmarshalJSON 

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

type AccessIdentityProvidersAccessGoogleAppsType 

type AccessIdentityProvidersAccessGoogleAppsType string

The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). 

const (
	AccessIdentityProvidersAccessGoogleAppsTypeOnetimepin AccessIdentityProvidersAccessGoogleAppsType = "onetimepin"
	AccessIdentityProvidersAccessGoogleAppsTypeAzureAd    AccessIdentityProvidersAccessGoogleAppsType = "azureAD"
	AccessIdentityProvidersAccessGoogleAppsTypeSaml       AccessIdentityProvidersAccessGoogleAppsType = "saml"
	AccessIdentityProvidersAccessGoogleAppsTypeCentrify   AccessIdentityProvidersAccessGoogleAppsType = "centrify"
	AccessIdentityProvidersAccessGoogleAppsTypeFacebook   AccessIdentityProvidersAccessGoogleAppsType = "facebook"
	AccessIdentityProvidersAccessGoogleAppsTypeGitHub     AccessIdentityProvidersAccessGoogleAppsType = "github"
	AccessIdentityProvidersAccessGoogleAppsTypeGoogleApps AccessIdentityProvidersAccessGoogleAppsType = "google-apps"
	AccessIdentityProvidersAccessGoogleAppsTypeGoogle     AccessIdentityProvidersAccessGoogleAppsType = "google"
	AccessIdentityProvidersAccessGoogleAppsTypeLinkedin   AccessIdentityProvidersAccessGoogleAppsType = "linkedin"
	AccessIdentityProvidersAccessGoogleAppsTypeOidc       AccessIdentityProvidersAccessGoogleAppsType = "oidc"
	AccessIdentityProvidersAccessGoogleAppsTypeOkta       AccessIdentityProvidersAccessGoogleAppsType = "okta"
	AccessIdentityProvidersAccessGoogleAppsTypeOnelogin   AccessIdentityProvidersAccessGoogleAppsType = "onelogin"
	AccessIdentityProvidersAccessGoogleAppsTypePingone    AccessIdentityProvidersAccessGoogleAppsType = "pingone"
	AccessIdentityProvidersAccessGoogleAppsTypeYandex     AccessIdentityProvidersAccessGoogleAppsType = "yandex"
)

type AccessIdentityProvidersAccessGoogleConfig 

type AccessIdentityProvidersAccessGoogleConfig struct {
	// Custom claims
	Claims []string `json:"claims"`
	// Your OAuth Client ID
	ClientID string `json:"client_id"`
	// Your OAuth Client Secret
	ClientSecret string `json:"client_secret"`
	// The claim name for email in the id_token response.
	EmailClaimName string                                        `json:"email_claim_name"`
	JSON           accessIdentityProvidersAccessGoogleConfigJSON `json:"-"`
}

The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).

func (*AccessIdentityProvidersAccessGoogleConfig) UnmarshalJSON 

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

type AccessIdentityProvidersAccessGoogleScimConfig 

type AccessIdentityProvidersAccessGoogleScimConfig struct {
	// A flag to enable or disable SCIM for the identity provider.
	Enabled bool `json:"enabled"`
	// A flag to revoke a user's session in Access and force a reauthentication on the
	// user's Gateway session when they have been added or removed from a group in the
	// Identity Provider.
	GroupMemberDeprovision bool `json:"group_member_deprovision"`
	// A flag to remove a user's seat in Zero Trust when they have been deprovisioned
	// in the Identity Provider. This cannot be enabled unless user_deprovision is also
	// enabled.
	SeatDeprovision bool `json:"seat_deprovision"`
	// A read-only token generated when the SCIM integration is enabled for the first
	// time. It is redacted on subsequent requests. If you lose this you will need to
	// refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.
	Secret string `json:"secret"`
	// A flag to enable revoking a user's session in Access and Gateway when they have
	// been deprovisioned in the Identity Provider.
	UserDeprovision bool                                              `json:"user_deprovision"`
	JSON            accessIdentityProvidersAccessGoogleScimConfigJSON `json:"-"`
}

The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.

func (*AccessIdentityProvidersAccessGoogleScimConfig) UnmarshalJSON 

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

type AccessIdentityProvidersAccessGoogleType 

type AccessIdentityProvidersAccessGoogleType string

The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). 

const (
	AccessIdentityProvidersAccessGoogleTypeOnetimepin AccessIdentityProvidersAccessGoogleType = "onetimepin"
	AccessIdentityProvidersAccessGoogleTypeAzureAd    AccessIdentityProvidersAccessGoogleType = "azureAD"
	AccessIdentityProvidersAccessGoogleTypeSaml       AccessIdentityProvidersAccessGoogleType = "saml"
	AccessIdentityProvidersAccessGoogleTypeCentrify   AccessIdentityProvidersAccessGoogleType = "centrify"
	AccessIdentityProvidersAccessGoogleTypeFacebook   AccessIdentityProvidersAccessGoogleType = "facebook"
	AccessIdentityProvidersAccessGoogleTypeGitHub     AccessIdentityProvidersAccessGoogleType = "github"
	AccessIdentityProvidersAccessGoogleTypeGoogleApps AccessIdentityProvidersAccessGoogleType = "google-apps"
	AccessIdentityProvidersAccessGoogleTypeGoogle     AccessIdentityProvidersAccessGoogleType = "google"
	AccessIdentityProvidersAccessGoogleTypeLinkedin   AccessIdentityProvidersAccessGoogleType = "linkedin"
	AccessIdentityProvidersAccessGoogleTypeOidc       AccessIdentityProvidersAccessGoogleType = "oidc"
	AccessIdentityProvidersAccessGoogleTypeOkta       AccessIdentityProvidersAccessGoogleType = "okta"
	AccessIdentityProvidersAccessGoogleTypeOnelogin   AccessIdentityProvidersAccessGoogleType = "onelogin"
	AccessIdentityProvidersAccessGoogleTypePingone    AccessIdentityProvidersAccessGoogleType = "pingone"
	AccessIdentityProvidersAccessGoogleTypeYandex     AccessIdentityProvidersAccessGoogleType = "yandex"
)

type AccessIdentityProvidersAccessLinkedin 

type AccessIdentityProvidersAccessLinkedin struct {
	// The configuration parameters for the identity provider. To view the required
	// parameters for a specific provider, refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Config AccessIdentityProvidersAccessLinkedinConfig `json:"config,required"`
	// The name of the identity provider, shown to users on the login page.
	Name string `json:"name,required"`
	// The type of identity provider. To determine the value for a specific provider,
	// refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Type AccessIdentityProvidersAccessLinkedinType `json:"type,required"`
	// UUID
	ID string `json:"id"`
	// The configuration settings for enabling a System for Cross-Domain Identity
	// Management (SCIM) with the identity provider.
	ScimConfig AccessIdentityProvidersAccessLinkedinScimConfig `json:"scim_config"`
	JSON       accessIdentityProvidersAccessLinkedinJSON       `json:"-"`
}

func (*AccessIdentityProvidersAccessLinkedin) UnmarshalJSON 

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

type AccessIdentityProvidersAccessLinkedinConfig 

type AccessIdentityProvidersAccessLinkedinConfig struct {
	// Your OAuth Client ID
	ClientID string `json:"client_id"`
	// Your OAuth Client Secret
	ClientSecret string                                          `json:"client_secret"`
	JSON         accessIdentityProvidersAccessLinkedinConfigJSON `json:"-"`
}

The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).

func (*AccessIdentityProvidersAccessLinkedinConfig) UnmarshalJSON 

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

type AccessIdentityProvidersAccessLinkedinScimConfig 

type AccessIdentityProvidersAccessLinkedinScimConfig struct {
	// A flag to enable or disable SCIM for the identity provider.
	Enabled bool `json:"enabled"`
	// A flag to revoke a user's session in Access and force a reauthentication on the
	// user's Gateway session when they have been added or removed from a group in the
	// Identity Provider.
	GroupMemberDeprovision bool `json:"group_member_deprovision"`
	// A flag to remove a user's seat in Zero Trust when they have been deprovisioned
	// in the Identity Provider. This cannot be enabled unless user_deprovision is also
	// enabled.
	SeatDeprovision bool `json:"seat_deprovision"`
	// A read-only token generated when the SCIM integration is enabled for the first
	// time. It is redacted on subsequent requests. If you lose this you will need to
	// refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.
	Secret string `json:"secret"`
	// A flag to enable revoking a user's session in Access and Gateway when they have
	// been deprovisioned in the Identity Provider.
	UserDeprovision bool                                                `json:"user_deprovision"`
	JSON            accessIdentityProvidersAccessLinkedinScimConfigJSON `json:"-"`
}

The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.

func (*AccessIdentityProvidersAccessLinkedinScimConfig) UnmarshalJSON 

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

type AccessIdentityProvidersAccessLinkedinType 

type AccessIdentityProvidersAccessLinkedinType string

The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). 

const (
	AccessIdentityProvidersAccessLinkedinTypeOnetimepin AccessIdentityProvidersAccessLinkedinType = "onetimepin"
	AccessIdentityProvidersAccessLinkedinTypeAzureAd    AccessIdentityProvidersAccessLinkedinType = "azureAD"
	AccessIdentityProvidersAccessLinkedinTypeSaml       AccessIdentityProvidersAccessLinkedinType = "saml"
	AccessIdentityProvidersAccessLinkedinTypeCentrify   AccessIdentityProvidersAccessLinkedinType = "centrify"
	AccessIdentityProvidersAccessLinkedinTypeFacebook   AccessIdentityProvidersAccessLinkedinType = "facebook"
	AccessIdentityProvidersAccessLinkedinTypeGitHub     AccessIdentityProvidersAccessLinkedinType = "github"
	AccessIdentityProvidersAccessLinkedinTypeGoogleApps AccessIdentityProvidersAccessLinkedinType = "google-apps"
	AccessIdentityProvidersAccessLinkedinTypeGoogle     AccessIdentityProvidersAccessLinkedinType = "google"
	AccessIdentityProvidersAccessLinkedinTypeLinkedin   AccessIdentityProvidersAccessLinkedinType = "linkedin"
	AccessIdentityProvidersAccessLinkedinTypeOidc       AccessIdentityProvidersAccessLinkedinType = "oidc"
	AccessIdentityProvidersAccessLinkedinTypeOkta       AccessIdentityProvidersAccessLinkedinType = "okta"
	AccessIdentityProvidersAccessLinkedinTypeOnelogin   AccessIdentityProvidersAccessLinkedinType = "onelogin"
	AccessIdentityProvidersAccessLinkedinTypePingone    AccessIdentityProvidersAccessLinkedinType = "pingone"
	AccessIdentityProvidersAccessLinkedinTypeYandex     AccessIdentityProvidersAccessLinkedinType = "yandex"
)

type AccessIdentityProvidersAccessOidc 

type AccessIdentityProvidersAccessOidc struct {
	// The configuration parameters for the identity provider. To view the required
	// parameters for a specific provider, refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Config AccessIdentityProvidersAccessOidcConfig `json:"config,required"`
	// The name of the identity provider, shown to users on the login page.
	Name string `json:"name,required"`
	// The type of identity provider. To determine the value for a specific provider,
	// refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Type AccessIdentityProvidersAccessOidcType `json:"type,required"`
	// UUID
	ID string `json:"id"`
	// The configuration settings for enabling a System for Cross-Domain Identity
	// Management (SCIM) with the identity provider.
	ScimConfig AccessIdentityProvidersAccessOidcScimConfig `json:"scim_config"`
	JSON       accessIdentityProvidersAccessOidcJSON       `json:"-"`
}

func (*AccessIdentityProvidersAccessOidc) UnmarshalJSON 

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

type AccessIdentityProvidersAccessOidcConfig 

type AccessIdentityProvidersAccessOidcConfig struct {
	// The authorization_endpoint URL of your IdP
	AuthURL string `json:"auth_url"`
	// The jwks_uri endpoint of your IdP to allow the IdP keys to sign the tokens
	CertsURL string `json:"certs_url"`
	// Custom claims
	Claims []string `json:"claims"`
	// Your OAuth Client ID
	ClientID string `json:"client_id"`
	// Your OAuth Client Secret
	ClientSecret string `json:"client_secret"`
	// The claim name for email in the id_token response.
	EmailClaimName string `json:"email_claim_name"`
	// OAuth scopes
	Scopes []string `json:"scopes"`
	// The token_endpoint URL of your IdP
	TokenURL string                                      `json:"token_url"`
	JSON     accessIdentityProvidersAccessOidcConfigJSON `json:"-"`
}

The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).

func (*AccessIdentityProvidersAccessOidcConfig) UnmarshalJSON 

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

type AccessIdentityProvidersAccessOidcScimConfig 

type AccessIdentityProvidersAccessOidcScimConfig struct {
	// A flag to enable or disable SCIM for the identity provider.
	Enabled bool `json:"enabled"`
	// A flag to revoke a user's session in Access and force a reauthentication on the
	// user's Gateway session when they have been added or removed from a group in the
	// Identity Provider.
	GroupMemberDeprovision bool `json:"group_member_deprovision"`
	// A flag to remove a user's seat in Zero Trust when they have been deprovisioned
	// in the Identity Provider. This cannot be enabled unless user_deprovision is also
	// enabled.
	SeatDeprovision bool `json:"seat_deprovision"`
	// A read-only token generated when the SCIM integration is enabled for the first
	// time. It is redacted on subsequent requests. If you lose this you will need to
	// refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.
	Secret string `json:"secret"`
	// A flag to enable revoking a user's session in Access and Gateway when they have
	// been deprovisioned in the Identity Provider.
	UserDeprovision bool                                            `json:"user_deprovision"`
	JSON            accessIdentityProvidersAccessOidcScimConfigJSON `json:"-"`
}

The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.

func (*AccessIdentityProvidersAccessOidcScimConfig) UnmarshalJSON 

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

type AccessIdentityProvidersAccessOidcType 

type AccessIdentityProvidersAccessOidcType string

The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). 

const (
	AccessIdentityProvidersAccessOidcTypeOnetimepin AccessIdentityProvidersAccessOidcType = "onetimepin"
	AccessIdentityProvidersAccessOidcTypeAzureAd    AccessIdentityProvidersAccessOidcType = "azureAD"
	AccessIdentityProvidersAccessOidcTypeSaml       AccessIdentityProvidersAccessOidcType = "saml"
	AccessIdentityProvidersAccessOidcTypeCentrify   AccessIdentityProvidersAccessOidcType = "centrify"
	AccessIdentityProvidersAccessOidcTypeFacebook   AccessIdentityProvidersAccessOidcType = "facebook"
	AccessIdentityProvidersAccessOidcTypeGitHub     AccessIdentityProvidersAccessOidcType = "github"
	AccessIdentityProvidersAccessOidcTypeGoogleApps AccessIdentityProvidersAccessOidcType = "google-apps"
	AccessIdentityProvidersAccessOidcTypeGoogle     AccessIdentityProvidersAccessOidcType = "google"
	AccessIdentityProvidersAccessOidcTypeLinkedin   AccessIdentityProvidersAccessOidcType = "linkedin"
	AccessIdentityProvidersAccessOidcTypeOidc       AccessIdentityProvidersAccessOidcType = "oidc"
	AccessIdentityProvidersAccessOidcTypeOkta       AccessIdentityProvidersAccessOidcType = "okta"
	AccessIdentityProvidersAccessOidcTypeOnelogin   AccessIdentityProvidersAccessOidcType = "onelogin"
	AccessIdentityProvidersAccessOidcTypePingone    AccessIdentityProvidersAccessOidcType = "pingone"
	AccessIdentityProvidersAccessOidcTypeYandex     AccessIdentityProvidersAccessOidcType = "yandex"
)

type AccessIdentityProvidersAccessOkta 

type AccessIdentityProvidersAccessOkta struct {
	// The configuration parameters for the identity provider. To view the required
	// parameters for a specific provider, refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Config AccessIdentityProvidersAccessOktaConfig `json:"config,required"`
	// The name of the identity provider, shown to users on the login page.
	Name string `json:"name,required"`
	// The type of identity provider. To determine the value for a specific provider,
	// refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Type AccessIdentityProvidersAccessOktaType `json:"type,required"`
	// UUID
	ID string `json:"id"`
	// The configuration settings for enabling a System for Cross-Domain Identity
	// Management (SCIM) with the identity provider.
	ScimConfig AccessIdentityProvidersAccessOktaScimConfig `json:"scim_config"`
	JSON       accessIdentityProvidersAccessOktaJSON       `json:"-"`
}

func (*AccessIdentityProvidersAccessOkta) UnmarshalJSON 

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

type AccessIdentityProvidersAccessOktaConfig 

type AccessIdentityProvidersAccessOktaConfig struct {
	// Your okta authorization server id
	AuthorizationServerID string `json:"authorization_server_id"`
	// Custom claims
	Claims []string `json:"claims"`
	// Your OAuth Client ID
	ClientID string `json:"client_id"`
	// Your OAuth Client Secret
	ClientSecret string `json:"client_secret"`
	// The claim name for email in the id_token response.
	EmailClaimName string `json:"email_claim_name"`
	// Your okta account url
	OktaAccount string                                      `json:"okta_account"`
	JSON        accessIdentityProvidersAccessOktaConfigJSON `json:"-"`
}

The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).

func (*AccessIdentityProvidersAccessOktaConfig) UnmarshalJSON 

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

type AccessIdentityProvidersAccessOktaScimConfig 

type AccessIdentityProvidersAccessOktaScimConfig struct {
	// A flag to enable or disable SCIM for the identity provider.
	Enabled bool `json:"enabled"`
	// A flag to revoke a user's session in Access and force a reauthentication on the
	// user's Gateway session when they have been added or removed from a group in the
	// Identity Provider.
	GroupMemberDeprovision bool `json:"group_member_deprovision"`
	// A flag to remove a user's seat in Zero Trust when they have been deprovisioned
	// in the Identity Provider. This cannot be enabled unless user_deprovision is also
	// enabled.
	SeatDeprovision bool `json:"seat_deprovision"`
	// A read-only token generated when the SCIM integration is enabled for the first
	// time. It is redacted on subsequent requests. If you lose this you will need to
	// refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.
	Secret string `json:"secret"`
	// A flag to enable revoking a user's session in Access and Gateway when they have
	// been deprovisioned in the Identity Provider.
	UserDeprovision bool                                            `json:"user_deprovision"`
	JSON            accessIdentityProvidersAccessOktaScimConfigJSON `json:"-"`
}

The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.

func (*AccessIdentityProvidersAccessOktaScimConfig) UnmarshalJSON 

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

type AccessIdentityProvidersAccessOktaType 

type AccessIdentityProvidersAccessOktaType string

The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). 

const (
	AccessIdentityProvidersAccessOktaTypeOnetimepin AccessIdentityProvidersAccessOktaType = "onetimepin"
	AccessIdentityProvidersAccessOktaTypeAzureAd    AccessIdentityProvidersAccessOktaType = "azureAD"
	AccessIdentityProvidersAccessOktaTypeSaml       AccessIdentityProvidersAccessOktaType = "saml"
	AccessIdentityProvidersAccessOktaTypeCentrify   AccessIdentityProvidersAccessOktaType = "centrify"
	AccessIdentityProvidersAccessOktaTypeFacebook   AccessIdentityProvidersAccessOktaType = "facebook"
	AccessIdentityProvidersAccessOktaTypeGitHub     AccessIdentityProvidersAccessOktaType = "github"
	AccessIdentityProvidersAccessOktaTypeGoogleApps AccessIdentityProvidersAccessOktaType = "google-apps"
	AccessIdentityProvidersAccessOktaTypeGoogle     AccessIdentityProvidersAccessOktaType = "google"
	AccessIdentityProvidersAccessOktaTypeLinkedin   AccessIdentityProvidersAccessOktaType = "linkedin"
	AccessIdentityProvidersAccessOktaTypeOidc       AccessIdentityProvidersAccessOktaType = "oidc"
	AccessIdentityProvidersAccessOktaTypeOkta       AccessIdentityProvidersAccessOktaType = "okta"
	AccessIdentityProvidersAccessOktaTypeOnelogin   AccessIdentityProvidersAccessOktaType = "onelogin"
	AccessIdentityProvidersAccessOktaTypePingone    AccessIdentityProvidersAccessOktaType = "pingone"
	AccessIdentityProvidersAccessOktaTypeYandex     AccessIdentityProvidersAccessOktaType = "yandex"
)

type AccessIdentityProvidersAccessOnelogin 

type AccessIdentityProvidersAccessOnelogin struct {
	// The configuration parameters for the identity provider. To view the required
	// parameters for a specific provider, refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Config AccessIdentityProvidersAccessOneloginConfig `json:"config,required"`
	// The name of the identity provider, shown to users on the login page.
	Name string `json:"name,required"`
	// The type of identity provider. To determine the value for a specific provider,
	// refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Type AccessIdentityProvidersAccessOneloginType `json:"type,required"`
	// UUID
	ID string `json:"id"`
	// The configuration settings for enabling a System for Cross-Domain Identity
	// Management (SCIM) with the identity provider.
	ScimConfig AccessIdentityProvidersAccessOneloginScimConfig `json:"scim_config"`
	JSON       accessIdentityProvidersAccessOneloginJSON       `json:"-"`
}

func (*AccessIdentityProvidersAccessOnelogin) UnmarshalJSON 

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

type AccessIdentityProvidersAccessOneloginConfig 

type AccessIdentityProvidersAccessOneloginConfig struct {
	// Custom claims
	Claims []string `json:"claims"`
	// Your OAuth Client ID
	ClientID string `json:"client_id"`
	// Your OAuth Client Secret
	ClientSecret string `json:"client_secret"`
	// The claim name for email in the id_token response.
	EmailClaimName string `json:"email_claim_name"`
	// Your OneLogin account url
	OneloginAccount string                                          `json:"onelogin_account"`
	JSON            accessIdentityProvidersAccessOneloginConfigJSON `json:"-"`
}

The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).

func (*AccessIdentityProvidersAccessOneloginConfig) UnmarshalJSON 

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

type AccessIdentityProvidersAccessOneloginScimConfig 

type AccessIdentityProvidersAccessOneloginScimConfig struct {
	// A flag to enable or disable SCIM for the identity provider.
	Enabled bool `json:"enabled"`
	// A flag to revoke a user's session in Access and force a reauthentication on the
	// user's Gateway session when they have been added or removed from a group in the
	// Identity Provider.
	GroupMemberDeprovision bool `json:"group_member_deprovision"`
	// A flag to remove a user's seat in Zero Trust when they have been deprovisioned
	// in the Identity Provider. This cannot be enabled unless user_deprovision is also
	// enabled.
	SeatDeprovision bool `json:"seat_deprovision"`
	// A read-only token generated when the SCIM integration is enabled for the first
	// time. It is redacted on subsequent requests. If you lose this you will need to
	// refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.
	Secret string `json:"secret"`
	// A flag to enable revoking a user's session in Access and Gateway when they have
	// been deprovisioned in the Identity Provider.
	UserDeprovision bool                                                `json:"user_deprovision"`
	JSON            accessIdentityProvidersAccessOneloginScimConfigJSON `json:"-"`
}

The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.

func (*AccessIdentityProvidersAccessOneloginScimConfig) UnmarshalJSON 

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

type AccessIdentityProvidersAccessOneloginType 

type AccessIdentityProvidersAccessOneloginType string

The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). 

const (
	AccessIdentityProvidersAccessOneloginTypeOnetimepin AccessIdentityProvidersAccessOneloginType = "onetimepin"
	AccessIdentityProvidersAccessOneloginTypeAzureAd    AccessIdentityProvidersAccessOneloginType = "azureAD"
	AccessIdentityProvidersAccessOneloginTypeSaml       AccessIdentityProvidersAccessOneloginType = "saml"
	AccessIdentityProvidersAccessOneloginTypeCentrify   AccessIdentityProvidersAccessOneloginType = "centrify"
	AccessIdentityProvidersAccessOneloginTypeFacebook   AccessIdentityProvidersAccessOneloginType = "facebook"
	AccessIdentityProvidersAccessOneloginTypeGitHub     AccessIdentityProvidersAccessOneloginType = "github"
	AccessIdentityProvidersAccessOneloginTypeGoogleApps AccessIdentityProvidersAccessOneloginType = "google-apps"
	AccessIdentityProvidersAccessOneloginTypeGoogle     AccessIdentityProvidersAccessOneloginType = "google"
	AccessIdentityProvidersAccessOneloginTypeLinkedin   AccessIdentityProvidersAccessOneloginType = "linkedin"
	AccessIdentityProvidersAccessOneloginTypeOidc       AccessIdentityProvidersAccessOneloginType = "oidc"
	AccessIdentityProvidersAccessOneloginTypeOkta       AccessIdentityProvidersAccessOneloginType = "okta"
	AccessIdentityProvidersAccessOneloginTypeOnelogin   AccessIdentityProvidersAccessOneloginType = "onelogin"
	AccessIdentityProvidersAccessOneloginTypePingone    AccessIdentityProvidersAccessOneloginType = "pingone"
	AccessIdentityProvidersAccessOneloginTypeYandex     AccessIdentityProvidersAccessOneloginType = "yandex"
)

type AccessIdentityProvidersAccessOnetimepin 

type AccessIdentityProvidersAccessOnetimepin struct {
	// The configuration parameters for the identity provider. To view the required
	// parameters for a specific provider, refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Config interface{} `json:"config,required"`
	// The name of the identity provider, shown to users on the login page.
	Name string `json:"name,required"`
	// The type of identity provider. To determine the value for a specific provider,
	// refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Type AccessIdentityProvidersAccessOnetimepinType `json:"type,required"`
	// UUID
	ID string `json:"id"`
	// The configuration settings for enabling a System for Cross-Domain Identity
	// Management (SCIM) with the identity provider.
	ScimConfig AccessIdentityProvidersAccessOnetimepinScimConfig `json:"scim_config"`
	JSON       accessIdentityProvidersAccessOnetimepinJSON       `json:"-"`
}

func (*AccessIdentityProvidersAccessOnetimepin) UnmarshalJSON 

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

type AccessIdentityProvidersAccessOnetimepinScimConfig 

type AccessIdentityProvidersAccessOnetimepinScimConfig struct {
	// A flag to enable or disable SCIM for the identity provider.
	Enabled bool `json:"enabled"`
	// A flag to revoke a user's session in Access and force a reauthentication on the
	// user's Gateway session when they have been added or removed from a group in the
	// Identity Provider.
	GroupMemberDeprovision bool `json:"group_member_deprovision"`
	// A flag to remove a user's seat in Zero Trust when they have been deprovisioned
	// in the Identity Provider. This cannot be enabled unless user_deprovision is also
	// enabled.
	SeatDeprovision bool `json:"seat_deprovision"`
	// A read-only token generated when the SCIM integration is enabled for the first
	// time. It is redacted on subsequent requests. If you lose this you will need to
	// refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.
	Secret string `json:"secret"`
	// A flag to enable revoking a user's session in Access and Gateway when they have
	// been deprovisioned in the Identity Provider.
	UserDeprovision bool                                                  `json:"user_deprovision"`
	JSON            accessIdentityProvidersAccessOnetimepinScimConfigJSON `json:"-"`
}

The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.

func (*AccessIdentityProvidersAccessOnetimepinScimConfig) UnmarshalJSON 

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

type AccessIdentityProvidersAccessOnetimepinType 

type AccessIdentityProvidersAccessOnetimepinType string

The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). 

const (
	AccessIdentityProvidersAccessOnetimepinTypeOnetimepin AccessIdentityProvidersAccessOnetimepinType = "onetimepin"
	AccessIdentityProvidersAccessOnetimepinTypeAzureAd    AccessIdentityProvidersAccessOnetimepinType = "azureAD"
	AccessIdentityProvidersAccessOnetimepinTypeSaml       AccessIdentityProvidersAccessOnetimepinType = "saml"
	AccessIdentityProvidersAccessOnetimepinTypeCentrify   AccessIdentityProvidersAccessOnetimepinType = "centrify"
	AccessIdentityProvidersAccessOnetimepinTypeFacebook   AccessIdentityProvidersAccessOnetimepinType = "facebook"
	AccessIdentityProvidersAccessOnetimepinTypeGitHub     AccessIdentityProvidersAccessOnetimepinType = "github"
	AccessIdentityProvidersAccessOnetimepinTypeGoogleApps AccessIdentityProvidersAccessOnetimepinType = "google-apps"
	AccessIdentityProvidersAccessOnetimepinTypeGoogle     AccessIdentityProvidersAccessOnetimepinType = "google"
	AccessIdentityProvidersAccessOnetimepinTypeLinkedin   AccessIdentityProvidersAccessOnetimepinType = "linkedin"
	AccessIdentityProvidersAccessOnetimepinTypeOidc       AccessIdentityProvidersAccessOnetimepinType = "oidc"
	AccessIdentityProvidersAccessOnetimepinTypeOkta       AccessIdentityProvidersAccessOnetimepinType = "okta"
	AccessIdentityProvidersAccessOnetimepinTypeOnelogin   AccessIdentityProvidersAccessOnetimepinType = "onelogin"
	AccessIdentityProvidersAccessOnetimepinTypePingone    AccessIdentityProvidersAccessOnetimepinType = "pingone"
	AccessIdentityProvidersAccessOnetimepinTypeYandex     AccessIdentityProvidersAccessOnetimepinType = "yandex"
)

type AccessIdentityProvidersAccessPingone 

type AccessIdentityProvidersAccessPingone struct {
	// The configuration parameters for the identity provider. To view the required
	// parameters for a specific provider, refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Config AccessIdentityProvidersAccessPingoneConfig `json:"config,required"`
	// The name of the identity provider, shown to users on the login page.
	Name string `json:"name,required"`
	// The type of identity provider. To determine the value for a specific provider,
	// refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Type AccessIdentityProvidersAccessPingoneType `json:"type,required"`
	// UUID
	ID string `json:"id"`
	// The configuration settings for enabling a System for Cross-Domain Identity
	// Management (SCIM) with the identity provider.
	ScimConfig AccessIdentityProvidersAccessPingoneScimConfig `json:"scim_config"`
	JSON       accessIdentityProvidersAccessPingoneJSON       `json:"-"`
}

func (*AccessIdentityProvidersAccessPingone) UnmarshalJSON 

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

type AccessIdentityProvidersAccessPingoneConfig 

type AccessIdentityProvidersAccessPingoneConfig struct {
	// Custom claims
	Claims []string `json:"claims"`
	// Your OAuth Client ID
	ClientID string `json:"client_id"`
	// Your OAuth Client Secret
	ClientSecret string `json:"client_secret"`
	// The claim name for email in the id_token response.
	EmailClaimName string `json:"email_claim_name"`
	// Your PingOne environment identifier
	PingEnvID string                                         `json:"ping_env_id"`
	JSON      accessIdentityProvidersAccessPingoneConfigJSON `json:"-"`
}

The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).

func (*AccessIdentityProvidersAccessPingoneConfig) UnmarshalJSON 

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

type AccessIdentityProvidersAccessPingoneScimConfig 

type AccessIdentityProvidersAccessPingoneScimConfig struct {
	// A flag to enable or disable SCIM for the identity provider.
	Enabled bool `json:"enabled"`
	// A flag to revoke a user's session in Access and force a reauthentication on the
	// user's Gateway session when they have been added or removed from a group in the
	// Identity Provider.
	GroupMemberDeprovision bool `json:"group_member_deprovision"`
	// A flag to remove a user's seat in Zero Trust when they have been deprovisioned
	// in the Identity Provider. This cannot be enabled unless user_deprovision is also
	// enabled.
	SeatDeprovision bool `json:"seat_deprovision"`
	// A read-only token generated when the SCIM integration is enabled for the first
	// time. It is redacted on subsequent requests. If you lose this you will need to
	// refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.
	Secret string `json:"secret"`
	// A flag to enable revoking a user's session in Access and Gateway when they have
	// been deprovisioned in the Identity Provider.
	UserDeprovision bool                                               `json:"user_deprovision"`
	JSON            accessIdentityProvidersAccessPingoneScimConfigJSON `json:"-"`
}

The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.

func (*AccessIdentityProvidersAccessPingoneScimConfig) UnmarshalJSON 

func (r *AccessIdentityProvidersAccessPingoneScimConfig) UnmarshalJSON(data []byte) (err error)

type AccessIdentityProvidersAccessPingoneType 

type AccessIdentityProvidersAccessPingoneType string

The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). 

const (
	AccessIdentityProvidersAccessPingoneTypeOnetimepin AccessIdentityProvidersAccessPingoneType = "onetimepin"
	AccessIdentityProvidersAccessPingoneTypeAzureAd    AccessIdentityProvidersAccessPingoneType = "azureAD"
	AccessIdentityProvidersAccessPingoneTypeSaml       AccessIdentityProvidersAccessPingoneType = "saml"
	AccessIdentityProvidersAccessPingoneTypeCentrify   AccessIdentityProvidersAccessPingoneType = "centrify"
	AccessIdentityProvidersAccessPingoneTypeFacebook   AccessIdentityProvidersAccessPingoneType = "facebook"
	AccessIdentityProvidersAccessPingoneTypeGitHub     AccessIdentityProvidersAccessPingoneType = "github"
	AccessIdentityProvidersAccessPingoneTypeGoogleApps AccessIdentityProvidersAccessPingoneType = "google-apps"
	AccessIdentityProvidersAccessPingoneTypeGoogle     AccessIdentityProvidersAccessPingoneType = "google"
	AccessIdentityProvidersAccessPingoneTypeLinkedin   AccessIdentityProvidersAccessPingoneType = "linkedin"
	AccessIdentityProvidersAccessPingoneTypeOidc       AccessIdentityProvidersAccessPingoneType = "oidc"
	AccessIdentityProvidersAccessPingoneTypeOkta       AccessIdentityProvidersAccessPingoneType = "okta"
	AccessIdentityProvidersAccessPingoneTypeOnelogin   AccessIdentityProvidersAccessPingoneType = "onelogin"
	AccessIdentityProvidersAccessPingoneTypePingone    AccessIdentityProvidersAccessPingoneType = "pingone"
	AccessIdentityProvidersAccessPingoneTypeYandex     AccessIdentityProvidersAccessPingoneType = "yandex"
)

type AccessIdentityProvidersAccessSaml 

type AccessIdentityProvidersAccessSaml struct {
	// The configuration parameters for the identity provider. To view the required
	// parameters for a specific provider, refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Config AccessIdentityProvidersAccessSamlConfig `json:"config,required"`
	// The name of the identity provider, shown to users on the login page.
	Name string `json:"name,required"`
	// The type of identity provider. To determine the value for a specific provider,
	// refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Type AccessIdentityProvidersAccessSamlType `json:"type,required"`
	// UUID
	ID string `json:"id"`
	// The configuration settings for enabling a System for Cross-Domain Identity
	// Management (SCIM) with the identity provider.
	ScimConfig AccessIdentityProvidersAccessSamlScimConfig `json:"scim_config"`
	JSON       accessIdentityProvidersAccessSamlJSON       `json:"-"`
}

func (*AccessIdentityProvidersAccessSaml) UnmarshalJSON 

func (r *AccessIdentityProvidersAccessSaml) UnmarshalJSON(data []byte) (err error)

type AccessIdentityProvidersAccessSamlConfig 

type AccessIdentityProvidersAccessSamlConfig struct {
	// A list of SAML attribute names that will be added to your signed JWT token and
	// can be used in SAML policy rules.
	Attributes []string `json:"attributes"`
	// The attribute name for email in the SAML response.
	EmailAttributeName string `json:"email_attribute_name"`
	// Add a list of attribute names that will be returned in the response header from
	// the Access callback.
	HeaderAttributes []AccessIdentityProvidersAccessSamlConfigHeaderAttribute `json:"header_attributes"`
	// X509 certificate to verify the signature in the SAML authentication response
	IdpPublicCerts []string `json:"idp_public_certs"`
	// IdP Entity ID or Issuer URL
	IssuerURL string `json:"issuer_url"`
	// Sign the SAML authentication request with Access credentials. To verify the
	// signature, use the public key from the Access certs endpoints.
	SignRequest bool `json:"sign_request"`
	// URL to send the SAML authentication requests to
	SSOTargetURL string                                      `json:"sso_target_url"`
	JSON         accessIdentityProvidersAccessSamlConfigJSON `json:"-"`
}

The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).

func (*AccessIdentityProvidersAccessSamlConfig) UnmarshalJSON 

func (r *AccessIdentityProvidersAccessSamlConfig) UnmarshalJSON(data []byte) (err error)

type AccessIdentityProvidersAccessSamlConfigHeaderAttribute 

type AccessIdentityProvidersAccessSamlConfigHeaderAttribute struct {
	// attribute name from the IDP
	AttributeName string `json:"attribute_name"`
	// header that will be added on the request to the origin
	HeaderName string                                                     `json:"header_name"`
	JSON       accessIdentityProvidersAccessSamlConfigHeaderAttributeJSON `json:"-"`
}

func (*AccessIdentityProvidersAccessSamlConfigHeaderAttribute) UnmarshalJSON 

func (r *AccessIdentityProvidersAccessSamlConfigHeaderAttribute) UnmarshalJSON(data []byte) (err error)

type AccessIdentityProvidersAccessSamlScimConfig 

type AccessIdentityProvidersAccessSamlScimConfig struct {
	// A flag to enable or disable SCIM for the identity provider.
	Enabled bool `json:"enabled"`
	// A flag to revoke a user's session in Access and force a reauthentication on the
	// user's Gateway session when they have been added or removed from a group in the
	// Identity Provider.
	GroupMemberDeprovision bool `json:"group_member_deprovision"`
	// A flag to remove a user's seat in Zero Trust when they have been deprovisioned
	// in the Identity Provider. This cannot be enabled unless user_deprovision is also
	// enabled.
	SeatDeprovision bool `json:"seat_deprovision"`
	// A read-only token generated when the SCIM integration is enabled for the first
	// time. It is redacted on subsequent requests. If you lose this you will need to
	// refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.
	Secret string `json:"secret"`
	// A flag to enable revoking a user's session in Access and Gateway when they have
	// been deprovisioned in the Identity Provider.
	UserDeprovision bool                                            `json:"user_deprovision"`
	JSON            accessIdentityProvidersAccessSamlScimConfigJSON `json:"-"`
}

The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.

func (*AccessIdentityProvidersAccessSamlScimConfig) UnmarshalJSON 

func (r *AccessIdentityProvidersAccessSamlScimConfig) UnmarshalJSON(data []byte) (err error)

type AccessIdentityProvidersAccessSamlType 

type AccessIdentityProvidersAccessSamlType string

The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). 

const (
	AccessIdentityProvidersAccessSamlTypeOnetimepin AccessIdentityProvidersAccessSamlType = "onetimepin"
	AccessIdentityProvidersAccessSamlTypeAzureAd    AccessIdentityProvidersAccessSamlType = "azureAD"
	AccessIdentityProvidersAccessSamlTypeSaml       AccessIdentityProvidersAccessSamlType = "saml"
	AccessIdentityProvidersAccessSamlTypeCentrify   AccessIdentityProvidersAccessSamlType = "centrify"
	AccessIdentityProvidersAccessSamlTypeFacebook   AccessIdentityProvidersAccessSamlType = "facebook"
	AccessIdentityProvidersAccessSamlTypeGitHub     AccessIdentityProvidersAccessSamlType = "github"
	AccessIdentityProvidersAccessSamlTypeGoogleApps AccessIdentityProvidersAccessSamlType = "google-apps"
	AccessIdentityProvidersAccessSamlTypeGoogle     AccessIdentityProvidersAccessSamlType = "google"
	AccessIdentityProvidersAccessSamlTypeLinkedin   AccessIdentityProvidersAccessSamlType = "linkedin"
	AccessIdentityProvidersAccessSamlTypeOidc       AccessIdentityProvidersAccessSamlType = "oidc"
	AccessIdentityProvidersAccessSamlTypeOkta       AccessIdentityProvidersAccessSamlType = "okta"
	AccessIdentityProvidersAccessSamlTypeOnelogin   AccessIdentityProvidersAccessSamlType = "onelogin"
	AccessIdentityProvidersAccessSamlTypePingone    AccessIdentityProvidersAccessSamlType = "pingone"
	AccessIdentityProvidersAccessSamlTypeYandex     AccessIdentityProvidersAccessSamlType = "yandex"
)

type AccessIdentityProvidersAccessYandex 

type AccessIdentityProvidersAccessYandex struct {
	// The configuration parameters for the identity provider. To view the required
	// parameters for a specific provider, refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Config AccessIdentityProvidersAccessYandexConfig `json:"config,required"`
	// The name of the identity provider, shown to users on the login page.
	Name string `json:"name,required"`
	// The type of identity provider. To determine the value for a specific provider,
	// refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Type AccessIdentityProvidersAccessYandexType `json:"type,required"`
	// UUID
	ID string `json:"id"`
	// The configuration settings for enabling a System for Cross-Domain Identity
	// Management (SCIM) with the identity provider.
	ScimConfig AccessIdentityProvidersAccessYandexScimConfig `json:"scim_config"`
	JSON       accessIdentityProvidersAccessYandexJSON       `json:"-"`
}

func (*AccessIdentityProvidersAccessYandex) UnmarshalJSON 

func (r *AccessIdentityProvidersAccessYandex) UnmarshalJSON(data []byte) (err error)

type AccessIdentityProvidersAccessYandexConfig 

type AccessIdentityProvidersAccessYandexConfig struct {
	// Your OAuth Client ID
	ClientID string `json:"client_id"`
	// Your OAuth Client Secret
	ClientSecret string                                        `json:"client_secret"`
	JSON         accessIdentityProvidersAccessYandexConfigJSON `json:"-"`
}

The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).

func (*AccessIdentityProvidersAccessYandexConfig) UnmarshalJSON 

func (r *AccessIdentityProvidersAccessYandexConfig) UnmarshalJSON(data []byte) (err error)

type AccessIdentityProvidersAccessYandexScimConfig 

type AccessIdentityProvidersAccessYandexScimConfig struct {
	// A flag to enable or disable SCIM for the identity provider.
	Enabled bool `json:"enabled"`
	// A flag to revoke a user's session in Access and force a reauthentication on the
	// user's Gateway session when they have been added or removed from a group in the
	// Identity Provider.
	GroupMemberDeprovision bool `json:"group_member_deprovision"`
	// A flag to remove a user's seat in Zero Trust when they have been deprovisioned
	// in the Identity Provider. This cannot be enabled unless user_deprovision is also
	// enabled.
	SeatDeprovision bool `json:"seat_deprovision"`
	// A read-only token generated when the SCIM integration is enabled for the first
	// time. It is redacted on subsequent requests. If you lose this you will need to
	// refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.
	Secret string `json:"secret"`
	// A flag to enable revoking a user's session in Access and Gateway when they have
	// been deprovisioned in the Identity Provider.
	UserDeprovision bool                                              `json:"user_deprovision"`
	JSON            accessIdentityProvidersAccessYandexScimConfigJSON `json:"-"`
}

The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.

func (*AccessIdentityProvidersAccessYandexScimConfig) UnmarshalJSON 

func (r *AccessIdentityProvidersAccessYandexScimConfig) UnmarshalJSON(data []byte) (err error)

type AccessIdentityProvidersAccessYandexType 

type AccessIdentityProvidersAccessYandexType string

The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). 

const (
	AccessIdentityProvidersAccessYandexTypeOnetimepin AccessIdentityProvidersAccessYandexType = "onetimepin"
	AccessIdentityProvidersAccessYandexTypeAzureAd    AccessIdentityProvidersAccessYandexType = "azureAD"
	AccessIdentityProvidersAccessYandexTypeSaml       AccessIdentityProvidersAccessYandexType = "saml"
	AccessIdentityProvidersAccessYandexTypeCentrify   AccessIdentityProvidersAccessYandexType = "centrify"
	AccessIdentityProvidersAccessYandexTypeFacebook   AccessIdentityProvidersAccessYandexType = "facebook"
	AccessIdentityProvidersAccessYandexTypeGitHub     AccessIdentityProvidersAccessYandexType = "github"
	AccessIdentityProvidersAccessYandexTypeGoogleApps AccessIdentityProvidersAccessYandexType = "google-apps"
	AccessIdentityProvidersAccessYandexTypeGoogle     AccessIdentityProvidersAccessYandexType = "google"
	AccessIdentityProvidersAccessYandexTypeLinkedin   AccessIdentityProvidersAccessYandexType = "linkedin"
	AccessIdentityProvidersAccessYandexTypeOidc       AccessIdentityProvidersAccessYandexType = "oidc"
	AccessIdentityProvidersAccessYandexTypeOkta       AccessIdentityProvidersAccessYandexType = "okta"
	AccessIdentityProvidersAccessYandexTypeOnelogin   AccessIdentityProvidersAccessYandexType = "onelogin"
	AccessIdentityProvidersAccessYandexTypePingone    AccessIdentityProvidersAccessYandexType = "pingone"
	AccessIdentityProvidersAccessYandexTypeYandex     AccessIdentityProvidersAccessYandexType = "yandex"
)

type AccessKeyListResponse 

type AccessKeyListResponse interface {
	ImplementsZeroTrustAccessKeyListResponse()
}

Union satisfied by zero_trust.AccessKeyListResponseUnknown or shared.UnionString.

type AccessKeyListResponseEnvelope 

type AccessKeyListResponseEnvelope struct {
	Errors   []AccessKeyListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessKeyListResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessKeyListResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success AccessKeyListResponseEnvelopeSuccess `json:"success,required"`
	// The number of days until the next key rotation.
	DaysUntilNextRotation float64 `json:"days_until_next_rotation"`
	// The number of days between key rotations.
	KeyRotationIntervalDays float64 `json:"key_rotation_interval_days"`
	// The timestamp of the previous key rotation.
	LastKeyRotationAt time.Time                         `json:"last_key_rotation_at" format:"date-time"`
	JSON              accessKeyListResponseEnvelopeJSON `json:"-"`
}

func (*AccessKeyListResponseEnvelope) UnmarshalJSON 

func (r *AccessKeyListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AccessKeyListResponseEnvelopeErrors 

type AccessKeyListResponseEnvelopeErrors struct {
	Code    int64                                   `json:"code,required"`
	Message string                                  `json:"message,required"`
	JSON    accessKeyListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessKeyListResponseEnvelopeErrors) UnmarshalJSON 

func (r *AccessKeyListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type AccessKeyListResponseEnvelopeMessages 

type AccessKeyListResponseEnvelopeMessages struct {
	Code    int64                                     `json:"code,required"`
	Message string                                    `json:"message,required"`
	JSON    accessKeyListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessKeyListResponseEnvelopeMessages) UnmarshalJSON 

func (r *AccessKeyListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type AccessKeyListResponseEnvelopeSuccess 

type AccessKeyListResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessKeyListResponseEnvelopeSuccessTrue AccessKeyListResponseEnvelopeSuccess = true
)

type AccessKeyRotateResponse 

type AccessKeyRotateResponse interface {
	ImplementsZeroTrustAccessKeyRotateResponse()
}

Union satisfied by zero_trust.AccessKeyRotateResponseUnknown or shared.UnionString.

type AccessKeyRotateResponseEnvelope 

type AccessKeyRotateResponseEnvelope struct {
	Errors   []AccessKeyRotateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessKeyRotateResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessKeyRotateResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success AccessKeyRotateResponseEnvelopeSuccess `json:"success,required"`
	// The number of days until the next key rotation.
	DaysUntilNextRotation float64 `json:"days_until_next_rotation"`
	// The number of days between key rotations.
	KeyRotationIntervalDays float64 `json:"key_rotation_interval_days"`
	// The timestamp of the previous key rotation.
	LastKeyRotationAt time.Time                           `json:"last_key_rotation_at" format:"date-time"`
	JSON              accessKeyRotateResponseEnvelopeJSON `json:"-"`
}

func (*AccessKeyRotateResponseEnvelope) UnmarshalJSON 

func (r *AccessKeyRotateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AccessKeyRotateResponseEnvelopeErrors 

type AccessKeyRotateResponseEnvelopeErrors struct {
	Code    int64                                     `json:"code,required"`
	Message string                                    `json:"message,required"`
	JSON    accessKeyRotateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessKeyRotateResponseEnvelopeErrors) UnmarshalJSON 

func (r *AccessKeyRotateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type AccessKeyRotateResponseEnvelopeMessages 

type AccessKeyRotateResponseEnvelopeMessages struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    accessKeyRotateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessKeyRotateResponseEnvelopeMessages) UnmarshalJSON 

func (r *AccessKeyRotateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type AccessKeyRotateResponseEnvelopeSuccess 

type AccessKeyRotateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessKeyRotateResponseEnvelopeSuccessTrue AccessKeyRotateResponseEnvelopeSuccess = true
)

type AccessKeyService 

type AccessKeyService struct {
	Options []option.RequestOption
}

AccessKeyService 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 NewAccessKeyService method instead.

func NewAccessKeyService 

func NewAccessKeyService(opts ...option.RequestOption) (r *AccessKeyService)

NewAccessKeyService 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 (*AccessKeyService) List 

func (r *AccessKeyService) List(ctx context.Context, identifier string, opts ...option.RequestOption) (res *AccessKeyListResponse, err error)

Gets the Access key rotation settings for an account.

func (*AccessKeyService) Rotate 

func (r *AccessKeyService) Rotate(ctx context.Context, identifier string, opts ...option.RequestOption) (res *AccessKeyRotateResponse, err error)

Perfoms a key rotation for an account.

func (*AccessKeyService) Update 

func (r *AccessKeyService) Update(ctx context.Context, identifier string, body AccessKeyUpdateParams, opts ...option.RequestOption) (res *AccessKeyUpdateResponse, err error)

Updates the Access key rotation settings for an account.

type AccessKeyUpdateParams 

type AccessKeyUpdateParams struct {
	// The number of days between key rotations.
	KeyRotationIntervalDays param.Field[float64] `json:"key_rotation_interval_days,required"`
}

func (AccessKeyUpdateParams) MarshalJSON 

func (r AccessKeyUpdateParams) MarshalJSON() (data []byte, err error)

type AccessKeyUpdateResponse 

type AccessKeyUpdateResponse interface {
	ImplementsZeroTrustAccessKeyUpdateResponse()
}

Union satisfied by zero_trust.AccessKeyUpdateResponseUnknown or shared.UnionString.

type AccessKeyUpdateResponseEnvelope 

type AccessKeyUpdateResponseEnvelope struct {
	Errors   []AccessKeyUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessKeyUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessKeyUpdateResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success AccessKeyUpdateResponseEnvelopeSuccess `json:"success,required"`
	// The number of days until the next key rotation.
	DaysUntilNextRotation float64 `json:"days_until_next_rotation"`
	// The number of days between key rotations.
	KeyRotationIntervalDays float64 `json:"key_rotation_interval_days"`
	// The timestamp of the previous key rotation.
	LastKeyRotationAt time.Time                           `json:"last_key_rotation_at" format:"date-time"`
	JSON              accessKeyUpdateResponseEnvelopeJSON `json:"-"`
}

func (*AccessKeyUpdateResponseEnvelope) UnmarshalJSON 

func (r *AccessKeyUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AccessKeyUpdateResponseEnvelopeErrors 

type AccessKeyUpdateResponseEnvelopeErrors struct {
	Code    int64                                     `json:"code,required"`
	Message string                                    `json:"message,required"`
	JSON    accessKeyUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessKeyUpdateResponseEnvelopeErrors) UnmarshalJSON 

func (r *AccessKeyUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type AccessKeyUpdateResponseEnvelopeMessages 

type AccessKeyUpdateResponseEnvelopeMessages struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    accessKeyUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessKeyUpdateResponseEnvelopeMessages) UnmarshalJSON 

func (r *AccessKeyUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type AccessKeyUpdateResponseEnvelopeSuccess 

type AccessKeyUpdateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessKeyUpdateResponseEnvelopeSuccessTrue AccessKeyUpdateResponseEnvelopeSuccess = true
)

type AccessLogAccessRequestListResponseEnvelope 

type AccessLogAccessRequestListResponseEnvelope struct {
	Errors   []AccessLogAccessRequestListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessLogAccessRequestListResponseEnvelopeMessages `json:"messages,required"`
	Result   []AccessAccessRequests                               `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    AccessLogAccessRequestListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo AccessLogAccessRequestListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       accessLogAccessRequestListResponseEnvelopeJSON       `json:"-"`
}

func (*AccessLogAccessRequestListResponseEnvelope) UnmarshalJSON 

func (r *AccessLogAccessRequestListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AccessLogAccessRequestListResponseEnvelopeErrors 

type AccessLogAccessRequestListResponseEnvelopeErrors struct {
	Code    int64                                                `json:"code,required"`
	Message string                                               `json:"message,required"`
	JSON    accessLogAccessRequestListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessLogAccessRequestListResponseEnvelopeErrors) UnmarshalJSON 

func (r *AccessLogAccessRequestListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type AccessLogAccessRequestListResponseEnvelopeMessages 

type AccessLogAccessRequestListResponseEnvelopeMessages struct {
	Code    int64                                                  `json:"code,required"`
	Message string                                                 `json:"message,required"`
	JSON    accessLogAccessRequestListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessLogAccessRequestListResponseEnvelopeMessages) UnmarshalJSON 

func (r *AccessLogAccessRequestListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type AccessLogAccessRequestListResponseEnvelopeResultInfo 

type AccessLogAccessRequestListResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                                  `json:"total_count"`
	JSON       accessLogAccessRequestListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*AccessLogAccessRequestListResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *AccessLogAccessRequestListResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type AccessLogAccessRequestListResponseEnvelopeSuccess 

type AccessLogAccessRequestListResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessLogAccessRequestListResponseEnvelopeSuccessTrue AccessLogAccessRequestListResponseEnvelopeSuccess = true
)

type AccessLogAccessRequestService 

type AccessLogAccessRequestService struct {
	Options []option.RequestOption
}

AccessLogAccessRequestService 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 NewAccessLogAccessRequestService method instead.

func NewAccessLogAccessRequestService 

func NewAccessLogAccessRequestService(opts ...option.RequestOption) (r *AccessLogAccessRequestService)

NewAccessLogAccessRequestService 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 (*AccessLogAccessRequestService) List 

func (r *AccessLogAccessRequestService) List(ctx context.Context, identifier string, opts ...option.RequestOption) (res *[]AccessAccessRequests, err error)

Gets a list of Access authentication audit logs for an account.

type AccessLogService 

type AccessLogService struct {
	Options        []option.RequestOption
	AccessRequests *AccessLogAccessRequestService
}

AccessLogService 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 NewAccessLogService method instead.

func NewAccessLogService 

func NewAccessLogService(opts ...option.RequestOption) (r *AccessLogService)

NewAccessLogService 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 AccessOrganizations 

type AccessOrganizations struct {
	// When set to true, users can authenticate via WARP for any application in your
	// organization. Application settings will take precedence over this value.
	AllowAuthenticateViaWARP bool `json:"allow_authenticate_via_warp"`
	// The unique subdomain assigned to your Zero Trust organization.
	AuthDomain string `json:"auth_domain"`
	// When set to `true`, users skip the identity provider selection step during
	// login.
	AutoRedirectToIdentity bool                           `json:"auto_redirect_to_identity"`
	CreatedAt              time.Time                      `json:"created_at" format:"date-time"`
	CustomPages            AccessOrganizationsCustomPages `json:"custom_pages"`
	// Lock all settings as Read-Only in the Dashboard, regardless of user permission.
	// Updates may only be made via the API or Terraform for this account when enabled.
	IsUiReadOnly bool                           `json:"is_ui_read_only"`
	LoginDesign  AccessOrganizationsLoginDesign `json:"login_design"`
	// The name of your Zero Trust organization.
	Name string `json:"name"`
	// The amount of time that tokens issued for applications will be valid. Must be in
	// the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m,
	// h.
	SessionDuration string `json:"session_duration"`
	// A description of the reason why the UI read only field is being toggled.
	UiReadOnlyToggleReason string    `json:"ui_read_only_toggle_reason"`
	UpdatedAt              time.Time `json:"updated_at" format:"date-time"`
	// The amount of time a user seat is inactive before it expires. When the user seat
	// exceeds the set time of inactivity, the user is removed as an active seat and no
	// longer counts against your Teams seat count. Must be in the format `300ms` or
	// `2h45m`. Valid time units are: `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`.
	UserSeatExpirationInactiveTime string `json:"user_seat_expiration_inactive_time"`
	// The amount of time that tokens issued for applications will be valid. Must be in
	// the format `30m` or `2h45m`. Valid time units are: m, h.
	WARPAuthSessionDuration string                  `json:"warp_auth_session_duration"`
	JSON                    accessOrganizationsJSON `json:"-"`
}

func (*AccessOrganizations) UnmarshalJSON 

func (r *AccessOrganizations) UnmarshalJSON(data []byte) (err error)

type AccessOrganizationsCustomPages 

type AccessOrganizationsCustomPages struct {
	// The uid of the custom page to use when a user is denied access after failing a
	// non-identity rule.
	Forbidden string `json:"forbidden"`
	// The uid of the custom page to use when a user is denied access.
	IdentityDenied string                             `json:"identity_denied"`
	JSON           accessOrganizationsCustomPagesJSON `json:"-"`
}

func (*AccessOrganizationsCustomPages) UnmarshalJSON 

func (r *AccessOrganizationsCustomPages) UnmarshalJSON(data []byte) (err error)

type AccessOrganizationsLoginDesign 

type AccessOrganizationsLoginDesign struct {
	// The background color on your login page.
	BackgroundColor string `json:"background_color"`
	// The text at the bottom of your login page.
	FooterText string `json:"footer_text"`
	// The text at the top of your login page.
	HeaderText string `json:"header_text"`
	// The URL of the logo on your login page.
	LogoPath string `json:"logo_path"`
	// The text color on your login page.
	TextColor string                             `json:"text_color"`
	JSON      accessOrganizationsLoginDesignJSON `json:"-"`
}

func (*AccessOrganizationsLoginDesign) UnmarshalJSON 

func (r *AccessOrganizationsLoginDesign) UnmarshalJSON(data []byte) (err error)

type AccessPolicies 

type AccessPolicies struct {
	// UUID
	ID string `json:"id"`
	// Administrators who can approve a temporary authentication request.
	ApprovalGroups []AccessPoliciesApprovalGroup `json:"approval_groups"`
	// Requires the user to request access from an administrator at the start of each
	// session.
	ApprovalRequired bool      `json:"approval_required"`
	CreatedAt        time.Time `json:"created_at" format:"date-time"`
	// The action Access will take if a user matches this policy.
	Decision AccessPoliciesDecision `json:"decision"`
	// Rules evaluated with a NOT logical operator. To match the policy, a user cannot
	// meet any of the Exclude rules.
	Exclude []AccessPoliciesExclude `json:"exclude"`
	// Rules evaluated with an OR logical operator. A user needs to meet only one of
	// the Include rules.
	Include []AccessPoliciesInclude `json:"include"`
	// Require this application to be served in an isolated browser for users matching
	// this policy. 'Client Web Isolation' must be on for the account in order to use
	// this feature.
	IsolationRequired bool `json:"isolation_required"`
	// The name of the Access policy.
	Name string `json:"name"`
	// The order of execution for this policy. Must be unique for each policy.
	Precedence int64 `json:"precedence"`
	// A custom message that will appear on the purpose justification screen.
	PurposeJustificationPrompt string `json:"purpose_justification_prompt"`
	// Require users to enter a justification when they log in to the application.
	PurposeJustificationRequired bool `json:"purpose_justification_required"`
	// Rules evaluated with an AND logical operator. To match the policy, a user must
	// meet all of the Require rules.
	Require []AccessPoliciesRequire `json:"require"`
	// The amount of time that tokens issued for the application will be valid. Must be
	// in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s,
	// m, h.
	SessionDuration string             `json:"session_duration"`
	UpdatedAt       time.Time          `json:"updated_at" format:"date-time"`
	JSON            accessPoliciesJSON `json:"-"`
}

func (*AccessPolicies) UnmarshalJSON 

func (r *AccessPolicies) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesApprovalGroup 

type AccessPoliciesApprovalGroup struct {
	// The number of approvals needed to obtain access.
	ApprovalsNeeded float64 `json:"approvals_needed,required"`
	// A list of emails that can approve the access request.
	EmailAddresses []interface{} `json:"email_addresses"`
	// The UUID of an re-usable email list.
	EmailListUUID string                          `json:"email_list_uuid"`
	JSON          accessPoliciesApprovalGroupJSON `json:"-"`
}

A group of email addresses that can approve a temporary authentication request.

func (*AccessPoliciesApprovalGroup) UnmarshalJSON 

func (r *AccessPoliciesApprovalGroup) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesDecision 

type AccessPoliciesDecision string

The action Access will take if a user matches this policy. 

const (
	AccessPoliciesDecisionAllow       AccessPoliciesDecision = "allow"
	AccessPoliciesDecisionDeny        AccessPoliciesDecision = "deny"
	AccessPoliciesDecisionNonIdentity AccessPoliciesDecision = "non_identity"
	AccessPoliciesDecisionBypass      AccessPoliciesDecision = "bypass"
)

type AccessPoliciesExclude 

type AccessPoliciesExclude interface {
	// contains filtered or unexported methods
}

Matches a specific email.

Union satisfied by zero_trust.AccessPoliciesExcludeAccessEmailRule, zero_trust.AccessPoliciesExcludeAccessEmailListRule, zero_trust.AccessPoliciesExcludeAccessDomainRule, zero_trust.AccessPoliciesExcludeAccessEveryoneRule, zero_trust.AccessPoliciesExcludeAccessIPRule, zero_trust.AccessPoliciesExcludeAccessIPListRule, zero_trust.AccessPoliciesExcludeAccessCertificateRule, zero_trust.AccessPoliciesExcludeAccessAccessGroupRule, zero_trust.AccessPoliciesExcludeAccessAzureGroupRule, zero_trust.AccessPoliciesExcludeAccessGitHubOrganizationRule, zero_trust.AccessPoliciesExcludeAccessGsuiteGroupRule, zero_trust.AccessPoliciesExcludeAccessOktaGroupRule, zero_trust.AccessPoliciesExcludeAccessSamlGroupRule, zero_trust.AccessPoliciesExcludeAccessServiceTokenRule, zero_trust.AccessPoliciesExcludeAccessAnyValidServiceTokenRule, zero_trust.AccessPoliciesExcludeAccessExternalEvaluationRule, zero_trust.AccessPoliciesExcludeAccessCountryRule, zero_trust.AccessPoliciesExcludeAccessAuthenticationMethodRule or zero_trust.AccessPoliciesExcludeAccessDevicePostureRule.

type AccessPoliciesExcludeAccessAccessGroupRule 

type AccessPoliciesExcludeAccessAccessGroupRule struct {
	Group AccessPoliciesExcludeAccessAccessGroupRuleGroup `json:"group,required"`
	JSON  accessPoliciesExcludeAccessAccessGroupRuleJSON  `json:"-"`
}

Matches an Access group.

func (*AccessPoliciesExcludeAccessAccessGroupRule) UnmarshalJSON 

func (r *AccessPoliciesExcludeAccessAccessGroupRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesExcludeAccessAccessGroupRuleGroup 

type AccessPoliciesExcludeAccessAccessGroupRuleGroup struct {
	// The ID of a previously created Access group.
	ID   string                                              `json:"id,required"`
	JSON accessPoliciesExcludeAccessAccessGroupRuleGroupJSON `json:"-"`
}

func (*AccessPoliciesExcludeAccessAccessGroupRuleGroup) UnmarshalJSON 

func (r *AccessPoliciesExcludeAccessAccessGroupRuleGroup) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesExcludeAccessAnyValidServiceTokenRule 

type AccessPoliciesExcludeAccessAnyValidServiceTokenRule struct {
	// An empty object which matches on all service tokens.
	AnyValidServiceToken interface{}                                             `json:"any_valid_service_token,required"`
	JSON                 accessPoliciesExcludeAccessAnyValidServiceTokenRuleJSON `json:"-"`
}

Matches any valid Access Service Token

func (*AccessPoliciesExcludeAccessAnyValidServiceTokenRule) UnmarshalJSON 

func (r *AccessPoliciesExcludeAccessAnyValidServiceTokenRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesExcludeAccessAuthenticationMethodRule 

type AccessPoliciesExcludeAccessAuthenticationMethodRule struct {
	AuthMethod AccessPoliciesExcludeAccessAuthenticationMethodRuleAuthMethod `json:"auth_method,required"`
	JSON       accessPoliciesExcludeAccessAuthenticationMethodRuleJSON       `json:"-"`
}

Enforce different MFA options

func (*AccessPoliciesExcludeAccessAuthenticationMethodRule) UnmarshalJSON 

func (r *AccessPoliciesExcludeAccessAuthenticationMethodRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesExcludeAccessAuthenticationMethodRuleAuthMethod 

type AccessPoliciesExcludeAccessAuthenticationMethodRuleAuthMethod struct {
	// The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
	AuthMethod string                                                            `json:"auth_method,required"`
	JSON       accessPoliciesExcludeAccessAuthenticationMethodRuleAuthMethodJSON `json:"-"`
}

func (*AccessPoliciesExcludeAccessAuthenticationMethodRuleAuthMethod) UnmarshalJSON 

func (r *AccessPoliciesExcludeAccessAuthenticationMethodRuleAuthMethod) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesExcludeAccessAzureGroupRule 

type AccessPoliciesExcludeAccessAzureGroupRule struct {
	AzureAd AccessPoliciesExcludeAccessAzureGroupRuleAzureAd `json:"azureAD,required"`
	JSON    accessPoliciesExcludeAccessAzureGroupRuleJSON    `json:"-"`
}

Matches an Azure group. Requires an Azure identity provider.

func (*AccessPoliciesExcludeAccessAzureGroupRule) UnmarshalJSON 

func (r *AccessPoliciesExcludeAccessAzureGroupRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesExcludeAccessAzureGroupRuleAzureAd 

type AccessPoliciesExcludeAccessAzureGroupRuleAzureAd struct {
	// The ID of an Azure group.
	ID string `json:"id,required"`
	// The ID of your Azure identity provider.
	ConnectionID string                                               `json:"connection_id,required"`
	JSON         accessPoliciesExcludeAccessAzureGroupRuleAzureAdJSON `json:"-"`
}

func (*AccessPoliciesExcludeAccessAzureGroupRuleAzureAd) UnmarshalJSON 

func (r *AccessPoliciesExcludeAccessAzureGroupRuleAzureAd) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesExcludeAccessCertificateRule 

type AccessPoliciesExcludeAccessCertificateRule struct {
	Certificate interface{}                                    `json:"certificate,required"`
	JSON        accessPoliciesExcludeAccessCertificateRuleJSON `json:"-"`
}

Matches any valid client certificate.

func (*AccessPoliciesExcludeAccessCertificateRule) UnmarshalJSON 

func (r *AccessPoliciesExcludeAccessCertificateRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesExcludeAccessCountryRule 

type AccessPoliciesExcludeAccessCountryRule struct {
	Geo  AccessPoliciesExcludeAccessCountryRuleGeo  `json:"geo,required"`
	JSON accessPoliciesExcludeAccessCountryRuleJSON `json:"-"`
}

Matches a specific country

func (*AccessPoliciesExcludeAccessCountryRule) UnmarshalJSON 

func (r *AccessPoliciesExcludeAccessCountryRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesExcludeAccessCountryRuleGeo 

type AccessPoliciesExcludeAccessCountryRuleGeo struct {
	// The country code that should be matched.
	CountryCode string                                        `json:"country_code,required"`
	JSON        accessPoliciesExcludeAccessCountryRuleGeoJSON `json:"-"`
}

func (*AccessPoliciesExcludeAccessCountryRuleGeo) UnmarshalJSON 

func (r *AccessPoliciesExcludeAccessCountryRuleGeo) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesExcludeAccessDevicePostureRule 

type AccessPoliciesExcludeAccessDevicePostureRule struct {
	DevicePosture AccessPoliciesExcludeAccessDevicePostureRuleDevicePosture `json:"device_posture,required"`
	JSON          accessPoliciesExcludeAccessDevicePostureRuleJSON          `json:"-"`
}

Enforces a device posture rule has run successfully

func (*AccessPoliciesExcludeAccessDevicePostureRule) UnmarshalJSON 

func (r *AccessPoliciesExcludeAccessDevicePostureRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesExcludeAccessDevicePostureRuleDevicePosture 

type AccessPoliciesExcludeAccessDevicePostureRuleDevicePosture struct {
	// The ID of a device posture integration.
	IntegrationUid string                                                        `json:"integration_uid,required"`
	JSON           accessPoliciesExcludeAccessDevicePostureRuleDevicePostureJSON `json:"-"`
}

func (*AccessPoliciesExcludeAccessDevicePostureRuleDevicePosture) UnmarshalJSON 

func (r *AccessPoliciesExcludeAccessDevicePostureRuleDevicePosture) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesExcludeAccessDomainRule 

type AccessPoliciesExcludeAccessDomainRule struct {
	EmailDomain AccessPoliciesExcludeAccessDomainRuleEmailDomain `json:"email_domain,required"`
	JSON        accessPoliciesExcludeAccessDomainRuleJSON        `json:"-"`
}

Match an entire email domain.

func (*AccessPoliciesExcludeAccessDomainRule) UnmarshalJSON 

func (r *AccessPoliciesExcludeAccessDomainRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesExcludeAccessDomainRuleEmailDomain 

type AccessPoliciesExcludeAccessDomainRuleEmailDomain struct {
	// The email domain to match.
	Domain string                                               `json:"domain,required"`
	JSON   accessPoliciesExcludeAccessDomainRuleEmailDomainJSON `json:"-"`
}

func (*AccessPoliciesExcludeAccessDomainRuleEmailDomain) UnmarshalJSON 

func (r *AccessPoliciesExcludeAccessDomainRuleEmailDomain) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesExcludeAccessEmailListRule 

type AccessPoliciesExcludeAccessEmailListRule struct {
	EmailList AccessPoliciesExcludeAccessEmailListRuleEmailList `json:"email_list,required"`
	JSON      accessPoliciesExcludeAccessEmailListRuleJSON      `json:"-"`
}

Matches an email address from a list.

func (*AccessPoliciesExcludeAccessEmailListRule) UnmarshalJSON 

func (r *AccessPoliciesExcludeAccessEmailListRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesExcludeAccessEmailListRuleEmailList 

type AccessPoliciesExcludeAccessEmailListRuleEmailList struct {
	// The ID of a previously created email list.
	ID   string                                                `json:"id,required"`
	JSON accessPoliciesExcludeAccessEmailListRuleEmailListJSON `json:"-"`
}

func (*AccessPoliciesExcludeAccessEmailListRuleEmailList) UnmarshalJSON 

func (r *AccessPoliciesExcludeAccessEmailListRuleEmailList) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesExcludeAccessEmailRule 

type AccessPoliciesExcludeAccessEmailRule struct {
	Email AccessPoliciesExcludeAccessEmailRuleEmail `json:"email,required"`
	JSON  accessPoliciesExcludeAccessEmailRuleJSON  `json:"-"`
}

Matches a specific email.

func (*AccessPoliciesExcludeAccessEmailRule) UnmarshalJSON 

func (r *AccessPoliciesExcludeAccessEmailRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesExcludeAccessEmailRuleEmail 

type AccessPoliciesExcludeAccessEmailRuleEmail struct {
	// The email of the user.
	Email string                                        `json:"email,required" format:"email"`
	JSON  accessPoliciesExcludeAccessEmailRuleEmailJSON `json:"-"`
}

func (*AccessPoliciesExcludeAccessEmailRuleEmail) UnmarshalJSON 

func (r *AccessPoliciesExcludeAccessEmailRuleEmail) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesExcludeAccessEveryoneRule 

type AccessPoliciesExcludeAccessEveryoneRule struct {
	// An empty object which matches on all users.
	Everyone interface{}                                 `json:"everyone,required"`
	JSON     accessPoliciesExcludeAccessEveryoneRuleJSON `json:"-"`
}

Matches everyone.

func (*AccessPoliciesExcludeAccessEveryoneRule) UnmarshalJSON 

func (r *AccessPoliciesExcludeAccessEveryoneRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesExcludeAccessExternalEvaluationRule 

type AccessPoliciesExcludeAccessExternalEvaluationRule struct {
	ExternalEvaluation AccessPoliciesExcludeAccessExternalEvaluationRuleExternalEvaluation `json:"external_evaluation,required"`
	JSON               accessPoliciesExcludeAccessExternalEvaluationRuleJSON               `json:"-"`
}

Create Allow or Block policies which evaluate the user based on custom criteria.

func (*AccessPoliciesExcludeAccessExternalEvaluationRule) UnmarshalJSON 

func (r *AccessPoliciesExcludeAccessExternalEvaluationRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesExcludeAccessExternalEvaluationRuleExternalEvaluation 

type AccessPoliciesExcludeAccessExternalEvaluationRuleExternalEvaluation struct {
	// The API endpoint containing your business logic.
	EvaluateURL string `json:"evaluate_url,required"`
	// The API endpoint containing the key that Access uses to verify that the response
	// came from your API.
	KeysURL string                                                                  `json:"keys_url,required"`
	JSON    accessPoliciesExcludeAccessExternalEvaluationRuleExternalEvaluationJSON `json:"-"`
}

func (*AccessPoliciesExcludeAccessExternalEvaluationRuleExternalEvaluation) UnmarshalJSON 

func (r *AccessPoliciesExcludeAccessExternalEvaluationRuleExternalEvaluation) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesExcludeAccessGitHubOrganizationRule 

type AccessPoliciesExcludeAccessGitHubOrganizationRule struct {
	GitHubOrganization AccessPoliciesExcludeAccessGitHubOrganizationRuleGitHubOrganization `json:"github-organization,required"`
	JSON               accessPoliciesExcludeAccessGitHubOrganizationRuleJSON               `json:"-"`
}

Matches a Github organization. Requires a Github identity provider.

func (*AccessPoliciesExcludeAccessGitHubOrganizationRule) UnmarshalJSON 

func (r *AccessPoliciesExcludeAccessGitHubOrganizationRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesExcludeAccessGitHubOrganizationRuleGitHubOrganization 

type AccessPoliciesExcludeAccessGitHubOrganizationRuleGitHubOrganization struct {
	// The ID of your Github identity provider.
	ConnectionID string `json:"connection_id,required"`
	// The name of the organization.
	Name string                                                                  `json:"name,required"`
	JSON accessPoliciesExcludeAccessGitHubOrganizationRuleGitHubOrganizationJSON `json:"-"`
}

func (*AccessPoliciesExcludeAccessGitHubOrganizationRuleGitHubOrganization) UnmarshalJSON 

func (r *AccessPoliciesExcludeAccessGitHubOrganizationRuleGitHubOrganization) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesExcludeAccessGsuiteGroupRule 

type AccessPoliciesExcludeAccessGsuiteGroupRule struct {
	Gsuite AccessPoliciesExcludeAccessGsuiteGroupRuleGsuite `json:"gsuite,required"`
	JSON   accessPoliciesExcludeAccessGsuiteGroupRuleJSON   `json:"-"`
}

Matches a group in Google Workspace. Requires a Google Workspace identity provider.

func (*AccessPoliciesExcludeAccessGsuiteGroupRule) UnmarshalJSON 

func (r *AccessPoliciesExcludeAccessGsuiteGroupRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesExcludeAccessGsuiteGroupRuleGsuite 

type AccessPoliciesExcludeAccessGsuiteGroupRuleGsuite struct {
	// The ID of your Google Workspace identity provider.
	ConnectionID string `json:"connection_id,required"`
	// The email of the Google Workspace group.
	Email string                                               `json:"email,required"`
	JSON  accessPoliciesExcludeAccessGsuiteGroupRuleGsuiteJSON `json:"-"`
}

func (*AccessPoliciesExcludeAccessGsuiteGroupRuleGsuite) UnmarshalJSON 

func (r *AccessPoliciesExcludeAccessGsuiteGroupRuleGsuite) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesExcludeAccessIPListRule 

type AccessPoliciesExcludeAccessIPListRule struct {
	IPList AccessPoliciesExcludeAccessIPListRuleIPList `json:"ip_list,required"`
	JSON   accessPoliciesExcludeAccessIPListRuleJSON   `json:"-"`
}

Matches an IP address from a list.

func (*AccessPoliciesExcludeAccessIPListRule) UnmarshalJSON 

func (r *AccessPoliciesExcludeAccessIPListRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesExcludeAccessIPListRuleIPList 

type AccessPoliciesExcludeAccessIPListRuleIPList struct {
	// The ID of a previously created IP list.
	ID   string                                          `json:"id,required"`
	JSON accessPoliciesExcludeAccessIPListRuleIPListJSON `json:"-"`
}

func (*AccessPoliciesExcludeAccessIPListRuleIPList) UnmarshalJSON 

func (r *AccessPoliciesExcludeAccessIPListRuleIPList) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesExcludeAccessIPRule 

type AccessPoliciesExcludeAccessIPRule struct {
	IP   AccessPoliciesExcludeAccessIPRuleIP   `json:"ip,required"`
	JSON accessPoliciesExcludeAccessIPRuleJSON `json:"-"`
}

Matches an IP address block.

func (*AccessPoliciesExcludeAccessIPRule) UnmarshalJSON 

func (r *AccessPoliciesExcludeAccessIPRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesExcludeAccessIPRuleIP 

type AccessPoliciesExcludeAccessIPRuleIP struct {
	// An IPv4 or IPv6 CIDR block.
	IP   string                                  `json:"ip,required"`
	JSON accessPoliciesExcludeAccessIPRuleIPJSON `json:"-"`
}

func (*AccessPoliciesExcludeAccessIPRuleIP) UnmarshalJSON 

func (r *AccessPoliciesExcludeAccessIPRuleIP) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesExcludeAccessOktaGroupRule 

type AccessPoliciesExcludeAccessOktaGroupRule struct {
	Okta AccessPoliciesExcludeAccessOktaGroupRuleOkta `json:"okta,required"`
	JSON accessPoliciesExcludeAccessOktaGroupRuleJSON `json:"-"`
}

Matches an Okta group. Requires an Okta identity provider.

func (*AccessPoliciesExcludeAccessOktaGroupRule) UnmarshalJSON 

func (r *AccessPoliciesExcludeAccessOktaGroupRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesExcludeAccessOktaGroupRuleOkta 

type AccessPoliciesExcludeAccessOktaGroupRuleOkta struct {
	// The ID of your Okta identity provider.
	ConnectionID string `json:"connection_id,required"`
	// The email of the Okta group.
	Email string                                           `json:"email,required"`
	JSON  accessPoliciesExcludeAccessOktaGroupRuleOktaJSON `json:"-"`
}

func (*AccessPoliciesExcludeAccessOktaGroupRuleOkta) UnmarshalJSON 

func (r *AccessPoliciesExcludeAccessOktaGroupRuleOkta) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesExcludeAccessSamlGroupRule 

type AccessPoliciesExcludeAccessSamlGroupRule struct {
	Saml AccessPoliciesExcludeAccessSamlGroupRuleSaml `json:"saml,required"`
	JSON accessPoliciesExcludeAccessSamlGroupRuleJSON `json:"-"`
}

Matches a SAML group. Requires a SAML identity provider.

func (*AccessPoliciesExcludeAccessSamlGroupRule) UnmarshalJSON 

func (r *AccessPoliciesExcludeAccessSamlGroupRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesExcludeAccessSamlGroupRuleSaml 

type AccessPoliciesExcludeAccessSamlGroupRuleSaml struct {
	// The name of the SAML attribute.
	AttributeName string `json:"attribute_name,required"`
	// The SAML attribute value to look for.
	AttributeValue string                                           `json:"attribute_value,required"`
	JSON           accessPoliciesExcludeAccessSamlGroupRuleSamlJSON `json:"-"`
}

func (*AccessPoliciesExcludeAccessSamlGroupRuleSaml) UnmarshalJSON 

func (r *AccessPoliciesExcludeAccessSamlGroupRuleSaml) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesExcludeAccessServiceTokenRule 

type AccessPoliciesExcludeAccessServiceTokenRule struct {
	ServiceToken AccessPoliciesExcludeAccessServiceTokenRuleServiceToken `json:"service_token,required"`
	JSON         accessPoliciesExcludeAccessServiceTokenRuleJSON         `json:"-"`
}

Matches a specific Access Service Token

func (*AccessPoliciesExcludeAccessServiceTokenRule) UnmarshalJSON 

func (r *AccessPoliciesExcludeAccessServiceTokenRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesExcludeAccessServiceTokenRuleServiceToken 

type AccessPoliciesExcludeAccessServiceTokenRuleServiceToken struct {
	// The ID of a Service Token.
	TokenID string                                                      `json:"token_id,required"`
	JSON    accessPoliciesExcludeAccessServiceTokenRuleServiceTokenJSON `json:"-"`
}

func (*AccessPoliciesExcludeAccessServiceTokenRuleServiceToken) UnmarshalJSON 

func (r *AccessPoliciesExcludeAccessServiceTokenRuleServiceToken) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesInclude 

type AccessPoliciesInclude interface {
	// contains filtered or unexported methods
}

Matches a specific email.

Union satisfied by zero_trust.AccessPoliciesIncludeAccessEmailRule, zero_trust.AccessPoliciesIncludeAccessEmailListRule, zero_trust.AccessPoliciesIncludeAccessDomainRule, zero_trust.AccessPoliciesIncludeAccessEveryoneRule, zero_trust.AccessPoliciesIncludeAccessIPRule, zero_trust.AccessPoliciesIncludeAccessIPListRule, zero_trust.AccessPoliciesIncludeAccessCertificateRule, zero_trust.AccessPoliciesIncludeAccessAccessGroupRule, zero_trust.AccessPoliciesIncludeAccessAzureGroupRule, zero_trust.AccessPoliciesIncludeAccessGitHubOrganizationRule, zero_trust.AccessPoliciesIncludeAccessGsuiteGroupRule, zero_trust.AccessPoliciesIncludeAccessOktaGroupRule, zero_trust.AccessPoliciesIncludeAccessSamlGroupRule, zero_trust.AccessPoliciesIncludeAccessServiceTokenRule, zero_trust.AccessPoliciesIncludeAccessAnyValidServiceTokenRule, zero_trust.AccessPoliciesIncludeAccessExternalEvaluationRule, zero_trust.AccessPoliciesIncludeAccessCountryRule, zero_trust.AccessPoliciesIncludeAccessAuthenticationMethodRule or zero_trust.AccessPoliciesIncludeAccessDevicePostureRule.

type AccessPoliciesIncludeAccessAccessGroupRule 

type AccessPoliciesIncludeAccessAccessGroupRule struct {
	Group AccessPoliciesIncludeAccessAccessGroupRuleGroup `json:"group,required"`
	JSON  accessPoliciesIncludeAccessAccessGroupRuleJSON  `json:"-"`
}

Matches an Access group.

func (*AccessPoliciesIncludeAccessAccessGroupRule) UnmarshalJSON 

func (r *AccessPoliciesIncludeAccessAccessGroupRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesIncludeAccessAccessGroupRuleGroup 

type AccessPoliciesIncludeAccessAccessGroupRuleGroup struct {
	// The ID of a previously created Access group.
	ID   string                                              `json:"id,required"`
	JSON accessPoliciesIncludeAccessAccessGroupRuleGroupJSON `json:"-"`
}

func (*AccessPoliciesIncludeAccessAccessGroupRuleGroup) UnmarshalJSON 

func (r *AccessPoliciesIncludeAccessAccessGroupRuleGroup) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesIncludeAccessAnyValidServiceTokenRule 

type AccessPoliciesIncludeAccessAnyValidServiceTokenRule struct {
	// An empty object which matches on all service tokens.
	AnyValidServiceToken interface{}                                             `json:"any_valid_service_token,required"`
	JSON                 accessPoliciesIncludeAccessAnyValidServiceTokenRuleJSON `json:"-"`
}

Matches any valid Access Service Token

func (*AccessPoliciesIncludeAccessAnyValidServiceTokenRule) UnmarshalJSON 

func (r *AccessPoliciesIncludeAccessAnyValidServiceTokenRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesIncludeAccessAuthenticationMethodRule 

type AccessPoliciesIncludeAccessAuthenticationMethodRule struct {
	AuthMethod AccessPoliciesIncludeAccessAuthenticationMethodRuleAuthMethod `json:"auth_method,required"`
	JSON       accessPoliciesIncludeAccessAuthenticationMethodRuleJSON       `json:"-"`
}

Enforce different MFA options

func (*AccessPoliciesIncludeAccessAuthenticationMethodRule) UnmarshalJSON 

func (r *AccessPoliciesIncludeAccessAuthenticationMethodRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesIncludeAccessAuthenticationMethodRuleAuthMethod 

type AccessPoliciesIncludeAccessAuthenticationMethodRuleAuthMethod struct {
	// The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
	AuthMethod string                                                            `json:"auth_method,required"`
	JSON       accessPoliciesIncludeAccessAuthenticationMethodRuleAuthMethodJSON `json:"-"`
}

func (*AccessPoliciesIncludeAccessAuthenticationMethodRuleAuthMethod) UnmarshalJSON 

func (r *AccessPoliciesIncludeAccessAuthenticationMethodRuleAuthMethod) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesIncludeAccessAzureGroupRule 

type AccessPoliciesIncludeAccessAzureGroupRule struct {
	AzureAd AccessPoliciesIncludeAccessAzureGroupRuleAzureAd `json:"azureAD,required"`
	JSON    accessPoliciesIncludeAccessAzureGroupRuleJSON    `json:"-"`
}

Matches an Azure group. Requires an Azure identity provider.

func (*AccessPoliciesIncludeAccessAzureGroupRule) UnmarshalJSON 

func (r *AccessPoliciesIncludeAccessAzureGroupRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesIncludeAccessAzureGroupRuleAzureAd 

type AccessPoliciesIncludeAccessAzureGroupRuleAzureAd struct {
	// The ID of an Azure group.
	ID string `json:"id,required"`
	// The ID of your Azure identity provider.
	ConnectionID string                                               `json:"connection_id,required"`
	JSON         accessPoliciesIncludeAccessAzureGroupRuleAzureAdJSON `json:"-"`
}

func (*AccessPoliciesIncludeAccessAzureGroupRuleAzureAd) UnmarshalJSON 

func (r *AccessPoliciesIncludeAccessAzureGroupRuleAzureAd) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesIncludeAccessCertificateRule 

type AccessPoliciesIncludeAccessCertificateRule struct {
	Certificate interface{}                                    `json:"certificate,required"`
	JSON        accessPoliciesIncludeAccessCertificateRuleJSON `json:"-"`
}

Matches any valid client certificate.

func (*AccessPoliciesIncludeAccessCertificateRule) UnmarshalJSON 

func (r *AccessPoliciesIncludeAccessCertificateRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesIncludeAccessCountryRule 

type AccessPoliciesIncludeAccessCountryRule struct {
	Geo  AccessPoliciesIncludeAccessCountryRuleGeo  `json:"geo,required"`
	JSON accessPoliciesIncludeAccessCountryRuleJSON `json:"-"`
}

Matches a specific country

func (*AccessPoliciesIncludeAccessCountryRule) UnmarshalJSON 

func (r *AccessPoliciesIncludeAccessCountryRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesIncludeAccessCountryRuleGeo 

type AccessPoliciesIncludeAccessCountryRuleGeo struct {
	// The country code that should be matched.
	CountryCode string                                        `json:"country_code,required"`
	JSON        accessPoliciesIncludeAccessCountryRuleGeoJSON `json:"-"`
}

func (*AccessPoliciesIncludeAccessCountryRuleGeo) UnmarshalJSON 

func (r *AccessPoliciesIncludeAccessCountryRuleGeo) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesIncludeAccessDevicePostureRule 

type AccessPoliciesIncludeAccessDevicePostureRule struct {
	DevicePosture AccessPoliciesIncludeAccessDevicePostureRuleDevicePosture `json:"device_posture,required"`
	JSON          accessPoliciesIncludeAccessDevicePostureRuleJSON          `json:"-"`
}

Enforces a device posture rule has run successfully

func (*AccessPoliciesIncludeAccessDevicePostureRule) UnmarshalJSON 

func (r *AccessPoliciesIncludeAccessDevicePostureRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesIncludeAccessDevicePostureRuleDevicePosture 

type AccessPoliciesIncludeAccessDevicePostureRuleDevicePosture struct {
	// The ID of a device posture integration.
	IntegrationUid string                                                        `json:"integration_uid,required"`
	JSON           accessPoliciesIncludeAccessDevicePostureRuleDevicePostureJSON `json:"-"`
}

func (*AccessPoliciesIncludeAccessDevicePostureRuleDevicePosture) UnmarshalJSON 

func (r *AccessPoliciesIncludeAccessDevicePostureRuleDevicePosture) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesIncludeAccessDomainRule 

type AccessPoliciesIncludeAccessDomainRule struct {
	EmailDomain AccessPoliciesIncludeAccessDomainRuleEmailDomain `json:"email_domain,required"`
	JSON        accessPoliciesIncludeAccessDomainRuleJSON        `json:"-"`
}

Match an entire email domain.

func (*AccessPoliciesIncludeAccessDomainRule) UnmarshalJSON 

func (r *AccessPoliciesIncludeAccessDomainRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesIncludeAccessDomainRuleEmailDomain 

type AccessPoliciesIncludeAccessDomainRuleEmailDomain struct {
	// The email domain to match.
	Domain string                                               `json:"domain,required"`
	JSON   accessPoliciesIncludeAccessDomainRuleEmailDomainJSON `json:"-"`
}

func (*AccessPoliciesIncludeAccessDomainRuleEmailDomain) UnmarshalJSON 

func (r *AccessPoliciesIncludeAccessDomainRuleEmailDomain) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesIncludeAccessEmailListRule 

type AccessPoliciesIncludeAccessEmailListRule struct {
	EmailList AccessPoliciesIncludeAccessEmailListRuleEmailList `json:"email_list,required"`
	JSON      accessPoliciesIncludeAccessEmailListRuleJSON      `json:"-"`
}

Matches an email address from a list.

func (*AccessPoliciesIncludeAccessEmailListRule) UnmarshalJSON 

func (r *AccessPoliciesIncludeAccessEmailListRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesIncludeAccessEmailListRuleEmailList 

type AccessPoliciesIncludeAccessEmailListRuleEmailList struct {
	// The ID of a previously created email list.
	ID   string                                                `json:"id,required"`
	JSON accessPoliciesIncludeAccessEmailListRuleEmailListJSON `json:"-"`
}

func (*AccessPoliciesIncludeAccessEmailListRuleEmailList) UnmarshalJSON 

func (r *AccessPoliciesIncludeAccessEmailListRuleEmailList) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesIncludeAccessEmailRule 

type AccessPoliciesIncludeAccessEmailRule struct {
	Email AccessPoliciesIncludeAccessEmailRuleEmail `json:"email,required"`
	JSON  accessPoliciesIncludeAccessEmailRuleJSON  `json:"-"`
}

Matches a specific email.

func (*AccessPoliciesIncludeAccessEmailRule) UnmarshalJSON 

func (r *AccessPoliciesIncludeAccessEmailRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesIncludeAccessEmailRuleEmail 

type AccessPoliciesIncludeAccessEmailRuleEmail struct {
	// The email of the user.
	Email string                                        `json:"email,required" format:"email"`
	JSON  accessPoliciesIncludeAccessEmailRuleEmailJSON `json:"-"`
}

func (*AccessPoliciesIncludeAccessEmailRuleEmail) UnmarshalJSON 

func (r *AccessPoliciesIncludeAccessEmailRuleEmail) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesIncludeAccessEveryoneRule 

type AccessPoliciesIncludeAccessEveryoneRule struct {
	// An empty object which matches on all users.
	Everyone interface{}                                 `json:"everyone,required"`
	JSON     accessPoliciesIncludeAccessEveryoneRuleJSON `json:"-"`
}

Matches everyone.

func (*AccessPoliciesIncludeAccessEveryoneRule) UnmarshalJSON 

func (r *AccessPoliciesIncludeAccessEveryoneRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesIncludeAccessExternalEvaluationRule 

type AccessPoliciesIncludeAccessExternalEvaluationRule struct {
	ExternalEvaluation AccessPoliciesIncludeAccessExternalEvaluationRuleExternalEvaluation `json:"external_evaluation,required"`
	JSON               accessPoliciesIncludeAccessExternalEvaluationRuleJSON               `json:"-"`
}

Create Allow or Block policies which evaluate the user based on custom criteria.

func (*AccessPoliciesIncludeAccessExternalEvaluationRule) UnmarshalJSON 

func (r *AccessPoliciesIncludeAccessExternalEvaluationRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesIncludeAccessExternalEvaluationRuleExternalEvaluation 

type AccessPoliciesIncludeAccessExternalEvaluationRuleExternalEvaluation struct {
	// The API endpoint containing your business logic.
	EvaluateURL string `json:"evaluate_url,required"`
	// The API endpoint containing the key that Access uses to verify that the response
	// came from your API.
	KeysURL string                                                                  `json:"keys_url,required"`
	JSON    accessPoliciesIncludeAccessExternalEvaluationRuleExternalEvaluationJSON `json:"-"`
}

func (*AccessPoliciesIncludeAccessExternalEvaluationRuleExternalEvaluation) UnmarshalJSON 

func (r *AccessPoliciesIncludeAccessExternalEvaluationRuleExternalEvaluation) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesIncludeAccessGitHubOrganizationRule 

type AccessPoliciesIncludeAccessGitHubOrganizationRule struct {
	GitHubOrganization AccessPoliciesIncludeAccessGitHubOrganizationRuleGitHubOrganization `json:"github-organization,required"`
	JSON               accessPoliciesIncludeAccessGitHubOrganizationRuleJSON               `json:"-"`
}

Matches a Github organization. Requires a Github identity provider.

func (*AccessPoliciesIncludeAccessGitHubOrganizationRule) UnmarshalJSON 

func (r *AccessPoliciesIncludeAccessGitHubOrganizationRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesIncludeAccessGitHubOrganizationRuleGitHubOrganization 

type AccessPoliciesIncludeAccessGitHubOrganizationRuleGitHubOrganization struct {
	// The ID of your Github identity provider.
	ConnectionID string `json:"connection_id,required"`
	// The name of the organization.
	Name string                                                                  `json:"name,required"`
	JSON accessPoliciesIncludeAccessGitHubOrganizationRuleGitHubOrganizationJSON `json:"-"`
}

func (*AccessPoliciesIncludeAccessGitHubOrganizationRuleGitHubOrganization) UnmarshalJSON 

func (r *AccessPoliciesIncludeAccessGitHubOrganizationRuleGitHubOrganization) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesIncludeAccessGsuiteGroupRule 

type AccessPoliciesIncludeAccessGsuiteGroupRule struct {
	Gsuite AccessPoliciesIncludeAccessGsuiteGroupRuleGsuite `json:"gsuite,required"`
	JSON   accessPoliciesIncludeAccessGsuiteGroupRuleJSON   `json:"-"`
}

Matches a group in Google Workspace. Requires a Google Workspace identity provider.

func (*AccessPoliciesIncludeAccessGsuiteGroupRule) UnmarshalJSON 

func (r *AccessPoliciesIncludeAccessGsuiteGroupRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesIncludeAccessGsuiteGroupRuleGsuite 

type AccessPoliciesIncludeAccessGsuiteGroupRuleGsuite struct {
	// The ID of your Google Workspace identity provider.
	ConnectionID string `json:"connection_id,required"`
	// The email of the Google Workspace group.
	Email string                                               `json:"email,required"`
	JSON  accessPoliciesIncludeAccessGsuiteGroupRuleGsuiteJSON `json:"-"`
}

func (*AccessPoliciesIncludeAccessGsuiteGroupRuleGsuite) UnmarshalJSON 

func (r *AccessPoliciesIncludeAccessGsuiteGroupRuleGsuite) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesIncludeAccessIPListRule 

type AccessPoliciesIncludeAccessIPListRule struct {
	IPList AccessPoliciesIncludeAccessIPListRuleIPList `json:"ip_list,required"`
	JSON   accessPoliciesIncludeAccessIPListRuleJSON   `json:"-"`
}

Matches an IP address from a list.

func (*AccessPoliciesIncludeAccessIPListRule) UnmarshalJSON 

func (r *AccessPoliciesIncludeAccessIPListRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesIncludeAccessIPListRuleIPList 

type AccessPoliciesIncludeAccessIPListRuleIPList struct {
	// The ID of a previously created IP list.
	ID   string                                          `json:"id,required"`
	JSON accessPoliciesIncludeAccessIPListRuleIPListJSON `json:"-"`
}

func (*AccessPoliciesIncludeAccessIPListRuleIPList) UnmarshalJSON 

func (r *AccessPoliciesIncludeAccessIPListRuleIPList) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesIncludeAccessIPRule 

type AccessPoliciesIncludeAccessIPRule struct {
	IP   AccessPoliciesIncludeAccessIPRuleIP   `json:"ip,required"`
	JSON accessPoliciesIncludeAccessIPRuleJSON `json:"-"`
}

Matches an IP address block.

func (*AccessPoliciesIncludeAccessIPRule) UnmarshalJSON 

func (r *AccessPoliciesIncludeAccessIPRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesIncludeAccessIPRuleIP 

type AccessPoliciesIncludeAccessIPRuleIP struct {
	// An IPv4 or IPv6 CIDR block.
	IP   string                                  `json:"ip,required"`
	JSON accessPoliciesIncludeAccessIPRuleIPJSON `json:"-"`
}

func (*AccessPoliciesIncludeAccessIPRuleIP) UnmarshalJSON 

func (r *AccessPoliciesIncludeAccessIPRuleIP) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesIncludeAccessOktaGroupRule 

type AccessPoliciesIncludeAccessOktaGroupRule struct {
	Okta AccessPoliciesIncludeAccessOktaGroupRuleOkta `json:"okta,required"`
	JSON accessPoliciesIncludeAccessOktaGroupRuleJSON `json:"-"`
}

Matches an Okta group. Requires an Okta identity provider.

func (*AccessPoliciesIncludeAccessOktaGroupRule) UnmarshalJSON 

func (r *AccessPoliciesIncludeAccessOktaGroupRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesIncludeAccessOktaGroupRuleOkta 

type AccessPoliciesIncludeAccessOktaGroupRuleOkta struct {
	// The ID of your Okta identity provider.
	ConnectionID string `json:"connection_id,required"`
	// The email of the Okta group.
	Email string                                           `json:"email,required"`
	JSON  accessPoliciesIncludeAccessOktaGroupRuleOktaJSON `json:"-"`
}

func (*AccessPoliciesIncludeAccessOktaGroupRuleOkta) UnmarshalJSON 

func (r *AccessPoliciesIncludeAccessOktaGroupRuleOkta) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesIncludeAccessSamlGroupRule 

type AccessPoliciesIncludeAccessSamlGroupRule struct {
	Saml AccessPoliciesIncludeAccessSamlGroupRuleSaml `json:"saml,required"`
	JSON accessPoliciesIncludeAccessSamlGroupRuleJSON `json:"-"`
}

Matches a SAML group. Requires a SAML identity provider.

func (*AccessPoliciesIncludeAccessSamlGroupRule) UnmarshalJSON 

func (r *AccessPoliciesIncludeAccessSamlGroupRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesIncludeAccessSamlGroupRuleSaml 

type AccessPoliciesIncludeAccessSamlGroupRuleSaml struct {
	// The name of the SAML attribute.
	AttributeName string `json:"attribute_name,required"`
	// The SAML attribute value to look for.
	AttributeValue string                                           `json:"attribute_value,required"`
	JSON           accessPoliciesIncludeAccessSamlGroupRuleSamlJSON `json:"-"`
}

func (*AccessPoliciesIncludeAccessSamlGroupRuleSaml) UnmarshalJSON 

func (r *AccessPoliciesIncludeAccessSamlGroupRuleSaml) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesIncludeAccessServiceTokenRule 

type AccessPoliciesIncludeAccessServiceTokenRule struct {
	ServiceToken AccessPoliciesIncludeAccessServiceTokenRuleServiceToken `json:"service_token,required"`
	JSON         accessPoliciesIncludeAccessServiceTokenRuleJSON         `json:"-"`
}

Matches a specific Access Service Token

func (*AccessPoliciesIncludeAccessServiceTokenRule) UnmarshalJSON 

func (r *AccessPoliciesIncludeAccessServiceTokenRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesIncludeAccessServiceTokenRuleServiceToken 

type AccessPoliciesIncludeAccessServiceTokenRuleServiceToken struct {
	// The ID of a Service Token.
	TokenID string                                                      `json:"token_id,required"`
	JSON    accessPoliciesIncludeAccessServiceTokenRuleServiceTokenJSON `json:"-"`
}

func (*AccessPoliciesIncludeAccessServiceTokenRuleServiceToken) UnmarshalJSON 

func (r *AccessPoliciesIncludeAccessServiceTokenRuleServiceToken) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesRequire 

type AccessPoliciesRequire interface {
	// contains filtered or unexported methods
}

Matches a specific email.

Union satisfied by zero_trust.AccessPoliciesRequireAccessEmailRule, zero_trust.AccessPoliciesRequireAccessEmailListRule, zero_trust.AccessPoliciesRequireAccessDomainRule, zero_trust.AccessPoliciesRequireAccessEveryoneRule, zero_trust.AccessPoliciesRequireAccessIPRule, zero_trust.AccessPoliciesRequireAccessIPListRule, zero_trust.AccessPoliciesRequireAccessCertificateRule, zero_trust.AccessPoliciesRequireAccessAccessGroupRule, zero_trust.AccessPoliciesRequireAccessAzureGroupRule, zero_trust.AccessPoliciesRequireAccessGitHubOrganizationRule, zero_trust.AccessPoliciesRequireAccessGsuiteGroupRule, zero_trust.AccessPoliciesRequireAccessOktaGroupRule, zero_trust.AccessPoliciesRequireAccessSamlGroupRule, zero_trust.AccessPoliciesRequireAccessServiceTokenRule, zero_trust.AccessPoliciesRequireAccessAnyValidServiceTokenRule, zero_trust.AccessPoliciesRequireAccessExternalEvaluationRule, zero_trust.AccessPoliciesRequireAccessCountryRule, zero_trust.AccessPoliciesRequireAccessAuthenticationMethodRule or zero_trust.AccessPoliciesRequireAccessDevicePostureRule.

type AccessPoliciesRequireAccessAccessGroupRule 

type AccessPoliciesRequireAccessAccessGroupRule struct {
	Group AccessPoliciesRequireAccessAccessGroupRuleGroup `json:"group,required"`
	JSON  accessPoliciesRequireAccessAccessGroupRuleJSON  `json:"-"`
}

Matches an Access group.

func (*AccessPoliciesRequireAccessAccessGroupRule) UnmarshalJSON 

func (r *AccessPoliciesRequireAccessAccessGroupRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesRequireAccessAccessGroupRuleGroup 

type AccessPoliciesRequireAccessAccessGroupRuleGroup struct {
	// The ID of a previously created Access group.
	ID   string                                              `json:"id,required"`
	JSON accessPoliciesRequireAccessAccessGroupRuleGroupJSON `json:"-"`
}

func (*AccessPoliciesRequireAccessAccessGroupRuleGroup) UnmarshalJSON 

func (r *AccessPoliciesRequireAccessAccessGroupRuleGroup) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesRequireAccessAnyValidServiceTokenRule 

type AccessPoliciesRequireAccessAnyValidServiceTokenRule struct {
	// An empty object which matches on all service tokens.
	AnyValidServiceToken interface{}                                             `json:"any_valid_service_token,required"`
	JSON                 accessPoliciesRequireAccessAnyValidServiceTokenRuleJSON `json:"-"`
}

Matches any valid Access Service Token

func (*AccessPoliciesRequireAccessAnyValidServiceTokenRule) UnmarshalJSON 

func (r *AccessPoliciesRequireAccessAnyValidServiceTokenRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesRequireAccessAuthenticationMethodRule 

type AccessPoliciesRequireAccessAuthenticationMethodRule struct {
	AuthMethod AccessPoliciesRequireAccessAuthenticationMethodRuleAuthMethod `json:"auth_method,required"`
	JSON       accessPoliciesRequireAccessAuthenticationMethodRuleJSON       `json:"-"`
}

Enforce different MFA options

func (*AccessPoliciesRequireAccessAuthenticationMethodRule) UnmarshalJSON 

func (r *AccessPoliciesRequireAccessAuthenticationMethodRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesRequireAccessAuthenticationMethodRuleAuthMethod 

type AccessPoliciesRequireAccessAuthenticationMethodRuleAuthMethod struct {
	// The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
	AuthMethod string                                                            `json:"auth_method,required"`
	JSON       accessPoliciesRequireAccessAuthenticationMethodRuleAuthMethodJSON `json:"-"`
}

func (*AccessPoliciesRequireAccessAuthenticationMethodRuleAuthMethod) UnmarshalJSON 

func (r *AccessPoliciesRequireAccessAuthenticationMethodRuleAuthMethod) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesRequireAccessAzureGroupRule 

type AccessPoliciesRequireAccessAzureGroupRule struct {
	AzureAd AccessPoliciesRequireAccessAzureGroupRuleAzureAd `json:"azureAD,required"`
	JSON    accessPoliciesRequireAccessAzureGroupRuleJSON    `json:"-"`
}

Matches an Azure group. Requires an Azure identity provider.

func (*AccessPoliciesRequireAccessAzureGroupRule) UnmarshalJSON 

func (r *AccessPoliciesRequireAccessAzureGroupRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesRequireAccessAzureGroupRuleAzureAd 

type AccessPoliciesRequireAccessAzureGroupRuleAzureAd struct {
	// The ID of an Azure group.
	ID string `json:"id,required"`
	// The ID of your Azure identity provider.
	ConnectionID string                                               `json:"connection_id,required"`
	JSON         accessPoliciesRequireAccessAzureGroupRuleAzureAdJSON `json:"-"`
}

func (*AccessPoliciesRequireAccessAzureGroupRuleAzureAd) UnmarshalJSON 

func (r *AccessPoliciesRequireAccessAzureGroupRuleAzureAd) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesRequireAccessCertificateRule 

type AccessPoliciesRequireAccessCertificateRule struct {
	Certificate interface{}                                    `json:"certificate,required"`
	JSON        accessPoliciesRequireAccessCertificateRuleJSON `json:"-"`
}

Matches any valid client certificate.

func (*AccessPoliciesRequireAccessCertificateRule) UnmarshalJSON 

func (r *AccessPoliciesRequireAccessCertificateRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesRequireAccessCountryRule 

type AccessPoliciesRequireAccessCountryRule struct {
	Geo  AccessPoliciesRequireAccessCountryRuleGeo  `json:"geo,required"`
	JSON accessPoliciesRequireAccessCountryRuleJSON `json:"-"`
}

Matches a specific country

func (*AccessPoliciesRequireAccessCountryRule) UnmarshalJSON 

func (r *AccessPoliciesRequireAccessCountryRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesRequireAccessCountryRuleGeo 

type AccessPoliciesRequireAccessCountryRuleGeo struct {
	// The country code that should be matched.
	CountryCode string                                        `json:"country_code,required"`
	JSON        accessPoliciesRequireAccessCountryRuleGeoJSON `json:"-"`
}

func (*AccessPoliciesRequireAccessCountryRuleGeo) UnmarshalJSON 

func (r *AccessPoliciesRequireAccessCountryRuleGeo) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesRequireAccessDevicePostureRule 

type AccessPoliciesRequireAccessDevicePostureRule struct {
	DevicePosture AccessPoliciesRequireAccessDevicePostureRuleDevicePosture `json:"device_posture,required"`
	JSON          accessPoliciesRequireAccessDevicePostureRuleJSON          `json:"-"`
}

Enforces a device posture rule has run successfully

func (*AccessPoliciesRequireAccessDevicePostureRule) UnmarshalJSON 

func (r *AccessPoliciesRequireAccessDevicePostureRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesRequireAccessDevicePostureRuleDevicePosture 

type AccessPoliciesRequireAccessDevicePostureRuleDevicePosture struct {
	// The ID of a device posture integration.
	IntegrationUid string                                                        `json:"integration_uid,required"`
	JSON           accessPoliciesRequireAccessDevicePostureRuleDevicePostureJSON `json:"-"`
}

func (*AccessPoliciesRequireAccessDevicePostureRuleDevicePosture) UnmarshalJSON 

func (r *AccessPoliciesRequireAccessDevicePostureRuleDevicePosture) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesRequireAccessDomainRule 

type AccessPoliciesRequireAccessDomainRule struct {
	EmailDomain AccessPoliciesRequireAccessDomainRuleEmailDomain `json:"email_domain,required"`
	JSON        accessPoliciesRequireAccessDomainRuleJSON        `json:"-"`
}

Match an entire email domain.

func (*AccessPoliciesRequireAccessDomainRule) UnmarshalJSON 

func (r *AccessPoliciesRequireAccessDomainRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesRequireAccessDomainRuleEmailDomain 

type AccessPoliciesRequireAccessDomainRuleEmailDomain struct {
	// The email domain to match.
	Domain string                                               `json:"domain,required"`
	JSON   accessPoliciesRequireAccessDomainRuleEmailDomainJSON `json:"-"`
}

func (*AccessPoliciesRequireAccessDomainRuleEmailDomain) UnmarshalJSON 

func (r *AccessPoliciesRequireAccessDomainRuleEmailDomain) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesRequireAccessEmailListRule 

type AccessPoliciesRequireAccessEmailListRule struct {
	EmailList AccessPoliciesRequireAccessEmailListRuleEmailList `json:"email_list,required"`
	JSON      accessPoliciesRequireAccessEmailListRuleJSON      `json:"-"`
}

Matches an email address from a list.

func (*AccessPoliciesRequireAccessEmailListRule) UnmarshalJSON 

func (r *AccessPoliciesRequireAccessEmailListRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesRequireAccessEmailListRuleEmailList 

type AccessPoliciesRequireAccessEmailListRuleEmailList struct {
	// The ID of a previously created email list.
	ID   string                                                `json:"id,required"`
	JSON accessPoliciesRequireAccessEmailListRuleEmailListJSON `json:"-"`
}

func (*AccessPoliciesRequireAccessEmailListRuleEmailList) UnmarshalJSON 

func (r *AccessPoliciesRequireAccessEmailListRuleEmailList) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesRequireAccessEmailRule 

type AccessPoliciesRequireAccessEmailRule struct {
	Email AccessPoliciesRequireAccessEmailRuleEmail `json:"email,required"`
	JSON  accessPoliciesRequireAccessEmailRuleJSON  `json:"-"`
}

Matches a specific email.

func (*AccessPoliciesRequireAccessEmailRule) UnmarshalJSON 

func (r *AccessPoliciesRequireAccessEmailRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesRequireAccessEmailRuleEmail 

type AccessPoliciesRequireAccessEmailRuleEmail struct {
	// The email of the user.
	Email string                                        `json:"email,required" format:"email"`
	JSON  accessPoliciesRequireAccessEmailRuleEmailJSON `json:"-"`
}

func (*AccessPoliciesRequireAccessEmailRuleEmail) UnmarshalJSON 

func (r *AccessPoliciesRequireAccessEmailRuleEmail) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesRequireAccessEveryoneRule 

type AccessPoliciesRequireAccessEveryoneRule struct {
	// An empty object which matches on all users.
	Everyone interface{}                                 `json:"everyone,required"`
	JSON     accessPoliciesRequireAccessEveryoneRuleJSON `json:"-"`
}

Matches everyone.

func (*AccessPoliciesRequireAccessEveryoneRule) UnmarshalJSON 

func (r *AccessPoliciesRequireAccessEveryoneRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesRequireAccessExternalEvaluationRule 

type AccessPoliciesRequireAccessExternalEvaluationRule struct {
	ExternalEvaluation AccessPoliciesRequireAccessExternalEvaluationRuleExternalEvaluation `json:"external_evaluation,required"`
	JSON               accessPoliciesRequireAccessExternalEvaluationRuleJSON               `json:"-"`
}

Create Allow or Block policies which evaluate the user based on custom criteria.

func (*AccessPoliciesRequireAccessExternalEvaluationRule) UnmarshalJSON 

func (r *AccessPoliciesRequireAccessExternalEvaluationRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesRequireAccessExternalEvaluationRuleExternalEvaluation 

type AccessPoliciesRequireAccessExternalEvaluationRuleExternalEvaluation struct {
	// The API endpoint containing your business logic.
	EvaluateURL string `json:"evaluate_url,required"`
	// The API endpoint containing the key that Access uses to verify that the response
	// came from your API.
	KeysURL string                                                                  `json:"keys_url,required"`
	JSON    accessPoliciesRequireAccessExternalEvaluationRuleExternalEvaluationJSON `json:"-"`
}

func (*AccessPoliciesRequireAccessExternalEvaluationRuleExternalEvaluation) UnmarshalJSON 

func (r *AccessPoliciesRequireAccessExternalEvaluationRuleExternalEvaluation) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesRequireAccessGitHubOrganizationRule 

type AccessPoliciesRequireAccessGitHubOrganizationRule struct {
	GitHubOrganization AccessPoliciesRequireAccessGitHubOrganizationRuleGitHubOrganization `json:"github-organization,required"`
	JSON               accessPoliciesRequireAccessGitHubOrganizationRuleJSON               `json:"-"`
}

Matches a Github organization. Requires a Github identity provider.

func (*AccessPoliciesRequireAccessGitHubOrganizationRule) UnmarshalJSON 

func (r *AccessPoliciesRequireAccessGitHubOrganizationRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesRequireAccessGitHubOrganizationRuleGitHubOrganization 

type AccessPoliciesRequireAccessGitHubOrganizationRuleGitHubOrganization struct {
	// The ID of your Github identity provider.
	ConnectionID string `json:"connection_id,required"`
	// The name of the organization.
	Name string                                                                  `json:"name,required"`
	JSON accessPoliciesRequireAccessGitHubOrganizationRuleGitHubOrganizationJSON `json:"-"`
}

func (*AccessPoliciesRequireAccessGitHubOrganizationRuleGitHubOrganization) UnmarshalJSON 

func (r *AccessPoliciesRequireAccessGitHubOrganizationRuleGitHubOrganization) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesRequireAccessGsuiteGroupRule 

type AccessPoliciesRequireAccessGsuiteGroupRule struct {
	Gsuite AccessPoliciesRequireAccessGsuiteGroupRuleGsuite `json:"gsuite,required"`
	JSON   accessPoliciesRequireAccessGsuiteGroupRuleJSON   `json:"-"`
}

Matches a group in Google Workspace. Requires a Google Workspace identity provider.

func (*AccessPoliciesRequireAccessGsuiteGroupRule) UnmarshalJSON 

func (r *AccessPoliciesRequireAccessGsuiteGroupRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesRequireAccessGsuiteGroupRuleGsuite 

type AccessPoliciesRequireAccessGsuiteGroupRuleGsuite struct {
	// The ID of your Google Workspace identity provider.
	ConnectionID string `json:"connection_id,required"`
	// The email of the Google Workspace group.
	Email string                                               `json:"email,required"`
	JSON  accessPoliciesRequireAccessGsuiteGroupRuleGsuiteJSON `json:"-"`
}

func (*AccessPoliciesRequireAccessGsuiteGroupRuleGsuite) UnmarshalJSON 

func (r *AccessPoliciesRequireAccessGsuiteGroupRuleGsuite) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesRequireAccessIPListRule 

type AccessPoliciesRequireAccessIPListRule struct {
	IPList AccessPoliciesRequireAccessIPListRuleIPList `json:"ip_list,required"`
	JSON   accessPoliciesRequireAccessIPListRuleJSON   `json:"-"`
}

Matches an IP address from a list.

func (*AccessPoliciesRequireAccessIPListRule) UnmarshalJSON 

func (r *AccessPoliciesRequireAccessIPListRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesRequireAccessIPListRuleIPList 

type AccessPoliciesRequireAccessIPListRuleIPList struct {
	// The ID of a previously created IP list.
	ID   string                                          `json:"id,required"`
	JSON accessPoliciesRequireAccessIPListRuleIPListJSON `json:"-"`
}

func (*AccessPoliciesRequireAccessIPListRuleIPList) UnmarshalJSON 

func (r *AccessPoliciesRequireAccessIPListRuleIPList) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesRequireAccessIPRule 

type AccessPoliciesRequireAccessIPRule struct {
	IP   AccessPoliciesRequireAccessIPRuleIP   `json:"ip,required"`
	JSON accessPoliciesRequireAccessIPRuleJSON `json:"-"`
}

Matches an IP address block.

func (*AccessPoliciesRequireAccessIPRule) UnmarshalJSON 

func (r *AccessPoliciesRequireAccessIPRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesRequireAccessIPRuleIP 

type AccessPoliciesRequireAccessIPRuleIP struct {
	// An IPv4 or IPv6 CIDR block.
	IP   string                                  `json:"ip,required"`
	JSON accessPoliciesRequireAccessIPRuleIPJSON `json:"-"`
}

func (*AccessPoliciesRequireAccessIPRuleIP) UnmarshalJSON 

func (r *AccessPoliciesRequireAccessIPRuleIP) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesRequireAccessOktaGroupRule 

type AccessPoliciesRequireAccessOktaGroupRule struct {
	Okta AccessPoliciesRequireAccessOktaGroupRuleOkta `json:"okta,required"`
	JSON accessPoliciesRequireAccessOktaGroupRuleJSON `json:"-"`
}

Matches an Okta group. Requires an Okta identity provider.

func (*AccessPoliciesRequireAccessOktaGroupRule) UnmarshalJSON 

func (r *AccessPoliciesRequireAccessOktaGroupRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesRequireAccessOktaGroupRuleOkta 

type AccessPoliciesRequireAccessOktaGroupRuleOkta struct {
	// The ID of your Okta identity provider.
	ConnectionID string `json:"connection_id,required"`
	// The email of the Okta group.
	Email string                                           `json:"email,required"`
	JSON  accessPoliciesRequireAccessOktaGroupRuleOktaJSON `json:"-"`
}

func (*AccessPoliciesRequireAccessOktaGroupRuleOkta) UnmarshalJSON 

func (r *AccessPoliciesRequireAccessOktaGroupRuleOkta) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesRequireAccessSamlGroupRule 

type AccessPoliciesRequireAccessSamlGroupRule struct {
	Saml AccessPoliciesRequireAccessSamlGroupRuleSaml `json:"saml,required"`
	JSON accessPoliciesRequireAccessSamlGroupRuleJSON `json:"-"`
}

Matches a SAML group. Requires a SAML identity provider.

func (*AccessPoliciesRequireAccessSamlGroupRule) UnmarshalJSON 

func (r *AccessPoliciesRequireAccessSamlGroupRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesRequireAccessSamlGroupRuleSaml 

type AccessPoliciesRequireAccessSamlGroupRuleSaml struct {
	// The name of the SAML attribute.
	AttributeName string `json:"attribute_name,required"`
	// The SAML attribute value to look for.
	AttributeValue string                                           `json:"attribute_value,required"`
	JSON           accessPoliciesRequireAccessSamlGroupRuleSamlJSON `json:"-"`
}

func (*AccessPoliciesRequireAccessSamlGroupRuleSaml) UnmarshalJSON 

func (r *AccessPoliciesRequireAccessSamlGroupRuleSaml) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesRequireAccessServiceTokenRule 

type AccessPoliciesRequireAccessServiceTokenRule struct {
	ServiceToken AccessPoliciesRequireAccessServiceTokenRuleServiceToken `json:"service_token,required"`
	JSON         accessPoliciesRequireAccessServiceTokenRuleJSON         `json:"-"`
}

Matches a specific Access Service Token

func (*AccessPoliciesRequireAccessServiceTokenRule) UnmarshalJSON 

func (r *AccessPoliciesRequireAccessServiceTokenRule) UnmarshalJSON(data []byte) (err error)

type AccessPoliciesRequireAccessServiceTokenRuleServiceToken 

type AccessPoliciesRequireAccessServiceTokenRuleServiceToken struct {
	// The ID of a Service Token.
	TokenID string                                                      `json:"token_id,required"`
	JSON    accessPoliciesRequireAccessServiceTokenRuleServiceTokenJSON `json:"-"`
}

func (*AccessPoliciesRequireAccessServiceTokenRuleServiceToken) UnmarshalJSON 

func (r *AccessPoliciesRequireAccessServiceTokenRuleServiceToken) UnmarshalJSON(data []byte) (err error)

type AccessSeats 

type AccessSeats struct {
	// True if the seat is part of Access.
	AccessSeat bool      `json:"access_seat"`
	CreatedAt  time.Time `json:"created_at" format:"date-time"`
	// True if the seat is part of Gateway.
	GatewaySeat bool `json:"gateway_seat"`
	// Identifier
	SeatUid   string          `json:"seat_uid"`
	UpdatedAt time.Time       `json:"updated_at" format:"date-time"`
	JSON      accessSeatsJSON `json:"-"`
}

func (*AccessSeats) UnmarshalJSON 

func (r *AccessSeats) UnmarshalJSON(data []byte) (err error)

type AccessService 

type AccessService struct {
	Options       []option.RequestOption
	Applications  *AccessApplicationService
	Certificates  *AccessCertificateService
	Groups        *AccessGroupService
	ServiceTokens *AccessServiceTokenService
	Bookmarks     *AccessBookmarkService
	Keys          *AccessKeyService
	Logs          *AccessLogService
	Users         *AccessUserService
	CustomPages   *AccessCustomPageService
	Tags          *AccessTagService
}

AccessService 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 NewAccessService method instead.

func NewAccessService 

func NewAccessService(opts ...option.RequestOption) (r *AccessService)

NewAccessService 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 AccessServiceTokenDeleteParams 

type AccessServiceTokenDeleteParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type AccessServiceTokenDeleteResponseEnvelope 

type AccessServiceTokenDeleteResponseEnvelope struct {
	Errors   []AccessServiceTokenDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessServiceTokenDeleteResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessServiceTokens                                `json:"result,required"`
	// Whether the API call was successful
	Success AccessServiceTokenDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessServiceTokenDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*AccessServiceTokenDeleteResponseEnvelope) UnmarshalJSON 

func (r *AccessServiceTokenDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AccessServiceTokenDeleteResponseEnvelopeErrors 

type AccessServiceTokenDeleteResponseEnvelopeErrors struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    accessServiceTokenDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessServiceTokenDeleteResponseEnvelopeErrors) UnmarshalJSON 

func (r *AccessServiceTokenDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type AccessServiceTokenDeleteResponseEnvelopeMessages 

type AccessServiceTokenDeleteResponseEnvelopeMessages struct {
	Code    int64                                                `json:"code,required"`
	Message string                                               `json:"message,required"`
	JSON    accessServiceTokenDeleteResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessServiceTokenDeleteResponseEnvelopeMessages) UnmarshalJSON 

func (r *AccessServiceTokenDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type AccessServiceTokenDeleteResponseEnvelopeSuccess 

type AccessServiceTokenDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessServiceTokenDeleteResponseEnvelopeSuccessTrue AccessServiceTokenDeleteResponseEnvelopeSuccess = true
)

type AccessServiceTokenListParams 

type AccessServiceTokenListParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type AccessServiceTokenListResponseEnvelope 

type AccessServiceTokenListResponseEnvelope struct {
	Errors   []AccessServiceTokenListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessServiceTokenListResponseEnvelopeMessages `json:"messages,required"`
	Result   []AccessServiceTokens                            `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    AccessServiceTokenListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo AccessServiceTokenListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       accessServiceTokenListResponseEnvelopeJSON       `json:"-"`
}

func (*AccessServiceTokenListResponseEnvelope) UnmarshalJSON 

func (r *AccessServiceTokenListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AccessServiceTokenListResponseEnvelopeErrors 

type AccessServiceTokenListResponseEnvelopeErrors struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    accessServiceTokenListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessServiceTokenListResponseEnvelopeErrors) UnmarshalJSON 

func (r *AccessServiceTokenListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type AccessServiceTokenListResponseEnvelopeMessages 

type AccessServiceTokenListResponseEnvelopeMessages struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    accessServiceTokenListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessServiceTokenListResponseEnvelopeMessages) UnmarshalJSON 

func (r *AccessServiceTokenListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type AccessServiceTokenListResponseEnvelopeResultInfo 

type AccessServiceTokenListResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                              `json:"total_count"`
	JSON       accessServiceTokenListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*AccessServiceTokenListResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *AccessServiceTokenListResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type AccessServiceTokenListResponseEnvelopeSuccess 

type AccessServiceTokenListResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessServiceTokenListResponseEnvelopeSuccessTrue AccessServiceTokenListResponseEnvelopeSuccess = true
)

type AccessServiceTokenNewParams 

type AccessServiceTokenNewParams struct {
	// The name of the service token.
	Name param.Field[string] `json:"name,required"`
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
	// The duration for how long the service token will be valid. Must be in the format
	// `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h. The
	// default is 1 year in hours (8760h).
	Duration param.Field[string] `json:"duration"`
}

func (AccessServiceTokenNewParams) MarshalJSON 

func (r AccessServiceTokenNewParams) MarshalJSON() (data []byte, err error)

type AccessServiceTokenNewResponse 

type AccessServiceTokenNewResponse struct {
	// The ID of the service token.
	ID interface{} `json:"id"`
	// The Client ID for the service token. Access will check for this value in the
	// `CF-Access-Client-ID` request header.
	ClientID string `json:"client_id"`
	// The Client Secret for the service token. Access will check for this value in the
	// `CF-Access-Client-Secret` request header.
	ClientSecret string    `json:"client_secret"`
	CreatedAt    time.Time `json:"created_at" format:"date-time"`
	// The duration for how long the service token will be valid. Must be in the format
	// `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h. The
	// default is 1 year in hours (8760h).
	Duration string `json:"duration"`
	// The name of the service token.
	Name      string                            `json:"name"`
	UpdatedAt time.Time                         `json:"updated_at" format:"date-time"`
	JSON      accessServiceTokenNewResponseJSON `json:"-"`
}

func (*AccessServiceTokenNewResponse) UnmarshalJSON 

func (r *AccessServiceTokenNewResponse) UnmarshalJSON(data []byte) (err error)

type AccessServiceTokenNewResponseEnvelope 

type AccessServiceTokenNewResponseEnvelope struct {
	Errors   []AccessServiceTokenNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessServiceTokenNewResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessServiceTokenNewResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success AccessServiceTokenNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessServiceTokenNewResponseEnvelopeJSON    `json:"-"`
}

func (*AccessServiceTokenNewResponseEnvelope) UnmarshalJSON 

func (r *AccessServiceTokenNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AccessServiceTokenNewResponseEnvelopeErrors 

type AccessServiceTokenNewResponseEnvelopeErrors struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    accessServiceTokenNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessServiceTokenNewResponseEnvelopeErrors) UnmarshalJSON 

func (r *AccessServiceTokenNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type AccessServiceTokenNewResponseEnvelopeMessages 

type AccessServiceTokenNewResponseEnvelopeMessages struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    accessServiceTokenNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessServiceTokenNewResponseEnvelopeMessages) UnmarshalJSON 

func (r *AccessServiceTokenNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type AccessServiceTokenNewResponseEnvelopeSuccess 

type AccessServiceTokenNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessServiceTokenNewResponseEnvelopeSuccessTrue AccessServiceTokenNewResponseEnvelopeSuccess = true
)

type AccessServiceTokenRefreshResponseEnvelope 

type AccessServiceTokenRefreshResponseEnvelope struct {
	Errors   []AccessServiceTokenRefreshResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessServiceTokenRefreshResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessServiceTokens                                 `json:"result,required"`
	// Whether the API call was successful
	Success AccessServiceTokenRefreshResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessServiceTokenRefreshResponseEnvelopeJSON    `json:"-"`
}

func (*AccessServiceTokenRefreshResponseEnvelope) UnmarshalJSON 

func (r *AccessServiceTokenRefreshResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AccessServiceTokenRefreshResponseEnvelopeErrors 

type AccessServiceTokenRefreshResponseEnvelopeErrors struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    accessServiceTokenRefreshResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessServiceTokenRefreshResponseEnvelopeErrors) UnmarshalJSON 

func (r *AccessServiceTokenRefreshResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type AccessServiceTokenRefreshResponseEnvelopeMessages 

type AccessServiceTokenRefreshResponseEnvelopeMessages struct {
	Code    int64                                                 `json:"code,required"`
	Message string                                                `json:"message,required"`
	JSON    accessServiceTokenRefreshResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessServiceTokenRefreshResponseEnvelopeMessages) UnmarshalJSON 

func (r *AccessServiceTokenRefreshResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type AccessServiceTokenRefreshResponseEnvelopeSuccess 

type AccessServiceTokenRefreshResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessServiceTokenRefreshResponseEnvelopeSuccessTrue AccessServiceTokenRefreshResponseEnvelopeSuccess = true
)

type AccessServiceTokenRotateResponse 

type AccessServiceTokenRotateResponse struct {
	// The ID of the service token.
	ID interface{} `json:"id"`
	// The Client ID for the service token. Access will check for this value in the
	// `CF-Access-Client-ID` request header.
	ClientID string `json:"client_id"`
	// The Client Secret for the service token. Access will check for this value in the
	// `CF-Access-Client-Secret` request header.
	ClientSecret string    `json:"client_secret"`
	CreatedAt    time.Time `json:"created_at" format:"date-time"`
	// The duration for how long the service token will be valid. Must be in the format
	// `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h. The
	// default is 1 year in hours (8760h).
	Duration string `json:"duration"`
	// The name of the service token.
	Name      string                               `json:"name"`
	UpdatedAt time.Time                            `json:"updated_at" format:"date-time"`
	JSON      accessServiceTokenRotateResponseJSON `json:"-"`
}

func (*AccessServiceTokenRotateResponse) UnmarshalJSON 

func (r *AccessServiceTokenRotateResponse) UnmarshalJSON(data []byte) (err error)

type AccessServiceTokenRotateResponseEnvelope 

type AccessServiceTokenRotateResponseEnvelope struct {
	Errors   []AccessServiceTokenRotateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessServiceTokenRotateResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessServiceTokenRotateResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success AccessServiceTokenRotateResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessServiceTokenRotateResponseEnvelopeJSON    `json:"-"`
}

func (*AccessServiceTokenRotateResponseEnvelope) UnmarshalJSON 

func (r *AccessServiceTokenRotateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AccessServiceTokenRotateResponseEnvelopeErrors 

type AccessServiceTokenRotateResponseEnvelopeErrors struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    accessServiceTokenRotateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessServiceTokenRotateResponseEnvelopeErrors) UnmarshalJSON 

func (r *AccessServiceTokenRotateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type AccessServiceTokenRotateResponseEnvelopeMessages 

type AccessServiceTokenRotateResponseEnvelopeMessages struct {
	Code    int64                                                `json:"code,required"`
	Message string                                               `json:"message,required"`
	JSON    accessServiceTokenRotateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessServiceTokenRotateResponseEnvelopeMessages) UnmarshalJSON 

func (r *AccessServiceTokenRotateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type AccessServiceTokenRotateResponseEnvelopeSuccess 

type AccessServiceTokenRotateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessServiceTokenRotateResponseEnvelopeSuccessTrue AccessServiceTokenRotateResponseEnvelopeSuccess = true
)

type AccessServiceTokenService 

type AccessServiceTokenService struct {
	Options []option.RequestOption
}

AccessServiceTokenService 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 NewAccessServiceTokenService method instead.

func NewAccessServiceTokenService 

func NewAccessServiceTokenService(opts ...option.RequestOption) (r *AccessServiceTokenService)

NewAccessServiceTokenService 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 (*AccessServiceTokenService) Delete 

func (r *AccessServiceTokenService) Delete(ctx context.Context, uuid string, body AccessServiceTokenDeleteParams, opts ...option.RequestOption) (res *AccessServiceTokens, err error)

Deletes a service token.

func (*AccessServiceTokenService) List 

func (r *AccessServiceTokenService) List(ctx context.Context, query AccessServiceTokenListParams, opts ...option.RequestOption) (res *[]AccessServiceTokens, err error)

Lists all service tokens.

func (*AccessServiceTokenService) New 

func (r *AccessServiceTokenService) New(ctx context.Context, params AccessServiceTokenNewParams, opts ...option.RequestOption) (res *AccessServiceTokenNewResponse, err error)

Generates a new service token. **Note:** This is the only time you can get the Client Secret. If you lose the Client Secret, you will have to rotate the Client Secret or create a new service token.

func (*AccessServiceTokenService) Refresh 

func (r *AccessServiceTokenService) Refresh(ctx context.Context, identifier string, uuid string, opts ...option.RequestOption) (res *AccessServiceTokens, err error)

Refreshes the expiration of a service token.

func (*AccessServiceTokenService) Rotate 

func (r *AccessServiceTokenService) Rotate(ctx context.Context, identifier string, uuid string, opts ...option.RequestOption) (res *AccessServiceTokenRotateResponse, err error)

Generates a new Client Secret for a service token and revokes the old one.

func (*AccessServiceTokenService) Update 

func (r *AccessServiceTokenService) Update(ctx context.Context, uuid string, params AccessServiceTokenUpdateParams, opts ...option.RequestOption) (res *AccessServiceTokens, err error)

Updates a configured service token.

type AccessServiceTokenUpdateParams 

type AccessServiceTokenUpdateParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
	// The duration for how long the service token will be valid. Must be in the format
	// `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h. The
	// default is 1 year in hours (8760h).
	Duration param.Field[string] `json:"duration"`
	// The name of the service token.
	Name param.Field[string] `json:"name"`
}

func (AccessServiceTokenUpdateParams) MarshalJSON 

func (r AccessServiceTokenUpdateParams) MarshalJSON() (data []byte, err error)

type AccessServiceTokenUpdateResponseEnvelope 

type AccessServiceTokenUpdateResponseEnvelope struct {
	Errors   []AccessServiceTokenUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessServiceTokenUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessServiceTokens                                `json:"result,required"`
	// Whether the API call was successful
	Success AccessServiceTokenUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessServiceTokenUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*AccessServiceTokenUpdateResponseEnvelope) UnmarshalJSON 

func (r *AccessServiceTokenUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AccessServiceTokenUpdateResponseEnvelopeErrors 

type AccessServiceTokenUpdateResponseEnvelopeErrors struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    accessServiceTokenUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessServiceTokenUpdateResponseEnvelopeErrors) UnmarshalJSON 

func (r *AccessServiceTokenUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type AccessServiceTokenUpdateResponseEnvelopeMessages 

type AccessServiceTokenUpdateResponseEnvelopeMessages struct {
	Code    int64                                                `json:"code,required"`
	Message string                                               `json:"message,required"`
	JSON    accessServiceTokenUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessServiceTokenUpdateResponseEnvelopeMessages) UnmarshalJSON 

func (r *AccessServiceTokenUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type AccessServiceTokenUpdateResponseEnvelopeSuccess 

type AccessServiceTokenUpdateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessServiceTokenUpdateResponseEnvelopeSuccessTrue AccessServiceTokenUpdateResponseEnvelopeSuccess = true
)

type AccessServiceTokens 

type AccessServiceTokens struct {
	// The ID of the service token.
	ID interface{} `json:"id"`
	// The Client ID for the service token. Access will check for this value in the
	// `CF-Access-Client-ID` request header.
	ClientID  string    `json:"client_id"`
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// The duration for how long the service token will be valid. Must be in the format
	// `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h. The
	// default is 1 year in hours (8760h).
	Duration string `json:"duration"`
	// The name of the service token.
	Name      string                  `json:"name"`
	UpdatedAt time.Time               `json:"updated_at" format:"date-time"`
	JSON      accessServiceTokensJSON `json:"-"`
}

func (*AccessServiceTokens) UnmarshalJSON 

func (r *AccessServiceTokens) UnmarshalJSON(data []byte) (err error)

type AccessSettings 

type AccessSettings struct {
	// Request client certificates for this hostname in China. Can only be set to true
	// if this zone is china network enabled.
	ChinaNetwork bool `json:"china_network,required"`
	// Client Certificate Forwarding is a feature that takes the client cert provided
	// by the eyeball to the edge, and forwards it to the origin as a HTTP header to
	// allow logging on the origin.
	ClientCertificateForwarding bool `json:"client_certificate_forwarding,required"`
	// The hostname that these settings apply to.
	Hostname string             `json:"hostname,required"`
	JSON     accessSettingsJSON `json:"-"`
}

func (*AccessSettings) UnmarshalJSON 

func (r *AccessSettings) UnmarshalJSON(data []byte) (err error)

type AccessSettingsParam 

type AccessSettingsParam struct {
	// Request client certificates for this hostname in China. Can only be set to true
	// if this zone is china network enabled.
	ChinaNetwork param.Field[bool] `json:"china_network,required"`
	// Client Certificate Forwarding is a feature that takes the client cert provided
	// by the eyeball to the edge, and forwards it to the origin as a HTTP header to
	// allow logging on the origin.
	ClientCertificateForwarding param.Field[bool] `json:"client_certificate_forwarding,required"`
	// The hostname that these settings apply to.
	Hostname param.Field[string] `json:"hostname,required"`
}

func (AccessSettingsParam) MarshalJSON 

func (r AccessSettingsParam) MarshalJSON() (data []byte, err error)

type AccessTag 

type AccessTag struct {
	// The name of the tag
	Name string `json:"name,required"`
	// The number of applications that have this tag
	AppCount  int64         `json:"app_count"`
	CreatedAt time.Time     `json:"created_at" format:"date-time"`
	UpdatedAt time.Time     `json:"updated_at" format:"date-time"`
	JSON      accessTagJSON `json:"-"`
}

A tag

func (*AccessTag) UnmarshalJSON 

func (r *AccessTag) UnmarshalJSON(data []byte) (err error)

type AccessTagDeleteResponse 

type AccessTagDeleteResponse struct {
	// The name of the tag
	Name string                      `json:"name"`
	JSON accessTagDeleteResponseJSON `json:"-"`
}

func (*AccessTagDeleteResponse) UnmarshalJSON 

func (r *AccessTagDeleteResponse) UnmarshalJSON(data []byte) (err error)

type AccessTagDeleteResponseEnvelope 

type AccessTagDeleteResponseEnvelope struct {
	Errors   []AccessTagDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessTagDeleteResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessTagDeleteResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success AccessTagDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessTagDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*AccessTagDeleteResponseEnvelope) UnmarshalJSON 

func (r *AccessTagDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AccessTagDeleteResponseEnvelopeErrors 

type AccessTagDeleteResponseEnvelopeErrors struct {
	Code    int64                                     `json:"code,required"`
	Message string                                    `json:"message,required"`
	JSON    accessTagDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessTagDeleteResponseEnvelopeErrors) UnmarshalJSON 

func (r *AccessTagDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type AccessTagDeleteResponseEnvelopeMessages 

type AccessTagDeleteResponseEnvelopeMessages struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    accessTagDeleteResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessTagDeleteResponseEnvelopeMessages) UnmarshalJSON 

func (r *AccessTagDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type AccessTagDeleteResponseEnvelopeSuccess 

type AccessTagDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessTagDeleteResponseEnvelopeSuccessTrue AccessTagDeleteResponseEnvelopeSuccess = true
)

type AccessTagGetResponseEnvelope 

type AccessTagGetResponseEnvelope struct {
	Errors   []AccessTagGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessTagGetResponseEnvelopeMessages `json:"messages,required"`
	// A tag
	Result AccessTag `json:"result,required"`
	// Whether the API call was successful
	Success AccessTagGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessTagGetResponseEnvelopeJSON    `json:"-"`
}

func (*AccessTagGetResponseEnvelope) UnmarshalJSON 

func (r *AccessTagGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AccessTagGetResponseEnvelopeErrors 

type AccessTagGetResponseEnvelopeErrors struct {
	Code    int64                                  `json:"code,required"`
	Message string                                 `json:"message,required"`
	JSON    accessTagGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessTagGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *AccessTagGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type AccessTagGetResponseEnvelopeMessages 

type AccessTagGetResponseEnvelopeMessages struct {
	Code    int64                                    `json:"code,required"`
	Message string                                   `json:"message,required"`
	JSON    accessTagGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessTagGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *AccessTagGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type AccessTagGetResponseEnvelopeSuccess 

type AccessTagGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessTagGetResponseEnvelopeSuccessTrue AccessTagGetResponseEnvelopeSuccess = true
)

type AccessTagListResponseEnvelope 

type AccessTagListResponseEnvelope struct {
	Errors   []AccessTagListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessTagListResponseEnvelopeMessages `json:"messages,required"`
	Result   []AccessTag                             `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    AccessTagListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo AccessTagListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       accessTagListResponseEnvelopeJSON       `json:"-"`
}

func (*AccessTagListResponseEnvelope) UnmarshalJSON 

func (r *AccessTagListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AccessTagListResponseEnvelopeErrors 

type AccessTagListResponseEnvelopeErrors struct {
	Code    int64                                   `json:"code,required"`
	Message string                                  `json:"message,required"`
	JSON    accessTagListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessTagListResponseEnvelopeErrors) UnmarshalJSON 

func (r *AccessTagListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type AccessTagListResponseEnvelopeMessages 

type AccessTagListResponseEnvelopeMessages struct {
	Code    int64                                     `json:"code,required"`
	Message string                                    `json:"message,required"`
	JSON    accessTagListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessTagListResponseEnvelopeMessages) UnmarshalJSON 

func (r *AccessTagListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type AccessTagListResponseEnvelopeResultInfo 

type AccessTagListResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                     `json:"total_count"`
	JSON       accessTagListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*AccessTagListResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *AccessTagListResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type AccessTagListResponseEnvelopeSuccess 

type AccessTagListResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessTagListResponseEnvelopeSuccessTrue AccessTagListResponseEnvelopeSuccess = true
)

type AccessTagNewParams 

type AccessTagNewParams struct {
	// The name of the tag
	Name param.Field[string] `json:"name,required"`
}

func (AccessTagNewParams) MarshalJSON 

func (r AccessTagNewParams) MarshalJSON() (data []byte, err error)

type AccessTagNewResponseEnvelope 

type AccessTagNewResponseEnvelope struct {
	Errors   []AccessTagNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessTagNewResponseEnvelopeMessages `json:"messages,required"`
	// A tag
	Result AccessTag `json:"result,required"`
	// Whether the API call was successful
	Success AccessTagNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessTagNewResponseEnvelopeJSON    `json:"-"`
}

func (*AccessTagNewResponseEnvelope) UnmarshalJSON 

func (r *AccessTagNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AccessTagNewResponseEnvelopeErrors 

type AccessTagNewResponseEnvelopeErrors struct {
	Code    int64                                  `json:"code,required"`
	Message string                                 `json:"message,required"`
	JSON    accessTagNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessTagNewResponseEnvelopeErrors) UnmarshalJSON 

func (r *AccessTagNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type AccessTagNewResponseEnvelopeMessages 

type AccessTagNewResponseEnvelopeMessages struct {
	Code    int64                                    `json:"code,required"`
	Message string                                   `json:"message,required"`
	JSON    accessTagNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessTagNewResponseEnvelopeMessages) UnmarshalJSON 

func (r *AccessTagNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type AccessTagNewResponseEnvelopeSuccess 

type AccessTagNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessTagNewResponseEnvelopeSuccessTrue AccessTagNewResponseEnvelopeSuccess = true
)

type AccessTagService 

type AccessTagService struct {
	Options []option.RequestOption
}

AccessTagService 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 NewAccessTagService method instead.

func NewAccessTagService 

func NewAccessTagService(opts ...option.RequestOption) (r *AccessTagService)

NewAccessTagService 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 (*AccessTagService) Delete 

func (r *AccessTagService) Delete(ctx context.Context, identifier string, name string, opts ...option.RequestOption) (res *AccessTagDeleteResponse, err error)

Delete a tag

func (*AccessTagService) Get 

func (r *AccessTagService) Get(ctx context.Context, identifier string, name string, opts ...option.RequestOption) (res *AccessTag, err error)

Get a tag

func (*AccessTagService) List 

func (r *AccessTagService) List(ctx context.Context, identifier string, opts ...option.RequestOption) (res *[]AccessTag, err error)

List tags

func (*AccessTagService) New 

func (r *AccessTagService) New(ctx context.Context, identifier string, body AccessTagNewParams, opts ...option.RequestOption) (res *AccessTag, err error)

Create a tag

func (*AccessTagService) Update 

func (r *AccessTagService) Update(ctx context.Context, identifier string, tagName string, body AccessTagUpdateParams, opts ...option.RequestOption) (res *AccessTag, err error)

Update a tag

type AccessTagUpdateParams 

type AccessTagUpdateParams struct {
	// The name of the tag
	Name param.Field[string] `json:"name,required"`
}

func (AccessTagUpdateParams) MarshalJSON 

func (r AccessTagUpdateParams) MarshalJSON() (data []byte, err error)

type AccessTagUpdateResponseEnvelope 

type AccessTagUpdateResponseEnvelope struct {
	Errors   []AccessTagUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessTagUpdateResponseEnvelopeMessages `json:"messages,required"`
	// A tag
	Result AccessTag `json:"result,required"`
	// Whether the API call was successful
	Success AccessTagUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessTagUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*AccessTagUpdateResponseEnvelope) UnmarshalJSON 

func (r *AccessTagUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AccessTagUpdateResponseEnvelopeErrors 

type AccessTagUpdateResponseEnvelopeErrors struct {
	Code    int64                                     `json:"code,required"`
	Message string                                    `json:"message,required"`
	JSON    accessTagUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessTagUpdateResponseEnvelopeErrors) UnmarshalJSON 

func (r *AccessTagUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type AccessTagUpdateResponseEnvelopeMessages 

type AccessTagUpdateResponseEnvelopeMessages struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    accessTagUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessTagUpdateResponseEnvelopeMessages) UnmarshalJSON 

func (r *AccessTagUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type AccessTagUpdateResponseEnvelopeSuccess 

type AccessTagUpdateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessTagUpdateResponseEnvelopeSuccessTrue AccessTagUpdateResponseEnvelopeSuccess = true
)

type AccessUserActiveSessionGetResponse 

type AccessUserActiveSessionGetResponse struct {
	AccountID          string                                                     `json:"account_id"`
	AuthStatus         string                                                     `json:"auth_status"`
	CommonName         string                                                     `json:"common_name"`
	DeviceID           string                                                     `json:"device_id"`
	DeviceSessions     map[string]AccessUserActiveSessionGetResponseDeviceSession `json:"device_sessions"`
	DevicePosture      map[string]AccessUserActiveSessionGetResponseDevicePosture `json:"devicePosture"`
	Email              string                                                     `json:"email"`
	Geo                AccessUserActiveSessionGetResponseGeo                      `json:"geo"`
	Iat                float64                                                    `json:"iat"`
	Idp                AccessUserActiveSessionGetResponseIdp                      `json:"idp"`
	IP                 string                                                     `json:"ip"`
	IsGateway          bool                                                       `json:"is_gateway"`
	IsWARP             bool                                                       `json:"is_warp"`
	IsActive           bool                                                       `json:"isActive"`
	MTLSAuth           AccessUserActiveSessionGetResponseMTLSAuth                 `json:"mtls_auth"`
	ServiceTokenID     string                                                     `json:"service_token_id"`
	ServiceTokenStatus bool                                                       `json:"service_token_status"`
	UserUUID           string                                                     `json:"user_uuid"`
	Version            float64                                                    `json:"version"`
	JSON               accessUserActiveSessionGetResponseJSON                     `json:"-"`
}

func (*AccessUserActiveSessionGetResponse) UnmarshalJSON 

func (r *AccessUserActiveSessionGetResponse) UnmarshalJSON(data []byte) (err error)

type AccessUserActiveSessionGetResponseDevicePosture 

type AccessUserActiveSessionGetResponseDevicePosture struct {
	ID          string                                               `json:"id"`
	Check       AccessUserActiveSessionGetResponseDevicePostureCheck `json:"check"`
	Data        interface{}                                          `json:"data"`
	Description string                                               `json:"description"`
	Error       string                                               `json:"error"`
	RuleName    string                                               `json:"rule_name"`
	Success     bool                                                 `json:"success"`
	Timestamp   string                                               `json:"timestamp"`
	Type        string                                               `json:"type"`
	JSON        accessUserActiveSessionGetResponseDevicePostureJSON  `json:"-"`
}

func (*AccessUserActiveSessionGetResponseDevicePosture) UnmarshalJSON 

func (r *AccessUserActiveSessionGetResponseDevicePosture) UnmarshalJSON(data []byte) (err error)

type AccessUserActiveSessionGetResponseDevicePostureCheck 

type AccessUserActiveSessionGetResponseDevicePostureCheck struct {
	Exists bool                                                     `json:"exists"`
	Path   string                                                   `json:"path"`
	JSON   accessUserActiveSessionGetResponseDevicePostureCheckJSON `json:"-"`
}

func (*AccessUserActiveSessionGetResponseDevicePostureCheck) UnmarshalJSON 

func (r *AccessUserActiveSessionGetResponseDevicePostureCheck) UnmarshalJSON(data []byte) (err error)

type AccessUserActiveSessionGetResponseDeviceSession 

type AccessUserActiveSessionGetResponseDeviceSession struct {
	LastAuthenticated float64                                             `json:"last_authenticated"`
	JSON              accessUserActiveSessionGetResponseDeviceSessionJSON `json:"-"`
}

func (*AccessUserActiveSessionGetResponseDeviceSession) UnmarshalJSON 

func (r *AccessUserActiveSessionGetResponseDeviceSession) UnmarshalJSON(data []byte) (err error)

type AccessUserActiveSessionGetResponseEnvelope 

type AccessUserActiveSessionGetResponseEnvelope struct {
	Errors   []AccessUserActiveSessionGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessUserActiveSessionGetResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessUserActiveSessionGetResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success AccessUserActiveSessionGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessUserActiveSessionGetResponseEnvelopeJSON    `json:"-"`
}

func (*AccessUserActiveSessionGetResponseEnvelope) UnmarshalJSON 

func (r *AccessUserActiveSessionGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AccessUserActiveSessionGetResponseEnvelopeErrors 

type AccessUserActiveSessionGetResponseEnvelopeErrors struct {
	Code    int64                                                `json:"code,required"`
	Message string                                               `json:"message,required"`
	JSON    accessUserActiveSessionGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessUserActiveSessionGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *AccessUserActiveSessionGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type AccessUserActiveSessionGetResponseEnvelopeMessages 

type AccessUserActiveSessionGetResponseEnvelopeMessages struct {
	Code    int64                                                  `json:"code,required"`
	Message string                                                 `json:"message,required"`
	JSON    accessUserActiveSessionGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessUserActiveSessionGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *AccessUserActiveSessionGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type AccessUserActiveSessionGetResponseEnvelopeSuccess 

type AccessUserActiveSessionGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessUserActiveSessionGetResponseEnvelopeSuccessTrue AccessUserActiveSessionGetResponseEnvelopeSuccess = true
)

type AccessUserActiveSessionGetResponseGeo 

type AccessUserActiveSessionGetResponseGeo struct {
	Country string                                    `json:"country"`
	JSON    accessUserActiveSessionGetResponseGeoJSON `json:"-"`
}

func (*AccessUserActiveSessionGetResponseGeo) UnmarshalJSON 

func (r *AccessUserActiveSessionGetResponseGeo) UnmarshalJSON(data []byte) (err error)

type AccessUserActiveSessionGetResponseIdp 

type AccessUserActiveSessionGetResponseIdp struct {
	ID   string                                    `json:"id"`
	Type string                                    `json:"type"`
	JSON accessUserActiveSessionGetResponseIdpJSON `json:"-"`
}

func (*AccessUserActiveSessionGetResponseIdp) UnmarshalJSON 

func (r *AccessUserActiveSessionGetResponseIdp) UnmarshalJSON(data []byte) (err error)

type AccessUserActiveSessionGetResponseMTLSAuth 

type AccessUserActiveSessionGetResponseMTLSAuth struct {
	AuthStatus    string                                         `json:"auth_status"`
	CertIssuerDn  string                                         `json:"cert_issuer_dn"`
	CertIssuerSki string                                         `json:"cert_issuer_ski"`
	CertPresented bool                                           `json:"cert_presented"`
	CertSerial    string                                         `json:"cert_serial"`
	JSON          accessUserActiveSessionGetResponseMTLSAuthJSON `json:"-"`
}

func (*AccessUserActiveSessionGetResponseMTLSAuth) UnmarshalJSON 

func (r *AccessUserActiveSessionGetResponseMTLSAuth) UnmarshalJSON(data []byte) (err error)

type AccessUserActiveSessionListResponse 

type AccessUserActiveSessionListResponse struct {
	Expiration int64                                       `json:"expiration"`
	Metadata   AccessUserActiveSessionListResponseMetadata `json:"metadata"`
	Name       string                                      `json:"name"`
	JSON       accessUserActiveSessionListResponseJSON     `json:"-"`
}

func (*AccessUserActiveSessionListResponse) UnmarshalJSON 

func (r *AccessUserActiveSessionListResponse) UnmarshalJSON(data []byte) (err error)

type AccessUserActiveSessionListResponseEnvelope 

type AccessUserActiveSessionListResponseEnvelope struct {
	Errors   []AccessUserActiveSessionListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessUserActiveSessionListResponseEnvelopeMessages `json:"messages,required"`
	Result   []AccessUserActiveSessionListResponse                 `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    AccessUserActiveSessionListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo AccessUserActiveSessionListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       accessUserActiveSessionListResponseEnvelopeJSON       `json:"-"`
}

func (*AccessUserActiveSessionListResponseEnvelope) UnmarshalJSON 

func (r *AccessUserActiveSessionListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AccessUserActiveSessionListResponseEnvelopeErrors 

type AccessUserActiveSessionListResponseEnvelopeErrors struct {
	Code    int64                                                 `json:"code,required"`
	Message string                                                `json:"message,required"`
	JSON    accessUserActiveSessionListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessUserActiveSessionListResponseEnvelopeErrors) UnmarshalJSON 

func (r *AccessUserActiveSessionListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type AccessUserActiveSessionListResponseEnvelopeMessages 

type AccessUserActiveSessionListResponseEnvelopeMessages struct {
	Code    int64                                                   `json:"code,required"`
	Message string                                                  `json:"message,required"`
	JSON    accessUserActiveSessionListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessUserActiveSessionListResponseEnvelopeMessages) UnmarshalJSON 

func (r *AccessUserActiveSessionListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type AccessUserActiveSessionListResponseEnvelopeResultInfo 

type AccessUserActiveSessionListResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                                   `json:"total_count"`
	JSON       accessUserActiveSessionListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*AccessUserActiveSessionListResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *AccessUserActiveSessionListResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type AccessUserActiveSessionListResponseEnvelopeSuccess 

type AccessUserActiveSessionListResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessUserActiveSessionListResponseEnvelopeSuccessTrue AccessUserActiveSessionListResponseEnvelopeSuccess = true
)

type AccessUserActiveSessionListResponseMetadata 

type AccessUserActiveSessionListResponseMetadata struct {
	Apps    map[string]AccessUserActiveSessionListResponseMetadataApp `json:"apps"`
	Expires int64                                                     `json:"expires"`
	Iat     int64                                                     `json:"iat"`
	Nonce   string                                                    `json:"nonce"`
	TTL     int64                                                     `json:"ttl"`
	JSON    accessUserActiveSessionListResponseMetadataJSON           `json:"-"`
}

func (*AccessUserActiveSessionListResponseMetadata) UnmarshalJSON 

func (r *AccessUserActiveSessionListResponseMetadata) UnmarshalJSON(data []byte) (err error)

type AccessUserActiveSessionListResponseMetadataApp 

type AccessUserActiveSessionListResponseMetadataApp struct {
	Hostname string                                             `json:"hostname"`
	Name     string                                             `json:"name"`
	Type     string                                             `json:"type"`
	Uid      string                                             `json:"uid"`
	JSON     accessUserActiveSessionListResponseMetadataAppJSON `json:"-"`
}

func (*AccessUserActiveSessionListResponseMetadataApp) UnmarshalJSON 

func (r *AccessUserActiveSessionListResponseMetadataApp) UnmarshalJSON(data []byte) (err error)

type AccessUserActiveSessionService 

type AccessUserActiveSessionService struct {
	Options []option.RequestOption
}

AccessUserActiveSessionService 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 NewAccessUserActiveSessionService method instead.

func NewAccessUserActiveSessionService 

func NewAccessUserActiveSessionService(opts ...option.RequestOption) (r *AccessUserActiveSessionService)

NewAccessUserActiveSessionService 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 (*AccessUserActiveSessionService) Get 

func (r *AccessUserActiveSessionService) Get(ctx context.Context, identifier string, id string, nonce string, opts ...option.RequestOption) (res *AccessUserActiveSessionGetResponse, err error)

Get an active session for a single user.

func (*AccessUserActiveSessionService) List 

func (r *AccessUserActiveSessionService) List(ctx context.Context, identifier string, id string, opts ...option.RequestOption) (res *[]AccessUserActiveSessionListResponse, err error)

Get active sessions for a single user.

type AccessUserFailedLoginListResponse 

type AccessUserFailedLoginListResponse struct {
	Expiration int64                                 `json:"expiration"`
	Metadata   interface{}                           `json:"metadata"`
	JSON       accessUserFailedLoginListResponseJSON `json:"-"`
}

func (*AccessUserFailedLoginListResponse) UnmarshalJSON 

func (r *AccessUserFailedLoginListResponse) UnmarshalJSON(data []byte) (err error)

type AccessUserFailedLoginListResponseEnvelope 

type AccessUserFailedLoginListResponseEnvelope struct {
	Errors   []AccessUserFailedLoginListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessUserFailedLoginListResponseEnvelopeMessages `json:"messages,required"`
	Result   []AccessUserFailedLoginListResponse                 `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    AccessUserFailedLoginListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo AccessUserFailedLoginListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       accessUserFailedLoginListResponseEnvelopeJSON       `json:"-"`
}

func (*AccessUserFailedLoginListResponseEnvelope) UnmarshalJSON 

func (r *AccessUserFailedLoginListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AccessUserFailedLoginListResponseEnvelopeErrors 

type AccessUserFailedLoginListResponseEnvelopeErrors struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    accessUserFailedLoginListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessUserFailedLoginListResponseEnvelopeErrors) UnmarshalJSON 

func (r *AccessUserFailedLoginListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type AccessUserFailedLoginListResponseEnvelopeMessages 

type AccessUserFailedLoginListResponseEnvelopeMessages struct {
	Code    int64                                                 `json:"code,required"`
	Message string                                                `json:"message,required"`
	JSON    accessUserFailedLoginListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessUserFailedLoginListResponseEnvelopeMessages) UnmarshalJSON 

func (r *AccessUserFailedLoginListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type AccessUserFailedLoginListResponseEnvelopeResultInfo 

type AccessUserFailedLoginListResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                                 `json:"total_count"`
	JSON       accessUserFailedLoginListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*AccessUserFailedLoginListResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *AccessUserFailedLoginListResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type AccessUserFailedLoginListResponseEnvelopeSuccess 

type AccessUserFailedLoginListResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessUserFailedLoginListResponseEnvelopeSuccessTrue AccessUserFailedLoginListResponseEnvelopeSuccess = true
)

type AccessUserFailedLoginService 

type AccessUserFailedLoginService struct {
	Options []option.RequestOption
}

AccessUserFailedLoginService 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 NewAccessUserFailedLoginService method instead.

func NewAccessUserFailedLoginService 

func NewAccessUserFailedLoginService(opts ...option.RequestOption) (r *AccessUserFailedLoginService)

NewAccessUserFailedLoginService 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 (*AccessUserFailedLoginService) List 

func (r *AccessUserFailedLoginService) List(ctx context.Context, identifier string, id string, opts ...option.RequestOption) (res *[]AccessUserFailedLoginListResponse, err error)

Get all failed login attempts for a single user.

type AccessUserLastSeenIdentityGetResponseEnvelope 

type AccessUserLastSeenIdentityGetResponseEnvelope struct {
	Errors   []AccessUserLastSeenIdentityGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessUserLastSeenIdentityGetResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessIdentity                                          `json:"result,required"`
	// Whether the API call was successful
	Success AccessUserLastSeenIdentityGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    accessUserLastSeenIdentityGetResponseEnvelopeJSON    `json:"-"`
}

func (*AccessUserLastSeenIdentityGetResponseEnvelope) UnmarshalJSON 

func (r *AccessUserLastSeenIdentityGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AccessUserLastSeenIdentityGetResponseEnvelopeErrors 

type AccessUserLastSeenIdentityGetResponseEnvelopeErrors struct {
	Code    int64                                                   `json:"code,required"`
	Message string                                                  `json:"message,required"`
	JSON    accessUserLastSeenIdentityGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessUserLastSeenIdentityGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *AccessUserLastSeenIdentityGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type AccessUserLastSeenIdentityGetResponseEnvelopeMessages 

type AccessUserLastSeenIdentityGetResponseEnvelopeMessages struct {
	Code    int64                                                     `json:"code,required"`
	Message string                                                    `json:"message,required"`
	JSON    accessUserLastSeenIdentityGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessUserLastSeenIdentityGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *AccessUserLastSeenIdentityGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type AccessUserLastSeenIdentityGetResponseEnvelopeSuccess 

type AccessUserLastSeenIdentityGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessUserLastSeenIdentityGetResponseEnvelopeSuccessTrue AccessUserLastSeenIdentityGetResponseEnvelopeSuccess = true
)

type AccessUserLastSeenIdentityService 

type AccessUserLastSeenIdentityService struct {
	Options []option.RequestOption
}

AccessUserLastSeenIdentityService 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 NewAccessUserLastSeenIdentityService method instead.

func NewAccessUserLastSeenIdentityService 

func NewAccessUserLastSeenIdentityService(opts ...option.RequestOption) (r *AccessUserLastSeenIdentityService)

NewAccessUserLastSeenIdentityService 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 (*AccessUserLastSeenIdentityService) Get 

func (r *AccessUserLastSeenIdentityService) Get(ctx context.Context, identifier string, id string, opts ...option.RequestOption) (res *AccessIdentity, err error)

Get last seen identity for a single user.

type AccessUserListResponseEnvelope 

type AccessUserListResponseEnvelope struct {
	Errors   []AccessUserListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccessUserListResponseEnvelopeMessages `json:"messages,required"`
	Result   []AccessUsers                            `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    AccessUserListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo AccessUserListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       accessUserListResponseEnvelopeJSON       `json:"-"`
}

func (*AccessUserListResponseEnvelope) UnmarshalJSON 

func (r *AccessUserListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AccessUserListResponseEnvelopeErrors 

type AccessUserListResponseEnvelopeErrors struct {
	Code    int64                                    `json:"code,required"`
	Message string                                   `json:"message,required"`
	JSON    accessUserListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AccessUserListResponseEnvelopeErrors) UnmarshalJSON 

func (r *AccessUserListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type AccessUserListResponseEnvelopeMessages 

type AccessUserListResponseEnvelopeMessages struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    accessUserListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AccessUserListResponseEnvelopeMessages) UnmarshalJSON 

func (r *AccessUserListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type AccessUserListResponseEnvelopeResultInfo 

type AccessUserListResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                      `json:"total_count"`
	JSON       accessUserListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*AccessUserListResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *AccessUserListResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type AccessUserListResponseEnvelopeSuccess 

type AccessUserListResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	AccessUserListResponseEnvelopeSuccessTrue AccessUserListResponseEnvelopeSuccess = true
)

type AccessUserService 

type AccessUserService struct {
	Options          []option.RequestOption
	ActiveSessions   *AccessUserActiveSessionService
	LastSeenIdentity *AccessUserLastSeenIdentityService
	FailedLogins     *AccessUserFailedLoginService
}

AccessUserService 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 NewAccessUserService method instead.

func NewAccessUserService 

func NewAccessUserService(opts ...option.RequestOption) (r *AccessUserService)

NewAccessUserService 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 (*AccessUserService) List 

func (r *AccessUserService) List(ctx context.Context, identifier string, opts ...option.RequestOption) (res *[]AccessUsers, err error)

Gets a list of users for an account.

type AccessUsers 

type AccessUsers struct {
	// UUID
	ID string `json:"id"`
	// True if the user has authenticated with Cloudflare Access.
	AccessSeat bool `json:"access_seat"`
	// The number of active devices registered to the user.
	ActiveDeviceCount float64   `json:"active_device_count"`
	CreatedAt         time.Time `json:"created_at" format:"date-time"`
	// The email of the user.
	Email string `json:"email" format:"email"`
	// True if the user has logged into the WARP client.
	GatewaySeat bool `json:"gateway_seat"`
	// The time at which the user last successfully logged in.
	LastSuccessfulLogin time.Time `json:"last_successful_login" format:"date-time"`
	// The name of the user.
	Name string `json:"name"`
	// The unique API identifier for the Zero Trust seat.
	SeatUid interface{} `json:"seat_uid"`
	// The unique API identifier for the user.
	Uid       interface{}     `json:"uid"`
	UpdatedAt time.Time       `json:"updated_at" format:"date-time"`
	JSON      accessUsersJSON `json:"-"`
}

func (*AccessUsers) UnmarshalJSON 

func (r *AccessUsers) UnmarshalJSON(data []byte) (err error)

type ConnectivitySettingEditParams 

type ConnectivitySettingEditParams struct {
	// Cloudflare account ID
	AccountID param.Field[string] `path:"account_id,required"`
	// A flag to enable the ICMP proxy for the account network.
	IcmpProxyEnabled param.Field[bool] `json:"icmp_proxy_enabled"`
	// A flag to enable WARP to WARP traffic.
	OfframpWARPEnabled param.Field[bool] `json:"offramp_warp_enabled"`
}

func (ConnectivitySettingEditParams) MarshalJSON 

func (r ConnectivitySettingEditParams) MarshalJSON() (data []byte, err error)

type ConnectivitySettingEditResponse 

type ConnectivitySettingEditResponse struct {
	// A flag to enable the ICMP proxy for the account network.
	IcmpProxyEnabled bool `json:"icmp_proxy_enabled"`
	// A flag to enable WARP to WARP traffic.
	OfframpWARPEnabled bool                                `json:"offramp_warp_enabled"`
	JSON               connectivitySettingEditResponseJSON `json:"-"`
}

func (*ConnectivitySettingEditResponse) UnmarshalJSON 

func (r *ConnectivitySettingEditResponse) UnmarshalJSON(data []byte) (err error)

type ConnectivitySettingEditResponseEnvelope 

type ConnectivitySettingEditResponseEnvelope struct {
	Errors   []ConnectivitySettingEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ConnectivitySettingEditResponseEnvelopeMessages `json:"messages,required"`
	Result   ConnectivitySettingEditResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success ConnectivitySettingEditResponseEnvelopeSuccess `json:"success,required"`
	JSON    connectivitySettingEditResponseEnvelopeJSON    `json:"-"`
}

func (*ConnectivitySettingEditResponseEnvelope) UnmarshalJSON 

func (r *ConnectivitySettingEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type ConnectivitySettingEditResponseEnvelopeErrors 

type ConnectivitySettingEditResponseEnvelopeErrors struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    connectivitySettingEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ConnectivitySettingEditResponseEnvelopeErrors) UnmarshalJSON 

func (r *ConnectivitySettingEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type ConnectivitySettingEditResponseEnvelopeMessages 

type ConnectivitySettingEditResponseEnvelopeMessages struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    connectivitySettingEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*ConnectivitySettingEditResponseEnvelopeMessages) UnmarshalJSON 

func (r *ConnectivitySettingEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type ConnectivitySettingEditResponseEnvelopeSuccess 

type ConnectivitySettingEditResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	ConnectivitySettingEditResponseEnvelopeSuccessTrue ConnectivitySettingEditResponseEnvelopeSuccess = true
)

type ConnectivitySettingGetParams 

type ConnectivitySettingGetParams struct {
	// Cloudflare account ID
	AccountID param.Field[string] `path:"account_id,required"`
}

type ConnectivitySettingGetResponse 

type ConnectivitySettingGetResponse struct {
	// A flag to enable the ICMP proxy for the account network.
	IcmpProxyEnabled bool `json:"icmp_proxy_enabled"`
	// A flag to enable WARP to WARP traffic.
	OfframpWARPEnabled bool                               `json:"offramp_warp_enabled"`
	JSON               connectivitySettingGetResponseJSON `json:"-"`
}

func (*ConnectivitySettingGetResponse) UnmarshalJSON 

func (r *ConnectivitySettingGetResponse) UnmarshalJSON(data []byte) (err error)

type ConnectivitySettingGetResponseEnvelope 

type ConnectivitySettingGetResponseEnvelope struct {
	Errors   []ConnectivitySettingGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ConnectivitySettingGetResponseEnvelopeMessages `json:"messages,required"`
	Result   ConnectivitySettingGetResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success ConnectivitySettingGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    connectivitySettingGetResponseEnvelopeJSON    `json:"-"`
}

func (*ConnectivitySettingGetResponseEnvelope) UnmarshalJSON 

func (r *ConnectivitySettingGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type ConnectivitySettingGetResponseEnvelopeErrors 

type ConnectivitySettingGetResponseEnvelopeErrors struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    connectivitySettingGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ConnectivitySettingGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *ConnectivitySettingGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type ConnectivitySettingGetResponseEnvelopeMessages 

type ConnectivitySettingGetResponseEnvelopeMessages struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    connectivitySettingGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*ConnectivitySettingGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *ConnectivitySettingGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type ConnectivitySettingGetResponseEnvelopeSuccess 

type ConnectivitySettingGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	ConnectivitySettingGetResponseEnvelopeSuccessTrue ConnectivitySettingGetResponseEnvelopeSuccess = true
)

type ConnectivitySettingService 

type ConnectivitySettingService struct {
	Options []option.RequestOption
}

ConnectivitySettingService 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 NewConnectivitySettingService method instead.

func NewConnectivitySettingService 

func NewConnectivitySettingService(opts ...option.RequestOption) (r *ConnectivitySettingService)

NewConnectivitySettingService 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 (*ConnectivitySettingService) Edit 

func (r *ConnectivitySettingService) Edit(ctx context.Context, params ConnectivitySettingEditParams, opts ...option.RequestOption) (res *ConnectivitySettingEditResponse, err error)

Updates the Zero Trust Connectivity Settings for the given account.

func (*ConnectivitySettingService) Get 

func (r *ConnectivitySettingService) Get(ctx context.Context, query ConnectivitySettingGetParams, opts ...option.RequestOption) (res *ConnectivitySettingGetResponse, err error)

Gets the Zero Trust Connectivity Settings for the given account.

type DEXColoListParams 

type DEXColoListParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
	// End time for connection period in RFC3339 (ISO 8601) format.
	TimeEnd param.Field[string] `query:"timeEnd,required"`
	// Start time for connection period in RFC3339 (ISO 8601) format.
	TimeStart param.Field[string] `query:"timeStart,required"`
	// Type of usage that colos should be sorted by. If unspecified, returns all
	// Cloudflare colos sorted alphabetically.
	SortBy param.Field[DEXColoListParamsSortBy] `query:"sortBy"`
}

func (DEXColoListParams) URLQuery 

func (r DEXColoListParams) URLQuery() (v url.Values)

URLQuery serializes DEXColoListParams's query parameters as `url.Values`.

type DEXColoListParamsSortBy 

type DEXColoListParamsSortBy string

Type of usage that colos should be sorted by. If unspecified, returns all Cloudflare colos sorted alphabetically. 

const (
	DEXColoListParamsSortByFleetStatusUsage      DEXColoListParamsSortBy = "fleet-status-usage"
	DEXColoListParamsSortByApplicationTestsUsage DEXColoListParamsSortBy = "application-tests-usage"
)

type DEXColoListResponse 

type DEXColoListResponse = interface{}

type DEXColoListResponseEnvelope 

type DEXColoListResponseEnvelope struct {
	Errors   []DEXColoListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DEXColoListResponseEnvelopeMessages `json:"messages,required"`
	// array of colos.
	Result []DEXColoListResponse `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    DEXColoListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo DEXColoListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       dexColoListResponseEnvelopeJSON       `json:"-"`
}

func (*DEXColoListResponseEnvelope) UnmarshalJSON 

func (r *DEXColoListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DEXColoListResponseEnvelopeErrors 

type DEXColoListResponseEnvelopeErrors struct {
	Code    int64                                 `json:"code,required"`
	Message string                                `json:"message,required"`
	JSON    dexColoListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DEXColoListResponseEnvelopeErrors) UnmarshalJSON 

func (r *DEXColoListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DEXColoListResponseEnvelopeMessages 

type DEXColoListResponseEnvelopeMessages struct {
	Code    int64                                   `json:"code,required"`
	Message string                                  `json:"message,required"`
	JSON    dexColoListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DEXColoListResponseEnvelopeMessages) UnmarshalJSON 

func (r *DEXColoListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DEXColoListResponseEnvelopeResultInfo 

type DEXColoListResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                   `json:"total_count"`
	JSON       dexColoListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*DEXColoListResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *DEXColoListResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type DEXColoListResponseEnvelopeSuccess 

type DEXColoListResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	DEXColoListResponseEnvelopeSuccessTrue DEXColoListResponseEnvelopeSuccess = true
)

type DEXColoService 

type DEXColoService struct {
	Options []option.RequestOption
}

DEXColoService 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 NewDEXColoService method instead.

func NewDEXColoService 

func NewDEXColoService(opts ...option.RequestOption) (r *DEXColoService)

NewDEXColoService 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 (*DEXColoService) List 

func (r *DEXColoService) List(ctx context.Context, params DEXColoListParams, opts ...option.RequestOption) (res *[]DEXColoListResponse, err error)

List Cloudflare colos that account's devices were connected to during a time period, sorted by usage starting from the most used colo. Colos without traffic are also returned and sorted alphabetically.

type DEXFleetStatusDeviceListParams 

type DEXFleetStatusDeviceListParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
	// Page number of paginated results
	Page param.Field[float64] `query:"page,required"`
	// Number of items per page
	PerPage param.Field[float64] `query:"per_page,required"`
	// Timestamp in ISO format
	TimeEnd param.Field[string] `query:"time_end,required"`
	// Timestamp in ISO format
	TimeStart param.Field[string] `query:"time_start,required"`
	// Cloudflare colo
	Colo param.Field[string] `query:"colo"`
	// Device-specific ID, given as UUID v4
	DeviceID param.Field[string] `query:"device_id"`
	// The mode under which the WARP client is run
	Mode param.Field[string] `query:"mode"`
	// Operating system
	Platform param.Field[string] `query:"platform"`
	// Dimension to sort results by
	SortBy param.Field[DEXFleetStatusDeviceListParamsSortBy] `query:"sort_by"`
	// Network status
	Status param.Field[string] `query:"status"`
	// WARP client version
	Version param.Field[string] `query:"version"`
}

func (DEXFleetStatusDeviceListParams) URLQuery 

func (r DEXFleetStatusDeviceListParams) URLQuery() (v url.Values)

URLQuery serializes DEXFleetStatusDeviceListParams's query parameters as `url.Values`.

type DEXFleetStatusDeviceListParamsSortBy 

type DEXFleetStatusDeviceListParamsSortBy string

Dimension to sort results by 

const (
	DEXFleetStatusDeviceListParamsSortByColo      DEXFleetStatusDeviceListParamsSortBy = "colo"
	DEXFleetStatusDeviceListParamsSortByDeviceID  DEXFleetStatusDeviceListParamsSortBy = "device_id"
	DEXFleetStatusDeviceListParamsSortByMode      DEXFleetStatusDeviceListParamsSortBy = "mode"
	DEXFleetStatusDeviceListParamsSortByPlatform  DEXFleetStatusDeviceListParamsSortBy = "platform"
	DEXFleetStatusDeviceListParamsSortByStatus    DEXFleetStatusDeviceListParamsSortBy = "status"
	DEXFleetStatusDeviceListParamsSortByTimestamp DEXFleetStatusDeviceListParamsSortBy = "timestamp"
	DEXFleetStatusDeviceListParamsSortByVersion   DEXFleetStatusDeviceListParamsSortBy = "version"
)

type DEXFleetStatusDeviceService 

type DEXFleetStatusDeviceService struct {
	Options []option.RequestOption
}

DEXFleetStatusDeviceService 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 NewDEXFleetStatusDeviceService method instead.

func NewDEXFleetStatusDeviceService 

func NewDEXFleetStatusDeviceService(opts ...option.RequestOption) (r *DEXFleetStatusDeviceService)

NewDEXFleetStatusDeviceService 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 (*DEXFleetStatusDeviceService) List 

func (r *DEXFleetStatusDeviceService) List(ctx context.Context, params DEXFleetStatusDeviceListParams, opts ...option.RequestOption) (res *shared.V4PagePaginationArray[DigitalExperienceMonitoringDevice], err error)

List details for devices using WARP

func (*DEXFleetStatusDeviceService) ListAutoPaging 

func (r *DEXFleetStatusDeviceService) ListAutoPaging(ctx context.Context, params DEXFleetStatusDeviceListParams, opts ...option.RequestOption) *shared.V4PagePaginationArrayAutoPager[DigitalExperienceMonitoringDevice]

List details for devices using WARP

type DEXFleetStatusLiveParams 

type DEXFleetStatusLiveParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
	// Number of minutes before current time
	SinceMinutes param.Field[float64] `query:"since_minutes,required"`
}

func (DEXFleetStatusLiveParams) URLQuery 

func (r DEXFleetStatusLiveParams) URLQuery() (v url.Values)

URLQuery serializes DEXFleetStatusLiveParams's query parameters as `url.Values`.

type DEXFleetStatusLiveResponse 

type DEXFleetStatusLiveResponse struct {
	DeviceStats DEXFleetStatusLiveResponseDeviceStats `json:"deviceStats"`
	JSON        dexFleetStatusLiveResponseJSON        `json:"-"`
}

func (*DEXFleetStatusLiveResponse) UnmarshalJSON 

func (r *DEXFleetStatusLiveResponse) UnmarshalJSON(data []byte) (err error)

type DEXFleetStatusLiveResponseDeviceStats 

type DEXFleetStatusLiveResponseDeviceStats struct {
	ByColo     []DEXFleetStatusLiveResponseDeviceStatsByColo     `json:"byColo,nullable"`
	ByMode     []DEXFleetStatusLiveResponseDeviceStatsByMode     `json:"byMode,nullable"`
	ByPlatform []DEXFleetStatusLiveResponseDeviceStatsByPlatform `json:"byPlatform,nullable"`
	ByStatus   []DEXFleetStatusLiveResponseDeviceStatsByStatus   `json:"byStatus,nullable"`
	ByVersion  []DEXFleetStatusLiveResponseDeviceStatsByVersion  `json:"byVersion,nullable"`
	// Number of unique devices
	UniqueDevicesTotal float64                                   `json:"uniqueDevicesTotal"`
	JSON               dexFleetStatusLiveResponseDeviceStatsJSON `json:"-"`
}

func (*DEXFleetStatusLiveResponseDeviceStats) UnmarshalJSON 

func (r *DEXFleetStatusLiveResponseDeviceStats) UnmarshalJSON(data []byte) (err error)

type DEXFleetStatusLiveResponseDeviceStatsByColo 

type DEXFleetStatusLiveResponseDeviceStatsByColo struct {
	// Number of unique devices
	UniqueDevicesTotal float64                                         `json:"uniqueDevicesTotal"`
	Value              string                                          `json:"value"`
	JSON               dexFleetStatusLiveResponseDeviceStatsByColoJSON `json:"-"`
}

func (*DEXFleetStatusLiveResponseDeviceStatsByColo) UnmarshalJSON 

func (r *DEXFleetStatusLiveResponseDeviceStatsByColo) UnmarshalJSON(data []byte) (err error)

type DEXFleetStatusLiveResponseDeviceStatsByMode 

type DEXFleetStatusLiveResponseDeviceStatsByMode struct {
	// Number of unique devices
	UniqueDevicesTotal float64                                         `json:"uniqueDevicesTotal"`
	Value              string                                          `json:"value"`
	JSON               dexFleetStatusLiveResponseDeviceStatsByModeJSON `json:"-"`
}

func (*DEXFleetStatusLiveResponseDeviceStatsByMode) UnmarshalJSON 

func (r *DEXFleetStatusLiveResponseDeviceStatsByMode) UnmarshalJSON(data []byte) (err error)

type DEXFleetStatusLiveResponseDeviceStatsByPlatform 

type DEXFleetStatusLiveResponseDeviceStatsByPlatform struct {
	// Number of unique devices
	UniqueDevicesTotal float64                                             `json:"uniqueDevicesTotal"`
	Value              string                                              `json:"value"`
	JSON               dexFleetStatusLiveResponseDeviceStatsByPlatformJSON `json:"-"`
}

func (*DEXFleetStatusLiveResponseDeviceStatsByPlatform) UnmarshalJSON 

func (r *DEXFleetStatusLiveResponseDeviceStatsByPlatform) UnmarshalJSON(data []byte) (err error)

type DEXFleetStatusLiveResponseDeviceStatsByStatus 

type DEXFleetStatusLiveResponseDeviceStatsByStatus struct {
	// Number of unique devices
	UniqueDevicesTotal float64                                           `json:"uniqueDevicesTotal"`
	Value              string                                            `json:"value"`
	JSON               dexFleetStatusLiveResponseDeviceStatsByStatusJSON `json:"-"`
}

func (*DEXFleetStatusLiveResponseDeviceStatsByStatus) UnmarshalJSON 

func (r *DEXFleetStatusLiveResponseDeviceStatsByStatus) UnmarshalJSON(data []byte) (err error)

type DEXFleetStatusLiveResponseDeviceStatsByVersion 

type DEXFleetStatusLiveResponseDeviceStatsByVersion struct {
	// Number of unique devices
	UniqueDevicesTotal float64                                            `json:"uniqueDevicesTotal"`
	Value              string                                             `json:"value"`
	JSON               dexFleetStatusLiveResponseDeviceStatsByVersionJSON `json:"-"`
}

func (*DEXFleetStatusLiveResponseDeviceStatsByVersion) UnmarshalJSON 

func (r *DEXFleetStatusLiveResponseDeviceStatsByVersion) UnmarshalJSON(data []byte) (err error)

type DEXFleetStatusLiveResponseEnvelope 

type DEXFleetStatusLiveResponseEnvelope struct {
	Errors   []DEXFleetStatusLiveResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DEXFleetStatusLiveResponseEnvelopeMessages `json:"messages,required"`
	Result   DEXFleetStatusLiveResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success DEXFleetStatusLiveResponseEnvelopeSuccess `json:"success,required"`
	JSON    dexFleetStatusLiveResponseEnvelopeJSON    `json:"-"`
}

func (*DEXFleetStatusLiveResponseEnvelope) UnmarshalJSON 

func (r *DEXFleetStatusLiveResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DEXFleetStatusLiveResponseEnvelopeErrors 

type DEXFleetStatusLiveResponseEnvelopeErrors struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    dexFleetStatusLiveResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DEXFleetStatusLiveResponseEnvelopeErrors) UnmarshalJSON 

func (r *DEXFleetStatusLiveResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DEXFleetStatusLiveResponseEnvelopeMessages 

type DEXFleetStatusLiveResponseEnvelopeMessages struct {
	Code    int64                                          `json:"code,required"`
	Message string                                         `json:"message,required"`
	JSON    dexFleetStatusLiveResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DEXFleetStatusLiveResponseEnvelopeMessages) UnmarshalJSON 

func (r *DEXFleetStatusLiveResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DEXFleetStatusLiveResponseEnvelopeSuccess 

type DEXFleetStatusLiveResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	DEXFleetStatusLiveResponseEnvelopeSuccessTrue DEXFleetStatusLiveResponseEnvelopeSuccess = true
)

type DEXFleetStatusOverTimeParams 

type DEXFleetStatusOverTimeParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
	// Timestamp in ISO format
	TimeEnd param.Field[string] `query:"time_end,required"`
	// Timestamp in ISO format
	TimeStart param.Field[string] `query:"time_start,required"`
	// Cloudflare colo
	Colo param.Field[string] `query:"colo"`
	// Device-specific ID, given as UUID v4
	DeviceID param.Field[string] `query:"device_id"`
}

func (DEXFleetStatusOverTimeParams) URLQuery 

func (r DEXFleetStatusOverTimeParams) URLQuery() (v url.Values)

URLQuery serializes DEXFleetStatusOverTimeParams's query parameters as `url.Values`.

type DEXFleetStatusService 

type DEXFleetStatusService struct {
	Options []option.RequestOption
	Devices *DEXFleetStatusDeviceService
}

DEXFleetStatusService 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 NewDEXFleetStatusService method instead.

func NewDEXFleetStatusService 

func NewDEXFleetStatusService(opts ...option.RequestOption) (r *DEXFleetStatusService)

NewDEXFleetStatusService 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 (*DEXFleetStatusService) Live 

func (r *DEXFleetStatusService) Live(ctx context.Context, params DEXFleetStatusLiveParams, opts ...option.RequestOption) (res *DEXFleetStatusLiveResponse, err error)

List details for live (up to 60 minutes) devices using WARP

func (*DEXFleetStatusService) OverTime 

func (r *DEXFleetStatusService) OverTime(ctx context.Context, params DEXFleetStatusOverTimeParams, opts ...option.RequestOption) (err error)

List details for devices using WARP, up to 7 days

type DEXHTTPTestGetParams 

type DEXHTTPTestGetParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
	// Time interval for aggregate time slots.
	Interval param.Field[DexhttpTestGetParamsInterval] `query:"interval,required"`
	// End time for aggregate metrics in ISO ms
	TimeEnd param.Field[string] `query:"timeEnd,required"`
	// Start time for aggregate metrics in ISO ms
	TimeStart param.Field[string] `query:"timeStart,required"`
	// Optionally filter result stats to a Cloudflare colo. Cannot be used in
	// combination with deviceId param.
	Colo param.Field[string] `query:"colo"`
	// Optionally filter result stats to a specific device(s). Cannot be used in
	// combination with colo param.
	DeviceID param.Field[[]string] `query:"deviceId"`
}

func (DEXHTTPTestGetParams) URLQuery 

func (r DEXHTTPTestGetParams) URLQuery() (v url.Values)

URLQuery serializes DEXHTTPTestGetParams's query parameters as `url.Values`.

type DEXHTTPTestPercentileGetParams 

type DEXHTTPTestPercentileGetParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
	// End time for aggregate metrics in ISO format
	TimeEnd param.Field[string] `query:"timeEnd,required"`
	// Start time for aggregate metrics in ISO format
	TimeStart param.Field[string] `query:"timeStart,required"`
	// Optionally filter result stats to a Cloudflare colo. Cannot be used in
	// combination with deviceId param.
	Colo param.Field[string] `query:"colo"`
	// Optionally filter result stats to a specific device(s). Cannot be used in
	// combination with colo param.
	DeviceID param.Field[[]string] `query:"deviceId"`
}

func (DEXHTTPTestPercentileGetParams) URLQuery 

func (r DEXHTTPTestPercentileGetParams) URLQuery() (v url.Values)

URLQuery serializes DEXHTTPTestPercentileGetParams's query parameters as `url.Values`.

type DEXHTTPTestPercentileService 

type DEXHTTPTestPercentileService struct {
	Options []option.RequestOption
}

DEXHTTPTestPercentileService 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 NewDEXHTTPTestPercentileService method instead.

func NewDEXHTTPTestPercentileService 

func NewDEXHTTPTestPercentileService(opts ...option.RequestOption) (r *DEXHTTPTestPercentileService)

NewDEXHTTPTestPercentileService 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 (*DEXHTTPTestPercentileService) Get 

func (r *DEXHTTPTestPercentileService) Get(ctx context.Context, testID string, params DEXHTTPTestPercentileGetParams, opts ...option.RequestOption) (res *DigitalExperienceMonitoringHTTPDetailsPercentiles, err error)

Get percentiles for an http test for a given time period between 1 hour and 7 days.

type DEXHTTPTestService 

type DEXHTTPTestService struct {
	Options     []option.RequestOption
	Percentiles *DEXHTTPTestPercentileService
}

DEXHTTPTestService 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 NewDEXHTTPTestService method instead.

func NewDEXHTTPTestService 

func NewDEXHTTPTestService(opts ...option.RequestOption) (r *DEXHTTPTestService)

NewDEXHTTPTestService 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 (*DEXHTTPTestService) Get 

func (r *DEXHTTPTestService) Get(ctx context.Context, testID string, params DEXHTTPTestGetParams, opts ...option.RequestOption) (res *DigitalExperienceMonitoringHTTPDetails, err error)

Get test details and aggregate performance metrics for an http test for a given time period between 1 hour and 7 days.

type DEXService 

type DEXService struct {
	Options               []option.RequestOption
	Colos                 *DEXColoService
	FleetStatus           *DEXFleetStatusService
	HTTPTests             *DEXHTTPTestService
	Tests                 *DEXTestService
	TracerouteTestResults *DEXTracerouteTestResultService
	TracerouteTests       *DEXTracerouteTestService
}

DEXService 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 NewDEXService method instead.

func NewDEXService 

func NewDEXService(opts ...option.RequestOption) (r *DEXService)

NewDEXService 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 DEXTestListParams 

type DEXTestListParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
	// Optionally filter result stats to a Cloudflare colo. Cannot be used in
	// combination with deviceId param.
	Colo param.Field[string] `query:"colo"`
	// Optionally filter result stats to a specific device(s). Cannot be used in
	// combination with colo param.
	DeviceID param.Field[[]string] `query:"deviceId"`
	// Page number of paginated results
	Page param.Field[float64] `query:"page"`
	// Number of items per page
	PerPage param.Field[float64] `query:"per_page"`
	// Optionally filter results by test name
	TestName param.Field[string] `query:"testName"`
}

func (DEXTestListParams) URLQuery 

func (r DEXTestListParams) URLQuery() (v url.Values)

URLQuery serializes DEXTestListParams's query parameters as `url.Values`.

type DEXTestListResponse 

type DEXTestListResponse struct {
	Errors   []DEXTestListResponseError       `json:"errors,required"`
	Messages []DEXTestListResponseMessage     `json:"messages,required"`
	Result   DigitalExperienceMonitoringTests `json:"result,required"`
	// Whether the API call was successful
	Success    DEXTestListResponseSuccess    `json:"success,required"`
	ResultInfo DEXTestListResponseResultInfo `json:"result_info"`
	JSON       dexTestListResponseJSON       `json:"-"`
}

func (*DEXTestListResponse) UnmarshalJSON 

func (r *DEXTestListResponse) UnmarshalJSON(data []byte) (err error)

type DEXTestListResponseError 

type DEXTestListResponseError struct {
	Code    int64                        `json:"code,required"`
	Message string                       `json:"message,required"`
	JSON    dexTestListResponseErrorJSON `json:"-"`
}

func (*DEXTestListResponseError) UnmarshalJSON 

func (r *DEXTestListResponseError) UnmarshalJSON(data []byte) (err error)

type DEXTestListResponseMessage 

type DEXTestListResponseMessage struct {
	Code    int64                          `json:"code,required"`
	Message string                         `json:"message,required"`
	JSON    dexTestListResponseMessageJSON `json:"-"`
}

func (*DEXTestListResponseMessage) UnmarshalJSON 

func (r *DEXTestListResponseMessage) UnmarshalJSON(data []byte) (err error)

type DEXTestListResponseResultInfo 

type DEXTestListResponseResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                           `json:"total_count"`
	JSON       dexTestListResponseResultInfoJSON `json:"-"`
}

func (*DEXTestListResponseResultInfo) UnmarshalJSON 

func (r *DEXTestListResponseResultInfo) UnmarshalJSON(data []byte) (err error)

type DEXTestListResponseSuccess 

type DEXTestListResponseSuccess bool

Whether the API call was successful 

const (
	DEXTestListResponseSuccessTrue DEXTestListResponseSuccess = true
)

type DEXTestService 

type DEXTestService struct {
	Options       []option.RequestOption
	UniqueDevices *DEXTestUniqueDeviceService
}

DEXTestService 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 NewDEXTestService method instead.

func NewDEXTestService 

func NewDEXTestService(opts ...option.RequestOption) (r *DEXTestService)

NewDEXTestService 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 (*DEXTestService) List 

func (r *DEXTestService) List(ctx context.Context, params DEXTestListParams, opts ...option.RequestOption) (res *shared.V4PagePagination[DEXTestListResponse], err error)

List DEX tests

func (*DEXTestService) ListAutoPaging 

func (r *DEXTestService) ListAutoPaging(ctx context.Context, params DEXTestListParams, opts ...option.RequestOption) *shared.V4PagePaginationAutoPager[DEXTestListResponse]

List DEX tests

type DEXTestUniqueDeviceListParams 

type DEXTestUniqueDeviceListParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
	// Optionally filter result stats to a specific device(s). Cannot be used in
	// combination with colo param.
	DeviceID param.Field[[]string] `query:"deviceId"`
	// Optionally filter results by test name
	TestName param.Field[string] `query:"testName"`
}

func (DEXTestUniqueDeviceListParams) URLQuery 

func (r DEXTestUniqueDeviceListParams) URLQuery() (v url.Values)

URLQuery serializes DEXTestUniqueDeviceListParams's query parameters as `url.Values`.

type DEXTestUniqueDeviceListResponseEnvelope 

type DEXTestUniqueDeviceListResponseEnvelope struct {
	Errors   []DEXTestUniqueDeviceListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DEXTestUniqueDeviceListResponseEnvelopeMessages `json:"messages,required"`
	Result   DigitalExperienceMonitoringUniqueDevices          `json:"result,required"`
	// Whether the API call was successful
	Success DEXTestUniqueDeviceListResponseEnvelopeSuccess `json:"success,required"`
	JSON    dexTestUniqueDeviceListResponseEnvelopeJSON    `json:"-"`
}

func (*DEXTestUniqueDeviceListResponseEnvelope) UnmarshalJSON 

func (r *DEXTestUniqueDeviceListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DEXTestUniqueDeviceListResponseEnvelopeErrors 

type DEXTestUniqueDeviceListResponseEnvelopeErrors struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    dexTestUniqueDeviceListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DEXTestUniqueDeviceListResponseEnvelopeErrors) UnmarshalJSON 

func (r *DEXTestUniqueDeviceListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DEXTestUniqueDeviceListResponseEnvelopeMessages 

type DEXTestUniqueDeviceListResponseEnvelopeMessages struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    dexTestUniqueDeviceListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DEXTestUniqueDeviceListResponseEnvelopeMessages) UnmarshalJSON 

func (r *DEXTestUniqueDeviceListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DEXTestUniqueDeviceListResponseEnvelopeSuccess 

type DEXTestUniqueDeviceListResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	DEXTestUniqueDeviceListResponseEnvelopeSuccessTrue DEXTestUniqueDeviceListResponseEnvelopeSuccess = true
)

type DEXTestUniqueDeviceService 

type DEXTestUniqueDeviceService struct {
	Options []option.RequestOption
}

DEXTestUniqueDeviceService 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 NewDEXTestUniqueDeviceService method instead.

func NewDEXTestUniqueDeviceService 

func NewDEXTestUniqueDeviceService(opts ...option.RequestOption) (r *DEXTestUniqueDeviceService)

NewDEXTestUniqueDeviceService 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 (*DEXTestUniqueDeviceService) List 

func (r *DEXTestUniqueDeviceService) List(ctx context.Context, params DEXTestUniqueDeviceListParams, opts ...option.RequestOption) (res *DigitalExperienceMonitoringUniqueDevices, err error)

Returns unique count of devices that have run synthetic application monitoring tests in the past 7 days.

type DEXTracerouteTestGetParams 

type DEXTracerouteTestGetParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
	// Time interval for aggregate time slots.
	Interval param.Field[DEXTracerouteTestGetParamsInterval] `query:"interval,required"`
	// End time for aggregate metrics in ISO ms
	TimeEnd param.Field[string] `query:"timeEnd,required"`
	// Start time for aggregate metrics in ISO ms
	TimeStart param.Field[string] `query:"timeStart,required"`
	// Optionally filter result stats to a Cloudflare colo. Cannot be used in
	// combination with deviceId param.
	Colo param.Field[string] `query:"colo"`
	// Optionally filter result stats to a specific device(s). Cannot be used in
	// combination with colo param.
	DeviceID param.Field[[]string] `query:"deviceId"`
}

func (DEXTracerouteTestGetParams) URLQuery 

func (r DEXTracerouteTestGetParams) URLQuery() (v url.Values)

URLQuery serializes DEXTracerouteTestGetParams's query parameters as `url.Values`.

type DEXTracerouteTestGetParamsInterval 

type DEXTracerouteTestGetParamsInterval string

Time interval for aggregate time slots. 

const (
	DEXTracerouteTestGetParamsIntervalMinute DEXTracerouteTestGetParamsInterval = "minute"
	DEXTracerouteTestGetParamsIntervalHour   DEXTracerouteTestGetParamsInterval = "hour"
)

type DEXTracerouteTestGetResponseEnvelope 

type DEXTracerouteTestGetResponseEnvelope struct {
	Errors   []DEXTracerouteTestGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DEXTracerouteTestGetResponseEnvelopeMessages `json:"messages,required"`
	Result   DigitalExperienceMonitoringTracerouteDetails   `json:"result,required"`
	// Whether the API call was successful
	Success DEXTracerouteTestGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    dexTracerouteTestGetResponseEnvelopeJSON    `json:"-"`
}

func (*DEXTracerouteTestGetResponseEnvelope) UnmarshalJSON 

func (r *DEXTracerouteTestGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DEXTracerouteTestGetResponseEnvelopeErrors 

type DEXTracerouteTestGetResponseEnvelopeErrors struct {
	Code    int64                                          `json:"code,required"`
	Message string                                         `json:"message,required"`
	JSON    dexTracerouteTestGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DEXTracerouteTestGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *DEXTracerouteTestGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DEXTracerouteTestGetResponseEnvelopeMessages 

type DEXTracerouteTestGetResponseEnvelopeMessages struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    dexTracerouteTestGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DEXTracerouteTestGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *DEXTracerouteTestGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DEXTracerouteTestGetResponseEnvelopeSuccess 

type DEXTracerouteTestGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	DEXTracerouteTestGetResponseEnvelopeSuccessTrue DEXTracerouteTestGetResponseEnvelopeSuccess = true
)

type DEXTracerouteTestNetworkPathParams 

type DEXTracerouteTestNetworkPathParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
	// Device to filter tracroute result runs to
	DeviceID param.Field[string] `query:"deviceId,required"`
	// Time interval for aggregate time slots.
	Interval param.Field[DEXTracerouteTestNetworkPathParamsInterval] `query:"interval,required"`
	// End time for aggregate metrics in ISO ms
	TimeEnd param.Field[string] `query:"timeEnd,required"`
	// Start time for aggregate metrics in ISO ms
	TimeStart param.Field[string] `query:"timeStart,required"`
}

func (DEXTracerouteTestNetworkPathParams) URLQuery 

func (r DEXTracerouteTestNetworkPathParams) URLQuery() (v url.Values)

URLQuery serializes DEXTracerouteTestNetworkPathParams's query parameters as `url.Values`.

type DEXTracerouteTestNetworkPathParamsInterval 

type DEXTracerouteTestNetworkPathParamsInterval string

Time interval for aggregate time slots. 

const (
	DEXTracerouteTestNetworkPathParamsIntervalMinute DEXTracerouteTestNetworkPathParamsInterval = "minute"
	DEXTracerouteTestNetworkPathParamsIntervalHour   DEXTracerouteTestNetworkPathParamsInterval = "hour"
)

type DEXTracerouteTestNetworkPathResponseEnvelope 

type DEXTracerouteTestNetworkPathResponseEnvelope struct {
	Errors   []DEXTracerouteTestNetworkPathResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DEXTracerouteTestNetworkPathResponseEnvelopeMessages `json:"messages,required"`
	Result   DigitalExperienceMonitoringTracerouteTestNetworkPath   `json:"result,required"`
	// Whether the API call was successful
	Success DEXTracerouteTestNetworkPathResponseEnvelopeSuccess `json:"success,required"`
	JSON    dexTracerouteTestNetworkPathResponseEnvelopeJSON    `json:"-"`
}

func (*DEXTracerouteTestNetworkPathResponseEnvelope) UnmarshalJSON 

func (r *DEXTracerouteTestNetworkPathResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DEXTracerouteTestNetworkPathResponseEnvelopeErrors 

type DEXTracerouteTestNetworkPathResponseEnvelopeErrors struct {
	Code    int64                                                  `json:"code,required"`
	Message string                                                 `json:"message,required"`
	JSON    dexTracerouteTestNetworkPathResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DEXTracerouteTestNetworkPathResponseEnvelopeErrors) UnmarshalJSON 

func (r *DEXTracerouteTestNetworkPathResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DEXTracerouteTestNetworkPathResponseEnvelopeMessages 

type DEXTracerouteTestNetworkPathResponseEnvelopeMessages struct {
	Code    int64                                                    `json:"code,required"`
	Message string                                                   `json:"message,required"`
	JSON    dexTracerouteTestNetworkPathResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DEXTracerouteTestNetworkPathResponseEnvelopeMessages) UnmarshalJSON 

func (r *DEXTracerouteTestNetworkPathResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DEXTracerouteTestNetworkPathResponseEnvelopeSuccess 

type DEXTracerouteTestNetworkPathResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	DEXTracerouteTestNetworkPathResponseEnvelopeSuccessTrue DEXTracerouteTestNetworkPathResponseEnvelopeSuccess = true
)

type DEXTracerouteTestPercentilesParams 

type DEXTracerouteTestPercentilesParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
	// End time for aggregate metrics in ISO format
	TimeEnd param.Field[string] `query:"timeEnd,required"`
	// Start time for aggregate metrics in ISO format
	TimeStart param.Field[string] `query:"timeStart,required"`
	// Optionally filter result stats to a Cloudflare colo. Cannot be used in
	// combination with deviceId param.
	Colo param.Field[string] `query:"colo"`
	// Optionally filter result stats to a specific device(s). Cannot be used in
	// combination with colo param.
	DeviceID param.Field[[]string] `query:"deviceId"`
}

func (DEXTracerouteTestPercentilesParams) URLQuery 

func (r DEXTracerouteTestPercentilesParams) URLQuery() (v url.Values)

URLQuery serializes DEXTracerouteTestPercentilesParams's query parameters as `url.Values`.

type DEXTracerouteTestPercentilesResponseEnvelope 

type DEXTracerouteTestPercentilesResponseEnvelope struct {
	Errors   []DEXTracerouteTestPercentilesResponseEnvelopeErrors    `json:"errors,required"`
	Messages []DEXTracerouteTestPercentilesResponseEnvelopeMessages  `json:"messages,required"`
	Result   DigitalExperienceMonitoringTracerouteDetailsPercentiles `json:"result,required"`
	// Whether the API call was successful
	Success DEXTracerouteTestPercentilesResponseEnvelopeSuccess `json:"success,required"`
	JSON    dexTracerouteTestPercentilesResponseEnvelopeJSON    `json:"-"`
}

func (*DEXTracerouteTestPercentilesResponseEnvelope) UnmarshalJSON 

func (r *DEXTracerouteTestPercentilesResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DEXTracerouteTestPercentilesResponseEnvelopeErrors 

type DEXTracerouteTestPercentilesResponseEnvelopeErrors struct {
	Code    int64                                                  `json:"code,required"`
	Message string                                                 `json:"message,required"`
	JSON    dexTracerouteTestPercentilesResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DEXTracerouteTestPercentilesResponseEnvelopeErrors) UnmarshalJSON 

func (r *DEXTracerouteTestPercentilesResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DEXTracerouteTestPercentilesResponseEnvelopeMessages 

type DEXTracerouteTestPercentilesResponseEnvelopeMessages struct {
	Code    int64                                                    `json:"code,required"`
	Message string                                                   `json:"message,required"`
	JSON    dexTracerouteTestPercentilesResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DEXTracerouteTestPercentilesResponseEnvelopeMessages) UnmarshalJSON 

func (r *DEXTracerouteTestPercentilesResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DEXTracerouteTestPercentilesResponseEnvelopeSuccess 

type DEXTracerouteTestPercentilesResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	DEXTracerouteTestPercentilesResponseEnvelopeSuccessTrue DEXTracerouteTestPercentilesResponseEnvelopeSuccess = true
)

type DEXTracerouteTestResultNetworkPathGetParams 

type DEXTracerouteTestResultNetworkPathGetParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
}

type DEXTracerouteTestResultNetworkPathGetResponseEnvelope 

type DEXTracerouteTestResultNetworkPathGetResponseEnvelope struct {
	Errors   []DEXTracerouteTestResultNetworkPathGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DEXTracerouteTestResultNetworkPathGetResponseEnvelopeMessages `json:"messages,required"`
	Result   DigitalExperienceMonitoringTracerouteTestResultNetworkPath      `json:"result,required"`
	// Whether the API call was successful
	Success DEXTracerouteTestResultNetworkPathGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    dexTracerouteTestResultNetworkPathGetResponseEnvelopeJSON    `json:"-"`
}

func (*DEXTracerouteTestResultNetworkPathGetResponseEnvelope) UnmarshalJSON 

func (r *DEXTracerouteTestResultNetworkPathGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DEXTracerouteTestResultNetworkPathGetResponseEnvelopeErrors 

type DEXTracerouteTestResultNetworkPathGetResponseEnvelopeErrors struct {
	Code    int64                                                           `json:"code,required"`
	Message string                                                          `json:"message,required"`
	JSON    dexTracerouteTestResultNetworkPathGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DEXTracerouteTestResultNetworkPathGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *DEXTracerouteTestResultNetworkPathGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DEXTracerouteTestResultNetworkPathGetResponseEnvelopeMessages 

type DEXTracerouteTestResultNetworkPathGetResponseEnvelopeMessages struct {
	Code    int64                                                             `json:"code,required"`
	Message string                                                            `json:"message,required"`
	JSON    dexTracerouteTestResultNetworkPathGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DEXTracerouteTestResultNetworkPathGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *DEXTracerouteTestResultNetworkPathGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DEXTracerouteTestResultNetworkPathGetResponseEnvelopeSuccess 

type DEXTracerouteTestResultNetworkPathGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	DEXTracerouteTestResultNetworkPathGetResponseEnvelopeSuccessTrue DEXTracerouteTestResultNetworkPathGetResponseEnvelopeSuccess = true
)

type DEXTracerouteTestResultNetworkPathService 

type DEXTracerouteTestResultNetworkPathService struct {
	Options []option.RequestOption
}

DEXTracerouteTestResultNetworkPathService 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 NewDEXTracerouteTestResultNetworkPathService method instead.

func NewDEXTracerouteTestResultNetworkPathService 

func NewDEXTracerouteTestResultNetworkPathService(opts ...option.RequestOption) (r *DEXTracerouteTestResultNetworkPathService)

NewDEXTracerouteTestResultNetworkPathService 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 (*DEXTracerouteTestResultNetworkPathService) Get 

func (r *DEXTracerouteTestResultNetworkPathService) Get(ctx context.Context, testResultID string, query DEXTracerouteTestResultNetworkPathGetParams, opts ...option.RequestOption) (res *DigitalExperienceMonitoringTracerouteTestResultNetworkPath, err error)

Get a breakdown of hops and performance metrics for a specific traceroute test run

type DEXTracerouteTestResultService 

type DEXTracerouteTestResultService struct {
	Options     []option.RequestOption
	NetworkPath *DEXTracerouteTestResultNetworkPathService
}

DEXTracerouteTestResultService 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 NewDEXTracerouteTestResultService method instead.

func NewDEXTracerouteTestResultService 

func NewDEXTracerouteTestResultService(opts ...option.RequestOption) (r *DEXTracerouteTestResultService)

NewDEXTracerouteTestResultService 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 DEXTracerouteTestService 

type DEXTracerouteTestService struct {
	Options []option.RequestOption
}

DEXTracerouteTestService 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 NewDEXTracerouteTestService method instead.

func NewDEXTracerouteTestService 

func NewDEXTracerouteTestService(opts ...option.RequestOption) (r *DEXTracerouteTestService)

NewDEXTracerouteTestService 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 (*DEXTracerouteTestService) Get 

func (r *DEXTracerouteTestService) Get(ctx context.Context, testID string, params DEXTracerouteTestGetParams, opts ...option.RequestOption) (res *DigitalExperienceMonitoringTracerouteDetails, err error)

Get test details and aggregate performance metrics for an traceroute test for a given time period between 1 hour and 7 days.

func (*DEXTracerouteTestService) NetworkPath 

func (r *DEXTracerouteTestService) NetworkPath(ctx context.Context, testID string, params DEXTracerouteTestNetworkPathParams, opts ...option.RequestOption) (res *DigitalExperienceMonitoringTracerouteTestNetworkPath, err error)

Get a breakdown of metrics by hop for individual traceroute test runs

func (*DEXTracerouteTestService) Percentiles 

func (r *DEXTracerouteTestService) Percentiles(ctx context.Context, testID string, params DEXTracerouteTestPercentilesParams, opts ...option.RequestOption) (res *DigitalExperienceMonitoringTracerouteDetailsPercentiles, err error)

Get percentiles for a traceroute test for a given time period between 1 hour and 7 days.

type DLPCustomProfile 

type DLPCustomProfile struct {
	// The ID for this profile
	ID string `json:"id"`
	// Related DLP policies will trigger when the match count exceeds the number set.
	AllowedMatchCount float64 `json:"allowed_match_count"`
	// Scan the context of predefined entries to only return matches surrounded by
	// keywords.
	ContextAwareness DLPCustomProfileContextAwareness `json:"context_awareness"`
	CreatedAt        time.Time                        `json:"created_at" format:"date-time"`
	// The description of the profile.
	Description string `json:"description"`
	// The entries for this profile.
	Entries []DLPCustomProfileEntry `json:"entries"`
	// The name of the profile.
	Name string `json:"name"`
	// The type of the profile.
	Type      DLPCustomProfileType `json:"type"`
	UpdatedAt time.Time            `json:"updated_at" format:"date-time"`
	JSON      dlpCustomProfileJSON `json:"-"`
}

func (*DLPCustomProfile) UnmarshalJSON 

func (r *DLPCustomProfile) UnmarshalJSON(data []byte) (err error)

type DLPCustomProfileContextAwareness 

type DLPCustomProfileContextAwareness struct {
	// If true, scan the context of predefined entries to only return matches
	// surrounded by keywords.
	Enabled bool `json:"enabled,required"`
	// Content types to exclude from context analysis and return all matches.
	Skip DLPCustomProfileContextAwarenessSkip `json:"skip,required"`
	JSON dlpCustomProfileContextAwarenessJSON `json:"-"`
}

Scan the context of predefined entries to only return matches surrounded by keywords.

func (*DLPCustomProfileContextAwareness) UnmarshalJSON 

func (r *DLPCustomProfileContextAwareness) UnmarshalJSON(data []byte) (err error)

type DLPCustomProfileContextAwarenessSkip 

type DLPCustomProfileContextAwarenessSkip struct {
	// If the content type is a file, skip context analysis and return all matches.
	Files bool                                     `json:"files,required"`
	JSON  dlpCustomProfileContextAwarenessSkipJSON `json:"-"`
}

Content types to exclude from context analysis and return all matches.

func (*DLPCustomProfileContextAwarenessSkip) UnmarshalJSON 

func (r *DLPCustomProfileContextAwarenessSkip) UnmarshalJSON(data []byte) (err error)

type DLPCustomProfileEntriesPattern 

type DLPCustomProfileEntriesPattern struct {
	// The regex pattern.
	Regex string `json:"regex,required"`
	// Validation algorithm for the pattern. This algorithm will get run on potential
	// matches, and if it returns false, the entry will not be matched.
	Validation DLPCustomProfileEntriesPatternValidation `json:"validation"`
	JSON       dlpCustomProfileEntriesPatternJSON       `json:"-"`
}

A pattern that matches an entry

func (*DLPCustomProfileEntriesPattern) UnmarshalJSON 

func (r *DLPCustomProfileEntriesPattern) UnmarshalJSON(data []byte) (err error)

type DLPCustomProfileEntriesPatternValidation 

type DLPCustomProfileEntriesPatternValidation string

Validation algorithm for the pattern. This algorithm will get run on potential matches, and if it returns false, the entry will not be matched. 

const (
	DLPCustomProfileEntriesPatternValidationLuhn DLPCustomProfileEntriesPatternValidation = "luhn"
)

type DLPCustomProfileEntry 

type DLPCustomProfileEntry struct {
	// The ID for this entry
	ID        string    `json:"id"`
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Whether the entry is enabled or not.
	Enabled bool `json:"enabled"`
	// The name of the entry.
	Name string `json:"name"`
	// A pattern that matches an entry
	Pattern DLPCustomProfileEntriesPattern `json:"pattern"`
	// ID of the parent profile
	ProfileID interface{}               `json:"profile_id"`
	UpdatedAt time.Time                 `json:"updated_at" format:"date-time"`
	JSON      dlpCustomProfileEntryJSON `json:"-"`
}

A custom entry that matches a profile

func (*DLPCustomProfileEntry) UnmarshalJSON 

func (r *DLPCustomProfileEntry) UnmarshalJSON(data []byte) (err error)

type DLPCustomProfileType 

type DLPCustomProfileType string

The type of the profile. 

const (
	DLPCustomProfileTypeCustom DLPCustomProfileType = "custom"
)

type DLPDataset 

type DLPDataset struct {
	ID          string             `json:"id,required" format:"uuid"`
	CreatedAt   time.Time          `json:"created_at,required" format:"date-time"`
	Name        string             `json:"name,required"`
	NumCells    int64              `json:"num_cells,required"`
	Secret      bool               `json:"secret,required"`
	Status      DLPDatasetStatus   `json:"status,required"`
	UpdatedAt   time.Time          `json:"updated_at,required" format:"date-time"`
	Uploads     []DLPDatasetUpload `json:"uploads,required"`
	Description string             `json:"description,nullable"`
	JSON        dlpDatasetJSON     `json:"-"`
}

func (*DLPDataset) UnmarshalJSON 

func (r *DLPDataset) UnmarshalJSON(data []byte) (err error)

type DLPDatasetArray 

type DLPDatasetArray []DLPDataset

type DLPDatasetCreation 

type DLPDatasetCreation struct {
	Dataset  DLPDataset `json:"dataset,required"`
	MaxCells int64      `json:"max_cells,required"`
	// The version to use when uploading the dataset.
	Version int64 `json:"version,required"`
	// The secret to use for Exact Data Match datasets. This is not present in Custom
	// Wordlists.
	Secret string                 `json:"secret" format:"password"`
	JSON   dlpDatasetCreationJSON `json:"-"`
}

func (*DLPDatasetCreation) UnmarshalJSON 

func (r *DLPDatasetCreation) UnmarshalJSON(data []byte) (err error)

type DLPDatasetDeleteParams 

type DLPDatasetDeleteParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
}

type DLPDatasetGetParams 

type DLPDatasetGetParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
}

type DLPDatasetGetResponseEnvelope 

type DLPDatasetGetResponseEnvelope struct {
	Errors     []DLPDatasetGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages   []DLPDatasetGetResponseEnvelopeMessages `json:"messages,required"`
	Success    bool                                    `json:"success,required"`
	Result     DLPDataset                              `json:"result"`
	ResultInfo DLPDatasetGetResponseEnvelopeResultInfo `json:"result_info"`
	JSON       dlpDatasetGetResponseEnvelopeJSON       `json:"-"`
}

func (*DLPDatasetGetResponseEnvelope) UnmarshalJSON 

func (r *DLPDatasetGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DLPDatasetGetResponseEnvelopeErrors 

type DLPDatasetGetResponseEnvelopeErrors struct {
	Code    int64                                   `json:"code,required"`
	Message string                                  `json:"message,required"`
	JSON    dlpDatasetGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DLPDatasetGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *DLPDatasetGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DLPDatasetGetResponseEnvelopeMessages 

type DLPDatasetGetResponseEnvelopeMessages struct {
	Code    int64                                     `json:"code,required"`
	Message string                                    `json:"message,required"`
	JSON    dlpDatasetGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DLPDatasetGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *DLPDatasetGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DLPDatasetGetResponseEnvelopeResultInfo 

type DLPDatasetGetResponseEnvelopeResultInfo struct {
	// total number of pages
	Count int64 `json:"count,required"`
	// current page
	Page int64 `json:"page,required"`
	// number of items per page
	PerPage int64 `json:"per_page,required"`
	// total number of items
	TotalCount int64                                       `json:"total_count,required"`
	JSON       dlpDatasetGetResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*DLPDatasetGetResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *DLPDatasetGetResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type DLPDatasetListParams 

type DLPDatasetListParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
}

type DLPDatasetListResponseEnvelope 

type DLPDatasetListResponseEnvelope struct {
	Errors     []DLPDatasetListResponseEnvelopeErrors   `json:"errors,required"`
	Messages   []DLPDatasetListResponseEnvelopeMessages `json:"messages,required"`
	Success    bool                                     `json:"success,required"`
	Result     DLPDatasetArray                          `json:"result"`
	ResultInfo DLPDatasetListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       dlpDatasetListResponseEnvelopeJSON       `json:"-"`
}

func (*DLPDatasetListResponseEnvelope) UnmarshalJSON 

func (r *DLPDatasetListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DLPDatasetListResponseEnvelopeErrors 

type DLPDatasetListResponseEnvelopeErrors struct {
	Code    int64                                    `json:"code,required"`
	Message string                                   `json:"message,required"`
	JSON    dlpDatasetListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DLPDatasetListResponseEnvelopeErrors) UnmarshalJSON 

func (r *DLPDatasetListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DLPDatasetListResponseEnvelopeMessages 

type DLPDatasetListResponseEnvelopeMessages struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    dlpDatasetListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DLPDatasetListResponseEnvelopeMessages) UnmarshalJSON 

func (r *DLPDatasetListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DLPDatasetListResponseEnvelopeResultInfo 

type DLPDatasetListResponseEnvelopeResultInfo struct {
	// total number of pages
	Count int64 `json:"count,required"`
	// current page
	Page int64 `json:"page,required"`
	// number of items per page
	PerPage int64 `json:"per_page,required"`
	// total number of items
	TotalCount int64                                        `json:"total_count,required"`
	JSON       dlpDatasetListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*DLPDatasetListResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *DLPDatasetListResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type DLPDatasetNewParams 

type DLPDatasetNewParams struct {
	AccountID   param.Field[string] `path:"account_id,required"`
	Name        param.Field[string] `json:"name,required"`
	Description param.Field[string] `json:"description"`
	// Generate a secret dataset.
	//
	// If true, the response will include a secret to use with the EDM encoder. If
	// false, the response has no secret and the dataset is uploaded in plaintext.
	Secret param.Field[bool] `json:"secret"`
}

func (DLPDatasetNewParams) MarshalJSON 

func (r DLPDatasetNewParams) MarshalJSON() (data []byte, err error)

type DLPDatasetNewResponseEnvelope 

type DLPDatasetNewResponseEnvelope struct {
	Errors     []DLPDatasetNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages   []DLPDatasetNewResponseEnvelopeMessages `json:"messages,required"`
	Success    bool                                    `json:"success,required"`
	Result     DLPDatasetCreation                      `json:"result"`
	ResultInfo DLPDatasetNewResponseEnvelopeResultInfo `json:"result_info"`
	JSON       dlpDatasetNewResponseEnvelopeJSON       `json:"-"`
}

func (*DLPDatasetNewResponseEnvelope) UnmarshalJSON 

func (r *DLPDatasetNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DLPDatasetNewResponseEnvelopeErrors 

type DLPDatasetNewResponseEnvelopeErrors struct {
	Code    int64                                   `json:"code,required"`
	Message string                                  `json:"message,required"`
	JSON    dlpDatasetNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DLPDatasetNewResponseEnvelopeErrors) UnmarshalJSON 

func (r *DLPDatasetNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DLPDatasetNewResponseEnvelopeMessages 

type DLPDatasetNewResponseEnvelopeMessages struct {
	Code    int64                                     `json:"code,required"`
	Message string                                    `json:"message,required"`
	JSON    dlpDatasetNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DLPDatasetNewResponseEnvelopeMessages) UnmarshalJSON 

func (r *DLPDatasetNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DLPDatasetNewResponseEnvelopeResultInfo 

type DLPDatasetNewResponseEnvelopeResultInfo struct {
	// total number of pages
	Count int64 `json:"count,required"`
	// current page
	Page int64 `json:"page,required"`
	// number of items per page
	PerPage int64 `json:"per_page,required"`
	// total number of items
	TotalCount int64                                       `json:"total_count,required"`
	JSON       dlpDatasetNewResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*DLPDatasetNewResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *DLPDatasetNewResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type DLPDatasetNewVersion 

type DLPDatasetNewVersion struct {
	MaxCells int64                    `json:"max_cells,required"`
	Version  int64                    `json:"version,required"`
	Secret   string                   `json:"secret" format:"password"`
	JSON     dlpDatasetNewVersionJSON `json:"-"`
}

func (*DLPDatasetNewVersion) UnmarshalJSON 

func (r *DLPDatasetNewVersion) UnmarshalJSON(data []byte) (err error)

type DLPDatasetService 

type DLPDatasetService struct {
	Options []option.RequestOption
	Upload  *DLPDatasetUploadService
}

DLPDatasetService 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 NewDLPDatasetService method instead.

func NewDLPDatasetService 

func NewDLPDatasetService(opts ...option.RequestOption) (r *DLPDatasetService)

NewDLPDatasetService 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 (*DLPDatasetService) Delete 

func (r *DLPDatasetService) Delete(ctx context.Context, datasetID string, body DLPDatasetDeleteParams, opts ...option.RequestOption) (err error)

Delete a dataset.

This deletes all versions of the dataset.

func (*DLPDatasetService) Get 

func (r *DLPDatasetService) Get(ctx context.Context, datasetID string, query DLPDatasetGetParams, opts ...option.RequestOption) (res *DLPDataset, err error)

Fetch a specific dataset with information about available versions.

func (*DLPDatasetService) List 

func (r *DLPDatasetService) List(ctx context.Context, query DLPDatasetListParams, opts ...option.RequestOption) (res *DLPDatasetArray, err error)

Fetch all datasets with information about available versions.

func (*DLPDatasetService) New 

func (r *DLPDatasetService) New(ctx context.Context, params DLPDatasetNewParams, opts ...option.RequestOption) (res *DLPDatasetCreation, err error)

Create a new dataset.

func (*DLPDatasetService) Update 

func (r *DLPDatasetService) Update(ctx context.Context, datasetID string, params DLPDatasetUpdateParams, opts ...option.RequestOption) (res *DLPDataset, err error)

Update details about a dataset.

type DLPDatasetStatus 

type DLPDatasetStatus string
const (
	DLPDatasetStatusEmpty     DLPDatasetStatus = "empty"
	DLPDatasetStatusUploading DLPDatasetStatus = "uploading"
	DLPDatasetStatusFailed    DLPDatasetStatus = "failed"
	DLPDatasetStatusComplete  DLPDatasetStatus = "complete"
)

type DLPDatasetUpdateParams 

type DLPDatasetUpdateParams struct {
	AccountID   param.Field[string] `path:"account_id,required"`
	Description param.Field[string] `json:"description"`
	Name        param.Field[string] `json:"name"`
}

func (DLPDatasetUpdateParams) MarshalJSON 

func (r DLPDatasetUpdateParams) MarshalJSON() (data []byte, err error)

type DLPDatasetUpdateResponseEnvelope 

type DLPDatasetUpdateResponseEnvelope struct {
	Errors     []DLPDatasetUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages   []DLPDatasetUpdateResponseEnvelopeMessages `json:"messages,required"`
	Success    bool                                       `json:"success,required"`
	Result     DLPDataset                                 `json:"result"`
	ResultInfo DLPDatasetUpdateResponseEnvelopeResultInfo `json:"result_info"`
	JSON       dlpDatasetUpdateResponseEnvelopeJSON       `json:"-"`
}

func (*DLPDatasetUpdateResponseEnvelope) UnmarshalJSON 

func (r *DLPDatasetUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DLPDatasetUpdateResponseEnvelopeErrors 

type DLPDatasetUpdateResponseEnvelopeErrors struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    dlpDatasetUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DLPDatasetUpdateResponseEnvelopeErrors) UnmarshalJSON 

func (r *DLPDatasetUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DLPDatasetUpdateResponseEnvelopeMessages 

type DLPDatasetUpdateResponseEnvelopeMessages struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    dlpDatasetUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DLPDatasetUpdateResponseEnvelopeMessages) UnmarshalJSON 

func (r *DLPDatasetUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DLPDatasetUpdateResponseEnvelopeResultInfo 

type DLPDatasetUpdateResponseEnvelopeResultInfo struct {
	// total number of pages
	Count int64 `json:"count,required"`
	// current page
	Page int64 `json:"page,required"`
	// number of items per page
	PerPage int64 `json:"per_page,required"`
	// total number of items
	TotalCount int64                                          `json:"total_count,required"`
	JSON       dlpDatasetUpdateResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*DLPDatasetUpdateResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *DLPDatasetUpdateResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type DLPDatasetUpload 

type DLPDatasetUpload struct {
	NumCells int64                   `json:"num_cells,required"`
	Status   DLPDatasetUploadsStatus `json:"status,required"`
	Version  int64                   `json:"version,required"`
	JSON     dlpDatasetUploadJSON    `json:"-"`
}

func (*DLPDatasetUpload) UnmarshalJSON 

func (r *DLPDatasetUpload) UnmarshalJSON(data []byte) (err error)

type DLPDatasetUploadEditParams 

type DLPDatasetUploadEditParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
}

type DLPDatasetUploadEditResponseEnvelope 

type DLPDatasetUploadEditResponseEnvelope struct {
	Errors     []DLPDatasetUploadEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages   []DLPDatasetUploadEditResponseEnvelopeMessages `json:"messages,required"`
	Success    bool                                           `json:"success,required"`
	Result     DLPDataset                                     `json:"result"`
	ResultInfo DLPDatasetUploadEditResponseEnvelopeResultInfo `json:"result_info"`
	JSON       dlpDatasetUploadEditResponseEnvelopeJSON       `json:"-"`
}

func (*DLPDatasetUploadEditResponseEnvelope) UnmarshalJSON 

func (r *DLPDatasetUploadEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DLPDatasetUploadEditResponseEnvelopeErrors 

type DLPDatasetUploadEditResponseEnvelopeErrors struct {
	Code    int64                                          `json:"code,required"`
	Message string                                         `json:"message,required"`
	JSON    dlpDatasetUploadEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DLPDatasetUploadEditResponseEnvelopeErrors) UnmarshalJSON 

func (r *DLPDatasetUploadEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DLPDatasetUploadEditResponseEnvelopeMessages 

type DLPDatasetUploadEditResponseEnvelopeMessages struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    dlpDatasetUploadEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DLPDatasetUploadEditResponseEnvelopeMessages) UnmarshalJSON 

func (r *DLPDatasetUploadEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DLPDatasetUploadEditResponseEnvelopeResultInfo 

type DLPDatasetUploadEditResponseEnvelopeResultInfo struct {
	// total number of pages
	Count int64 `json:"count,required"`
	// current page
	Page int64 `json:"page,required"`
	// number of items per page
	PerPage int64 `json:"per_page,required"`
	// total number of items
	TotalCount int64                                              `json:"total_count,required"`
	JSON       dlpDatasetUploadEditResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*DLPDatasetUploadEditResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *DLPDatasetUploadEditResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type DLPDatasetUploadNewParams 

type DLPDatasetUploadNewParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
}

type DLPDatasetUploadNewResponseEnvelope 

type DLPDatasetUploadNewResponseEnvelope struct {
	Errors     []DLPDatasetUploadNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages   []DLPDatasetUploadNewResponseEnvelopeMessages `json:"messages,required"`
	Success    bool                                          `json:"success,required"`
	Result     DLPDatasetNewVersion                          `json:"result"`
	ResultInfo DLPDatasetUploadNewResponseEnvelopeResultInfo `json:"result_info"`
	JSON       dlpDatasetUploadNewResponseEnvelopeJSON       `json:"-"`
}

func (*DLPDatasetUploadNewResponseEnvelope) UnmarshalJSON 

func (r *DLPDatasetUploadNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DLPDatasetUploadNewResponseEnvelopeErrors 

type DLPDatasetUploadNewResponseEnvelopeErrors struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    dlpDatasetUploadNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DLPDatasetUploadNewResponseEnvelopeErrors) UnmarshalJSON 

func (r *DLPDatasetUploadNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DLPDatasetUploadNewResponseEnvelopeMessages 

type DLPDatasetUploadNewResponseEnvelopeMessages struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    dlpDatasetUploadNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DLPDatasetUploadNewResponseEnvelopeMessages) UnmarshalJSON 

func (r *DLPDatasetUploadNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DLPDatasetUploadNewResponseEnvelopeResultInfo 

type DLPDatasetUploadNewResponseEnvelopeResultInfo struct {
	// total number of pages
	Count int64 `json:"count,required"`
	// current page
	Page int64 `json:"page,required"`
	// number of items per page
	PerPage int64 `json:"per_page,required"`
	// total number of items
	TotalCount int64                                             `json:"total_count,required"`
	JSON       dlpDatasetUploadNewResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*DLPDatasetUploadNewResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *DLPDatasetUploadNewResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type DLPDatasetUploadService 

type DLPDatasetUploadService struct {
	Options []option.RequestOption
}

DLPDatasetUploadService 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 NewDLPDatasetUploadService method instead.

func NewDLPDatasetUploadService 

func NewDLPDatasetUploadService(opts ...option.RequestOption) (r *DLPDatasetUploadService)

NewDLPDatasetUploadService 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 (*DLPDatasetUploadService) Edit 

func (r *DLPDatasetUploadService) Edit(ctx context.Context, datasetID string, version int64, body DLPDatasetUploadEditParams, opts ...option.RequestOption) (res *DLPDataset, err error)

Upload a new version of a dataset.

func (*DLPDatasetUploadService) New 

func (r *DLPDatasetUploadService) New(ctx context.Context, datasetID string, body DLPDatasetUploadNewParams, opts ...option.RequestOption) (res *DLPDatasetNewVersion, err error)

Prepare to upload a new version of a dataset.

type DLPDatasetUploadsStatus 

type DLPDatasetUploadsStatus string
const (
	DLPDatasetUploadsStatusEmpty     DLPDatasetUploadsStatus = "empty"
	DLPDatasetUploadsStatusUploading DLPDatasetUploadsStatus = "uploading"
	DLPDatasetUploadsStatusFailed    DLPDatasetUploadsStatus = "failed"
	DLPDatasetUploadsStatusComplete  DLPDatasetUploadsStatus = "complete"
)

type DLPPatternService 

type DLPPatternService struct {
	Options []option.RequestOption
}

DLPPatternService 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 NewDLPPatternService method instead.

func NewDLPPatternService 

func NewDLPPatternService(opts ...option.RequestOption) (r *DLPPatternService)

NewDLPPatternService 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 (*DLPPatternService) Validate 

func (r *DLPPatternService) Validate(ctx context.Context, params DLPPatternValidateParams, opts ...option.RequestOption) (res *DLPPatternValidateResponse, err error)

Validates whether this pattern is a valid regular expression. Rejects it if the regular expression is too complex or can match an unbounded-length string. Your regex will be rejected if it uses the Kleene Star -- be sure to bound the maximum number of characters that can be matched.

type DLPPatternValidateParams 

type DLPPatternValidateParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	// The regex pattern.
	Regex param.Field[string] `json:"regex,required"`
}

func (DLPPatternValidateParams) MarshalJSON 

func (r DLPPatternValidateParams) MarshalJSON() (data []byte, err error)

type DLPPatternValidateResponse 

type DLPPatternValidateResponse struct {
	Valid bool                           `json:"valid"`
	JSON  dlpPatternValidateResponseJSON `json:"-"`
}

func (*DLPPatternValidateResponse) UnmarshalJSON 

func (r *DLPPatternValidateResponse) UnmarshalJSON(data []byte) (err error)

type DLPPatternValidateResponseEnvelope 

type DLPPatternValidateResponseEnvelope struct {
	Errors   []DLPPatternValidateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DLPPatternValidateResponseEnvelopeMessages `json:"messages,required"`
	Result   DLPPatternValidateResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success DLPPatternValidateResponseEnvelopeSuccess `json:"success,required"`
	JSON    dlpPatternValidateResponseEnvelopeJSON    `json:"-"`
}

func (*DLPPatternValidateResponseEnvelope) UnmarshalJSON 

func (r *DLPPatternValidateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DLPPatternValidateResponseEnvelopeErrors 

type DLPPatternValidateResponseEnvelopeErrors struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    dlpPatternValidateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DLPPatternValidateResponseEnvelopeErrors) UnmarshalJSON 

func (r *DLPPatternValidateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DLPPatternValidateResponseEnvelopeMessages 

type DLPPatternValidateResponseEnvelopeMessages struct {
	Code    int64                                          `json:"code,required"`
	Message string                                         `json:"message,required"`
	JSON    dlpPatternValidateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DLPPatternValidateResponseEnvelopeMessages) UnmarshalJSON 

func (r *DLPPatternValidateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DLPPatternValidateResponseEnvelopeSuccess 

type DLPPatternValidateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	DLPPatternValidateResponseEnvelopeSuccessTrue DLPPatternValidateResponseEnvelopeSuccess = true
)

type DLPPayloadLogGetParams 

type DLPPayloadLogGetParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
}

type DLPPayloadLogGetResponse 

type DLPPayloadLogGetResponse struct {
	PublicKey string                       `json:"public_key,required,nullable"`
	JSON      dlpPayloadLogGetResponseJSON `json:"-"`
}

func (*DLPPayloadLogGetResponse) UnmarshalJSON 

func (r *DLPPayloadLogGetResponse) UnmarshalJSON(data []byte) (err error)

type DLPPayloadLogGetResponseEnvelope 

type DLPPayloadLogGetResponseEnvelope struct {
	Errors   []DLPPayloadLogGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DLPPayloadLogGetResponseEnvelopeMessages `json:"messages,required"`
	Result   DLPPayloadLogGetResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success DLPPayloadLogGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    dlpPayloadLogGetResponseEnvelopeJSON    `json:"-"`
}

func (*DLPPayloadLogGetResponseEnvelope) UnmarshalJSON 

func (r *DLPPayloadLogGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DLPPayloadLogGetResponseEnvelopeErrors 

type DLPPayloadLogGetResponseEnvelopeErrors struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    dlpPayloadLogGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DLPPayloadLogGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *DLPPayloadLogGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DLPPayloadLogGetResponseEnvelopeMessages 

type DLPPayloadLogGetResponseEnvelopeMessages struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    dlpPayloadLogGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DLPPayloadLogGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *DLPPayloadLogGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DLPPayloadLogGetResponseEnvelopeSuccess 

type DLPPayloadLogGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	DLPPayloadLogGetResponseEnvelopeSuccessTrue DLPPayloadLogGetResponseEnvelopeSuccess = true
)

type DLPPayloadLogService 

type DLPPayloadLogService struct {
	Options []option.RequestOption
}

DLPPayloadLogService 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 NewDLPPayloadLogService method instead.

func NewDLPPayloadLogService 

func NewDLPPayloadLogService(opts ...option.RequestOption) (r *DLPPayloadLogService)

NewDLPPayloadLogService 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 (*DLPPayloadLogService) Get 

func (r *DLPPayloadLogService) Get(ctx context.Context, query DLPPayloadLogGetParams, opts ...option.RequestOption) (res *DLPPayloadLogGetResponse, err error)

Gets the current DLP payload log settings for this account.

func (*DLPPayloadLogService) Update 

func (r *DLPPayloadLogService) Update(ctx context.Context, params DLPPayloadLogUpdateParams, opts ...option.RequestOption) (res *DLPPayloadLogUpdateResponse, err error)

Updates the DLP payload log settings for this account.

type DLPPayloadLogUpdateParams 

type DLPPayloadLogUpdateParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	// The public key to use when encrypting extracted payloads, as a base64 string
	PublicKey param.Field[string] `json:"public_key,required"`
}

func (DLPPayloadLogUpdateParams) MarshalJSON 

func (r DLPPayloadLogUpdateParams) MarshalJSON() (data []byte, err error)

type DLPPayloadLogUpdateResponse 

type DLPPayloadLogUpdateResponse struct {
	PublicKey string                          `json:"public_key,required,nullable"`
	JSON      dlpPayloadLogUpdateResponseJSON `json:"-"`
}

func (*DLPPayloadLogUpdateResponse) UnmarshalJSON 

func (r *DLPPayloadLogUpdateResponse) UnmarshalJSON(data []byte) (err error)

type DLPPayloadLogUpdateResponseEnvelope 

type DLPPayloadLogUpdateResponseEnvelope struct {
	Errors   []DLPPayloadLogUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DLPPayloadLogUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   DLPPayloadLogUpdateResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success DLPPayloadLogUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    dlpPayloadLogUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*DLPPayloadLogUpdateResponseEnvelope) UnmarshalJSON 

func (r *DLPPayloadLogUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DLPPayloadLogUpdateResponseEnvelopeErrors 

type DLPPayloadLogUpdateResponseEnvelopeErrors struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    dlpPayloadLogUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DLPPayloadLogUpdateResponseEnvelopeErrors) UnmarshalJSON 

func (r *DLPPayloadLogUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DLPPayloadLogUpdateResponseEnvelopeMessages 

type DLPPayloadLogUpdateResponseEnvelopeMessages struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    dlpPayloadLogUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DLPPayloadLogUpdateResponseEnvelopeMessages) UnmarshalJSON 

func (r *DLPPayloadLogUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DLPPayloadLogUpdateResponseEnvelopeSuccess 

type DLPPayloadLogUpdateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	DLPPayloadLogUpdateResponseEnvelopeSuccessTrue DLPPayloadLogUpdateResponseEnvelopeSuccess = true
)

type DLPPredefinedProfile 

type DLPPredefinedProfile struct {
	// The ID for this profile
	ID string `json:"id"`
	// Related DLP policies will trigger when the match count exceeds the number set.
	AllowedMatchCount float64 `json:"allowed_match_count"`
	// Scan the context of predefined entries to only return matches surrounded by
	// keywords.
	ContextAwareness DLPPredefinedProfileContextAwareness `json:"context_awareness"`
	// The entries for this profile.
	Entries []DLPPredefinedProfileEntry `json:"entries"`
	// The name of the profile.
	Name string `json:"name"`
	// The type of the profile.
	Type DLPPredefinedProfileType `json:"type"`
	JSON dlpPredefinedProfileJSON `json:"-"`
}

func (*DLPPredefinedProfile) UnmarshalJSON 

func (r *DLPPredefinedProfile) UnmarshalJSON(data []byte) (err error)

type DLPPredefinedProfileContextAwareness 

type DLPPredefinedProfileContextAwareness struct {
	// If true, scan the context of predefined entries to only return matches
	// surrounded by keywords.
	Enabled bool `json:"enabled,required"`
	// Content types to exclude from context analysis and return all matches.
	Skip DLPPredefinedProfileContextAwarenessSkip `json:"skip,required"`
	JSON dlpPredefinedProfileContextAwarenessJSON `json:"-"`
}

Scan the context of predefined entries to only return matches surrounded by keywords.

func (*DLPPredefinedProfileContextAwareness) UnmarshalJSON 

func (r *DLPPredefinedProfileContextAwareness) UnmarshalJSON(data []byte) (err error)

type DLPPredefinedProfileContextAwarenessSkip 

type DLPPredefinedProfileContextAwarenessSkip struct {
	// If the content type is a file, skip context analysis and return all matches.
	Files bool                                         `json:"files,required"`
	JSON  dlpPredefinedProfileContextAwarenessSkipJSON `json:"-"`
}

Content types to exclude from context analysis and return all matches.

func (*DLPPredefinedProfileContextAwarenessSkip) UnmarshalJSON 

func (r *DLPPredefinedProfileContextAwarenessSkip) UnmarshalJSON(data []byte) (err error)

type DLPPredefinedProfileEntry 

type DLPPredefinedProfileEntry struct {
	// The ID for this entry
	ID string `json:"id"`
	// Whether the entry is enabled or not.
	Enabled bool `json:"enabled"`
	// The name of the entry.
	Name string `json:"name"`
	// ID of the parent profile
	ProfileID interface{}                   `json:"profile_id"`
	JSON      dlpPredefinedProfileEntryJSON `json:"-"`
}

A predefined entry that matches a profile

func (*DLPPredefinedProfileEntry) UnmarshalJSON 

func (r *DLPPredefinedProfileEntry) UnmarshalJSON(data []byte) (err error)

type DLPPredefinedProfileType 

type DLPPredefinedProfileType string

The type of the profile. 

const (
	DLPPredefinedProfileTypePredefined DLPPredefinedProfileType = "predefined"
)

type DLPProfileCustomDeleteParams 

type DLPProfileCustomDeleteParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
}

type DLPProfileCustomDeleteResponse 

type DLPProfileCustomDeleteResponse interface {
	ImplementsZeroTrustDLPProfileCustomDeleteResponse()
}

Union satisfied by zero_trust.DLPProfileCustomDeleteResponseUnknown or shared.UnionString.

type DLPProfileCustomDeleteResponseEnvelope 

type DLPProfileCustomDeleteResponseEnvelope struct {
	Errors   []DLPProfileCustomDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DLPProfileCustomDeleteResponseEnvelopeMessages `json:"messages,required"`
	Result   DLPProfileCustomDeleteResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success DLPProfileCustomDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    dlpProfileCustomDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*DLPProfileCustomDeleteResponseEnvelope) UnmarshalJSON 

func (r *DLPProfileCustomDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DLPProfileCustomDeleteResponseEnvelopeErrors 

type DLPProfileCustomDeleteResponseEnvelopeErrors struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    dlpProfileCustomDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DLPProfileCustomDeleteResponseEnvelopeErrors) UnmarshalJSON 

func (r *DLPProfileCustomDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DLPProfileCustomDeleteResponseEnvelopeMessages 

type DLPProfileCustomDeleteResponseEnvelopeMessages struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    dlpProfileCustomDeleteResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DLPProfileCustomDeleteResponseEnvelopeMessages) UnmarshalJSON 

func (r *DLPProfileCustomDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DLPProfileCustomDeleteResponseEnvelopeSuccess 

type DLPProfileCustomDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	DLPProfileCustomDeleteResponseEnvelopeSuccessTrue DLPProfileCustomDeleteResponseEnvelopeSuccess = true
)

type DLPProfileCustomGetParams 

type DLPProfileCustomGetParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
}

type DLPProfileCustomGetResponseEnvelope 

type DLPProfileCustomGetResponseEnvelope struct {
	Errors   []DLPProfileCustomGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DLPProfileCustomGetResponseEnvelopeMessages `json:"messages,required"`
	Result   DLPCustomProfile                              `json:"result,required"`
	// Whether the API call was successful
	Success DLPProfileCustomGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    dlpProfileCustomGetResponseEnvelopeJSON    `json:"-"`
}

func (*DLPProfileCustomGetResponseEnvelope) UnmarshalJSON 

func (r *DLPProfileCustomGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DLPProfileCustomGetResponseEnvelopeErrors 

type DLPProfileCustomGetResponseEnvelopeErrors struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    dlpProfileCustomGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DLPProfileCustomGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *DLPProfileCustomGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DLPProfileCustomGetResponseEnvelopeMessages 

type DLPProfileCustomGetResponseEnvelopeMessages struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    dlpProfileCustomGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DLPProfileCustomGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *DLPProfileCustomGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DLPProfileCustomGetResponseEnvelopeSuccess 

type DLPProfileCustomGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	DLPProfileCustomGetResponseEnvelopeSuccessTrue DLPProfileCustomGetResponseEnvelopeSuccess = true
)

type DLPProfileCustomNewParams 

type DLPProfileCustomNewParams struct {
	// Identifier
	AccountID param.Field[string]                             `path:"account_id,required"`
	Profiles  param.Field[[]DLPProfileCustomNewParamsProfile] `json:"profiles,required"`
}

func (DLPProfileCustomNewParams) MarshalJSON 

func (r DLPProfileCustomNewParams) MarshalJSON() (data []byte, err error)

type DLPProfileCustomNewParamsProfile 

type DLPProfileCustomNewParamsProfile struct {
	// Related DLP policies will trigger when the match count exceeds the number set.
	AllowedMatchCount param.Field[float64] `json:"allowed_match_count"`
	// Scan the context of predefined entries to only return matches surrounded by
	// keywords.
	ContextAwareness param.Field[DLPProfileCustomNewParamsProfilesContextAwareness] `json:"context_awareness"`
	// The description of the profile.
	Description param.Field[string] `json:"description"`
	// The entries for this profile.
	Entries param.Field[[]DLPProfileCustomNewParamsProfilesEntry] `json:"entries"`
	// The name of the profile.
	Name param.Field[string] `json:"name"`
}

func (DLPProfileCustomNewParamsProfile) MarshalJSON 

func (r DLPProfileCustomNewParamsProfile) MarshalJSON() (data []byte, err error)

type DLPProfileCustomNewParamsProfilesContextAwareness 

type DLPProfileCustomNewParamsProfilesContextAwareness struct {
	// If true, scan the context of predefined entries to only return matches
	// surrounded by keywords.
	Enabled param.Field[bool] `json:"enabled,required"`
	// Content types to exclude from context analysis and return all matches.
	Skip param.Field[DLPProfileCustomNewParamsProfilesContextAwarenessSkip] `json:"skip,required"`
}

Scan the context of predefined entries to only return matches surrounded by keywords.

func (DLPProfileCustomNewParamsProfilesContextAwareness) MarshalJSON 

func (r DLPProfileCustomNewParamsProfilesContextAwareness) MarshalJSON() (data []byte, err error)

type DLPProfileCustomNewParamsProfilesContextAwarenessSkip 

type DLPProfileCustomNewParamsProfilesContextAwarenessSkip struct {
	// If the content type is a file, skip context analysis and return all matches.
	Files param.Field[bool] `json:"files,required"`
}

Content types to exclude from context analysis and return all matches.

func (DLPProfileCustomNewParamsProfilesContextAwarenessSkip) MarshalJSON 

func (r DLPProfileCustomNewParamsProfilesContextAwarenessSkip) MarshalJSON() (data []byte, err error)

type DLPProfileCustomNewParamsProfilesEntriesPattern 

type DLPProfileCustomNewParamsProfilesEntriesPattern struct {
	// The regex pattern.
	Regex param.Field[string] `json:"regex,required"`
	// Validation algorithm for the pattern. This algorithm will get run on potential
	// matches, and if it returns false, the entry will not be matched.
	Validation param.Field[DLPProfileCustomNewParamsProfilesEntriesPatternValidation] `json:"validation"`
}

A pattern that matches an entry

func (DLPProfileCustomNewParamsProfilesEntriesPattern) MarshalJSON 

func (r DLPProfileCustomNewParamsProfilesEntriesPattern) MarshalJSON() (data []byte, err error)

type DLPProfileCustomNewParamsProfilesEntriesPatternValidation 

type DLPProfileCustomNewParamsProfilesEntriesPatternValidation string

Validation algorithm for the pattern. This algorithm will get run on potential matches, and if it returns false, the entry will not be matched. 

const (
	DLPProfileCustomNewParamsProfilesEntriesPatternValidationLuhn DLPProfileCustomNewParamsProfilesEntriesPatternValidation = "luhn"
)

type DLPProfileCustomNewParamsProfilesEntry 

type DLPProfileCustomNewParamsProfilesEntry struct {
	// Whether the entry is enabled or not.
	Enabled param.Field[bool] `json:"enabled,required"`
	// The name of the entry.
	Name param.Field[string] `json:"name,required"`
	// A pattern that matches an entry
	Pattern param.Field[DLPProfileCustomNewParamsProfilesEntriesPattern] `json:"pattern,required"`
}

A custom entry create payload

func (DLPProfileCustomNewParamsProfilesEntry) MarshalJSON 

func (r DLPProfileCustomNewParamsProfilesEntry) MarshalJSON() (data []byte, err error)

type DLPProfileCustomNewResponseEnvelope 

type DLPProfileCustomNewResponseEnvelope struct {
	Errors   []DLPProfileCustomNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DLPProfileCustomNewResponseEnvelopeMessages `json:"messages,required"`
	Result   []DLPCustomProfile                            `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    DLPProfileCustomNewResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo DLPProfileCustomNewResponseEnvelopeResultInfo `json:"result_info"`
	JSON       dlpProfileCustomNewResponseEnvelopeJSON       `json:"-"`
}

func (*DLPProfileCustomNewResponseEnvelope) UnmarshalJSON 

func (r *DLPProfileCustomNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DLPProfileCustomNewResponseEnvelopeErrors 

type DLPProfileCustomNewResponseEnvelopeErrors struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    dlpProfileCustomNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DLPProfileCustomNewResponseEnvelopeErrors) UnmarshalJSON 

func (r *DLPProfileCustomNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DLPProfileCustomNewResponseEnvelopeMessages 

type DLPProfileCustomNewResponseEnvelopeMessages struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    dlpProfileCustomNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DLPProfileCustomNewResponseEnvelopeMessages) UnmarshalJSON 

func (r *DLPProfileCustomNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DLPProfileCustomNewResponseEnvelopeResultInfo 

type DLPProfileCustomNewResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                           `json:"total_count"`
	JSON       dlpProfileCustomNewResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*DLPProfileCustomNewResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *DLPProfileCustomNewResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type DLPProfileCustomNewResponseEnvelopeSuccess 

type DLPProfileCustomNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	DLPProfileCustomNewResponseEnvelopeSuccessTrue DLPProfileCustomNewResponseEnvelopeSuccess = true
)

type DLPProfileCustomService 

type DLPProfileCustomService struct {
	Options []option.RequestOption
}

DLPProfileCustomService 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 NewDLPProfileCustomService method instead.

func NewDLPProfileCustomService 

func NewDLPProfileCustomService(opts ...option.RequestOption) (r *DLPProfileCustomService)

NewDLPProfileCustomService 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 (*DLPProfileCustomService) Delete 

func (r *DLPProfileCustomService) Delete(ctx context.Context, profileID string, body DLPProfileCustomDeleteParams, opts ...option.RequestOption) (res *DLPProfileCustomDeleteResponse, err error)

Deletes a DLP custom profile.

func (*DLPProfileCustomService) Get 

func (r *DLPProfileCustomService) Get(ctx context.Context, profileID string, query DLPProfileCustomGetParams, opts ...option.RequestOption) (res *DLPCustomProfile, err error)

Fetches a custom DLP profile.

func (*DLPProfileCustomService) New 

func (r *DLPProfileCustomService) New(ctx context.Context, params DLPProfileCustomNewParams, opts ...option.RequestOption) (res *[]DLPCustomProfile, err error)

Creates a set of DLP custom profiles.

func (*DLPProfileCustomService) Update 

func (r *DLPProfileCustomService) Update(ctx context.Context, profileID string, params DLPProfileCustomUpdateParams, opts ...option.RequestOption) (res *DLPCustomProfile, err error)

Updates a DLP custom profile.

type DLPProfileCustomUpdateParams 

type DLPProfileCustomUpdateParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	// Related DLP policies will trigger when the match count exceeds the number set.
	AllowedMatchCount param.Field[float64] `json:"allowed_match_count"`
	// Scan the context of predefined entries to only return matches surrounded by
	// keywords.
	ContextAwareness param.Field[DLPProfileCustomUpdateParamsContextAwareness] `json:"context_awareness"`
	// The description of the profile.
	Description param.Field[string] `json:"description"`
	// The custom entries for this profile. Array elements with IDs are modifying the
	// existing entry with that ID. Elements without ID will create new entries. Any
	// entry not in the list will be deleted.
	Entries param.Field[[]DLPProfileCustomUpdateParamsEntry] `json:"entries"`
	// The name of the profile.
	Name param.Field[string] `json:"name"`
	// Entries from other profiles (e.g. pre-defined Cloudflare profiles, or your
	// Microsoft Information Protection profiles).
	SharedEntries param.Field[[]DLPProfileCustomUpdateParamsSharedEntry] `json:"shared_entries"`
}

func (DLPProfileCustomUpdateParams) MarshalJSON 

func (r DLPProfileCustomUpdateParams) MarshalJSON() (data []byte, err error)

type DLPProfileCustomUpdateParamsContextAwareness 

type DLPProfileCustomUpdateParamsContextAwareness struct {
	// If true, scan the context of predefined entries to only return matches
	// surrounded by keywords.
	Enabled param.Field[bool] `json:"enabled,required"`
	// Content types to exclude from context analysis and return all matches.
	Skip param.Field[DLPProfileCustomUpdateParamsContextAwarenessSkip] `json:"skip,required"`
}

Scan the context of predefined entries to only return matches surrounded by keywords.

func (DLPProfileCustomUpdateParamsContextAwareness) MarshalJSON 

func (r DLPProfileCustomUpdateParamsContextAwareness) MarshalJSON() (data []byte, err error)

type DLPProfileCustomUpdateParamsContextAwarenessSkip 

type DLPProfileCustomUpdateParamsContextAwarenessSkip struct {
	// If the content type is a file, skip context analysis and return all matches.
	Files param.Field[bool] `json:"files,required"`
}

Content types to exclude from context analysis and return all matches.

func (DLPProfileCustomUpdateParamsContextAwarenessSkip) MarshalJSON 

func (r DLPProfileCustomUpdateParamsContextAwarenessSkip) MarshalJSON() (data []byte, err error)

type DLPProfileCustomUpdateParamsEntriesPattern 

type DLPProfileCustomUpdateParamsEntriesPattern struct {
	// The regex pattern.
	Regex param.Field[string] `json:"regex,required"`
	// Validation algorithm for the pattern. This algorithm will get run on potential
	// matches, and if it returns false, the entry will not be matched.
	Validation param.Field[DLPProfileCustomUpdateParamsEntriesPatternValidation] `json:"validation"`
}

A pattern that matches an entry

func (DLPProfileCustomUpdateParamsEntriesPattern) MarshalJSON 

func (r DLPProfileCustomUpdateParamsEntriesPattern) MarshalJSON() (data []byte, err error)

type DLPProfileCustomUpdateParamsEntriesPatternValidation 

type DLPProfileCustomUpdateParamsEntriesPatternValidation string

Validation algorithm for the pattern. This algorithm will get run on potential matches, and if it returns false, the entry will not be matched. 

const (
	DLPProfileCustomUpdateParamsEntriesPatternValidationLuhn DLPProfileCustomUpdateParamsEntriesPatternValidation = "luhn"
)

type DLPProfileCustomUpdateParamsEntry 

type DLPProfileCustomUpdateParamsEntry struct {
	// Whether the entry is enabled or not.
	Enabled param.Field[bool] `json:"enabled"`
	// The name of the entry.
	Name param.Field[string] `json:"name"`
	// A pattern that matches an entry
	Pattern param.Field[DLPProfileCustomUpdateParamsEntriesPattern] `json:"pattern"`
	// ID of the parent profile
	ProfileID param.Field[interface{}] `json:"profile_id"`
}

A custom entry that matches a profile

func (DLPProfileCustomUpdateParamsEntry) MarshalJSON 

func (r DLPProfileCustomUpdateParamsEntry) MarshalJSON() (data []byte, err error)

type DLPProfileCustomUpdateParamsSharedEntriesDLPSharedEntryUpdateIntegration 

type DLPProfileCustomUpdateParamsSharedEntriesDLPSharedEntryUpdateIntegration struct {
	// Whether the entry is enabled or not.
	Enabled param.Field[bool] `json:"enabled"`
}

Properties of an integration entry in a custom profile

func (DLPProfileCustomUpdateParamsSharedEntriesDLPSharedEntryUpdateIntegration) MarshalJSON 

func (r DLPProfileCustomUpdateParamsSharedEntriesDLPSharedEntryUpdateIntegration) MarshalJSON() (data []byte, err error)

type DLPProfileCustomUpdateParamsSharedEntriesDLPSharedEntryUpdatePredefined 

type DLPProfileCustomUpdateParamsSharedEntriesDLPSharedEntryUpdatePredefined struct {
	// Whether the entry is enabled or not.
	Enabled param.Field[bool] `json:"enabled"`
}

Properties of a predefined entry in a custom profile

func (DLPProfileCustomUpdateParamsSharedEntriesDLPSharedEntryUpdatePredefined) MarshalJSON 

func (r DLPProfileCustomUpdateParamsSharedEntriesDLPSharedEntryUpdatePredefined) MarshalJSON() (data []byte, err error)

type DLPProfileCustomUpdateParamsSharedEntry 

type DLPProfileCustomUpdateParamsSharedEntry interface {
	// contains filtered or unexported methods
}

Properties of a predefined entry in a custom profile

Satisfied by zero_trust.DLPProfileCustomUpdateParamsSharedEntriesDLPSharedEntryUpdatePredefined, zero_trust.DLPProfileCustomUpdateParamsSharedEntriesDLPSharedEntryUpdateIntegration.

type DLPProfileGetParams 

type DLPProfileGetParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
}

type DLPProfileGetResponse 

type DLPProfileGetResponse interface {
	// contains filtered or unexported methods
}

Union satisfied by zero_trust.DLPPredefinedProfile, zero_trust.DLPCustomProfile or zero_trust.DLPProfileGetResponseDLPIntegrationProfile.

type DLPProfileGetResponseDLPIntegrationProfile 

type DLPProfileGetResponseDLPIntegrationProfile struct {
	// The ID for this profile
	ID        string    `json:"id"`
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// The description of the profile.
	Description string `json:"description"`
	// The entries for this profile.
	Entries []DLPProfileGetResponseDLPIntegrationProfileEntry `json:"entries"`
	// The name of the profile.
	Name string `json:"name"`
	// The type of the profile.
	Type      DLPProfileGetResponseDLPIntegrationProfileType `json:"type"`
	UpdatedAt time.Time                                      `json:"updated_at" format:"date-time"`
	JSON      dlpProfileGetResponseDLPIntegrationProfileJSON `json:"-"`
}

func (*DLPProfileGetResponseDLPIntegrationProfile) UnmarshalJSON 

func (r *DLPProfileGetResponseDLPIntegrationProfile) UnmarshalJSON(data []byte) (err error)

type DLPProfileGetResponseDLPIntegrationProfileEntry 

type DLPProfileGetResponseDLPIntegrationProfileEntry struct {
	// The ID for this entry
	ID        string    `json:"id"`
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Whether the entry is enabled or not.
	Enabled bool `json:"enabled"`
	// The name of the entry.
	Name string `json:"name"`
	// ID of the parent profile
	ProfileID interface{}                                         `json:"profile_id"`
	UpdatedAt time.Time                                           `json:"updated_at" format:"date-time"`
	JSON      dlpProfileGetResponseDLPIntegrationProfileEntryJSON `json:"-"`
}

An entry derived from an integration

func (*DLPProfileGetResponseDLPIntegrationProfileEntry) UnmarshalJSON 

func (r *DLPProfileGetResponseDLPIntegrationProfileEntry) UnmarshalJSON(data []byte) (err error)

type DLPProfileGetResponseDLPIntegrationProfileType 

type DLPProfileGetResponseDLPIntegrationProfileType string

The type of the profile. 

const (
	DLPProfileGetResponseDLPIntegrationProfileTypeIntegration DLPProfileGetResponseDLPIntegrationProfileType = "integration"
)

type DLPProfileGetResponseEnvelope 

type DLPProfileGetResponseEnvelope struct {
	Errors   []DLPProfileGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DLPProfileGetResponseEnvelopeMessages `json:"messages,required"`
	Result   DLPProfileGetResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success DLPProfileGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    dlpProfileGetResponseEnvelopeJSON    `json:"-"`
}

func (*DLPProfileGetResponseEnvelope) UnmarshalJSON 

func (r *DLPProfileGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DLPProfileGetResponseEnvelopeErrors 

type DLPProfileGetResponseEnvelopeErrors struct {
	Code    int64                                   `json:"code,required"`
	Message string                                  `json:"message,required"`
	JSON    dlpProfileGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DLPProfileGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *DLPProfileGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DLPProfileGetResponseEnvelopeMessages 

type DLPProfileGetResponseEnvelopeMessages struct {
	Code    int64                                     `json:"code,required"`
	Message string                                    `json:"message,required"`
	JSON    dlpProfileGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DLPProfileGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *DLPProfileGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DLPProfileGetResponseEnvelopeSuccess 

type DLPProfileGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	DLPProfileGetResponseEnvelopeSuccessTrue DLPProfileGetResponseEnvelopeSuccess = true
)

type DLPProfileListParams 

type DLPProfileListParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
}

type DLPProfileListResponseEnvelope 

type DLPProfileListResponseEnvelope struct {
	Errors   []DLPProfileListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DLPProfileListResponseEnvelopeMessages `json:"messages,required"`
	Result   []DLPProfiles                            `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    DLPProfileListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo DLPProfileListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       dlpProfileListResponseEnvelopeJSON       `json:"-"`
}

func (*DLPProfileListResponseEnvelope) UnmarshalJSON 

func (r *DLPProfileListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DLPProfileListResponseEnvelopeErrors 

type DLPProfileListResponseEnvelopeErrors struct {
	Code    int64                                    `json:"code,required"`
	Message string                                   `json:"message,required"`
	JSON    dlpProfileListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DLPProfileListResponseEnvelopeErrors) UnmarshalJSON 

func (r *DLPProfileListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DLPProfileListResponseEnvelopeMessages 

type DLPProfileListResponseEnvelopeMessages struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    dlpProfileListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DLPProfileListResponseEnvelopeMessages) UnmarshalJSON 

func (r *DLPProfileListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DLPProfileListResponseEnvelopeResultInfo 

type DLPProfileListResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                      `json:"total_count"`
	JSON       dlpProfileListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*DLPProfileListResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *DLPProfileListResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type DLPProfileListResponseEnvelopeSuccess 

type DLPProfileListResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	DLPProfileListResponseEnvelopeSuccessTrue DLPProfileListResponseEnvelopeSuccess = true
)

type DLPProfilePredefinedGetParams 

type DLPProfilePredefinedGetParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
}

type DLPProfilePredefinedGetResponseEnvelope 

type DLPProfilePredefinedGetResponseEnvelope struct {
	Errors   []DLPProfilePredefinedGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DLPProfilePredefinedGetResponseEnvelopeMessages `json:"messages,required"`
	Result   DLPPredefinedProfile                              `json:"result,required"`
	// Whether the API call was successful
	Success DLPProfilePredefinedGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    dlpProfilePredefinedGetResponseEnvelopeJSON    `json:"-"`
}

func (*DLPProfilePredefinedGetResponseEnvelope) UnmarshalJSON 

func (r *DLPProfilePredefinedGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DLPProfilePredefinedGetResponseEnvelopeErrors 

type DLPProfilePredefinedGetResponseEnvelopeErrors struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    dlpProfilePredefinedGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DLPProfilePredefinedGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *DLPProfilePredefinedGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DLPProfilePredefinedGetResponseEnvelopeMessages 

type DLPProfilePredefinedGetResponseEnvelopeMessages struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    dlpProfilePredefinedGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DLPProfilePredefinedGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *DLPProfilePredefinedGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DLPProfilePredefinedGetResponseEnvelopeSuccess 

type DLPProfilePredefinedGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	DLPProfilePredefinedGetResponseEnvelopeSuccessTrue DLPProfilePredefinedGetResponseEnvelopeSuccess = true
)

type DLPProfilePredefinedService 

type DLPProfilePredefinedService struct {
	Options []option.RequestOption
}

DLPProfilePredefinedService 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 NewDLPProfilePredefinedService method instead.

func NewDLPProfilePredefinedService 

func NewDLPProfilePredefinedService(opts ...option.RequestOption) (r *DLPProfilePredefinedService)

NewDLPProfilePredefinedService 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 (*DLPProfilePredefinedService) Get 

func (r *DLPProfilePredefinedService) Get(ctx context.Context, profileID string, query DLPProfilePredefinedGetParams, opts ...option.RequestOption) (res *DLPPredefinedProfile, err error)

Fetches a predefined DLP profile.

func (*DLPProfilePredefinedService) Update 

func (r *DLPProfilePredefinedService) Update(ctx context.Context, profileID string, params DLPProfilePredefinedUpdateParams, opts ...option.RequestOption) (res *DLPPredefinedProfile, err error)

Updates a DLP predefined profile. Only supports enabling/disabling entries.

type DLPProfilePredefinedUpdateParams 

type DLPProfilePredefinedUpdateParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	// Related DLP policies will trigger when the match count exceeds the number set.
	AllowedMatchCount param.Field[float64] `json:"allowed_match_count"`
	// Scan the context of predefined entries to only return matches surrounded by
	// keywords.
	ContextAwareness param.Field[DLPProfilePredefinedUpdateParamsContextAwareness] `json:"context_awareness"`
	// The entries for this profile.
	Entries param.Field[[]DLPProfilePredefinedUpdateParamsEntry] `json:"entries"`
}

func (DLPProfilePredefinedUpdateParams) MarshalJSON 

func (r DLPProfilePredefinedUpdateParams) MarshalJSON() (data []byte, err error)

type DLPProfilePredefinedUpdateParamsContextAwareness 

type DLPProfilePredefinedUpdateParamsContextAwareness struct {
	// If true, scan the context of predefined entries to only return matches
	// surrounded by keywords.
	Enabled param.Field[bool] `json:"enabled,required"`
	// Content types to exclude from context analysis and return all matches.
	Skip param.Field[DLPProfilePredefinedUpdateParamsContextAwarenessSkip] `json:"skip,required"`
}

Scan the context of predefined entries to only return matches surrounded by keywords.

func (DLPProfilePredefinedUpdateParamsContextAwareness) MarshalJSON 

func (r DLPProfilePredefinedUpdateParamsContextAwareness) MarshalJSON() (data []byte, err error)

type DLPProfilePredefinedUpdateParamsContextAwarenessSkip 

type DLPProfilePredefinedUpdateParamsContextAwarenessSkip struct {
	// If the content type is a file, skip context analysis and return all matches.
	Files param.Field[bool] `json:"files,required"`
}

Content types to exclude from context analysis and return all matches.

func (DLPProfilePredefinedUpdateParamsContextAwarenessSkip) MarshalJSON 

func (r DLPProfilePredefinedUpdateParamsContextAwarenessSkip) MarshalJSON() (data []byte, err error)

type DLPProfilePredefinedUpdateParamsEntry 

type DLPProfilePredefinedUpdateParamsEntry struct {
	// Whether the entry is enabled or not.
	Enabled param.Field[bool] `json:"enabled"`
}

func (DLPProfilePredefinedUpdateParamsEntry) MarshalJSON 

func (r DLPProfilePredefinedUpdateParamsEntry) MarshalJSON() (data []byte, err error)

type DLPProfileService 

type DLPProfileService struct {
	Options    []option.RequestOption
	Custom     *DLPProfileCustomService
	Predefined *DLPProfilePredefinedService
}

DLPProfileService 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 NewDLPProfileService method instead.

func NewDLPProfileService 

func NewDLPProfileService(opts ...option.RequestOption) (r *DLPProfileService)

NewDLPProfileService 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 (*DLPProfileService) Get 

func (r *DLPProfileService) Get(ctx context.Context, profileID string, query DLPProfileGetParams, opts ...option.RequestOption) (res *DLPProfileGetResponse, err error)

Fetches a DLP profile by ID. Supports both predefined and custom profiles

func (*DLPProfileService) List 

func (r *DLPProfileService) List(ctx context.Context, query DLPProfileListParams, opts ...option.RequestOption) (res *[]DLPProfiles, err error)

Lists all DLP profiles in an account.

type DLPProfiles 

type DLPProfiles interface {
	// contains filtered or unexported methods
}

Union satisfied by zero_trust.DLPPredefinedProfile, zero_trust.DLPCustomProfile or zero_trust.DLPProfilesDLPIntegrationProfile.

type DLPProfilesDLPIntegrationProfile 

type DLPProfilesDLPIntegrationProfile struct {
	// The ID for this profile
	ID        string    `json:"id"`
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// The description of the profile.
	Description string `json:"description"`
	// The entries for this profile.
	Entries []DLPProfilesDLPIntegrationProfileEntry `json:"entries"`
	// The name of the profile.
	Name string `json:"name"`
	// The type of the profile.
	Type      DLPProfilesDLPIntegrationProfileType `json:"type"`
	UpdatedAt time.Time                            `json:"updated_at" format:"date-time"`
	JSON      dlpProfilesDLPIntegrationProfileJSON `json:"-"`
}

func (*DLPProfilesDLPIntegrationProfile) UnmarshalJSON 

func (r *DLPProfilesDLPIntegrationProfile) UnmarshalJSON(data []byte) (err error)

type DLPProfilesDLPIntegrationProfileEntry 

type DLPProfilesDLPIntegrationProfileEntry struct {
	// The ID for this entry
	ID        string    `json:"id"`
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Whether the entry is enabled or not.
	Enabled bool `json:"enabled"`
	// The name of the entry.
	Name string `json:"name"`
	// ID of the parent profile
	ProfileID interface{}                               `json:"profile_id"`
	UpdatedAt time.Time                                 `json:"updated_at" format:"date-time"`
	JSON      dlpProfilesDLPIntegrationProfileEntryJSON `json:"-"`
}

An entry derived from an integration

func (*DLPProfilesDLPIntegrationProfileEntry) UnmarshalJSON 

func (r *DLPProfilesDLPIntegrationProfileEntry) UnmarshalJSON(data []byte) (err error)

type DLPProfilesDLPIntegrationProfileType 

type DLPProfilesDLPIntegrationProfileType string

The type of the profile. 

const (
	DLPProfilesDLPIntegrationProfileTypeIntegration DLPProfilesDLPIntegrationProfileType = "integration"
)

type DLPService 

type DLPService struct {
	Options     []option.RequestOption
	Datasets    *DLPDatasetService
	Patterns    *DLPPatternService
	PayloadLogs *DLPPayloadLogService
	Profiles    *DLPProfileService
}

DLPService 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 NewDLPService method instead.

func NewDLPService 

func NewDLPService(opts ...option.RequestOption) (r *DLPService)

NewDLPService 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 DeviceDEXTestDeleteParams 

type DeviceDEXTestDeleteParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type DeviceDEXTestDeleteResponseEnvelope 

type DeviceDEXTestDeleteResponseEnvelope struct {
	Errors   []DeviceDEXTestDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DeviceDEXTestDeleteResponseEnvelopeMessages `json:"messages,required"`
	Result   []TeamsDevicesDeviceDEXTestSchemasHTTP        `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success DeviceDEXTestDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    deviceDEXTestDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*DeviceDEXTestDeleteResponseEnvelope) UnmarshalJSON 

func (r *DeviceDEXTestDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DeviceDEXTestDeleteResponseEnvelopeErrors 

type DeviceDEXTestDeleteResponseEnvelopeErrors struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    deviceDEXTestDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DeviceDEXTestDeleteResponseEnvelopeErrors) UnmarshalJSON 

func (r *DeviceDEXTestDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DeviceDEXTestDeleteResponseEnvelopeMessages 

type DeviceDEXTestDeleteResponseEnvelopeMessages struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    deviceDEXTestDeleteResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DeviceDEXTestDeleteResponseEnvelopeMessages) UnmarshalJSON 

func (r *DeviceDEXTestDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DeviceDEXTestDeleteResponseEnvelopeSuccess 

type DeviceDEXTestDeleteResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DeviceDEXTestDeleteResponseEnvelopeSuccessTrue DeviceDEXTestDeleteResponseEnvelopeSuccess = true
)

type DeviceDEXTestGetParams 

type DeviceDEXTestGetParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type DeviceDEXTestGetResponseEnvelope 

type DeviceDEXTestGetResponseEnvelope struct {
	Errors   []DeviceDEXTestGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DeviceDEXTestGetResponseEnvelopeMessages `json:"messages,required"`
	Result   TeamsDevicesDeviceDEXTestSchemasHTTP       `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success DeviceDEXTestGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    deviceDEXTestGetResponseEnvelopeJSON    `json:"-"`
}

func (*DeviceDEXTestGetResponseEnvelope) UnmarshalJSON 

func (r *DeviceDEXTestGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DeviceDEXTestGetResponseEnvelopeErrors 

type DeviceDEXTestGetResponseEnvelopeErrors struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    deviceDEXTestGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DeviceDEXTestGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *DeviceDEXTestGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DeviceDEXTestGetResponseEnvelopeMessages 

type DeviceDEXTestGetResponseEnvelopeMessages struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    deviceDEXTestGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DeviceDEXTestGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *DeviceDEXTestGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DeviceDEXTestGetResponseEnvelopeSuccess 

type DeviceDEXTestGetResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DeviceDEXTestGetResponseEnvelopeSuccessTrue DeviceDEXTestGetResponseEnvelopeSuccess = true
)

type DeviceDEXTestListParams 

type DeviceDEXTestListParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type DeviceDEXTestListResponseEnvelope 

type DeviceDEXTestListResponseEnvelope struct {
	Errors   []DeviceDEXTestListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DeviceDEXTestListResponseEnvelopeMessages `json:"messages,required"`
	Result   []TeamsDevicesDeviceDEXTestSchemasHTTP      `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success DeviceDEXTestListResponseEnvelopeSuccess `json:"success,required"`
	JSON    deviceDEXTestListResponseEnvelopeJSON    `json:"-"`
}

func (*DeviceDEXTestListResponseEnvelope) UnmarshalJSON 

func (r *DeviceDEXTestListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DeviceDEXTestListResponseEnvelopeErrors 

type DeviceDEXTestListResponseEnvelopeErrors struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    deviceDEXTestListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DeviceDEXTestListResponseEnvelopeErrors) UnmarshalJSON 

func (r *DeviceDEXTestListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DeviceDEXTestListResponseEnvelopeMessages 

type DeviceDEXTestListResponseEnvelopeMessages struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    deviceDEXTestListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DeviceDEXTestListResponseEnvelopeMessages) UnmarshalJSON 

func (r *DeviceDEXTestListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DeviceDEXTestListResponseEnvelopeSuccess 

type DeviceDEXTestListResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DeviceDEXTestListResponseEnvelopeSuccessTrue DeviceDEXTestListResponseEnvelopeSuccess = true
)

type DeviceDEXTestNewParams 

type DeviceDEXTestNewParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
	// The configuration object which contains the details for the WARP client to
	// conduct the test.
	Data param.Field[DeviceDEXTestNewParamsData] `json:"data,required"`
	// Determines whether or not the test is active.
	Enabled param.Field[bool] `json:"enabled,required"`
	// How often the test will run.
	Interval param.Field[string] `json:"interval,required"`
	// The name of the DEX test. Must be unique.
	Name param.Field[string] `json:"name,required"`
	// Additional details about the test.
	Description param.Field[string] `json:"description"`
}

func (DeviceDEXTestNewParams) MarshalJSON 

func (r DeviceDEXTestNewParams) MarshalJSON() (data []byte, err error)

type DeviceDEXTestNewParamsData 

type DeviceDEXTestNewParamsData struct {
	// The desired endpoint to test.
	Host param.Field[string] `json:"host"`
	// The type of test.
	Kind param.Field[string] `json:"kind"`
	// The HTTP request method type.
	Method param.Field[string] `json:"method"`
}

The configuration object which contains the details for the WARP client to conduct the test.

func (DeviceDEXTestNewParamsData) MarshalJSON 

func (r DeviceDEXTestNewParamsData) MarshalJSON() (data []byte, err error)

type DeviceDEXTestNewResponseEnvelope 

type DeviceDEXTestNewResponseEnvelope struct {
	Errors   []DeviceDEXTestNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DeviceDEXTestNewResponseEnvelopeMessages `json:"messages,required"`
	Result   TeamsDevicesDeviceDEXTestSchemasHTTP       `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success DeviceDEXTestNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    deviceDEXTestNewResponseEnvelopeJSON    `json:"-"`
}

func (*DeviceDEXTestNewResponseEnvelope) UnmarshalJSON 

func (r *DeviceDEXTestNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DeviceDEXTestNewResponseEnvelopeErrors 

type DeviceDEXTestNewResponseEnvelopeErrors struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    deviceDEXTestNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DeviceDEXTestNewResponseEnvelopeErrors) UnmarshalJSON 

func (r *DeviceDEXTestNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DeviceDEXTestNewResponseEnvelopeMessages 

type DeviceDEXTestNewResponseEnvelopeMessages struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    deviceDEXTestNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DeviceDEXTestNewResponseEnvelopeMessages) UnmarshalJSON 

func (r *DeviceDEXTestNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DeviceDEXTestNewResponseEnvelopeSuccess 

type DeviceDEXTestNewResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DeviceDEXTestNewResponseEnvelopeSuccessTrue DeviceDEXTestNewResponseEnvelopeSuccess = true
)

type DeviceDEXTestService 

type DeviceDEXTestService struct {
	Options []option.RequestOption
}

DeviceDEXTestService 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 NewDeviceDEXTestService method instead.

func NewDeviceDEXTestService 

func NewDeviceDEXTestService(opts ...option.RequestOption) (r *DeviceDEXTestService)

NewDeviceDEXTestService 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 (*DeviceDEXTestService) Delete 

func (r *DeviceDEXTestService) Delete(ctx context.Context, dexTestID string, body DeviceDEXTestDeleteParams, opts ...option.RequestOption) (res *[]TeamsDevicesDeviceDEXTestSchemasHTTP, err error)

Delete a Device DEX test. Returns the remaining device dex tests for the account.

func (*DeviceDEXTestService) Get 

func (r *DeviceDEXTestService) Get(ctx context.Context, dexTestID string, query DeviceDEXTestGetParams, opts ...option.RequestOption) (res *TeamsDevicesDeviceDEXTestSchemasHTTP, err error)

Fetch a single DEX test.

func (*DeviceDEXTestService) List 

func (r *DeviceDEXTestService) List(ctx context.Context, query DeviceDEXTestListParams, opts ...option.RequestOption) (res *[]TeamsDevicesDeviceDEXTestSchemasHTTP, err error)

Fetch all DEX tests.

func (*DeviceDEXTestService) New 

func (r *DeviceDEXTestService) New(ctx context.Context, params DeviceDEXTestNewParams, opts ...option.RequestOption) (res *TeamsDevicesDeviceDEXTestSchemasHTTP, err error)

Create a DEX test.

func (*DeviceDEXTestService) Update 

func (r *DeviceDEXTestService) Update(ctx context.Context, dexTestID string, params DeviceDEXTestUpdateParams, opts ...option.RequestOption) (res *TeamsDevicesDeviceDEXTestSchemasHTTP, err error)

Update a DEX test.

type DeviceDEXTestUpdateParams 

type DeviceDEXTestUpdateParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
	// The configuration object which contains the details for the WARP client to
	// conduct the test.
	Data param.Field[DeviceDEXTestUpdateParamsData] `json:"data,required"`
	// Determines whether or not the test is active.
	Enabled param.Field[bool] `json:"enabled,required"`
	// How often the test will run.
	Interval param.Field[string] `json:"interval,required"`
	// The name of the DEX test. Must be unique.
	Name param.Field[string] `json:"name,required"`
	// Additional details about the test.
	Description param.Field[string] `json:"description"`
}

func (DeviceDEXTestUpdateParams) MarshalJSON 

func (r DeviceDEXTestUpdateParams) MarshalJSON() (data []byte, err error)

type DeviceDEXTestUpdateParamsData 

type DeviceDEXTestUpdateParamsData struct {
	// The desired endpoint to test.
	Host param.Field[string] `json:"host"`
	// The type of test.
	Kind param.Field[string] `json:"kind"`
	// The HTTP request method type.
	Method param.Field[string] `json:"method"`
}

The configuration object which contains the details for the WARP client to conduct the test.

func (DeviceDEXTestUpdateParamsData) MarshalJSON 

func (r DeviceDEXTestUpdateParamsData) MarshalJSON() (data []byte, err error)

type DeviceDEXTestUpdateResponseEnvelope 

type DeviceDEXTestUpdateResponseEnvelope struct {
	Errors   []DeviceDEXTestUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DeviceDEXTestUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   TeamsDevicesDeviceDEXTestSchemasHTTP          `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success DeviceDEXTestUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    deviceDEXTestUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*DeviceDEXTestUpdateResponseEnvelope) UnmarshalJSON 

func (r *DeviceDEXTestUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DeviceDEXTestUpdateResponseEnvelopeErrors 

type DeviceDEXTestUpdateResponseEnvelopeErrors struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    deviceDEXTestUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DeviceDEXTestUpdateResponseEnvelopeErrors) UnmarshalJSON 

func (r *DeviceDEXTestUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DeviceDEXTestUpdateResponseEnvelopeMessages 

type DeviceDEXTestUpdateResponseEnvelopeMessages struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    deviceDEXTestUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DeviceDEXTestUpdateResponseEnvelopeMessages) UnmarshalJSON 

func (r *DeviceDEXTestUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DeviceDEXTestUpdateResponseEnvelopeSuccess 

type DeviceDEXTestUpdateResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DeviceDEXTestUpdateResponseEnvelopeSuccessTrue DeviceDEXTestUpdateResponseEnvelopeSuccess = true
)

type DeviceGetParams 

type DeviceGetParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type DeviceGetResponse 

type DeviceGetResponse interface {
	ImplementsZeroTrustDeviceGetResponse()
}

Union satisfied by zero_trust.DeviceGetResponseUnknown or shared.UnionString.

type DeviceGetResponseEnvelope 

type DeviceGetResponseEnvelope struct {
	Errors   []DeviceGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DeviceGetResponseEnvelopeMessages `json:"messages,required"`
	Result   DeviceGetResponse                   `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success DeviceGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    deviceGetResponseEnvelopeJSON    `json:"-"`
}

func (*DeviceGetResponseEnvelope) UnmarshalJSON 

func (r *DeviceGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DeviceGetResponseEnvelopeErrors 

type DeviceGetResponseEnvelopeErrors struct {
	Code    int64                               `json:"code,required"`
	Message string                              `json:"message,required"`
	JSON    deviceGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DeviceGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *DeviceGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DeviceGetResponseEnvelopeMessages 

type DeviceGetResponseEnvelopeMessages struct {
	Code    int64                                 `json:"code,required"`
	Message string                                `json:"message,required"`
	JSON    deviceGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DeviceGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *DeviceGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DeviceGetResponseEnvelopeSuccess 

type DeviceGetResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DeviceGetResponseEnvelopeSuccessTrue DeviceGetResponseEnvelopeSuccess = true
)

type DeviceListParams 

type DeviceListParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type DeviceListResponseEnvelope 

type DeviceListResponseEnvelope struct {
	Errors   []DeviceListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DeviceListResponseEnvelopeMessages `json:"messages,required"`
	Result   []TeamsDevicesDevices                `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success    DeviceListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo DeviceListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       deviceListResponseEnvelopeJSON       `json:"-"`
}

func (*DeviceListResponseEnvelope) UnmarshalJSON 

func (r *DeviceListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DeviceListResponseEnvelopeErrors 

type DeviceListResponseEnvelopeErrors struct {
	Code    int64                                `json:"code,required"`
	Message string                               `json:"message,required"`
	JSON    deviceListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DeviceListResponseEnvelopeErrors) UnmarshalJSON 

func (r *DeviceListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DeviceListResponseEnvelopeMessages 

type DeviceListResponseEnvelopeMessages struct {
	Code    int64                                  `json:"code,required"`
	Message string                                 `json:"message,required"`
	JSON    deviceListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DeviceListResponseEnvelopeMessages) UnmarshalJSON 

func (r *DeviceListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DeviceListResponseEnvelopeResultInfo 

type DeviceListResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                  `json:"total_count"`
	JSON       deviceListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*DeviceListResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *DeviceListResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type DeviceListResponseEnvelopeSuccess 

type DeviceListResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DeviceListResponseEnvelopeSuccessTrue DeviceListResponseEnvelopeSuccess = true
)

type DeviceNetworkDeleteParams 

type DeviceNetworkDeleteParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type DeviceNetworkDeleteResponseEnvelope 

type DeviceNetworkDeleteResponseEnvelope struct {
	Errors   []DeviceNetworkDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DeviceNetworkDeleteResponseEnvelopeMessages `json:"messages,required"`
	Result   []TeamsDevicesDeviceManagedNetworks           `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success    DeviceNetworkDeleteResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo DeviceNetworkDeleteResponseEnvelopeResultInfo `json:"result_info"`
	JSON       deviceNetworkDeleteResponseEnvelopeJSON       `json:"-"`
}

func (*DeviceNetworkDeleteResponseEnvelope) UnmarshalJSON 

func (r *DeviceNetworkDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DeviceNetworkDeleteResponseEnvelopeErrors 

type DeviceNetworkDeleteResponseEnvelopeErrors struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    deviceNetworkDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DeviceNetworkDeleteResponseEnvelopeErrors) UnmarshalJSON 

func (r *DeviceNetworkDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DeviceNetworkDeleteResponseEnvelopeMessages 

type DeviceNetworkDeleteResponseEnvelopeMessages struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    deviceNetworkDeleteResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DeviceNetworkDeleteResponseEnvelopeMessages) UnmarshalJSON 

func (r *DeviceNetworkDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DeviceNetworkDeleteResponseEnvelopeResultInfo 

type DeviceNetworkDeleteResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                           `json:"total_count"`
	JSON       deviceNetworkDeleteResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*DeviceNetworkDeleteResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *DeviceNetworkDeleteResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type DeviceNetworkDeleteResponseEnvelopeSuccess 

type DeviceNetworkDeleteResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DeviceNetworkDeleteResponseEnvelopeSuccessTrue DeviceNetworkDeleteResponseEnvelopeSuccess = true
)

type DeviceNetworkGetParams 

type DeviceNetworkGetParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type DeviceNetworkGetResponseEnvelope 

type DeviceNetworkGetResponseEnvelope struct {
	Errors   []DeviceNetworkGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DeviceNetworkGetResponseEnvelopeMessages `json:"messages,required"`
	Result   TeamsDevicesDeviceManagedNetworks          `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success DeviceNetworkGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    deviceNetworkGetResponseEnvelopeJSON    `json:"-"`
}

func (*DeviceNetworkGetResponseEnvelope) UnmarshalJSON 

func (r *DeviceNetworkGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DeviceNetworkGetResponseEnvelopeErrors 

type DeviceNetworkGetResponseEnvelopeErrors struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    deviceNetworkGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DeviceNetworkGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *DeviceNetworkGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DeviceNetworkGetResponseEnvelopeMessages 

type DeviceNetworkGetResponseEnvelopeMessages struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    deviceNetworkGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DeviceNetworkGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *DeviceNetworkGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DeviceNetworkGetResponseEnvelopeSuccess 

type DeviceNetworkGetResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DeviceNetworkGetResponseEnvelopeSuccessTrue DeviceNetworkGetResponseEnvelopeSuccess = true
)

type DeviceNetworkListParams 

type DeviceNetworkListParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type DeviceNetworkListResponseEnvelope 

type DeviceNetworkListResponseEnvelope struct {
	Errors   []DeviceNetworkListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DeviceNetworkListResponseEnvelopeMessages `json:"messages,required"`
	Result   []TeamsDevicesDeviceManagedNetworks         `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success    DeviceNetworkListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo DeviceNetworkListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       deviceNetworkListResponseEnvelopeJSON       `json:"-"`
}

func (*DeviceNetworkListResponseEnvelope) UnmarshalJSON 

func (r *DeviceNetworkListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DeviceNetworkListResponseEnvelopeErrors 

type DeviceNetworkListResponseEnvelopeErrors struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    deviceNetworkListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DeviceNetworkListResponseEnvelopeErrors) UnmarshalJSON 

func (r *DeviceNetworkListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DeviceNetworkListResponseEnvelopeMessages 

type DeviceNetworkListResponseEnvelopeMessages struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    deviceNetworkListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DeviceNetworkListResponseEnvelopeMessages) UnmarshalJSON 

func (r *DeviceNetworkListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DeviceNetworkListResponseEnvelopeResultInfo 

type DeviceNetworkListResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                         `json:"total_count"`
	JSON       deviceNetworkListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*DeviceNetworkListResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *DeviceNetworkListResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type DeviceNetworkListResponseEnvelopeSuccess 

type DeviceNetworkListResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DeviceNetworkListResponseEnvelopeSuccessTrue DeviceNetworkListResponseEnvelopeSuccess = true
)

type DeviceNetworkNewParams 

type DeviceNetworkNewParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
	// The configuration object containing information for the WARP client to detect
	// the managed network.
	Config param.Field[DeviceNetworkNewParamsConfig] `json:"config,required"`
	// The name of the device managed network. This name must be unique.
	Name param.Field[string] `json:"name,required"`
	// The type of device managed network.
	Type param.Field[DeviceNetworkNewParamsType] `json:"type,required"`
}

func (DeviceNetworkNewParams) MarshalJSON 

func (r DeviceNetworkNewParams) MarshalJSON() (data []byte, err error)

type DeviceNetworkNewParamsConfig 

type DeviceNetworkNewParamsConfig struct {
	// A network address of the form "host:port" that the WARP client will use to
	// detect the presence of a TLS host.
	TLSSockaddr param.Field[string] `json:"tls_sockaddr,required"`
	// The SHA-256 hash of the TLS certificate presented by the host found at
	// tls_sockaddr. If absent, regular certificate verification (trusted roots, valid
	// timestamp, etc) will be used to validate the certificate.
	Sha256 param.Field[string] `json:"sha256"`
}

The configuration object containing information for the WARP client to detect the managed network.

func (DeviceNetworkNewParamsConfig) MarshalJSON 

func (r DeviceNetworkNewParamsConfig) MarshalJSON() (data []byte, err error)

type DeviceNetworkNewParamsType 

type DeviceNetworkNewParamsType string

The type of device managed network. 

const (
	DeviceNetworkNewParamsTypeTLS DeviceNetworkNewParamsType = "tls"
)

type DeviceNetworkNewResponseEnvelope 

type DeviceNetworkNewResponseEnvelope struct {
	Errors   []DeviceNetworkNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DeviceNetworkNewResponseEnvelopeMessages `json:"messages,required"`
	Result   TeamsDevicesDeviceManagedNetworks          `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success DeviceNetworkNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    deviceNetworkNewResponseEnvelopeJSON    `json:"-"`
}

func (*DeviceNetworkNewResponseEnvelope) UnmarshalJSON 

func (r *DeviceNetworkNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DeviceNetworkNewResponseEnvelopeErrors 

type DeviceNetworkNewResponseEnvelopeErrors struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    deviceNetworkNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DeviceNetworkNewResponseEnvelopeErrors) UnmarshalJSON 

func (r *DeviceNetworkNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DeviceNetworkNewResponseEnvelopeMessages 

type DeviceNetworkNewResponseEnvelopeMessages struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    deviceNetworkNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DeviceNetworkNewResponseEnvelopeMessages) UnmarshalJSON 

func (r *DeviceNetworkNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DeviceNetworkNewResponseEnvelopeSuccess 

type DeviceNetworkNewResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DeviceNetworkNewResponseEnvelopeSuccessTrue DeviceNetworkNewResponseEnvelopeSuccess = true
)

type DeviceNetworkService 

type DeviceNetworkService struct {
	Options []option.RequestOption
}

DeviceNetworkService 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 NewDeviceNetworkService method instead.

func NewDeviceNetworkService 

func NewDeviceNetworkService(opts ...option.RequestOption) (r *DeviceNetworkService)

NewDeviceNetworkService 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 (*DeviceNetworkService) Delete 

func (r *DeviceNetworkService) Delete(ctx context.Context, networkID string, body DeviceNetworkDeleteParams, opts ...option.RequestOption) (res *[]TeamsDevicesDeviceManagedNetworks, err error)

Deletes a device managed network and fetches a list of the remaining device managed networks for an account.

func (*DeviceNetworkService) Get 

func (r *DeviceNetworkService) Get(ctx context.Context, networkID string, query DeviceNetworkGetParams, opts ...option.RequestOption) (res *TeamsDevicesDeviceManagedNetworks, err error)

Fetches details for a single managed network.

func (*DeviceNetworkService) List 

func (r *DeviceNetworkService) List(ctx context.Context, query DeviceNetworkListParams, opts ...option.RequestOption) (res *[]TeamsDevicesDeviceManagedNetworks, err error)

Fetches a list of managed networks for an account.

func (*DeviceNetworkService) New 

func (r *DeviceNetworkService) New(ctx context.Context, params DeviceNetworkNewParams, opts ...option.RequestOption) (res *TeamsDevicesDeviceManagedNetworks, err error)

Creates a new device managed network.

func (*DeviceNetworkService) Update 

func (r *DeviceNetworkService) Update(ctx context.Context, networkID string, params DeviceNetworkUpdateParams, opts ...option.RequestOption) (res *TeamsDevicesDeviceManagedNetworks, err error)

Updates a configured device managed network.

type DeviceNetworkUpdateParams 

type DeviceNetworkUpdateParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
	// The configuration object containing information for the WARP client to detect
	// the managed network.
	Config param.Field[DeviceNetworkUpdateParamsConfig] `json:"config"`
	// The name of the device managed network. This name must be unique.
	Name param.Field[string] `json:"name"`
	// The type of device managed network.
	Type param.Field[DeviceNetworkUpdateParamsType] `json:"type"`
}

func (DeviceNetworkUpdateParams) MarshalJSON 

func (r DeviceNetworkUpdateParams) MarshalJSON() (data []byte, err error)

type DeviceNetworkUpdateParamsConfig 

type DeviceNetworkUpdateParamsConfig struct {
	// A network address of the form "host:port" that the WARP client will use to
	// detect the presence of a TLS host.
	TLSSockaddr param.Field[string] `json:"tls_sockaddr,required"`
	// The SHA-256 hash of the TLS certificate presented by the host found at
	// tls_sockaddr. If absent, regular certificate verification (trusted roots, valid
	// timestamp, etc) will be used to validate the certificate.
	Sha256 param.Field[string] `json:"sha256"`
}

The configuration object containing information for the WARP client to detect the managed network.

func (DeviceNetworkUpdateParamsConfig) MarshalJSON 

func (r DeviceNetworkUpdateParamsConfig) MarshalJSON() (data []byte, err error)

type DeviceNetworkUpdateParamsType 

type DeviceNetworkUpdateParamsType string

The type of device managed network. 

const (
	DeviceNetworkUpdateParamsTypeTLS DeviceNetworkUpdateParamsType = "tls"
)

type DeviceNetworkUpdateResponseEnvelope 

type DeviceNetworkUpdateResponseEnvelope struct {
	Errors   []DeviceNetworkUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DeviceNetworkUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   TeamsDevicesDeviceManagedNetworks             `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success DeviceNetworkUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    deviceNetworkUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*DeviceNetworkUpdateResponseEnvelope) UnmarshalJSON 

func (r *DeviceNetworkUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DeviceNetworkUpdateResponseEnvelopeErrors 

type DeviceNetworkUpdateResponseEnvelopeErrors struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    deviceNetworkUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DeviceNetworkUpdateResponseEnvelopeErrors) UnmarshalJSON 

func (r *DeviceNetworkUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DeviceNetworkUpdateResponseEnvelopeMessages 

type DeviceNetworkUpdateResponseEnvelopeMessages struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    deviceNetworkUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DeviceNetworkUpdateResponseEnvelopeMessages) UnmarshalJSON 

func (r *DeviceNetworkUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DeviceNetworkUpdateResponseEnvelopeSuccess 

type DeviceNetworkUpdateResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DeviceNetworkUpdateResponseEnvelopeSuccessTrue DeviceNetworkUpdateResponseEnvelopeSuccess = true
)

type DeviceOverrideCodeListParams 

type DeviceOverrideCodeListParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type DeviceOverrideCodeListResponse 

type DeviceOverrideCodeListResponse struct {
	DisableForTime DeviceOverrideCodeListResponseDisableForTime `json:"disable_for_time"`
	JSON           deviceOverrideCodeListResponseJSON           `json:"-"`
}

func (*DeviceOverrideCodeListResponse) UnmarshalJSON 

func (r *DeviceOverrideCodeListResponse) UnmarshalJSON(data []byte) (err error)

type DeviceOverrideCodeListResponseDisableForTime 

type DeviceOverrideCodeListResponseDisableForTime struct {
	// Override code that is valid for 1 hour.
	Number1 interface{} `json:"1"`
	// Override code that is valid for 12 hour2.
	Number12 interface{} `json:"12"`
	// Override code that is valid for 24 hour.2.
	Number24 interface{} `json:"24"`
	// Override code that is valid for 3 hours.
	Number3 interface{} `json:"3"`
	// Override code that is valid for 6 hours.
	Number6 interface{}                                      `json:"6"`
	JSON    deviceOverrideCodeListResponseDisableForTimeJSON `json:"-"`
}

func (*DeviceOverrideCodeListResponseDisableForTime) UnmarshalJSON 

func (r *DeviceOverrideCodeListResponseDisableForTime) UnmarshalJSON(data []byte) (err error)

type DeviceOverrideCodeListResponseEnvelope 

type DeviceOverrideCodeListResponseEnvelope struct {
	Errors   []DeviceOverrideCodeListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DeviceOverrideCodeListResponseEnvelopeMessages `json:"messages,required"`
	Result   DeviceOverrideCodeListResponse                   `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success    DeviceOverrideCodeListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo DeviceOverrideCodeListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       deviceOverrideCodeListResponseEnvelopeJSON       `json:"-"`
}

func (*DeviceOverrideCodeListResponseEnvelope) UnmarshalJSON 

func (r *DeviceOverrideCodeListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DeviceOverrideCodeListResponseEnvelopeErrors 

type DeviceOverrideCodeListResponseEnvelopeErrors struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    deviceOverrideCodeListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DeviceOverrideCodeListResponseEnvelopeErrors) UnmarshalJSON 

func (r *DeviceOverrideCodeListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DeviceOverrideCodeListResponseEnvelopeMessages 

type DeviceOverrideCodeListResponseEnvelopeMessages struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    deviceOverrideCodeListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DeviceOverrideCodeListResponseEnvelopeMessages) UnmarshalJSON 

func (r *DeviceOverrideCodeListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DeviceOverrideCodeListResponseEnvelopeResultInfo 

type DeviceOverrideCodeListResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                              `json:"total_count"`
	JSON       deviceOverrideCodeListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*DeviceOverrideCodeListResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *DeviceOverrideCodeListResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type DeviceOverrideCodeListResponseEnvelopeSuccess 

type DeviceOverrideCodeListResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DeviceOverrideCodeListResponseEnvelopeSuccessTrue DeviceOverrideCodeListResponseEnvelopeSuccess = true
)

type DeviceOverrideCodeService 

type DeviceOverrideCodeService struct {
	Options []option.RequestOption
}

DeviceOverrideCodeService 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 NewDeviceOverrideCodeService method instead.

func NewDeviceOverrideCodeService 

func NewDeviceOverrideCodeService(opts ...option.RequestOption) (r *DeviceOverrideCodeService)

NewDeviceOverrideCodeService 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 (*DeviceOverrideCodeService) List 

func (r *DeviceOverrideCodeService) List(ctx context.Context, deviceID string, query DeviceOverrideCodeListParams, opts ...option.RequestOption) (res *DeviceOverrideCodeListResponse, err error)

Fetches a one-time use admin override code for a device. This relies on the **Admin Override** setting being enabled in your device configuration.

type DevicePolicyDefaultPolicyGetParams 

type DevicePolicyDefaultPolicyGetParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type DevicePolicyDefaultPolicyGetResponse 

type DevicePolicyDefaultPolicyGetResponse = interface{}

type DevicePolicyDefaultPolicyGetResponseEnvelope 

type DevicePolicyDefaultPolicyGetResponseEnvelope struct {
	Errors   []DevicePolicyDefaultPolicyGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DevicePolicyDefaultPolicyGetResponseEnvelopeMessages `json:"messages,required"`
	Result   []DevicePolicyDefaultPolicyGetResponse                 `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success    DevicePolicyDefaultPolicyGetResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo DevicePolicyDefaultPolicyGetResponseEnvelopeResultInfo `json:"result_info"`
	JSON       devicePolicyDefaultPolicyGetResponseEnvelopeJSON       `json:"-"`
}

func (*DevicePolicyDefaultPolicyGetResponseEnvelope) UnmarshalJSON 

func (r *DevicePolicyDefaultPolicyGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DevicePolicyDefaultPolicyGetResponseEnvelopeErrors 

type DevicePolicyDefaultPolicyGetResponseEnvelopeErrors struct {
	Code    int64                                                  `json:"code,required"`
	Message string                                                 `json:"message,required"`
	JSON    devicePolicyDefaultPolicyGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DevicePolicyDefaultPolicyGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *DevicePolicyDefaultPolicyGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DevicePolicyDefaultPolicyGetResponseEnvelopeMessages 

type DevicePolicyDefaultPolicyGetResponseEnvelopeMessages struct {
	Code    int64                                                    `json:"code,required"`
	Message string                                                   `json:"message,required"`
	JSON    devicePolicyDefaultPolicyGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DevicePolicyDefaultPolicyGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *DevicePolicyDefaultPolicyGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DevicePolicyDefaultPolicyGetResponseEnvelopeResultInfo 

type DevicePolicyDefaultPolicyGetResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                                    `json:"total_count"`
	JSON       devicePolicyDefaultPolicyGetResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*DevicePolicyDefaultPolicyGetResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *DevicePolicyDefaultPolicyGetResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type DevicePolicyDefaultPolicyGetResponseEnvelopeSuccess 

type DevicePolicyDefaultPolicyGetResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DevicePolicyDefaultPolicyGetResponseEnvelopeSuccessTrue DevicePolicyDefaultPolicyGetResponseEnvelopeSuccess = true
)

type DevicePolicyDefaultPolicyService 

type DevicePolicyDefaultPolicyService struct {
	Options []option.RequestOption
}

DevicePolicyDefaultPolicyService 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 NewDevicePolicyDefaultPolicyService method instead.

func NewDevicePolicyDefaultPolicyService 

func NewDevicePolicyDefaultPolicyService(opts ...option.RequestOption) (r *DevicePolicyDefaultPolicyService)

NewDevicePolicyDefaultPolicyService 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 (*DevicePolicyDefaultPolicyService) Get 

func (r *DevicePolicyDefaultPolicyService) Get(ctx context.Context, query DevicePolicyDefaultPolicyGetParams, opts ...option.RequestOption) (res *[]DevicePolicyDefaultPolicyGetResponse, err error)

Fetches the default device settings profile for an account.

type DevicePolicyDeleteParams 

type DevicePolicyDeleteParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type DevicePolicyDeleteResponseEnvelope 

type DevicePolicyDeleteResponseEnvelope struct {
	Errors   []DevicePolicyDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DevicePolicyDeleteResponseEnvelopeMessages `json:"messages,required"`
	Result   []TeamsDevicesDeviceSettingsPolicy           `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success    DevicePolicyDeleteResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo DevicePolicyDeleteResponseEnvelopeResultInfo `json:"result_info"`
	JSON       devicePolicyDeleteResponseEnvelopeJSON       `json:"-"`
}

func (*DevicePolicyDeleteResponseEnvelope) UnmarshalJSON 

func (r *DevicePolicyDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DevicePolicyDeleteResponseEnvelopeErrors 

type DevicePolicyDeleteResponseEnvelopeErrors struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    devicePolicyDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DevicePolicyDeleteResponseEnvelopeErrors) UnmarshalJSON 

func (r *DevicePolicyDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DevicePolicyDeleteResponseEnvelopeMessages 

type DevicePolicyDeleteResponseEnvelopeMessages struct {
	Code    int64                                          `json:"code,required"`
	Message string                                         `json:"message,required"`
	JSON    devicePolicyDeleteResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DevicePolicyDeleteResponseEnvelopeMessages) UnmarshalJSON 

func (r *DevicePolicyDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DevicePolicyDeleteResponseEnvelopeResultInfo 

type DevicePolicyDeleteResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                          `json:"total_count"`
	JSON       devicePolicyDeleteResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*DevicePolicyDeleteResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *DevicePolicyDeleteResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type DevicePolicyDeleteResponseEnvelopeSuccess 

type DevicePolicyDeleteResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DevicePolicyDeleteResponseEnvelopeSuccessTrue DevicePolicyDeleteResponseEnvelopeSuccess = true
)

type DevicePolicyEditParams 

type DevicePolicyEditParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
	// Whether to allow the user to switch WARP between modes.
	AllowModeSwitch param.Field[bool] `json:"allow_mode_switch"`
	// Whether to receive update notifications when a new version of the client is
	// available.
	AllowUpdates param.Field[bool] `json:"allow_updates"`
	// Whether to allow devices to leave the organization.
	AllowedToLeave param.Field[bool] `json:"allowed_to_leave"`
	// The amount of time in minutes to reconnect after having been disabled.
	AutoConnect param.Field[float64] `json:"auto_connect"`
	// Turn on the captive portal after the specified amount of time.
	CaptivePortal param.Field[float64] `json:"captive_portal"`
	// A description of the policy.
	Description param.Field[string] `json:"description"`
	// If the `dns_server` field of a fallback domain is not present, the client will
	// fall back to a best guess of the default/system DNS resolvers unless this policy
	// option is set to `true`.
	DisableAutoFallback param.Field[bool] `json:"disable_auto_fallback"`
	// Whether the policy will be applied to matching devices.
	Enabled param.Field[bool] `json:"enabled"`
	// Whether to add Microsoft IPs to Split Tunnel exclusions.
	ExcludeOfficeIPs param.Field[bool] `json:"exclude_office_ips"`
	// The wirefilter expression to match devices.
	Match param.Field[string] `json:"match"`
	// The name of the device settings profile.
	Name param.Field[string] `json:"name"`
	// The precedence of the policy. Lower values indicate higher precedence. Policies
	// will be evaluated in ascending order of this field.
	Precedence    param.Field[float64]                             `json:"precedence"`
	ServiceModeV2 param.Field[DevicePolicyEditParamsServiceModeV2] `json:"service_mode_v2"`
	// The URL to launch when the Send Feedback button is clicked.
	SupportURL param.Field[string] `json:"support_url"`
	// Whether to allow the user to turn off the WARP switch and disconnect the client.
	SwitchLocked param.Field[bool] `json:"switch_locked"`
}

func (DevicePolicyEditParams) MarshalJSON 

func (r DevicePolicyEditParams) MarshalJSON() (data []byte, err error)

type DevicePolicyEditParamsServiceModeV2 

type DevicePolicyEditParamsServiceModeV2 struct {
	// The mode to run the WARP client under.
	Mode param.Field[string] `json:"mode"`
	// The port number when used with proxy mode.
	Port param.Field[float64] `json:"port"`
}

func (DevicePolicyEditParamsServiceModeV2) MarshalJSON 

func (r DevicePolicyEditParamsServiceModeV2) MarshalJSON() (data []byte, err error)

type DevicePolicyEditResponse 

type DevicePolicyEditResponse = interface{}

type DevicePolicyEditResponseEnvelope 

type DevicePolicyEditResponseEnvelope struct {
	Errors   []DevicePolicyEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DevicePolicyEditResponseEnvelopeMessages `json:"messages,required"`
	Result   TeamsDevicesDeviceSettingsPolicy           `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success    DevicePolicyEditResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo DevicePolicyEditResponseEnvelopeResultInfo `json:"result_info"`
	JSON       devicePolicyEditResponseEnvelopeJSON       `json:"-"`
}

func (*DevicePolicyEditResponseEnvelope) UnmarshalJSON 

func (r *DevicePolicyEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DevicePolicyEditResponseEnvelopeErrors 

type DevicePolicyEditResponseEnvelopeErrors struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    devicePolicyEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DevicePolicyEditResponseEnvelopeErrors) UnmarshalJSON 

func (r *DevicePolicyEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DevicePolicyEditResponseEnvelopeMessages 

type DevicePolicyEditResponseEnvelopeMessages struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    devicePolicyEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DevicePolicyEditResponseEnvelopeMessages) UnmarshalJSON 

func (r *DevicePolicyEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DevicePolicyEditResponseEnvelopeResultInfo 

type DevicePolicyEditResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                        `json:"total_count"`
	JSON       devicePolicyEditResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*DevicePolicyEditResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *DevicePolicyEditResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type DevicePolicyEditResponseEnvelopeSuccess 

type DevicePolicyEditResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DevicePolicyEditResponseEnvelopeSuccessTrue DevicePolicyEditResponseEnvelopeSuccess = true
)

type DevicePolicyExcludeGetParams 

type DevicePolicyExcludeGetParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type DevicePolicyExcludeGetResponseEnvelope 

type DevicePolicyExcludeGetResponseEnvelope struct {
	Errors   []DevicePolicyExcludeGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DevicePolicyExcludeGetResponseEnvelopeMessages `json:"messages,required"`
	Result   []TeamsDevicesSplitTunnel                        `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success    DevicePolicyExcludeGetResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo DevicePolicyExcludeGetResponseEnvelopeResultInfo `json:"result_info"`
	JSON       devicePolicyExcludeGetResponseEnvelopeJSON       `json:"-"`
}

func (*DevicePolicyExcludeGetResponseEnvelope) UnmarshalJSON 

func (r *DevicePolicyExcludeGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DevicePolicyExcludeGetResponseEnvelopeErrors 

type DevicePolicyExcludeGetResponseEnvelopeErrors struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    devicePolicyExcludeGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DevicePolicyExcludeGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *DevicePolicyExcludeGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DevicePolicyExcludeGetResponseEnvelopeMessages 

type DevicePolicyExcludeGetResponseEnvelopeMessages struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    devicePolicyExcludeGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DevicePolicyExcludeGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *DevicePolicyExcludeGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DevicePolicyExcludeGetResponseEnvelopeResultInfo 

type DevicePolicyExcludeGetResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                              `json:"total_count"`
	JSON       devicePolicyExcludeGetResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*DevicePolicyExcludeGetResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *DevicePolicyExcludeGetResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type DevicePolicyExcludeGetResponseEnvelopeSuccess 

type DevicePolicyExcludeGetResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DevicePolicyExcludeGetResponseEnvelopeSuccessTrue DevicePolicyExcludeGetResponseEnvelopeSuccess = true
)

type DevicePolicyExcludeListParams 

type DevicePolicyExcludeListParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type DevicePolicyExcludeListResponseEnvelope 

type DevicePolicyExcludeListResponseEnvelope struct {
	Errors   []DevicePolicyExcludeListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DevicePolicyExcludeListResponseEnvelopeMessages `json:"messages,required"`
	Result   []TeamsDevicesSplitTunnel                         `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success    DevicePolicyExcludeListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo DevicePolicyExcludeListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       devicePolicyExcludeListResponseEnvelopeJSON       `json:"-"`
}

func (*DevicePolicyExcludeListResponseEnvelope) UnmarshalJSON 

func (r *DevicePolicyExcludeListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DevicePolicyExcludeListResponseEnvelopeErrors 

type DevicePolicyExcludeListResponseEnvelopeErrors struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    devicePolicyExcludeListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DevicePolicyExcludeListResponseEnvelopeErrors) UnmarshalJSON 

func (r *DevicePolicyExcludeListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DevicePolicyExcludeListResponseEnvelopeMessages 

type DevicePolicyExcludeListResponseEnvelopeMessages struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    devicePolicyExcludeListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DevicePolicyExcludeListResponseEnvelopeMessages) UnmarshalJSON 

func (r *DevicePolicyExcludeListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DevicePolicyExcludeListResponseEnvelopeResultInfo 

type DevicePolicyExcludeListResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                               `json:"total_count"`
	JSON       devicePolicyExcludeListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*DevicePolicyExcludeListResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *DevicePolicyExcludeListResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type DevicePolicyExcludeListResponseEnvelopeSuccess 

type DevicePolicyExcludeListResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DevicePolicyExcludeListResponseEnvelopeSuccessTrue DevicePolicyExcludeListResponseEnvelopeSuccess = true
)

type DevicePolicyExcludeService 

type DevicePolicyExcludeService struct {
	Options []option.RequestOption
}

DevicePolicyExcludeService 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 NewDevicePolicyExcludeService method instead.

func NewDevicePolicyExcludeService 

func NewDevicePolicyExcludeService(opts ...option.RequestOption) (r *DevicePolicyExcludeService)

NewDevicePolicyExcludeService 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 (*DevicePolicyExcludeService) Get 

func (r *DevicePolicyExcludeService) Get(ctx context.Context, policyID string, query DevicePolicyExcludeGetParams, opts ...option.RequestOption) (res *[]TeamsDevicesSplitTunnel, err error)

Fetches the list of routes excluded from the WARP client's tunnel for a specific device settings profile.

func (*DevicePolicyExcludeService) List 

func (r *DevicePolicyExcludeService) List(ctx context.Context, query DevicePolicyExcludeListParams, opts ...option.RequestOption) (res *[]TeamsDevicesSplitTunnel, err error)

Fetches the list of routes excluded from the WARP client's tunnel.

func (*DevicePolicyExcludeService) Update 

func (r *DevicePolicyExcludeService) Update(ctx context.Context, params DevicePolicyExcludeUpdateParams, opts ...option.RequestOption) (res *[]TeamsDevicesSplitTunnel, err error)

Sets the list of routes excluded from the WARP client's tunnel.

type DevicePolicyExcludeUpdateParams 

type DevicePolicyExcludeUpdateParams struct {
	AccountID param.Field[interface{}]                    `path:"account_id,required"`
	Body      param.Field[[]TeamsDevicesSplitTunnelParam] `json:"body,required"`
}

func (DevicePolicyExcludeUpdateParams) MarshalJSON 

func (r DevicePolicyExcludeUpdateParams) MarshalJSON() (data []byte, err error)

type DevicePolicyExcludeUpdateResponseEnvelope 

type DevicePolicyExcludeUpdateResponseEnvelope struct {
	Errors   []DevicePolicyExcludeUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DevicePolicyExcludeUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   []TeamsDevicesSplitTunnel                           `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success    DevicePolicyExcludeUpdateResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo DevicePolicyExcludeUpdateResponseEnvelopeResultInfo `json:"result_info"`
	JSON       devicePolicyExcludeUpdateResponseEnvelopeJSON       `json:"-"`
}

func (*DevicePolicyExcludeUpdateResponseEnvelope) UnmarshalJSON 

func (r *DevicePolicyExcludeUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DevicePolicyExcludeUpdateResponseEnvelopeErrors 

type DevicePolicyExcludeUpdateResponseEnvelopeErrors struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    devicePolicyExcludeUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DevicePolicyExcludeUpdateResponseEnvelopeErrors) UnmarshalJSON 

func (r *DevicePolicyExcludeUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DevicePolicyExcludeUpdateResponseEnvelopeMessages 

type DevicePolicyExcludeUpdateResponseEnvelopeMessages struct {
	Code    int64                                                 `json:"code,required"`
	Message string                                                `json:"message,required"`
	JSON    devicePolicyExcludeUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DevicePolicyExcludeUpdateResponseEnvelopeMessages) UnmarshalJSON 

func (r *DevicePolicyExcludeUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DevicePolicyExcludeUpdateResponseEnvelopeResultInfo 

type DevicePolicyExcludeUpdateResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                                 `json:"total_count"`
	JSON       devicePolicyExcludeUpdateResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*DevicePolicyExcludeUpdateResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *DevicePolicyExcludeUpdateResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type DevicePolicyExcludeUpdateResponseEnvelopeSuccess 

type DevicePolicyExcludeUpdateResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DevicePolicyExcludeUpdateResponseEnvelopeSuccessTrue DevicePolicyExcludeUpdateResponseEnvelopeSuccess = true
)

type DevicePolicyFallbackDomainGetParams 

type DevicePolicyFallbackDomainGetParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type DevicePolicyFallbackDomainGetResponseEnvelope 

type DevicePolicyFallbackDomainGetResponseEnvelope struct {
	Errors   []DevicePolicyFallbackDomainGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DevicePolicyFallbackDomainGetResponseEnvelopeMessages `json:"messages,required"`
	Result   []TeamsDevicesFallbackDomain                            `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success    DevicePolicyFallbackDomainGetResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo DevicePolicyFallbackDomainGetResponseEnvelopeResultInfo `json:"result_info"`
	JSON       devicePolicyFallbackDomainGetResponseEnvelopeJSON       `json:"-"`
}

func (*DevicePolicyFallbackDomainGetResponseEnvelope) UnmarshalJSON 

func (r *DevicePolicyFallbackDomainGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DevicePolicyFallbackDomainGetResponseEnvelopeErrors 

type DevicePolicyFallbackDomainGetResponseEnvelopeErrors struct {
	Code    int64                                                   `json:"code,required"`
	Message string                                                  `json:"message,required"`
	JSON    devicePolicyFallbackDomainGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DevicePolicyFallbackDomainGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *DevicePolicyFallbackDomainGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DevicePolicyFallbackDomainGetResponseEnvelopeMessages 

type DevicePolicyFallbackDomainGetResponseEnvelopeMessages struct {
	Code    int64                                                     `json:"code,required"`
	Message string                                                    `json:"message,required"`
	JSON    devicePolicyFallbackDomainGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DevicePolicyFallbackDomainGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *DevicePolicyFallbackDomainGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DevicePolicyFallbackDomainGetResponseEnvelopeResultInfo 

type DevicePolicyFallbackDomainGetResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                                     `json:"total_count"`
	JSON       devicePolicyFallbackDomainGetResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*DevicePolicyFallbackDomainGetResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *DevicePolicyFallbackDomainGetResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type DevicePolicyFallbackDomainGetResponseEnvelopeSuccess 

type DevicePolicyFallbackDomainGetResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DevicePolicyFallbackDomainGetResponseEnvelopeSuccessTrue DevicePolicyFallbackDomainGetResponseEnvelopeSuccess = true
)

type DevicePolicyFallbackDomainListParams 

type DevicePolicyFallbackDomainListParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type DevicePolicyFallbackDomainListResponseEnvelope 

type DevicePolicyFallbackDomainListResponseEnvelope struct {
	Errors   []DevicePolicyFallbackDomainListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DevicePolicyFallbackDomainListResponseEnvelopeMessages `json:"messages,required"`
	Result   []TeamsDevicesFallbackDomain                             `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success    DevicePolicyFallbackDomainListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo DevicePolicyFallbackDomainListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       devicePolicyFallbackDomainListResponseEnvelopeJSON       `json:"-"`
}

func (*DevicePolicyFallbackDomainListResponseEnvelope) UnmarshalJSON 

func (r *DevicePolicyFallbackDomainListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DevicePolicyFallbackDomainListResponseEnvelopeErrors 

type DevicePolicyFallbackDomainListResponseEnvelopeErrors struct {
	Code    int64                                                    `json:"code,required"`
	Message string                                                   `json:"message,required"`
	JSON    devicePolicyFallbackDomainListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DevicePolicyFallbackDomainListResponseEnvelopeErrors) UnmarshalJSON 

func (r *DevicePolicyFallbackDomainListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DevicePolicyFallbackDomainListResponseEnvelopeMessages 

type DevicePolicyFallbackDomainListResponseEnvelopeMessages struct {
	Code    int64                                                      `json:"code,required"`
	Message string                                                     `json:"message,required"`
	JSON    devicePolicyFallbackDomainListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DevicePolicyFallbackDomainListResponseEnvelopeMessages) UnmarshalJSON 

func (r *DevicePolicyFallbackDomainListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DevicePolicyFallbackDomainListResponseEnvelopeResultInfo 

type DevicePolicyFallbackDomainListResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                                      `json:"total_count"`
	JSON       devicePolicyFallbackDomainListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*DevicePolicyFallbackDomainListResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *DevicePolicyFallbackDomainListResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type DevicePolicyFallbackDomainListResponseEnvelopeSuccess 

type DevicePolicyFallbackDomainListResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DevicePolicyFallbackDomainListResponseEnvelopeSuccessTrue DevicePolicyFallbackDomainListResponseEnvelopeSuccess = true
)

type DevicePolicyFallbackDomainService 

type DevicePolicyFallbackDomainService struct {
	Options []option.RequestOption
}

DevicePolicyFallbackDomainService 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 NewDevicePolicyFallbackDomainService method instead.

func NewDevicePolicyFallbackDomainService 

func NewDevicePolicyFallbackDomainService(opts ...option.RequestOption) (r *DevicePolicyFallbackDomainService)

NewDevicePolicyFallbackDomainService 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 (*DevicePolicyFallbackDomainService) Get 

func (r *DevicePolicyFallbackDomainService) Get(ctx context.Context, policyID string, query DevicePolicyFallbackDomainGetParams, opts ...option.RequestOption) (res *[]TeamsDevicesFallbackDomain, err error)

Fetches the list of domains to bypass Gateway DNS resolution from a specified device settings profile. These domains will use the specified local DNS resolver instead.

func (*DevicePolicyFallbackDomainService) List 

func (r *DevicePolicyFallbackDomainService) List(ctx context.Context, query DevicePolicyFallbackDomainListParams, opts ...option.RequestOption) (res *[]TeamsDevicesFallbackDomain, err error)

Fetches a list of domains to bypass Gateway DNS resolution. These domains will use the specified local DNS resolver instead.

func (*DevicePolicyFallbackDomainService) Update 

func (r *DevicePolicyFallbackDomainService) Update(ctx context.Context, policyID string, params DevicePolicyFallbackDomainUpdateParams, opts ...option.RequestOption) (res *[]TeamsDevicesFallbackDomain, err error)

Sets the list of domains to bypass Gateway DNS resolution. These domains will use the specified local DNS resolver instead. This will only apply to the specified device settings profile.

type DevicePolicyFallbackDomainUpdateParams 

type DevicePolicyFallbackDomainUpdateParams struct {
	AccountID param.Field[interface{}]                       `path:"account_id,required"`
	Body      param.Field[[]TeamsDevicesFallbackDomainParam] `json:"body,required"`
}

func (DevicePolicyFallbackDomainUpdateParams) MarshalJSON 

func (r DevicePolicyFallbackDomainUpdateParams) MarshalJSON() (data []byte, err error)

type DevicePolicyFallbackDomainUpdateResponseEnvelope 

type DevicePolicyFallbackDomainUpdateResponseEnvelope struct {
	Errors   []DevicePolicyFallbackDomainUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DevicePolicyFallbackDomainUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   []TeamsDevicesFallbackDomain                               `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success    DevicePolicyFallbackDomainUpdateResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo DevicePolicyFallbackDomainUpdateResponseEnvelopeResultInfo `json:"result_info"`
	JSON       devicePolicyFallbackDomainUpdateResponseEnvelopeJSON       `json:"-"`
}

func (*DevicePolicyFallbackDomainUpdateResponseEnvelope) UnmarshalJSON 

func (r *DevicePolicyFallbackDomainUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DevicePolicyFallbackDomainUpdateResponseEnvelopeErrors 

type DevicePolicyFallbackDomainUpdateResponseEnvelopeErrors struct {
	Code    int64                                                      `json:"code,required"`
	Message string                                                     `json:"message,required"`
	JSON    devicePolicyFallbackDomainUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DevicePolicyFallbackDomainUpdateResponseEnvelopeErrors) UnmarshalJSON 

func (r *DevicePolicyFallbackDomainUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DevicePolicyFallbackDomainUpdateResponseEnvelopeMessages 

type DevicePolicyFallbackDomainUpdateResponseEnvelopeMessages struct {
	Code    int64                                                        `json:"code,required"`
	Message string                                                       `json:"message,required"`
	JSON    devicePolicyFallbackDomainUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DevicePolicyFallbackDomainUpdateResponseEnvelopeMessages) UnmarshalJSON 

func (r *DevicePolicyFallbackDomainUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DevicePolicyFallbackDomainUpdateResponseEnvelopeResultInfo 

type DevicePolicyFallbackDomainUpdateResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                                        `json:"total_count"`
	JSON       devicePolicyFallbackDomainUpdateResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*DevicePolicyFallbackDomainUpdateResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *DevicePolicyFallbackDomainUpdateResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type DevicePolicyFallbackDomainUpdateResponseEnvelopeSuccess 

type DevicePolicyFallbackDomainUpdateResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DevicePolicyFallbackDomainUpdateResponseEnvelopeSuccessTrue DevicePolicyFallbackDomainUpdateResponseEnvelopeSuccess = true
)

type DevicePolicyGetParams 

type DevicePolicyGetParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type DevicePolicyGetResponse 

type DevicePolicyGetResponse = interface{}

type DevicePolicyGetResponseEnvelope 

type DevicePolicyGetResponseEnvelope struct {
	Errors   []DevicePolicyGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DevicePolicyGetResponseEnvelopeMessages `json:"messages,required"`
	Result   TeamsDevicesDeviceSettingsPolicy          `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success    DevicePolicyGetResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo DevicePolicyGetResponseEnvelopeResultInfo `json:"result_info"`
	JSON       devicePolicyGetResponseEnvelopeJSON       `json:"-"`
}

func (*DevicePolicyGetResponseEnvelope) UnmarshalJSON 

func (r *DevicePolicyGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DevicePolicyGetResponseEnvelopeErrors 

type DevicePolicyGetResponseEnvelopeErrors struct {
	Code    int64                                     `json:"code,required"`
	Message string                                    `json:"message,required"`
	JSON    devicePolicyGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DevicePolicyGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *DevicePolicyGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DevicePolicyGetResponseEnvelopeMessages 

type DevicePolicyGetResponseEnvelopeMessages struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    devicePolicyGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DevicePolicyGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *DevicePolicyGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DevicePolicyGetResponseEnvelopeResultInfo 

type DevicePolicyGetResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                       `json:"total_count"`
	JSON       devicePolicyGetResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*DevicePolicyGetResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *DevicePolicyGetResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type DevicePolicyGetResponseEnvelopeSuccess 

type DevicePolicyGetResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DevicePolicyGetResponseEnvelopeSuccessTrue DevicePolicyGetResponseEnvelopeSuccess = true
)

type DevicePolicyIncludeGetParams 

type DevicePolicyIncludeGetParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type DevicePolicyIncludeGetResponseEnvelope 

type DevicePolicyIncludeGetResponseEnvelope struct {
	Errors   []DevicePolicyIncludeGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DevicePolicyIncludeGetResponseEnvelopeMessages `json:"messages,required"`
	Result   []TeamsDevicesSplitTunnelInclude                 `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success    DevicePolicyIncludeGetResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo DevicePolicyIncludeGetResponseEnvelopeResultInfo `json:"result_info"`
	JSON       devicePolicyIncludeGetResponseEnvelopeJSON       `json:"-"`
}

func (*DevicePolicyIncludeGetResponseEnvelope) UnmarshalJSON 

func (r *DevicePolicyIncludeGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DevicePolicyIncludeGetResponseEnvelopeErrors 

type DevicePolicyIncludeGetResponseEnvelopeErrors struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    devicePolicyIncludeGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DevicePolicyIncludeGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *DevicePolicyIncludeGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DevicePolicyIncludeGetResponseEnvelopeMessages 

type DevicePolicyIncludeGetResponseEnvelopeMessages struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    devicePolicyIncludeGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DevicePolicyIncludeGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *DevicePolicyIncludeGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DevicePolicyIncludeGetResponseEnvelopeResultInfo 

type DevicePolicyIncludeGetResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                              `json:"total_count"`
	JSON       devicePolicyIncludeGetResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*DevicePolicyIncludeGetResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *DevicePolicyIncludeGetResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type DevicePolicyIncludeGetResponseEnvelopeSuccess 

type DevicePolicyIncludeGetResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DevicePolicyIncludeGetResponseEnvelopeSuccessTrue DevicePolicyIncludeGetResponseEnvelopeSuccess = true
)

type DevicePolicyIncludeListParams 

type DevicePolicyIncludeListParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type DevicePolicyIncludeListResponseEnvelope 

type DevicePolicyIncludeListResponseEnvelope struct {
	Errors   []DevicePolicyIncludeListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DevicePolicyIncludeListResponseEnvelopeMessages `json:"messages,required"`
	Result   []TeamsDevicesSplitTunnelInclude                  `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success    DevicePolicyIncludeListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo DevicePolicyIncludeListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       devicePolicyIncludeListResponseEnvelopeJSON       `json:"-"`
}

func (*DevicePolicyIncludeListResponseEnvelope) UnmarshalJSON 

func (r *DevicePolicyIncludeListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DevicePolicyIncludeListResponseEnvelopeErrors 

type DevicePolicyIncludeListResponseEnvelopeErrors struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    devicePolicyIncludeListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DevicePolicyIncludeListResponseEnvelopeErrors) UnmarshalJSON 

func (r *DevicePolicyIncludeListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DevicePolicyIncludeListResponseEnvelopeMessages 

type DevicePolicyIncludeListResponseEnvelopeMessages struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    devicePolicyIncludeListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DevicePolicyIncludeListResponseEnvelopeMessages) UnmarshalJSON 

func (r *DevicePolicyIncludeListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DevicePolicyIncludeListResponseEnvelopeResultInfo 

type DevicePolicyIncludeListResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                               `json:"total_count"`
	JSON       devicePolicyIncludeListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*DevicePolicyIncludeListResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *DevicePolicyIncludeListResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type DevicePolicyIncludeListResponseEnvelopeSuccess 

type DevicePolicyIncludeListResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DevicePolicyIncludeListResponseEnvelopeSuccessTrue DevicePolicyIncludeListResponseEnvelopeSuccess = true
)

type DevicePolicyIncludeService 

type DevicePolicyIncludeService struct {
	Options []option.RequestOption
}

DevicePolicyIncludeService 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 NewDevicePolicyIncludeService method instead.

func NewDevicePolicyIncludeService 

func NewDevicePolicyIncludeService(opts ...option.RequestOption) (r *DevicePolicyIncludeService)

NewDevicePolicyIncludeService 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 (*DevicePolicyIncludeService) Get 

func (r *DevicePolicyIncludeService) Get(ctx context.Context, policyID string, query DevicePolicyIncludeGetParams, opts ...option.RequestOption) (res *[]TeamsDevicesSplitTunnelInclude, err error)

Fetches the list of routes included in the WARP client's tunnel for a specific device settings profile.

func (*DevicePolicyIncludeService) List 

func (r *DevicePolicyIncludeService) List(ctx context.Context, query DevicePolicyIncludeListParams, opts ...option.RequestOption) (res *[]TeamsDevicesSplitTunnelInclude, err error)

Fetches the list of routes included in the WARP client's tunnel.

func (*DevicePolicyIncludeService) Update 

func (r *DevicePolicyIncludeService) Update(ctx context.Context, params DevicePolicyIncludeUpdateParams, opts ...option.RequestOption) (res *[]TeamsDevicesSplitTunnelInclude, err error)

Sets the list of routes included in the WARP client's tunnel.

type DevicePolicyIncludeUpdateParams 

type DevicePolicyIncludeUpdateParams struct {
	AccountID param.Field[interface{}]                           `path:"account_id,required"`
	Body      param.Field[[]TeamsDevicesSplitTunnelIncludeParam] `json:"body,required"`
}

func (DevicePolicyIncludeUpdateParams) MarshalJSON 

func (r DevicePolicyIncludeUpdateParams) MarshalJSON() (data []byte, err error)

type DevicePolicyIncludeUpdateResponseEnvelope 

type DevicePolicyIncludeUpdateResponseEnvelope struct {
	Errors   []DevicePolicyIncludeUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DevicePolicyIncludeUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   []TeamsDevicesSplitTunnelInclude                    `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success    DevicePolicyIncludeUpdateResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo DevicePolicyIncludeUpdateResponseEnvelopeResultInfo `json:"result_info"`
	JSON       devicePolicyIncludeUpdateResponseEnvelopeJSON       `json:"-"`
}

func (*DevicePolicyIncludeUpdateResponseEnvelope) UnmarshalJSON 

func (r *DevicePolicyIncludeUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DevicePolicyIncludeUpdateResponseEnvelopeErrors 

type DevicePolicyIncludeUpdateResponseEnvelopeErrors struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    devicePolicyIncludeUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DevicePolicyIncludeUpdateResponseEnvelopeErrors) UnmarshalJSON 

func (r *DevicePolicyIncludeUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DevicePolicyIncludeUpdateResponseEnvelopeMessages 

type DevicePolicyIncludeUpdateResponseEnvelopeMessages struct {
	Code    int64                                                 `json:"code,required"`
	Message string                                                `json:"message,required"`
	JSON    devicePolicyIncludeUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DevicePolicyIncludeUpdateResponseEnvelopeMessages) UnmarshalJSON 

func (r *DevicePolicyIncludeUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DevicePolicyIncludeUpdateResponseEnvelopeResultInfo 

type DevicePolicyIncludeUpdateResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                                 `json:"total_count"`
	JSON       devicePolicyIncludeUpdateResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*DevicePolicyIncludeUpdateResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *DevicePolicyIncludeUpdateResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type DevicePolicyIncludeUpdateResponseEnvelopeSuccess 

type DevicePolicyIncludeUpdateResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DevicePolicyIncludeUpdateResponseEnvelopeSuccessTrue DevicePolicyIncludeUpdateResponseEnvelopeSuccess = true
)

type DevicePolicyListParams 

type DevicePolicyListParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type DevicePolicyListResponseEnvelope 

type DevicePolicyListResponseEnvelope struct {
	Errors   []DevicePolicyListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DevicePolicyListResponseEnvelopeMessages `json:"messages,required"`
	Result   []TeamsDevicesDeviceSettingsPolicy         `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success    DevicePolicyListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo DevicePolicyListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       devicePolicyListResponseEnvelopeJSON       `json:"-"`
}

func (*DevicePolicyListResponseEnvelope) UnmarshalJSON 

func (r *DevicePolicyListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DevicePolicyListResponseEnvelopeErrors 

type DevicePolicyListResponseEnvelopeErrors struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    devicePolicyListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DevicePolicyListResponseEnvelopeErrors) UnmarshalJSON 

func (r *DevicePolicyListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DevicePolicyListResponseEnvelopeMessages 

type DevicePolicyListResponseEnvelopeMessages struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    devicePolicyListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DevicePolicyListResponseEnvelopeMessages) UnmarshalJSON 

func (r *DevicePolicyListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DevicePolicyListResponseEnvelopeResultInfo 

type DevicePolicyListResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                        `json:"total_count"`
	JSON       devicePolicyListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*DevicePolicyListResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *DevicePolicyListResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type DevicePolicyListResponseEnvelopeSuccess 

type DevicePolicyListResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DevicePolicyListResponseEnvelopeSuccessTrue DevicePolicyListResponseEnvelopeSuccess = true
)

type DevicePolicyNewParams 

type DevicePolicyNewParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
	// The wirefilter expression to match devices.
	Match param.Field[string] `json:"match,required"`
	// The name of the device settings profile.
	Name param.Field[string] `json:"name,required"`
	// The precedence of the policy. Lower values indicate higher precedence. Policies
	// will be evaluated in ascending order of this field.
	Precedence param.Field[float64] `json:"precedence,required"`
	// Whether to allow the user to switch WARP between modes.
	AllowModeSwitch param.Field[bool] `json:"allow_mode_switch"`
	// Whether to receive update notifications when a new version of the client is
	// available.
	AllowUpdates param.Field[bool] `json:"allow_updates"`
	// Whether to allow devices to leave the organization.
	AllowedToLeave param.Field[bool] `json:"allowed_to_leave"`
	// The amount of time in minutes to reconnect after having been disabled.
	AutoConnect param.Field[float64] `json:"auto_connect"`
	// Turn on the captive portal after the specified amount of time.
	CaptivePortal param.Field[float64] `json:"captive_portal"`
	// A description of the policy.
	Description param.Field[string] `json:"description"`
	// If the `dns_server` field of a fallback domain is not present, the client will
	// fall back to a best guess of the default/system DNS resolvers unless this policy
	// option is set to `true`.
	DisableAutoFallback param.Field[bool] `json:"disable_auto_fallback"`
	// Whether the policy will be applied to matching devices.
	Enabled param.Field[bool] `json:"enabled"`
	// Whether to add Microsoft IPs to Split Tunnel exclusions.
	ExcludeOfficeIPs param.Field[bool] `json:"exclude_office_ips"`
	// The amount of time in minutes a user is allowed access to their LAN. A value of
	// 0 will allow LAN access until the next WARP reconnection, such as a reboot or a
	// laptop waking from sleep. Note that this field is omitted from the response if
	// null or unset.
	LanAllowMinutes param.Field[float64] `json:"lan_allow_minutes"`
	// The size of the subnet for the local access network. Note that this field is
	// omitted from the response if null or unset.
	LanAllowSubnetSize param.Field[float64]                            `json:"lan_allow_subnet_size"`
	ServiceModeV2      param.Field[DevicePolicyNewParamsServiceModeV2] `json:"service_mode_v2"`
	// The URL to launch when the Send Feedback button is clicked.
	SupportURL param.Field[string] `json:"support_url"`
	// Whether to allow the user to turn off the WARP switch and disconnect the client.
	SwitchLocked param.Field[bool] `json:"switch_locked"`
}

func (DevicePolicyNewParams) MarshalJSON 

func (r DevicePolicyNewParams) MarshalJSON() (data []byte, err error)

type DevicePolicyNewParamsServiceModeV2 

type DevicePolicyNewParamsServiceModeV2 struct {
	// The mode to run the WARP client under.
	Mode param.Field[string] `json:"mode"`
	// The port number when used with proxy mode.
	Port param.Field[float64] `json:"port"`
}

func (DevicePolicyNewParamsServiceModeV2) MarshalJSON 

func (r DevicePolicyNewParamsServiceModeV2) MarshalJSON() (data []byte, err error)

type DevicePolicyNewResponse 

type DevicePolicyNewResponse = interface{}

type DevicePolicyNewResponseEnvelope 

type DevicePolicyNewResponseEnvelope struct {
	Errors   []DevicePolicyNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DevicePolicyNewResponseEnvelopeMessages `json:"messages,required"`
	Result   TeamsDevicesDeviceSettingsPolicy          `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success    DevicePolicyNewResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo DevicePolicyNewResponseEnvelopeResultInfo `json:"result_info"`
	JSON       devicePolicyNewResponseEnvelopeJSON       `json:"-"`
}

func (*DevicePolicyNewResponseEnvelope) UnmarshalJSON 

func (r *DevicePolicyNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DevicePolicyNewResponseEnvelopeErrors 

type DevicePolicyNewResponseEnvelopeErrors struct {
	Code    int64                                     `json:"code,required"`
	Message string                                    `json:"message,required"`
	JSON    devicePolicyNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DevicePolicyNewResponseEnvelopeErrors) UnmarshalJSON 

func (r *DevicePolicyNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DevicePolicyNewResponseEnvelopeMessages 

type DevicePolicyNewResponseEnvelopeMessages struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    devicePolicyNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DevicePolicyNewResponseEnvelopeMessages) UnmarshalJSON 

func (r *DevicePolicyNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DevicePolicyNewResponseEnvelopeResultInfo 

type DevicePolicyNewResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                       `json:"total_count"`
	JSON       devicePolicyNewResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*DevicePolicyNewResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *DevicePolicyNewResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type DevicePolicyNewResponseEnvelopeSuccess 

type DevicePolicyNewResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DevicePolicyNewResponseEnvelopeSuccessTrue DevicePolicyNewResponseEnvelopeSuccess = true
)

type DevicePolicyService 

type DevicePolicyService struct {
	Options         []option.RequestOption
	DefaultPolicy   *DevicePolicyDefaultPolicyService
	Excludes        *DevicePolicyExcludeService
	FallbackDomains *DevicePolicyFallbackDomainService
	Includes        *DevicePolicyIncludeService
}

DevicePolicyService 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 NewDevicePolicyService method instead.

func NewDevicePolicyService 

func NewDevicePolicyService(opts ...option.RequestOption) (r *DevicePolicyService)

NewDevicePolicyService 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 (*DevicePolicyService) Delete 

func (r *DevicePolicyService) Delete(ctx context.Context, policyID string, body DevicePolicyDeleteParams, opts ...option.RequestOption) (res *[]TeamsDevicesDeviceSettingsPolicy, err error)

Deletes a device settings profile and fetches a list of the remaining profiles for an account.

func (*DevicePolicyService) Edit 

func (r *DevicePolicyService) Edit(ctx context.Context, policyID string, params DevicePolicyEditParams, opts ...option.RequestOption) (res *TeamsDevicesDeviceSettingsPolicy, err error)

Updates a configured device settings profile.

func (*DevicePolicyService) Get 

func (r *DevicePolicyService) Get(ctx context.Context, policyID string, query DevicePolicyGetParams, opts ...option.RequestOption) (res *TeamsDevicesDeviceSettingsPolicy, err error)

Fetches a device settings profile by ID.

func (*DevicePolicyService) List 

func (r *DevicePolicyService) List(ctx context.Context, query DevicePolicyListParams, opts ...option.RequestOption) (res *[]TeamsDevicesDeviceSettingsPolicy, err error)

Fetches a list of the device settings profiles for an account.

func (*DevicePolicyService) New 

func (r *DevicePolicyService) New(ctx context.Context, params DevicePolicyNewParams, opts ...option.RequestOption) (res *TeamsDevicesDeviceSettingsPolicy, err error)

Creates a device settings profile to be applied to certain devices matching the criteria.

type DevicePostureDeleteParams 

type DevicePostureDeleteParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type DevicePostureDeleteResponse 

type DevicePostureDeleteResponse struct {
	// API UUID.
	ID   string                          `json:"id"`
	JSON devicePostureDeleteResponseJSON `json:"-"`
}

func (*DevicePostureDeleteResponse) UnmarshalJSON 

func (r *DevicePostureDeleteResponse) UnmarshalJSON(data []byte) (err error)

type DevicePostureDeleteResponseEnvelope 

type DevicePostureDeleteResponseEnvelope struct {
	Errors   []DevicePostureDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DevicePostureDeleteResponseEnvelopeMessages `json:"messages,required"`
	Result   DevicePostureDeleteResponse                   `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success DevicePostureDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    devicePostureDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*DevicePostureDeleteResponseEnvelope) UnmarshalJSON 

func (r *DevicePostureDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DevicePostureDeleteResponseEnvelopeErrors 

type DevicePostureDeleteResponseEnvelopeErrors struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    devicePostureDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DevicePostureDeleteResponseEnvelopeErrors) UnmarshalJSON 

func (r *DevicePostureDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DevicePostureDeleteResponseEnvelopeMessages 

type DevicePostureDeleteResponseEnvelopeMessages struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    devicePostureDeleteResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DevicePostureDeleteResponseEnvelopeMessages) UnmarshalJSON 

func (r *DevicePostureDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DevicePostureDeleteResponseEnvelopeSuccess 

type DevicePostureDeleteResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DevicePostureDeleteResponseEnvelopeSuccessTrue DevicePostureDeleteResponseEnvelopeSuccess = true
)

type DevicePostureGetParams 

type DevicePostureGetParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type DevicePostureGetResponseEnvelope 

type DevicePostureGetResponseEnvelope struct {
	Errors   []DevicePostureGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DevicePostureGetResponseEnvelopeMessages `json:"messages,required"`
	Result   TeamsDevicesDevicePostureRules             `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success DevicePostureGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    devicePostureGetResponseEnvelopeJSON    `json:"-"`
}

func (*DevicePostureGetResponseEnvelope) UnmarshalJSON 

func (r *DevicePostureGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DevicePostureGetResponseEnvelopeErrors 

type DevicePostureGetResponseEnvelopeErrors struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    devicePostureGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DevicePostureGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *DevicePostureGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DevicePostureGetResponseEnvelopeMessages 

type DevicePostureGetResponseEnvelopeMessages struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    devicePostureGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DevicePostureGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *DevicePostureGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DevicePostureGetResponseEnvelopeSuccess 

type DevicePostureGetResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DevicePostureGetResponseEnvelopeSuccessTrue DevicePostureGetResponseEnvelopeSuccess = true
)

type DevicePostureIntegrationDeleteParams 

type DevicePostureIntegrationDeleteParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type DevicePostureIntegrationDeleteResponse 

type DevicePostureIntegrationDeleteResponse interface {
	ImplementsZeroTrustDevicePostureIntegrationDeleteResponse()
}

Union satisfied by zero_trust.DevicePostureIntegrationDeleteResponseUnknown or shared.UnionString.

type DevicePostureIntegrationDeleteResponseEnvelope 

type DevicePostureIntegrationDeleteResponseEnvelope struct {
	Errors   []DevicePostureIntegrationDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DevicePostureIntegrationDeleteResponseEnvelopeMessages `json:"messages,required"`
	Result   DevicePostureIntegrationDeleteResponse                   `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success DevicePostureIntegrationDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    devicePostureIntegrationDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*DevicePostureIntegrationDeleteResponseEnvelope) UnmarshalJSON 

func (r *DevicePostureIntegrationDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DevicePostureIntegrationDeleteResponseEnvelopeErrors 

type DevicePostureIntegrationDeleteResponseEnvelopeErrors struct {
	Code    int64                                                    `json:"code,required"`
	Message string                                                   `json:"message,required"`
	JSON    devicePostureIntegrationDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DevicePostureIntegrationDeleteResponseEnvelopeErrors) UnmarshalJSON 

func (r *DevicePostureIntegrationDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DevicePostureIntegrationDeleteResponseEnvelopeMessages 

type DevicePostureIntegrationDeleteResponseEnvelopeMessages struct {
	Code    int64                                                      `json:"code,required"`
	Message string                                                     `json:"message,required"`
	JSON    devicePostureIntegrationDeleteResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DevicePostureIntegrationDeleteResponseEnvelopeMessages) UnmarshalJSON 

func (r *DevicePostureIntegrationDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DevicePostureIntegrationDeleteResponseEnvelopeSuccess 

type DevicePostureIntegrationDeleteResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DevicePostureIntegrationDeleteResponseEnvelopeSuccessTrue DevicePostureIntegrationDeleteResponseEnvelopeSuccess = true
)

type DevicePostureIntegrationEditParams 

type DevicePostureIntegrationEditParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
	// The configuration object containing third-party integration information.
	Config param.Field[DevicePostureIntegrationEditParamsConfig] `json:"config"`
	// The interval between each posture check with the third-party API. Use `m` for
	// minutes (e.g. `5m`) and `h` for hours (e.g. `12h`).
	Interval param.Field[string] `json:"interval"`
	// The name of the device posture integration.
	Name param.Field[string] `json:"name"`
	// The type of device posture integration.
	Type param.Field[DevicePostureIntegrationEditParamsType] `json:"type"`
}

func (DevicePostureIntegrationEditParams) MarshalJSON 

func (r DevicePostureIntegrationEditParams) MarshalJSON() (data []byte, err error)

type DevicePostureIntegrationEditParamsConfig 

type DevicePostureIntegrationEditParamsConfig interface {
	// contains filtered or unexported methods
}

The configuration object containing third-party integration information.

Satisfied by zero_trust.DevicePostureIntegrationEditParamsConfigTeamsDevicesWorkspaceOneConfigRequest, zero_trust.DevicePostureIntegrationEditParamsConfigTeamsDevicesCrowdstrikeConfigRequest, zero_trust.DevicePostureIntegrationEditParamsConfigTeamsDevicesUptycsConfigRequest, zero_trust.DevicePostureIntegrationEditParamsConfigTeamsDevicesIntuneConfigRequest, zero_trust.DevicePostureIntegrationEditParamsConfigTeamsDevicesKolideConfigRequest, zero_trust.DevicePostureIntegrationEditParamsConfigTeamsDevicesTaniumConfigRequest, zero_trust.DevicePostureIntegrationEditParamsConfigTeamsDevicesSentineloneS2sConfigRequest.

type DevicePostureIntegrationEditParamsConfigTeamsDevicesCrowdstrikeConfigRequest 

type DevicePostureIntegrationEditParamsConfigTeamsDevicesCrowdstrikeConfigRequest struct {
	// The Crowdstrike API URL.
	APIURL param.Field[string] `json:"api_url,required"`
	// The Crowdstrike client ID.
	ClientID param.Field[string] `json:"client_id,required"`
	// The Crowdstrike client secret.
	ClientSecret param.Field[string] `json:"client_secret,required"`
	// The Crowdstrike customer ID.
	CustomerID param.Field[string] `json:"customer_id,required"`
}

func (DevicePostureIntegrationEditParamsConfigTeamsDevicesCrowdstrikeConfigRequest) MarshalJSON 

func (r DevicePostureIntegrationEditParamsConfigTeamsDevicesCrowdstrikeConfigRequest) MarshalJSON() (data []byte, err error)

type DevicePostureIntegrationEditParamsConfigTeamsDevicesIntuneConfigRequest 

type DevicePostureIntegrationEditParamsConfigTeamsDevicesIntuneConfigRequest struct {
	// The Intune client ID.
	ClientID param.Field[string] `json:"client_id,required"`
	// The Intune client secret.
	ClientSecret param.Field[string] `json:"client_secret,required"`
	// The Intune customer ID.
	CustomerID param.Field[string] `json:"customer_id,required"`
}

func (DevicePostureIntegrationEditParamsConfigTeamsDevicesIntuneConfigRequest) MarshalJSON 

func (r DevicePostureIntegrationEditParamsConfigTeamsDevicesIntuneConfigRequest) MarshalJSON() (data []byte, err error)

type DevicePostureIntegrationEditParamsConfigTeamsDevicesKolideConfigRequest 

type DevicePostureIntegrationEditParamsConfigTeamsDevicesKolideConfigRequest struct {
	// The Kolide client ID.
	ClientID param.Field[string] `json:"client_id,required"`
	// The Kolide client secret.
	ClientSecret param.Field[string] `json:"client_secret,required"`
}

func (DevicePostureIntegrationEditParamsConfigTeamsDevicesKolideConfigRequest) MarshalJSON 

func (r DevicePostureIntegrationEditParamsConfigTeamsDevicesKolideConfigRequest) MarshalJSON() (data []byte, err error)

type DevicePostureIntegrationEditParamsConfigTeamsDevicesSentineloneS2sConfigRequest 

type DevicePostureIntegrationEditParamsConfigTeamsDevicesSentineloneS2sConfigRequest struct {
	// The SentinelOne S2S API URL.
	APIURL param.Field[string] `json:"api_url,required"`
	// The SentinelOne S2S client secret.
	ClientSecret param.Field[string] `json:"client_secret,required"`
}

func (DevicePostureIntegrationEditParamsConfigTeamsDevicesSentineloneS2sConfigRequest) MarshalJSON 

func (r DevicePostureIntegrationEditParamsConfigTeamsDevicesSentineloneS2sConfigRequest) MarshalJSON() (data []byte, err error)

type DevicePostureIntegrationEditParamsConfigTeamsDevicesTaniumConfigRequest 

type DevicePostureIntegrationEditParamsConfigTeamsDevicesTaniumConfigRequest struct {
	// The Tanium API URL.
	APIURL param.Field[string] `json:"api_url,required"`
	// The Tanium client secret.
	ClientSecret param.Field[string] `json:"client_secret,required"`
	// If present, this id will be passed in the `CF-Access-Client-ID` header when
	// hitting the `api_url`
	AccessClientID param.Field[string] `json:"access_client_id"`
	// If present, this secret will be passed in the `CF-Access-Client-Secret` header
	// when hitting the `api_url`
	AccessClientSecret param.Field[string] `json:"access_client_secret"`
}

func (DevicePostureIntegrationEditParamsConfigTeamsDevicesTaniumConfigRequest) MarshalJSON 

func (r DevicePostureIntegrationEditParamsConfigTeamsDevicesTaniumConfigRequest) MarshalJSON() (data []byte, err error)

type DevicePostureIntegrationEditParamsConfigTeamsDevicesUptycsConfigRequest 

type DevicePostureIntegrationEditParamsConfigTeamsDevicesUptycsConfigRequest struct {
	// The Uptycs API URL.
	APIURL param.Field[string] `json:"api_url,required"`
	// The Uptycs client secret.
	ClientKey param.Field[string] `json:"client_key,required"`
	// The Uptycs client secret.
	ClientSecret param.Field[string] `json:"client_secret,required"`
	// The Uptycs customer ID.
	CustomerID param.Field[string] `json:"customer_id,required"`
}

func (DevicePostureIntegrationEditParamsConfigTeamsDevicesUptycsConfigRequest) MarshalJSON 

func (r DevicePostureIntegrationEditParamsConfigTeamsDevicesUptycsConfigRequest) MarshalJSON() (data []byte, err error)

type DevicePostureIntegrationEditParamsConfigTeamsDevicesWorkspaceOneConfigRequest 

type DevicePostureIntegrationEditParamsConfigTeamsDevicesWorkspaceOneConfigRequest struct {
	// The Workspace One API URL provided in the Workspace One Admin Dashboard.
	APIURL param.Field[string] `json:"api_url,required"`
	// The Workspace One Authorization URL depending on your region.
	AuthURL param.Field[string] `json:"auth_url,required"`
	// The Workspace One client ID provided in the Workspace One Admin Dashboard.
	ClientID param.Field[string] `json:"client_id,required"`
	// The Workspace One client secret provided in the Workspace One Admin Dashboard.
	ClientSecret param.Field[string] `json:"client_secret,required"`
}

func (DevicePostureIntegrationEditParamsConfigTeamsDevicesWorkspaceOneConfigRequest) MarshalJSON 

func (r DevicePostureIntegrationEditParamsConfigTeamsDevicesWorkspaceOneConfigRequest) MarshalJSON() (data []byte, err error)

type DevicePostureIntegrationEditParamsType 

type DevicePostureIntegrationEditParamsType string

The type of device posture integration. 

const (
	DevicePostureIntegrationEditParamsTypeWorkspaceOne   DevicePostureIntegrationEditParamsType = "workspace_one"
	DevicePostureIntegrationEditParamsTypeCrowdstrikeS2s DevicePostureIntegrationEditParamsType = "crowdstrike_s2s"
	DevicePostureIntegrationEditParamsTypeUptycs         DevicePostureIntegrationEditParamsType = "uptycs"
	DevicePostureIntegrationEditParamsTypeIntune         DevicePostureIntegrationEditParamsType = "intune"
	DevicePostureIntegrationEditParamsTypeKolide         DevicePostureIntegrationEditParamsType = "kolide"
	DevicePostureIntegrationEditParamsTypeTanium         DevicePostureIntegrationEditParamsType = "tanium"
	DevicePostureIntegrationEditParamsTypeSentineloneS2s DevicePostureIntegrationEditParamsType = "sentinelone_s2s"
)

type DevicePostureIntegrationEditResponseEnvelope 

type DevicePostureIntegrationEditResponseEnvelope struct {
	Errors   []DevicePostureIntegrationEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DevicePostureIntegrationEditResponseEnvelopeMessages `json:"messages,required"`
	Result   TeamsDevicesDevicePostureIntegrations                  `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success DevicePostureIntegrationEditResponseEnvelopeSuccess `json:"success,required"`
	JSON    devicePostureIntegrationEditResponseEnvelopeJSON    `json:"-"`
}

func (*DevicePostureIntegrationEditResponseEnvelope) UnmarshalJSON 

func (r *DevicePostureIntegrationEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DevicePostureIntegrationEditResponseEnvelopeErrors 

type DevicePostureIntegrationEditResponseEnvelopeErrors struct {
	Code    int64                                                  `json:"code,required"`
	Message string                                                 `json:"message,required"`
	JSON    devicePostureIntegrationEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DevicePostureIntegrationEditResponseEnvelopeErrors) UnmarshalJSON 

func (r *DevicePostureIntegrationEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DevicePostureIntegrationEditResponseEnvelopeMessages 

type DevicePostureIntegrationEditResponseEnvelopeMessages struct {
	Code    int64                                                    `json:"code,required"`
	Message string                                                   `json:"message,required"`
	JSON    devicePostureIntegrationEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DevicePostureIntegrationEditResponseEnvelopeMessages) UnmarshalJSON 

func (r *DevicePostureIntegrationEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DevicePostureIntegrationEditResponseEnvelopeSuccess 

type DevicePostureIntegrationEditResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DevicePostureIntegrationEditResponseEnvelopeSuccessTrue DevicePostureIntegrationEditResponseEnvelopeSuccess = true
)

type DevicePostureIntegrationGetParams 

type DevicePostureIntegrationGetParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type DevicePostureIntegrationGetResponseEnvelope 

type DevicePostureIntegrationGetResponseEnvelope struct {
	Errors   []DevicePostureIntegrationGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DevicePostureIntegrationGetResponseEnvelopeMessages `json:"messages,required"`
	Result   TeamsDevicesDevicePostureIntegrations                 `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success DevicePostureIntegrationGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    devicePostureIntegrationGetResponseEnvelopeJSON    `json:"-"`
}

func (*DevicePostureIntegrationGetResponseEnvelope) UnmarshalJSON 

func (r *DevicePostureIntegrationGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DevicePostureIntegrationGetResponseEnvelopeErrors 

type DevicePostureIntegrationGetResponseEnvelopeErrors struct {
	Code    int64                                                 `json:"code,required"`
	Message string                                                `json:"message,required"`
	JSON    devicePostureIntegrationGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DevicePostureIntegrationGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *DevicePostureIntegrationGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DevicePostureIntegrationGetResponseEnvelopeMessages 

type DevicePostureIntegrationGetResponseEnvelopeMessages struct {
	Code    int64                                                   `json:"code,required"`
	Message string                                                  `json:"message,required"`
	JSON    devicePostureIntegrationGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DevicePostureIntegrationGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *DevicePostureIntegrationGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DevicePostureIntegrationGetResponseEnvelopeSuccess 

type DevicePostureIntegrationGetResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DevicePostureIntegrationGetResponseEnvelopeSuccessTrue DevicePostureIntegrationGetResponseEnvelopeSuccess = true
)

type DevicePostureIntegrationListParams 

type DevicePostureIntegrationListParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type DevicePostureIntegrationListResponseEnvelope 

type DevicePostureIntegrationListResponseEnvelope struct {
	Errors   []DevicePostureIntegrationListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DevicePostureIntegrationListResponseEnvelopeMessages `json:"messages,required"`
	Result   []TeamsDevicesDevicePostureIntegrations                `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success    DevicePostureIntegrationListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo DevicePostureIntegrationListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       devicePostureIntegrationListResponseEnvelopeJSON       `json:"-"`
}

func (*DevicePostureIntegrationListResponseEnvelope) UnmarshalJSON 

func (r *DevicePostureIntegrationListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DevicePostureIntegrationListResponseEnvelopeErrors 

type DevicePostureIntegrationListResponseEnvelopeErrors struct {
	Code    int64                                                  `json:"code,required"`
	Message string                                                 `json:"message,required"`
	JSON    devicePostureIntegrationListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DevicePostureIntegrationListResponseEnvelopeErrors) UnmarshalJSON 

func (r *DevicePostureIntegrationListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DevicePostureIntegrationListResponseEnvelopeMessages 

type DevicePostureIntegrationListResponseEnvelopeMessages struct {
	Code    int64                                                    `json:"code,required"`
	Message string                                                   `json:"message,required"`
	JSON    devicePostureIntegrationListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DevicePostureIntegrationListResponseEnvelopeMessages) UnmarshalJSON 

func (r *DevicePostureIntegrationListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DevicePostureIntegrationListResponseEnvelopeResultInfo 

type DevicePostureIntegrationListResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                                    `json:"total_count"`
	JSON       devicePostureIntegrationListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*DevicePostureIntegrationListResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *DevicePostureIntegrationListResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type DevicePostureIntegrationListResponseEnvelopeSuccess 

type DevicePostureIntegrationListResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DevicePostureIntegrationListResponseEnvelopeSuccessTrue DevicePostureIntegrationListResponseEnvelopeSuccess = true
)

type DevicePostureIntegrationNewParams 

type DevicePostureIntegrationNewParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
	// The configuration object containing third-party integration information.
	Config param.Field[DevicePostureIntegrationNewParamsConfig] `json:"config,required"`
	// The interval between each posture check with the third-party API. Use `m` for
	// minutes (e.g. `5m`) and `h` for hours (e.g. `12h`).
	Interval param.Field[string] `json:"interval,required"`
	// The name of the device posture integration.
	Name param.Field[string] `json:"name,required"`
	// The type of device posture integration.
	Type param.Field[DevicePostureIntegrationNewParamsType] `json:"type,required"`
}

func (DevicePostureIntegrationNewParams) MarshalJSON 

func (r DevicePostureIntegrationNewParams) MarshalJSON() (data []byte, err error)

type DevicePostureIntegrationNewParamsConfig 

type DevicePostureIntegrationNewParamsConfig interface {
	// contains filtered or unexported methods
}

The configuration object containing third-party integration information.

Satisfied by zero_trust.DevicePostureIntegrationNewParamsConfigTeamsDevicesWorkspaceOneConfigRequest, zero_trust.DevicePostureIntegrationNewParamsConfigTeamsDevicesCrowdstrikeConfigRequest, zero_trust.DevicePostureIntegrationNewParamsConfigTeamsDevicesUptycsConfigRequest, zero_trust.DevicePostureIntegrationNewParamsConfigTeamsDevicesIntuneConfigRequest, zero_trust.DevicePostureIntegrationNewParamsConfigTeamsDevicesKolideConfigRequest, zero_trust.DevicePostureIntegrationNewParamsConfigTeamsDevicesTaniumConfigRequest, zero_trust.DevicePostureIntegrationNewParamsConfigTeamsDevicesSentineloneS2sConfigRequest.

type DevicePostureIntegrationNewParamsConfigTeamsDevicesCrowdstrikeConfigRequest 

type DevicePostureIntegrationNewParamsConfigTeamsDevicesCrowdstrikeConfigRequest struct {
	// The Crowdstrike API URL.
	APIURL param.Field[string] `json:"api_url,required"`
	// The Crowdstrike client ID.
	ClientID param.Field[string] `json:"client_id,required"`
	// The Crowdstrike client secret.
	ClientSecret param.Field[string] `json:"client_secret,required"`
	// The Crowdstrike customer ID.
	CustomerID param.Field[string] `json:"customer_id,required"`
}

func (DevicePostureIntegrationNewParamsConfigTeamsDevicesCrowdstrikeConfigRequest) MarshalJSON 

func (r DevicePostureIntegrationNewParamsConfigTeamsDevicesCrowdstrikeConfigRequest) MarshalJSON() (data []byte, err error)

type DevicePostureIntegrationNewParamsConfigTeamsDevicesIntuneConfigRequest 

type DevicePostureIntegrationNewParamsConfigTeamsDevicesIntuneConfigRequest struct {
	// The Intune client ID.
	ClientID param.Field[string] `json:"client_id,required"`
	// The Intune client secret.
	ClientSecret param.Field[string] `json:"client_secret,required"`
	// The Intune customer ID.
	CustomerID param.Field[string] `json:"customer_id,required"`
}

func (DevicePostureIntegrationNewParamsConfigTeamsDevicesIntuneConfigRequest) MarshalJSON 

func (r DevicePostureIntegrationNewParamsConfigTeamsDevicesIntuneConfigRequest) MarshalJSON() (data []byte, err error)

type DevicePostureIntegrationNewParamsConfigTeamsDevicesKolideConfigRequest 

type DevicePostureIntegrationNewParamsConfigTeamsDevicesKolideConfigRequest struct {
	// The Kolide client ID.
	ClientID param.Field[string] `json:"client_id,required"`
	// The Kolide client secret.
	ClientSecret param.Field[string] `json:"client_secret,required"`
}

func (DevicePostureIntegrationNewParamsConfigTeamsDevicesKolideConfigRequest) MarshalJSON 

func (r DevicePostureIntegrationNewParamsConfigTeamsDevicesKolideConfigRequest) MarshalJSON() (data []byte, err error)

type DevicePostureIntegrationNewParamsConfigTeamsDevicesSentineloneS2sConfigRequest 

type DevicePostureIntegrationNewParamsConfigTeamsDevicesSentineloneS2sConfigRequest struct {
	// The SentinelOne S2S API URL.
	APIURL param.Field[string] `json:"api_url,required"`
	// The SentinelOne S2S client secret.
	ClientSecret param.Field[string] `json:"client_secret,required"`
}

func (DevicePostureIntegrationNewParamsConfigTeamsDevicesSentineloneS2sConfigRequest) MarshalJSON 

func (r DevicePostureIntegrationNewParamsConfigTeamsDevicesSentineloneS2sConfigRequest) MarshalJSON() (data []byte, err error)

type DevicePostureIntegrationNewParamsConfigTeamsDevicesTaniumConfigRequest 

type DevicePostureIntegrationNewParamsConfigTeamsDevicesTaniumConfigRequest struct {
	// The Tanium API URL.
	APIURL param.Field[string] `json:"api_url,required"`
	// The Tanium client secret.
	ClientSecret param.Field[string] `json:"client_secret,required"`
	// If present, this id will be passed in the `CF-Access-Client-ID` header when
	// hitting the `api_url`
	AccessClientID param.Field[string] `json:"access_client_id"`
	// If present, this secret will be passed in the `CF-Access-Client-Secret` header
	// when hitting the `api_url`
	AccessClientSecret param.Field[string] `json:"access_client_secret"`
}

func (DevicePostureIntegrationNewParamsConfigTeamsDevicesTaniumConfigRequest) MarshalJSON 

func (r DevicePostureIntegrationNewParamsConfigTeamsDevicesTaniumConfigRequest) MarshalJSON() (data []byte, err error)

type DevicePostureIntegrationNewParamsConfigTeamsDevicesUptycsConfigRequest 

type DevicePostureIntegrationNewParamsConfigTeamsDevicesUptycsConfigRequest struct {
	// The Uptycs API URL.
	APIURL param.Field[string] `json:"api_url,required"`
	// The Uptycs client secret.
	ClientKey param.Field[string] `json:"client_key,required"`
	// The Uptycs client secret.
	ClientSecret param.Field[string] `json:"client_secret,required"`
	// The Uptycs customer ID.
	CustomerID param.Field[string] `json:"customer_id,required"`
}

func (DevicePostureIntegrationNewParamsConfigTeamsDevicesUptycsConfigRequest) MarshalJSON 

func (r DevicePostureIntegrationNewParamsConfigTeamsDevicesUptycsConfigRequest) MarshalJSON() (data []byte, err error)

type DevicePostureIntegrationNewParamsConfigTeamsDevicesWorkspaceOneConfigRequest 

type DevicePostureIntegrationNewParamsConfigTeamsDevicesWorkspaceOneConfigRequest struct {
	// The Workspace One API URL provided in the Workspace One Admin Dashboard.
	APIURL param.Field[string] `json:"api_url,required"`
	// The Workspace One Authorization URL depending on your region.
	AuthURL param.Field[string] `json:"auth_url,required"`
	// The Workspace One client ID provided in the Workspace One Admin Dashboard.
	ClientID param.Field[string] `json:"client_id,required"`
	// The Workspace One client secret provided in the Workspace One Admin Dashboard.
	ClientSecret param.Field[string] `json:"client_secret,required"`
}

func (DevicePostureIntegrationNewParamsConfigTeamsDevicesWorkspaceOneConfigRequest) MarshalJSON 

func (r DevicePostureIntegrationNewParamsConfigTeamsDevicesWorkspaceOneConfigRequest) MarshalJSON() (data []byte, err error)

type DevicePostureIntegrationNewParamsType 

type DevicePostureIntegrationNewParamsType string

The type of device posture integration. 

const (
	DevicePostureIntegrationNewParamsTypeWorkspaceOne   DevicePostureIntegrationNewParamsType = "workspace_one"
	DevicePostureIntegrationNewParamsTypeCrowdstrikeS2s DevicePostureIntegrationNewParamsType = "crowdstrike_s2s"
	DevicePostureIntegrationNewParamsTypeUptycs         DevicePostureIntegrationNewParamsType = "uptycs"
	DevicePostureIntegrationNewParamsTypeIntune         DevicePostureIntegrationNewParamsType = "intune"
	DevicePostureIntegrationNewParamsTypeKolide         DevicePostureIntegrationNewParamsType = "kolide"
	DevicePostureIntegrationNewParamsTypeTanium         DevicePostureIntegrationNewParamsType = "tanium"
	DevicePostureIntegrationNewParamsTypeSentineloneS2s DevicePostureIntegrationNewParamsType = "sentinelone_s2s"
)

type DevicePostureIntegrationNewResponseEnvelope 

type DevicePostureIntegrationNewResponseEnvelope struct {
	Errors   []DevicePostureIntegrationNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DevicePostureIntegrationNewResponseEnvelopeMessages `json:"messages,required"`
	Result   TeamsDevicesDevicePostureIntegrations                 `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success DevicePostureIntegrationNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    devicePostureIntegrationNewResponseEnvelopeJSON    `json:"-"`
}

func (*DevicePostureIntegrationNewResponseEnvelope) UnmarshalJSON 

func (r *DevicePostureIntegrationNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DevicePostureIntegrationNewResponseEnvelopeErrors 

type DevicePostureIntegrationNewResponseEnvelopeErrors struct {
	Code    int64                                                 `json:"code,required"`
	Message string                                                `json:"message,required"`
	JSON    devicePostureIntegrationNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DevicePostureIntegrationNewResponseEnvelopeErrors) UnmarshalJSON 

func (r *DevicePostureIntegrationNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DevicePostureIntegrationNewResponseEnvelopeMessages 

type DevicePostureIntegrationNewResponseEnvelopeMessages struct {
	Code    int64                                                   `json:"code,required"`
	Message string                                                  `json:"message,required"`
	JSON    devicePostureIntegrationNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DevicePostureIntegrationNewResponseEnvelopeMessages) UnmarshalJSON 

func (r *DevicePostureIntegrationNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DevicePostureIntegrationNewResponseEnvelopeSuccess 

type DevicePostureIntegrationNewResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DevicePostureIntegrationNewResponseEnvelopeSuccessTrue DevicePostureIntegrationNewResponseEnvelopeSuccess = true
)

type DevicePostureIntegrationService 

type DevicePostureIntegrationService struct {
	Options []option.RequestOption
}

DevicePostureIntegrationService 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 NewDevicePostureIntegrationService method instead.

func NewDevicePostureIntegrationService 

func NewDevicePostureIntegrationService(opts ...option.RequestOption) (r *DevicePostureIntegrationService)

NewDevicePostureIntegrationService 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 (*DevicePostureIntegrationService) Delete 

func (r *DevicePostureIntegrationService) Delete(ctx context.Context, integrationID string, body DevicePostureIntegrationDeleteParams, opts ...option.RequestOption) (res *DevicePostureIntegrationDeleteResponse, err error)

Delete a configured device posture integration.

func (*DevicePostureIntegrationService) Edit 

func (r *DevicePostureIntegrationService) Edit(ctx context.Context, integrationID string, params DevicePostureIntegrationEditParams, opts ...option.RequestOption) (res *TeamsDevicesDevicePostureIntegrations, err error)

Updates a configured device posture integration.

func (*DevicePostureIntegrationService) Get 

func (r *DevicePostureIntegrationService) Get(ctx context.Context, integrationID string, query DevicePostureIntegrationGetParams, opts ...option.RequestOption) (res *TeamsDevicesDevicePostureIntegrations, err error)

Fetches details for a single device posture integration.

func (*DevicePostureIntegrationService) List 

func (r *DevicePostureIntegrationService) List(ctx context.Context, query DevicePostureIntegrationListParams, opts ...option.RequestOption) (res *[]TeamsDevicesDevicePostureIntegrations, err error)

Fetches the list of device posture integrations for an account.

func (*DevicePostureIntegrationService) New 

func (r *DevicePostureIntegrationService) New(ctx context.Context, params DevicePostureIntegrationNewParams, opts ...option.RequestOption) (res *TeamsDevicesDevicePostureIntegrations, err error)

Create a new device posture integration.

type DevicePostureListParams 

type DevicePostureListParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type DevicePostureListResponseEnvelope 

type DevicePostureListResponseEnvelope struct {
	Errors   []DevicePostureListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DevicePostureListResponseEnvelopeMessages `json:"messages,required"`
	Result   []TeamsDevicesDevicePostureRules            `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success    DevicePostureListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo DevicePostureListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       devicePostureListResponseEnvelopeJSON       `json:"-"`
}

func (*DevicePostureListResponseEnvelope) UnmarshalJSON 

func (r *DevicePostureListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DevicePostureListResponseEnvelopeErrors 

type DevicePostureListResponseEnvelopeErrors struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    devicePostureListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DevicePostureListResponseEnvelopeErrors) UnmarshalJSON 

func (r *DevicePostureListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DevicePostureListResponseEnvelopeMessages 

type DevicePostureListResponseEnvelopeMessages struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    devicePostureListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DevicePostureListResponseEnvelopeMessages) UnmarshalJSON 

func (r *DevicePostureListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DevicePostureListResponseEnvelopeResultInfo 

type DevicePostureListResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                         `json:"total_count"`
	JSON       devicePostureListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*DevicePostureListResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *DevicePostureListResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type DevicePostureListResponseEnvelopeSuccess 

type DevicePostureListResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DevicePostureListResponseEnvelopeSuccessTrue DevicePostureListResponseEnvelopeSuccess = true
)

type DevicePostureNewParams 

type DevicePostureNewParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
	// The name of the device posture rule.
	Name param.Field[string] `json:"name,required"`
	// The type of device posture rule.
	Type param.Field[DevicePostureNewParamsType] `json:"type,required"`
	// The description of the device posture rule.
	Description param.Field[string] `json:"description"`
	// Sets the expiration time for a posture check result. If empty, the result
	// remains valid until it is overwritten by new data from the WARP client.
	Expiration param.Field[string] `json:"expiration"`
	// The value to be checked against.
	Input param.Field[DevicePostureNewParamsInput] `json:"input"`
	// The conditions that the client must match to run the rule.
	Match param.Field[[]DevicePostureNewParamsMatch] `json:"match"`
	// Polling frequency for the WARP client posture check. Default: `5m` (poll every
	// five minutes). Minimum: `1m`.
	Schedule param.Field[string] `json:"schedule"`
}

func (DevicePostureNewParams) MarshalJSON 

func (r DevicePostureNewParams) MarshalJSON() (data []byte, err error)

type DevicePostureNewParamsInput 

type DevicePostureNewParamsInput interface {
	// contains filtered or unexported methods
}

The value to be checked against.

Satisfied by zero_trust.DevicePostureNewParamsInputTeamsDevicesFileInputRequest, zero_trust.DevicePostureNewParamsInputTeamsDevicesUniqueClientIDInputRequest, zero_trust.DevicePostureNewParamsInputTeamsDevicesDomainJoinedInputRequest, zero_trust.DevicePostureNewParamsInputTeamsDevicesOSVersionInputRequest, zero_trust.DevicePostureNewParamsInputTeamsDevicesFirewallInputRequest, zero_trust.DevicePostureNewParamsInputTeamsDevicesSentineloneInputRequest, zero_trust.DevicePostureNewParamsInputTeamsDevicesCarbonblackInputRequest, zero_trust.DevicePostureNewParamsInputTeamsDevicesDiskEncryptionInputRequest, zero_trust.DevicePostureNewParamsInputTeamsDevicesApplicationInputRequest, zero_trust.DevicePostureNewParamsInputTeamsDevicesClientCertificateInputRequest, zero_trust.DevicePostureNewParamsInputTeamsDevicesWorkspaceOneInputRequest, zero_trust.DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequest, zero_trust.DevicePostureNewParamsInputTeamsDevicesIntuneInputRequest, zero_trust.DevicePostureNewParamsInputTeamsDevicesKolideInputRequest, zero_trust.DevicePostureNewParamsInputTeamsDevicesTaniumInputRequest, zero_trust.DevicePostureNewParamsInputTeamsDevicesSentineloneS2sInputRequest.

type DevicePostureNewParamsInputTeamsDevicesApplicationInputRequest 

type DevicePostureNewParamsInputTeamsDevicesApplicationInputRequest struct {
	// Operating system
	OperatingSystem param.Field[DevicePostureNewParamsInputTeamsDevicesApplicationInputRequestOperatingSystem] `json:"operating_system,required"`
	// Path for the application.
	Path param.Field[string] `json:"path,required"`
	// SHA-256.
	Sha256 param.Field[string] `json:"sha256"`
	// Signing certificate thumbprint.
	Thumbprint param.Field[string] `json:"thumbprint"`
}

func (DevicePostureNewParamsInputTeamsDevicesApplicationInputRequest) MarshalJSON 

func (r DevicePostureNewParamsInputTeamsDevicesApplicationInputRequest) MarshalJSON() (data []byte, err error)

type DevicePostureNewParamsInputTeamsDevicesApplicationInputRequestOperatingSystem 

type DevicePostureNewParamsInputTeamsDevicesApplicationInputRequestOperatingSystem string

Operating system 

const (
	DevicePostureNewParamsInputTeamsDevicesApplicationInputRequestOperatingSystemWindows DevicePostureNewParamsInputTeamsDevicesApplicationInputRequestOperatingSystem = "windows"
	DevicePostureNewParamsInputTeamsDevicesApplicationInputRequestOperatingSystemLinux   DevicePostureNewParamsInputTeamsDevicesApplicationInputRequestOperatingSystem = "linux"
	DevicePostureNewParamsInputTeamsDevicesApplicationInputRequestOperatingSystemMac     DevicePostureNewParamsInputTeamsDevicesApplicationInputRequestOperatingSystem = "mac"
)

type DevicePostureNewParamsInputTeamsDevicesCarbonblackInputRequest 

type DevicePostureNewParamsInputTeamsDevicesCarbonblackInputRequest struct {
	// Operating system
	OperatingSystem param.Field[DevicePostureNewParamsInputTeamsDevicesCarbonblackInputRequestOperatingSystem] `json:"operating_system,required"`
	// File path.
	Path param.Field[string] `json:"path,required"`
	// SHA-256.
	Sha256 param.Field[string] `json:"sha256"`
	// Signing certificate thumbprint.
	Thumbprint param.Field[string] `json:"thumbprint"`
}

func (DevicePostureNewParamsInputTeamsDevicesCarbonblackInputRequest) MarshalJSON 

func (r DevicePostureNewParamsInputTeamsDevicesCarbonblackInputRequest) MarshalJSON() (data []byte, err error)

type DevicePostureNewParamsInputTeamsDevicesCarbonblackInputRequestOperatingSystem 

type DevicePostureNewParamsInputTeamsDevicesCarbonblackInputRequestOperatingSystem string

Operating system 

const (
	DevicePostureNewParamsInputTeamsDevicesCarbonblackInputRequestOperatingSystemWindows DevicePostureNewParamsInputTeamsDevicesCarbonblackInputRequestOperatingSystem = "windows"
	DevicePostureNewParamsInputTeamsDevicesCarbonblackInputRequestOperatingSystemLinux   DevicePostureNewParamsInputTeamsDevicesCarbonblackInputRequestOperatingSystem = "linux"
	DevicePostureNewParamsInputTeamsDevicesCarbonblackInputRequestOperatingSystemMac     DevicePostureNewParamsInputTeamsDevicesCarbonblackInputRequestOperatingSystem = "mac"
)

type DevicePostureNewParamsInputTeamsDevicesClientCertificateInputRequest 

type DevicePostureNewParamsInputTeamsDevicesClientCertificateInputRequest struct {
	// UUID of Cloudflare managed certificate.
	CertificateID param.Field[string] `json:"certificate_id,required"`
	// Common Name that is protected by the certificate
	Cn param.Field[string] `json:"cn,required"`
}

func (DevicePostureNewParamsInputTeamsDevicesClientCertificateInputRequest) MarshalJSON 

func (r DevicePostureNewParamsInputTeamsDevicesClientCertificateInputRequest) MarshalJSON() (data []byte, err error)

type DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequest 

type DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequest struct {
	// Posture Integration ID.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// For more details on last seen, please refer to the Crowdstrike documentation.
	LastSeen param.Field[string] `json:"last_seen"`
	// Operator
	Operator param.Field[DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequestOperator] `json:"operator"`
	// Os Version
	OS param.Field[string] `json:"os"`
	// overall
	Overall param.Field[string] `json:"overall"`
	// SensorConfig
	SensorConfig param.Field[string] `json:"sensor_config"`
	// For more details on state, please refer to the Crowdstrike documentation.
	State param.Field[DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequestState] `json:"state"`
	// Version
	Version param.Field[string] `json:"version"`
	// Version Operator
	VersionOperator param.Field[DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequestVersionOperator] `json:"versionOperator"`
}

func (DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequest) MarshalJSON 

func (r DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequest) MarshalJSON() (data []byte, err error)

type DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequestOperator 

type DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequestOperator string

Operator 

const (
	DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequestOperatorUnknown85 DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequestOperator = "<"
	DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequestOperatorUnknown86 DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequestOperator = "<="
	DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequestOperatorUnknown87 DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequestOperator = ">"
	DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequestOperatorUnknown88 DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequestOperator = ">="
	DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequestOperatorUnknown89 DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequestOperator = "=="
)

type DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequestState 

type DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequestState string

For more details on state, please refer to the Crowdstrike documentation. 

const (
	DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequestStateOnline  DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequestState = "online"
	DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequestStateOffline DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequestState = "offline"
	DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequestStateUnknown DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequestState = "unknown"
)

type DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequestVersionOperator 

type DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequestVersionOperator string

Version Operator 

const (
	DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequestVersionOperatorUnknown95 DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequestVersionOperator = "<"
	DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequestVersionOperatorUnknown96 DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequestVersionOperator = "<="
	DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequestVersionOperatorUnknown97 DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequestVersionOperator = ">"
	DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequestVersionOperatorUnknown98 DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequestVersionOperator = ">="
	DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequestVersionOperatorUnknown99 DevicePostureNewParamsInputTeamsDevicesCrowdstrikeInputRequestVersionOperator = "=="
)

type DevicePostureNewParamsInputTeamsDevicesDiskEncryptionInputRequest 

type DevicePostureNewParamsInputTeamsDevicesDiskEncryptionInputRequest struct {
	// List of volume names to be checked for encryption.
	CheckDisks param.Field[[]string] `json:"checkDisks"`
	// Whether to check all disks for encryption.
	RequireAll param.Field[bool] `json:"requireAll"`
}

func (DevicePostureNewParamsInputTeamsDevicesDiskEncryptionInputRequest) MarshalJSON 

func (r DevicePostureNewParamsInputTeamsDevicesDiskEncryptionInputRequest) MarshalJSON() (data []byte, err error)

type DevicePostureNewParamsInputTeamsDevicesDomainJoinedInputRequest 

type DevicePostureNewParamsInputTeamsDevicesDomainJoinedInputRequest struct {
	// Operating System
	OperatingSystem param.Field[DevicePostureNewParamsInputTeamsDevicesDomainJoinedInputRequestOperatingSystem] `json:"operating_system,required"`
	// Domain
	Domain param.Field[string] `json:"domain"`
}

func (DevicePostureNewParamsInputTeamsDevicesDomainJoinedInputRequest) MarshalJSON 

func (r DevicePostureNewParamsInputTeamsDevicesDomainJoinedInputRequest) MarshalJSON() (data []byte, err error)

type DevicePostureNewParamsInputTeamsDevicesDomainJoinedInputRequestOperatingSystem 

type DevicePostureNewParamsInputTeamsDevicesDomainJoinedInputRequestOperatingSystem string

Operating System 

const (
	DevicePostureNewParamsInputTeamsDevicesDomainJoinedInputRequestOperatingSystemWindows DevicePostureNewParamsInputTeamsDevicesDomainJoinedInputRequestOperatingSystem = "windows"
)

type DevicePostureNewParamsInputTeamsDevicesFileInputRequest 

type DevicePostureNewParamsInputTeamsDevicesFileInputRequest struct {
	// Operating system
	OperatingSystem param.Field[DevicePostureNewParamsInputTeamsDevicesFileInputRequestOperatingSystem] `json:"operating_system,required"`
	// File path.
	Path param.Field[string] `json:"path,required"`
	// Whether or not file exists
	Exists param.Field[bool] `json:"exists"`
	// SHA-256.
	Sha256 param.Field[string] `json:"sha256"`
	// Signing certificate thumbprint.
	Thumbprint param.Field[string] `json:"thumbprint"`
}

func (DevicePostureNewParamsInputTeamsDevicesFileInputRequest) MarshalJSON 

func (r DevicePostureNewParamsInputTeamsDevicesFileInputRequest) MarshalJSON() (data []byte, err error)

type DevicePostureNewParamsInputTeamsDevicesFileInputRequestOperatingSystem 

type DevicePostureNewParamsInputTeamsDevicesFileInputRequestOperatingSystem string

Operating system 

const (
	DevicePostureNewParamsInputTeamsDevicesFileInputRequestOperatingSystemWindows DevicePostureNewParamsInputTeamsDevicesFileInputRequestOperatingSystem = "windows"
	DevicePostureNewParamsInputTeamsDevicesFileInputRequestOperatingSystemLinux   DevicePostureNewParamsInputTeamsDevicesFileInputRequestOperatingSystem = "linux"
	DevicePostureNewParamsInputTeamsDevicesFileInputRequestOperatingSystemMac     DevicePostureNewParamsInputTeamsDevicesFileInputRequestOperatingSystem = "mac"
)

type DevicePostureNewParamsInputTeamsDevicesFirewallInputRequest 

type DevicePostureNewParamsInputTeamsDevicesFirewallInputRequest struct {
	// Enabled
	Enabled param.Field[bool] `json:"enabled,required"`
	// Operating System
	OperatingSystem param.Field[DevicePostureNewParamsInputTeamsDevicesFirewallInputRequestOperatingSystem] `json:"operating_system,required"`
}

func (DevicePostureNewParamsInputTeamsDevicesFirewallInputRequest) MarshalJSON 

func (r DevicePostureNewParamsInputTeamsDevicesFirewallInputRequest) MarshalJSON() (data []byte, err error)

type DevicePostureNewParamsInputTeamsDevicesFirewallInputRequestOperatingSystem 

type DevicePostureNewParamsInputTeamsDevicesFirewallInputRequestOperatingSystem string

Operating System 

const (
	DevicePostureNewParamsInputTeamsDevicesFirewallInputRequestOperatingSystemWindows DevicePostureNewParamsInputTeamsDevicesFirewallInputRequestOperatingSystem = "windows"
	DevicePostureNewParamsInputTeamsDevicesFirewallInputRequestOperatingSystemMac     DevicePostureNewParamsInputTeamsDevicesFirewallInputRequestOperatingSystem = "mac"
)

type DevicePostureNewParamsInputTeamsDevicesIntuneInputRequest 

type DevicePostureNewParamsInputTeamsDevicesIntuneInputRequest struct {
	// Compliance Status
	ComplianceStatus param.Field[DevicePostureNewParamsInputTeamsDevicesIntuneInputRequestComplianceStatus] `json:"compliance_status,required"`
	// Posture Integration ID.
	ConnectionID param.Field[string] `json:"connection_id,required"`
}

func (DevicePostureNewParamsInputTeamsDevicesIntuneInputRequest) MarshalJSON 

func (r DevicePostureNewParamsInputTeamsDevicesIntuneInputRequest) MarshalJSON() (data []byte, err error)

type DevicePostureNewParamsInputTeamsDevicesIntuneInputRequestComplianceStatus 

type DevicePostureNewParamsInputTeamsDevicesIntuneInputRequestComplianceStatus string

Compliance Status 

const (
	DevicePostureNewParamsInputTeamsDevicesIntuneInputRequestComplianceStatusCompliant     DevicePostureNewParamsInputTeamsDevicesIntuneInputRequestComplianceStatus = "compliant"
	DevicePostureNewParamsInputTeamsDevicesIntuneInputRequestComplianceStatusNoncompliant  DevicePostureNewParamsInputTeamsDevicesIntuneInputRequestComplianceStatus = "noncompliant"
	DevicePostureNewParamsInputTeamsDevicesIntuneInputRequestComplianceStatusUnknown       DevicePostureNewParamsInputTeamsDevicesIntuneInputRequestComplianceStatus = "unknown"
	DevicePostureNewParamsInputTeamsDevicesIntuneInputRequestComplianceStatusNotapplicable DevicePostureNewParamsInputTeamsDevicesIntuneInputRequestComplianceStatus = "notapplicable"
	DevicePostureNewParamsInputTeamsDevicesIntuneInputRequestComplianceStatusIngraceperiod DevicePostureNewParamsInputTeamsDevicesIntuneInputRequestComplianceStatus = "ingraceperiod"
	DevicePostureNewParamsInputTeamsDevicesIntuneInputRequestComplianceStatusError         DevicePostureNewParamsInputTeamsDevicesIntuneInputRequestComplianceStatus = "error"
)

type DevicePostureNewParamsInputTeamsDevicesKolideInputRequest 

type DevicePostureNewParamsInputTeamsDevicesKolideInputRequest struct {
	// Posture Integration ID.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// Count Operator
	CountOperator param.Field[DevicePostureNewParamsInputTeamsDevicesKolideInputRequestCountOperator] `json:"countOperator,required"`
	// The Number of Issues.
	IssueCount param.Field[string] `json:"issue_count,required"`
}

func (DevicePostureNewParamsInputTeamsDevicesKolideInputRequest) MarshalJSON 

func (r DevicePostureNewParamsInputTeamsDevicesKolideInputRequest) MarshalJSON() (data []byte, err error)

type DevicePostureNewParamsInputTeamsDevicesKolideInputRequestCountOperator 

type DevicePostureNewParamsInputTeamsDevicesKolideInputRequestCountOperator string

Count Operator 

const (
	DevicePostureNewParamsInputTeamsDevicesKolideInputRequestCountOperatorUnknown105 DevicePostureNewParamsInputTeamsDevicesKolideInputRequestCountOperator = "<"
	DevicePostureNewParamsInputTeamsDevicesKolideInputRequestCountOperatorUnknown106 DevicePostureNewParamsInputTeamsDevicesKolideInputRequestCountOperator = "<="
	DevicePostureNewParamsInputTeamsDevicesKolideInputRequestCountOperatorUnknown107 DevicePostureNewParamsInputTeamsDevicesKolideInputRequestCountOperator = ">"
	DevicePostureNewParamsInputTeamsDevicesKolideInputRequestCountOperatorUnknown108 DevicePostureNewParamsInputTeamsDevicesKolideInputRequestCountOperator = ">="
	DevicePostureNewParamsInputTeamsDevicesKolideInputRequestCountOperatorUnknown109 DevicePostureNewParamsInputTeamsDevicesKolideInputRequestCountOperator = "=="
)

type DevicePostureNewParamsInputTeamsDevicesOSVersionInputRequest 

type DevicePostureNewParamsInputTeamsDevicesOSVersionInputRequest struct {
	// Operating System
	OperatingSystem param.Field[DevicePostureNewParamsInputTeamsDevicesOSVersionInputRequestOperatingSystem] `json:"operating_system,required"`
	// Operator
	Operator param.Field[DevicePostureNewParamsInputTeamsDevicesOSVersionInputRequestOperator] `json:"operator,required"`
	// Version of OS
	Version param.Field[string] `json:"version,required"`
	// Operating System Distribution Name (linux only)
	OSDistroName param.Field[string] `json:"os_distro_name"`
	// Version of OS Distribution (linux only)
	OSDistroRevision param.Field[string] `json:"os_distro_revision"`
	// Additional version data. For Mac or iOS, the Product Verison Extra. For Linux,
	// the kernel release version. (Mac, iOS, and Linux only)
	OSVersionExtra param.Field[string] `json:"os_version_extra"`
}

func (DevicePostureNewParamsInputTeamsDevicesOSVersionInputRequest) MarshalJSON 

func (r DevicePostureNewParamsInputTeamsDevicesOSVersionInputRequest) MarshalJSON() (data []byte, err error)

type DevicePostureNewParamsInputTeamsDevicesOSVersionInputRequestOperatingSystem 

type DevicePostureNewParamsInputTeamsDevicesOSVersionInputRequestOperatingSystem string

Operating System 

const (
	DevicePostureNewParamsInputTeamsDevicesOSVersionInputRequestOperatingSystemWindows DevicePostureNewParamsInputTeamsDevicesOSVersionInputRequestOperatingSystem = "windows"
)

type DevicePostureNewParamsInputTeamsDevicesOSVersionInputRequestOperator 

type DevicePostureNewParamsInputTeamsDevicesOSVersionInputRequestOperator string

Operator 

const (
	DevicePostureNewParamsInputTeamsDevicesOSVersionInputRequestOperatorUnknown75 DevicePostureNewParamsInputTeamsDevicesOSVersionInputRequestOperator = "<"
	DevicePostureNewParamsInputTeamsDevicesOSVersionInputRequestOperatorUnknown76 DevicePostureNewParamsInputTeamsDevicesOSVersionInputRequestOperator = "<="
	DevicePostureNewParamsInputTeamsDevicesOSVersionInputRequestOperatorUnknown77 DevicePostureNewParamsInputTeamsDevicesOSVersionInputRequestOperator = ">"
	DevicePostureNewParamsInputTeamsDevicesOSVersionInputRequestOperatorUnknown78 DevicePostureNewParamsInputTeamsDevicesOSVersionInputRequestOperator = ">="
	DevicePostureNewParamsInputTeamsDevicesOSVersionInputRequestOperatorUnknown79 DevicePostureNewParamsInputTeamsDevicesOSVersionInputRequestOperator = "=="
)

type DevicePostureNewParamsInputTeamsDevicesSentineloneInputRequest 

type DevicePostureNewParamsInputTeamsDevicesSentineloneInputRequest struct {
	// Operating system
	OperatingSystem param.Field[DevicePostureNewParamsInputTeamsDevicesSentineloneInputRequestOperatingSystem] `json:"operating_system,required"`
	// File path.
	Path param.Field[string] `json:"path,required"`
	// SHA-256.
	Sha256 param.Field[string] `json:"sha256"`
	// Signing certificate thumbprint.
	Thumbprint param.Field[string] `json:"thumbprint"`
}

func (DevicePostureNewParamsInputTeamsDevicesSentineloneInputRequest) MarshalJSON 

func (r DevicePostureNewParamsInputTeamsDevicesSentineloneInputRequest) MarshalJSON() (data []byte, err error)

type DevicePostureNewParamsInputTeamsDevicesSentineloneInputRequestOperatingSystem 

type DevicePostureNewParamsInputTeamsDevicesSentineloneInputRequestOperatingSystem string

Operating system 

const (
	DevicePostureNewParamsInputTeamsDevicesSentineloneInputRequestOperatingSystemWindows DevicePostureNewParamsInputTeamsDevicesSentineloneInputRequestOperatingSystem = "windows"
	DevicePostureNewParamsInputTeamsDevicesSentineloneInputRequestOperatingSystemLinux   DevicePostureNewParamsInputTeamsDevicesSentineloneInputRequestOperatingSystem = "linux"
	DevicePostureNewParamsInputTeamsDevicesSentineloneInputRequestOperatingSystemMac     DevicePostureNewParamsInputTeamsDevicesSentineloneInputRequestOperatingSystem = "mac"
)

type DevicePostureNewParamsInputTeamsDevicesSentineloneS2sInputRequest 

type DevicePostureNewParamsInputTeamsDevicesSentineloneS2sInputRequest struct {
	// Posture Integration ID.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The Number of active threats.
	ActiveThreats param.Field[float64] `json:"active_threats"`
	// Whether device is infected.
	Infected param.Field[bool] `json:"infected"`
	// Whether device is active.
	IsActive param.Field[bool] `json:"is_active"`
	// Network status of device.
	NetworkStatus param.Field[DevicePostureNewParamsInputTeamsDevicesSentineloneS2sInputRequestNetworkStatus] `json:"network_status"`
	// operator
	Operator param.Field[DevicePostureNewParamsInputTeamsDevicesSentineloneS2sInputRequestOperator] `json:"operator"`
}

func (DevicePostureNewParamsInputTeamsDevicesSentineloneS2sInputRequest) MarshalJSON 

func (r DevicePostureNewParamsInputTeamsDevicesSentineloneS2sInputRequest) MarshalJSON() (data []byte, err error)

type DevicePostureNewParamsInputTeamsDevicesSentineloneS2sInputRequestNetworkStatus 

type DevicePostureNewParamsInputTeamsDevicesSentineloneS2sInputRequestNetworkStatus string

Network status of device. 

const (
	DevicePostureNewParamsInputTeamsDevicesSentineloneS2sInputRequestNetworkStatusConnected     DevicePostureNewParamsInputTeamsDevicesSentineloneS2sInputRequestNetworkStatus = "connected"
	DevicePostureNewParamsInputTeamsDevicesSentineloneS2sInputRequestNetworkStatusDisconnected  DevicePostureNewParamsInputTeamsDevicesSentineloneS2sInputRequestNetworkStatus = "disconnected"
	DevicePostureNewParamsInputTeamsDevicesSentineloneS2sInputRequestNetworkStatusDisconnecting DevicePostureNewParamsInputTeamsDevicesSentineloneS2sInputRequestNetworkStatus = "disconnecting"
	DevicePostureNewParamsInputTeamsDevicesSentineloneS2sInputRequestNetworkStatusConnecting    DevicePostureNewParamsInputTeamsDevicesSentineloneS2sInputRequestNetworkStatus = "connecting"
)

type DevicePostureNewParamsInputTeamsDevicesSentineloneS2sInputRequestOperator 

type DevicePostureNewParamsInputTeamsDevicesSentineloneS2sInputRequestOperator string

operator 

const (
	DevicePostureNewParamsInputTeamsDevicesSentineloneS2sInputRequestOperatorUnknown135 DevicePostureNewParamsInputTeamsDevicesSentineloneS2sInputRequestOperator = "<"
	DevicePostureNewParamsInputTeamsDevicesSentineloneS2sInputRequestOperatorUnknown136 DevicePostureNewParamsInputTeamsDevicesSentineloneS2sInputRequestOperator = "<="
	DevicePostureNewParamsInputTeamsDevicesSentineloneS2sInputRequestOperatorUnknown137 DevicePostureNewParamsInputTeamsDevicesSentineloneS2sInputRequestOperator = ">"
	DevicePostureNewParamsInputTeamsDevicesSentineloneS2sInputRequestOperatorUnknown138 DevicePostureNewParamsInputTeamsDevicesSentineloneS2sInputRequestOperator = ">="
	DevicePostureNewParamsInputTeamsDevicesSentineloneS2sInputRequestOperatorUnknown139 DevicePostureNewParamsInputTeamsDevicesSentineloneS2sInputRequestOperator = "=="
)

type DevicePostureNewParamsInputTeamsDevicesTaniumInputRequest 

type DevicePostureNewParamsInputTeamsDevicesTaniumInputRequest struct {
	// Posture Integration ID.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// For more details on eid last seen, refer to the Tanium documentation.
	EidLastSeen param.Field[string] `json:"eid_last_seen"`
	// Operator to evaluate risk_level or eid_last_seen.
	Operator param.Field[DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestOperator] `json:"operator"`
	// For more details on risk level, refer to the Tanium documentation.
	RiskLevel param.Field[DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestRiskLevel] `json:"risk_level"`
	// Score Operator
	ScoreOperator param.Field[DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestScoreOperator] `json:"scoreOperator"`
	// For more details on total score, refer to the Tanium documentation.
	TotalScore param.Field[float64] `json:"total_score"`
}

func (DevicePostureNewParamsInputTeamsDevicesTaniumInputRequest) MarshalJSON 

func (r DevicePostureNewParamsInputTeamsDevicesTaniumInputRequest) MarshalJSON() (data []byte, err error)

type DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestOperator 

type DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestOperator string

Operator to evaluate risk_level or eid_last_seen. 

const (
	DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestOperatorUnknown115 DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestOperator = "<"
	DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestOperatorUnknown116 DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestOperator = "<="
	DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestOperatorUnknown117 DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestOperator = ">"
	DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestOperatorUnknown118 DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestOperator = ">="
	DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestOperatorUnknown119 DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestOperator = "=="
)

type DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestRiskLevel 

type DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestRiskLevel string

For more details on risk level, refer to the Tanium documentation. 

const (
	DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestRiskLevelLow      DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestRiskLevel = "low"
	DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestRiskLevelMedium   DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestRiskLevel = "medium"
	DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestRiskLevelHigh     DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestRiskLevel = "high"
	DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestRiskLevelCritical DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestRiskLevel = "critical"
)

type DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestScoreOperator 

type DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestScoreOperator string

Score Operator 

const (
	DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestScoreOperatorUnknown125 DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestScoreOperator = "<"
	DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestScoreOperatorUnknown126 DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestScoreOperator = "<="
	DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestScoreOperatorUnknown127 DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestScoreOperator = ">"
	DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestScoreOperatorUnknown128 DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestScoreOperator = ">="
	DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestScoreOperatorUnknown129 DevicePostureNewParamsInputTeamsDevicesTaniumInputRequestScoreOperator = "=="
)

type DevicePostureNewParamsInputTeamsDevicesUniqueClientIDInputRequest 

type DevicePostureNewParamsInputTeamsDevicesUniqueClientIDInputRequest struct {
	// List ID.
	ID param.Field[string] `json:"id,required"`
	// Operating System
	OperatingSystem param.Field[DevicePostureNewParamsInputTeamsDevicesUniqueClientIDInputRequestOperatingSystem] `json:"operating_system,required"`
}

func (DevicePostureNewParamsInputTeamsDevicesUniqueClientIDInputRequest) MarshalJSON 

func (r DevicePostureNewParamsInputTeamsDevicesUniqueClientIDInputRequest) MarshalJSON() (data []byte, err error)

type DevicePostureNewParamsInputTeamsDevicesUniqueClientIDInputRequestOperatingSystem 

type DevicePostureNewParamsInputTeamsDevicesUniqueClientIDInputRequestOperatingSystem string

Operating System 

const (
	DevicePostureNewParamsInputTeamsDevicesUniqueClientIDInputRequestOperatingSystemAndroid  DevicePostureNewParamsInputTeamsDevicesUniqueClientIDInputRequestOperatingSystem = "android"
	DevicePostureNewParamsInputTeamsDevicesUniqueClientIDInputRequestOperatingSystemIos      DevicePostureNewParamsInputTeamsDevicesUniqueClientIDInputRequestOperatingSystem = "ios"
	DevicePostureNewParamsInputTeamsDevicesUniqueClientIDInputRequestOperatingSystemChromeos DevicePostureNewParamsInputTeamsDevicesUniqueClientIDInputRequestOperatingSystem = "chromeos"
)

type DevicePostureNewParamsInputTeamsDevicesWorkspaceOneInputRequest 

type DevicePostureNewParamsInputTeamsDevicesWorkspaceOneInputRequest struct {
	// Compliance Status
	ComplianceStatus param.Field[DevicePostureNewParamsInputTeamsDevicesWorkspaceOneInputRequestComplianceStatus] `json:"compliance_status,required"`
	// Posture Integration ID.
	ConnectionID param.Field[string] `json:"connection_id,required"`
}

func (DevicePostureNewParamsInputTeamsDevicesWorkspaceOneInputRequest) MarshalJSON 

func (r DevicePostureNewParamsInputTeamsDevicesWorkspaceOneInputRequest) MarshalJSON() (data []byte, err error)

type DevicePostureNewParamsInputTeamsDevicesWorkspaceOneInputRequestComplianceStatus 

type DevicePostureNewParamsInputTeamsDevicesWorkspaceOneInputRequestComplianceStatus string

Compliance Status 

const (
	DevicePostureNewParamsInputTeamsDevicesWorkspaceOneInputRequestComplianceStatusCompliant    DevicePostureNewParamsInputTeamsDevicesWorkspaceOneInputRequestComplianceStatus = "compliant"
	DevicePostureNewParamsInputTeamsDevicesWorkspaceOneInputRequestComplianceStatusNoncompliant DevicePostureNewParamsInputTeamsDevicesWorkspaceOneInputRequestComplianceStatus = "noncompliant"
	DevicePostureNewParamsInputTeamsDevicesWorkspaceOneInputRequestComplianceStatusUnknown      DevicePostureNewParamsInputTeamsDevicesWorkspaceOneInputRequestComplianceStatus = "unknown"
)

type DevicePostureNewParamsMatch 

type DevicePostureNewParamsMatch struct {
	Platform param.Field[DevicePostureNewParamsMatchPlatform] `json:"platform"`
}

func (DevicePostureNewParamsMatch) MarshalJSON 

func (r DevicePostureNewParamsMatch) MarshalJSON() (data []byte, err error)

type DevicePostureNewParamsMatchPlatform 

type DevicePostureNewParamsMatchPlatform string
const (
	DevicePostureNewParamsMatchPlatformWindows DevicePostureNewParamsMatchPlatform = "windows"
	DevicePostureNewParamsMatchPlatformMac     DevicePostureNewParamsMatchPlatform = "mac"
	DevicePostureNewParamsMatchPlatformLinux   DevicePostureNewParamsMatchPlatform = "linux"
	DevicePostureNewParamsMatchPlatformAndroid DevicePostureNewParamsMatchPlatform = "android"
	DevicePostureNewParamsMatchPlatformIos     DevicePostureNewParamsMatchPlatform = "ios"
)

type DevicePostureNewParamsType 

type DevicePostureNewParamsType string

The type of device posture rule. 

const (
	DevicePostureNewParamsTypeFile              DevicePostureNewParamsType = "file"
	DevicePostureNewParamsTypeApplication       DevicePostureNewParamsType = "application"
	DevicePostureNewParamsTypeTanium            DevicePostureNewParamsType = "tanium"
	DevicePostureNewParamsTypeGateway           DevicePostureNewParamsType = "gateway"
	DevicePostureNewParamsTypeWARP              DevicePostureNewParamsType = "warp"
	DevicePostureNewParamsTypeDiskEncryption    DevicePostureNewParamsType = "disk_encryption"
	DevicePostureNewParamsTypeSentinelone       DevicePostureNewParamsType = "sentinelone"
	DevicePostureNewParamsTypeCarbonblack       DevicePostureNewParamsType = "carbonblack"
	DevicePostureNewParamsTypeFirewall          DevicePostureNewParamsType = "firewall"
	DevicePostureNewParamsTypeOSVersion         DevicePostureNewParamsType = "os_version"
	DevicePostureNewParamsTypeDomainJoined      DevicePostureNewParamsType = "domain_joined"
	DevicePostureNewParamsTypeClientCertificate DevicePostureNewParamsType = "client_certificate"
	DevicePostureNewParamsTypeUniqueClientID    DevicePostureNewParamsType = "unique_client_id"
	DevicePostureNewParamsTypeKolide            DevicePostureNewParamsType = "kolide"
	DevicePostureNewParamsTypeTaniumS2s         DevicePostureNewParamsType = "tanium_s2s"
	DevicePostureNewParamsTypeCrowdstrikeS2s    DevicePostureNewParamsType = "crowdstrike_s2s"
	DevicePostureNewParamsTypeIntune            DevicePostureNewParamsType = "intune"
	DevicePostureNewParamsTypeWorkspaceOne      DevicePostureNewParamsType = "workspace_one"
	DevicePostureNewParamsTypeSentineloneS2s    DevicePostureNewParamsType = "sentinelone_s2s"
)

type DevicePostureNewResponseEnvelope 

type DevicePostureNewResponseEnvelope struct {
	Errors   []DevicePostureNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DevicePostureNewResponseEnvelopeMessages `json:"messages,required"`
	Result   TeamsDevicesDevicePostureRules             `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success DevicePostureNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    devicePostureNewResponseEnvelopeJSON    `json:"-"`
}

func (*DevicePostureNewResponseEnvelope) UnmarshalJSON 

func (r *DevicePostureNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DevicePostureNewResponseEnvelopeErrors 

type DevicePostureNewResponseEnvelopeErrors struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    devicePostureNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DevicePostureNewResponseEnvelopeErrors) UnmarshalJSON 

func (r *DevicePostureNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DevicePostureNewResponseEnvelopeMessages 

type DevicePostureNewResponseEnvelopeMessages struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    devicePostureNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DevicePostureNewResponseEnvelopeMessages) UnmarshalJSON 

func (r *DevicePostureNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DevicePostureNewResponseEnvelopeSuccess 

type DevicePostureNewResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DevicePostureNewResponseEnvelopeSuccessTrue DevicePostureNewResponseEnvelopeSuccess = true
)

type DevicePostureService 

type DevicePostureService struct {
	Options      []option.RequestOption
	Integrations *DevicePostureIntegrationService
}

DevicePostureService 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 NewDevicePostureService method instead.

func NewDevicePostureService 

func NewDevicePostureService(opts ...option.RequestOption) (r *DevicePostureService)

NewDevicePostureService 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 (*DevicePostureService) Delete 

func (r *DevicePostureService) Delete(ctx context.Context, ruleID string, body DevicePostureDeleteParams, opts ...option.RequestOption) (res *DevicePostureDeleteResponse, err error)

Deletes a device posture rule.

func (*DevicePostureService) Get 

func (r *DevicePostureService) Get(ctx context.Context, ruleID string, query DevicePostureGetParams, opts ...option.RequestOption) (res *TeamsDevicesDevicePostureRules, err error)

Fetches a single device posture rule.

func (*DevicePostureService) List 

func (r *DevicePostureService) List(ctx context.Context, query DevicePostureListParams, opts ...option.RequestOption) (res *[]TeamsDevicesDevicePostureRules, err error)

Fetches device posture rules for a Zero Trust account.

func (*DevicePostureService) New 

func (r *DevicePostureService) New(ctx context.Context, params DevicePostureNewParams, opts ...option.RequestOption) (res *TeamsDevicesDevicePostureRules, err error)

Creates a new device posture rule.

func (*DevicePostureService) Update 

func (r *DevicePostureService) Update(ctx context.Context, ruleID string, params DevicePostureUpdateParams, opts ...option.RequestOption) (res *TeamsDevicesDevicePostureRules, err error)

Updates a device posture rule.

type DevicePostureUpdateParams 

type DevicePostureUpdateParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
	// The name of the device posture rule.
	Name param.Field[string] `json:"name,required"`
	// The type of device posture rule.
	Type param.Field[DevicePostureUpdateParamsType] `json:"type,required"`
	// The description of the device posture rule.
	Description param.Field[string] `json:"description"`
	// Sets the expiration time for a posture check result. If empty, the result
	// remains valid until it is overwritten by new data from the WARP client.
	Expiration param.Field[string] `json:"expiration"`
	// The value to be checked against.
	Input param.Field[DevicePostureUpdateParamsInput] `json:"input"`
	// The conditions that the client must match to run the rule.
	Match param.Field[[]DevicePostureUpdateParamsMatch] `json:"match"`
	// Polling frequency for the WARP client posture check. Default: `5m` (poll every
	// five minutes). Minimum: `1m`.
	Schedule param.Field[string] `json:"schedule"`
}

func (DevicePostureUpdateParams) MarshalJSON 

func (r DevicePostureUpdateParams) MarshalJSON() (data []byte, err error)

type DevicePostureUpdateParamsInput 

type DevicePostureUpdateParamsInput interface {
	// contains filtered or unexported methods
}

The value to be checked against.

Satisfied by zero_trust.DevicePostureUpdateParamsInputTeamsDevicesFileInputRequest, zero_trust.DevicePostureUpdateParamsInputTeamsDevicesUniqueClientIDInputRequest, zero_trust.DevicePostureUpdateParamsInputTeamsDevicesDomainJoinedInputRequest, zero_trust.DevicePostureUpdateParamsInputTeamsDevicesOSVersionInputRequest, zero_trust.DevicePostureUpdateParamsInputTeamsDevicesFirewallInputRequest, zero_trust.DevicePostureUpdateParamsInputTeamsDevicesSentineloneInputRequest, zero_trust.DevicePostureUpdateParamsInputTeamsDevicesCarbonblackInputRequest, zero_trust.DevicePostureUpdateParamsInputTeamsDevicesDiskEncryptionInputRequest, zero_trust.DevicePostureUpdateParamsInputTeamsDevicesApplicationInputRequest, zero_trust.DevicePostureUpdateParamsInputTeamsDevicesClientCertificateInputRequest, zero_trust.DevicePostureUpdateParamsInputTeamsDevicesWorkspaceOneInputRequest, zero_trust.DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequest, zero_trust.DevicePostureUpdateParamsInputTeamsDevicesIntuneInputRequest, zero_trust.DevicePostureUpdateParamsInputTeamsDevicesKolideInputRequest, zero_trust.DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequest, zero_trust.DevicePostureUpdateParamsInputTeamsDevicesSentineloneS2sInputRequest.

type DevicePostureUpdateParamsInputTeamsDevicesApplicationInputRequest 

type DevicePostureUpdateParamsInputTeamsDevicesApplicationInputRequest struct {
	// Operating system
	OperatingSystem param.Field[DevicePostureUpdateParamsInputTeamsDevicesApplicationInputRequestOperatingSystem] `json:"operating_system,required"`
	// Path for the application.
	Path param.Field[string] `json:"path,required"`
	// SHA-256.
	Sha256 param.Field[string] `json:"sha256"`
	// Signing certificate thumbprint.
	Thumbprint param.Field[string] `json:"thumbprint"`
}

func (DevicePostureUpdateParamsInputTeamsDevicesApplicationInputRequest) MarshalJSON 

func (r DevicePostureUpdateParamsInputTeamsDevicesApplicationInputRequest) MarshalJSON() (data []byte, err error)

type DevicePostureUpdateParamsInputTeamsDevicesApplicationInputRequestOperatingSystem 

type DevicePostureUpdateParamsInputTeamsDevicesApplicationInputRequestOperatingSystem string

Operating system 

const (
	DevicePostureUpdateParamsInputTeamsDevicesApplicationInputRequestOperatingSystemWindows DevicePostureUpdateParamsInputTeamsDevicesApplicationInputRequestOperatingSystem = "windows"
	DevicePostureUpdateParamsInputTeamsDevicesApplicationInputRequestOperatingSystemLinux   DevicePostureUpdateParamsInputTeamsDevicesApplicationInputRequestOperatingSystem = "linux"
	DevicePostureUpdateParamsInputTeamsDevicesApplicationInputRequestOperatingSystemMac     DevicePostureUpdateParamsInputTeamsDevicesApplicationInputRequestOperatingSystem = "mac"
)

type DevicePostureUpdateParamsInputTeamsDevicesCarbonblackInputRequest 

type DevicePostureUpdateParamsInputTeamsDevicesCarbonblackInputRequest struct {
	// Operating system
	OperatingSystem param.Field[DevicePostureUpdateParamsInputTeamsDevicesCarbonblackInputRequestOperatingSystem] `json:"operating_system,required"`
	// File path.
	Path param.Field[string] `json:"path,required"`
	// SHA-256.
	Sha256 param.Field[string] `json:"sha256"`
	// Signing certificate thumbprint.
	Thumbprint param.Field[string] `json:"thumbprint"`
}

func (DevicePostureUpdateParamsInputTeamsDevicesCarbonblackInputRequest) MarshalJSON 

func (r DevicePostureUpdateParamsInputTeamsDevicesCarbonblackInputRequest) MarshalJSON() (data []byte, err error)

type DevicePostureUpdateParamsInputTeamsDevicesCarbonblackInputRequestOperatingSystem 

type DevicePostureUpdateParamsInputTeamsDevicesCarbonblackInputRequestOperatingSystem string

Operating system 

const (
	DevicePostureUpdateParamsInputTeamsDevicesCarbonblackInputRequestOperatingSystemWindows DevicePostureUpdateParamsInputTeamsDevicesCarbonblackInputRequestOperatingSystem = "windows"
	DevicePostureUpdateParamsInputTeamsDevicesCarbonblackInputRequestOperatingSystemLinux   DevicePostureUpdateParamsInputTeamsDevicesCarbonblackInputRequestOperatingSystem = "linux"
	DevicePostureUpdateParamsInputTeamsDevicesCarbonblackInputRequestOperatingSystemMac     DevicePostureUpdateParamsInputTeamsDevicesCarbonblackInputRequestOperatingSystem = "mac"
)

type DevicePostureUpdateParamsInputTeamsDevicesClientCertificateInputRequest 

type DevicePostureUpdateParamsInputTeamsDevicesClientCertificateInputRequest struct {
	// UUID of Cloudflare managed certificate.
	CertificateID param.Field[string] `json:"certificate_id,required"`
	// Common Name that is protected by the certificate
	Cn param.Field[string] `json:"cn,required"`
}

func (DevicePostureUpdateParamsInputTeamsDevicesClientCertificateInputRequest) MarshalJSON 

func (r DevicePostureUpdateParamsInputTeamsDevicesClientCertificateInputRequest) MarshalJSON() (data []byte, err error)

type DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequest 

type DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequest struct {
	// Posture Integration ID.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// For more details on last seen, please refer to the Crowdstrike documentation.
	LastSeen param.Field[string] `json:"last_seen"`
	// Operator
	Operator param.Field[DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequestOperator] `json:"operator"`
	// Os Version
	OS param.Field[string] `json:"os"`
	// overall
	Overall param.Field[string] `json:"overall"`
	// SensorConfig
	SensorConfig param.Field[string] `json:"sensor_config"`
	// For more details on state, please refer to the Crowdstrike documentation.
	State param.Field[DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequestState] `json:"state"`
	// Version
	Version param.Field[string] `json:"version"`
	// Version Operator
	VersionOperator param.Field[DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequestVersionOperator] `json:"versionOperator"`
}

func (DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequest) MarshalJSON 

func (r DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequest) MarshalJSON() (data []byte, err error)

type DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequestOperator 

type DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequestOperator string

Operator 

const (
	DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequestOperatorUnknown155 DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequestOperator = "<"
	DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequestOperatorUnknown156 DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequestOperator = "<="
	DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequestOperatorUnknown157 DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequestOperator = ">"
	DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequestOperatorUnknown158 DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequestOperator = ">="
	DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequestOperatorUnknown159 DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequestOperator = "=="
)

type DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequestState 

type DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequestState string

For more details on state, please refer to the Crowdstrike documentation. 

const (
	DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequestStateOnline  DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequestState = "online"
	DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequestStateOffline DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequestState = "offline"
	DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequestStateUnknown DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequestState = "unknown"
)

type DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequestVersionOperator 

type DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequestVersionOperator string

Version Operator 

const (
	DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequestVersionOperatorUnknown165 DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequestVersionOperator = "<"
	DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequestVersionOperatorUnknown166 DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequestVersionOperator = "<="
	DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequestVersionOperatorUnknown167 DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequestVersionOperator = ">"
	DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequestVersionOperatorUnknown168 DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequestVersionOperator = ">="
	DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequestVersionOperatorUnknown169 DevicePostureUpdateParamsInputTeamsDevicesCrowdstrikeInputRequestVersionOperator = "=="
)

type DevicePostureUpdateParamsInputTeamsDevicesDiskEncryptionInputRequest 

type DevicePostureUpdateParamsInputTeamsDevicesDiskEncryptionInputRequest struct {
	// List of volume names to be checked for encryption.
	CheckDisks param.Field[[]string] `json:"checkDisks"`
	// Whether to check all disks for encryption.
	RequireAll param.Field[bool] `json:"requireAll"`
}

func (DevicePostureUpdateParamsInputTeamsDevicesDiskEncryptionInputRequest) MarshalJSON 

func (r DevicePostureUpdateParamsInputTeamsDevicesDiskEncryptionInputRequest) MarshalJSON() (data []byte, err error)

type DevicePostureUpdateParamsInputTeamsDevicesDomainJoinedInputRequest 

type DevicePostureUpdateParamsInputTeamsDevicesDomainJoinedInputRequest struct {
	// Operating System
	OperatingSystem param.Field[DevicePostureUpdateParamsInputTeamsDevicesDomainJoinedInputRequestOperatingSystem] `json:"operating_system,required"`
	// Domain
	Domain param.Field[string] `json:"domain"`
}

func (DevicePostureUpdateParamsInputTeamsDevicesDomainJoinedInputRequest) MarshalJSON 

func (r DevicePostureUpdateParamsInputTeamsDevicesDomainJoinedInputRequest) MarshalJSON() (data []byte, err error)

type DevicePostureUpdateParamsInputTeamsDevicesDomainJoinedInputRequestOperatingSystem 

type DevicePostureUpdateParamsInputTeamsDevicesDomainJoinedInputRequestOperatingSystem string

Operating System 

const (
	DevicePostureUpdateParamsInputTeamsDevicesDomainJoinedInputRequestOperatingSystemWindows DevicePostureUpdateParamsInputTeamsDevicesDomainJoinedInputRequestOperatingSystem = "windows"
)

type DevicePostureUpdateParamsInputTeamsDevicesFileInputRequest 

type DevicePostureUpdateParamsInputTeamsDevicesFileInputRequest struct {
	// Operating system
	OperatingSystem param.Field[DevicePostureUpdateParamsInputTeamsDevicesFileInputRequestOperatingSystem] `json:"operating_system,required"`
	// File path.
	Path param.Field[string] `json:"path,required"`
	// Whether or not file exists
	Exists param.Field[bool] `json:"exists"`
	// SHA-256.
	Sha256 param.Field[string] `json:"sha256"`
	// Signing certificate thumbprint.
	Thumbprint param.Field[string] `json:"thumbprint"`
}

func (DevicePostureUpdateParamsInputTeamsDevicesFileInputRequest) MarshalJSON 

func (r DevicePostureUpdateParamsInputTeamsDevicesFileInputRequest) MarshalJSON() (data []byte, err error)

type DevicePostureUpdateParamsInputTeamsDevicesFileInputRequestOperatingSystem 

type DevicePostureUpdateParamsInputTeamsDevicesFileInputRequestOperatingSystem string

Operating system 

const (
	DevicePostureUpdateParamsInputTeamsDevicesFileInputRequestOperatingSystemWindows DevicePostureUpdateParamsInputTeamsDevicesFileInputRequestOperatingSystem = "windows"
	DevicePostureUpdateParamsInputTeamsDevicesFileInputRequestOperatingSystemLinux   DevicePostureUpdateParamsInputTeamsDevicesFileInputRequestOperatingSystem = "linux"
	DevicePostureUpdateParamsInputTeamsDevicesFileInputRequestOperatingSystemMac     DevicePostureUpdateParamsInputTeamsDevicesFileInputRequestOperatingSystem = "mac"
)

type DevicePostureUpdateParamsInputTeamsDevicesFirewallInputRequest 

type DevicePostureUpdateParamsInputTeamsDevicesFirewallInputRequest struct {
	// Enabled
	Enabled param.Field[bool] `json:"enabled,required"`
	// Operating System
	OperatingSystem param.Field[DevicePostureUpdateParamsInputTeamsDevicesFirewallInputRequestOperatingSystem] `json:"operating_system,required"`
}

func (DevicePostureUpdateParamsInputTeamsDevicesFirewallInputRequest) MarshalJSON 

func (r DevicePostureUpdateParamsInputTeamsDevicesFirewallInputRequest) MarshalJSON() (data []byte, err error)

type DevicePostureUpdateParamsInputTeamsDevicesFirewallInputRequestOperatingSystem 

type DevicePostureUpdateParamsInputTeamsDevicesFirewallInputRequestOperatingSystem string

Operating System 

const (
	DevicePostureUpdateParamsInputTeamsDevicesFirewallInputRequestOperatingSystemWindows DevicePostureUpdateParamsInputTeamsDevicesFirewallInputRequestOperatingSystem = "windows"
	DevicePostureUpdateParamsInputTeamsDevicesFirewallInputRequestOperatingSystemMac     DevicePostureUpdateParamsInputTeamsDevicesFirewallInputRequestOperatingSystem = "mac"
)

type DevicePostureUpdateParamsInputTeamsDevicesIntuneInputRequest 

type DevicePostureUpdateParamsInputTeamsDevicesIntuneInputRequest struct {
	// Compliance Status
	ComplianceStatus param.Field[DevicePostureUpdateParamsInputTeamsDevicesIntuneInputRequestComplianceStatus] `json:"compliance_status,required"`
	// Posture Integration ID.
	ConnectionID param.Field[string] `json:"connection_id,required"`
}

func (DevicePostureUpdateParamsInputTeamsDevicesIntuneInputRequest) MarshalJSON 

func (r DevicePostureUpdateParamsInputTeamsDevicesIntuneInputRequest) MarshalJSON() (data []byte, err error)

type DevicePostureUpdateParamsInputTeamsDevicesIntuneInputRequestComplianceStatus 

type DevicePostureUpdateParamsInputTeamsDevicesIntuneInputRequestComplianceStatus string

Compliance Status 

const (
	DevicePostureUpdateParamsInputTeamsDevicesIntuneInputRequestComplianceStatusCompliant     DevicePostureUpdateParamsInputTeamsDevicesIntuneInputRequestComplianceStatus = "compliant"
	DevicePostureUpdateParamsInputTeamsDevicesIntuneInputRequestComplianceStatusNoncompliant  DevicePostureUpdateParamsInputTeamsDevicesIntuneInputRequestComplianceStatus = "noncompliant"
	DevicePostureUpdateParamsInputTeamsDevicesIntuneInputRequestComplianceStatusUnknown       DevicePostureUpdateParamsInputTeamsDevicesIntuneInputRequestComplianceStatus = "unknown"
	DevicePostureUpdateParamsInputTeamsDevicesIntuneInputRequestComplianceStatusNotapplicable DevicePostureUpdateParamsInputTeamsDevicesIntuneInputRequestComplianceStatus = "notapplicable"
	DevicePostureUpdateParamsInputTeamsDevicesIntuneInputRequestComplianceStatusIngraceperiod DevicePostureUpdateParamsInputTeamsDevicesIntuneInputRequestComplianceStatus = "ingraceperiod"
	DevicePostureUpdateParamsInputTeamsDevicesIntuneInputRequestComplianceStatusError         DevicePostureUpdateParamsInputTeamsDevicesIntuneInputRequestComplianceStatus = "error"
)

type DevicePostureUpdateParamsInputTeamsDevicesKolideInputRequest 

type DevicePostureUpdateParamsInputTeamsDevicesKolideInputRequest struct {
	// Posture Integration ID.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// Count Operator
	CountOperator param.Field[DevicePostureUpdateParamsInputTeamsDevicesKolideInputRequestCountOperator] `json:"countOperator,required"`
	// The Number of Issues.
	IssueCount param.Field[string] `json:"issue_count,required"`
}

func (DevicePostureUpdateParamsInputTeamsDevicesKolideInputRequest) MarshalJSON 

func (r DevicePostureUpdateParamsInputTeamsDevicesKolideInputRequest) MarshalJSON() (data []byte, err error)

type DevicePostureUpdateParamsInputTeamsDevicesKolideInputRequestCountOperator 

type DevicePostureUpdateParamsInputTeamsDevicesKolideInputRequestCountOperator string

Count Operator 

const (
	DevicePostureUpdateParamsInputTeamsDevicesKolideInputRequestCountOperatorUnknown175 DevicePostureUpdateParamsInputTeamsDevicesKolideInputRequestCountOperator = "<"
	DevicePostureUpdateParamsInputTeamsDevicesKolideInputRequestCountOperatorUnknown176 DevicePostureUpdateParamsInputTeamsDevicesKolideInputRequestCountOperator = "<="
	DevicePostureUpdateParamsInputTeamsDevicesKolideInputRequestCountOperatorUnknown177 DevicePostureUpdateParamsInputTeamsDevicesKolideInputRequestCountOperator = ">"
	DevicePostureUpdateParamsInputTeamsDevicesKolideInputRequestCountOperatorUnknown178 DevicePostureUpdateParamsInputTeamsDevicesKolideInputRequestCountOperator = ">="
	DevicePostureUpdateParamsInputTeamsDevicesKolideInputRequestCountOperatorUnknown179 DevicePostureUpdateParamsInputTeamsDevicesKolideInputRequestCountOperator = "=="
)

type DevicePostureUpdateParamsInputTeamsDevicesOSVersionInputRequest 

type DevicePostureUpdateParamsInputTeamsDevicesOSVersionInputRequest struct {
	// Operating System
	OperatingSystem param.Field[DevicePostureUpdateParamsInputTeamsDevicesOSVersionInputRequestOperatingSystem] `json:"operating_system,required"`
	// Operator
	Operator param.Field[DevicePostureUpdateParamsInputTeamsDevicesOSVersionInputRequestOperator] `json:"operator,required"`
	// Version of OS
	Version param.Field[string] `json:"version,required"`
	// Operating System Distribution Name (linux only)
	OSDistroName param.Field[string] `json:"os_distro_name"`
	// Version of OS Distribution (linux only)
	OSDistroRevision param.Field[string] `json:"os_distro_revision"`
	// Additional version data. For Mac or iOS, the Product Verison Extra. For Linux,
	// the kernel release version. (Mac, iOS, and Linux only)
	OSVersionExtra param.Field[string] `json:"os_version_extra"`
}

func (DevicePostureUpdateParamsInputTeamsDevicesOSVersionInputRequest) MarshalJSON 

func (r DevicePostureUpdateParamsInputTeamsDevicesOSVersionInputRequest) MarshalJSON() (data []byte, err error)

type DevicePostureUpdateParamsInputTeamsDevicesOSVersionInputRequestOperatingSystem 

type DevicePostureUpdateParamsInputTeamsDevicesOSVersionInputRequestOperatingSystem string

Operating System 

const (
	DevicePostureUpdateParamsInputTeamsDevicesOSVersionInputRequestOperatingSystemWindows DevicePostureUpdateParamsInputTeamsDevicesOSVersionInputRequestOperatingSystem = "windows"
)

type DevicePostureUpdateParamsInputTeamsDevicesOSVersionInputRequestOperator 

type DevicePostureUpdateParamsInputTeamsDevicesOSVersionInputRequestOperator string

Operator 

const (
	DevicePostureUpdateParamsInputTeamsDevicesOSVersionInputRequestOperatorUnknown145 DevicePostureUpdateParamsInputTeamsDevicesOSVersionInputRequestOperator = "<"
	DevicePostureUpdateParamsInputTeamsDevicesOSVersionInputRequestOperatorUnknown146 DevicePostureUpdateParamsInputTeamsDevicesOSVersionInputRequestOperator = "<="
	DevicePostureUpdateParamsInputTeamsDevicesOSVersionInputRequestOperatorUnknown147 DevicePostureUpdateParamsInputTeamsDevicesOSVersionInputRequestOperator = ">"
	DevicePostureUpdateParamsInputTeamsDevicesOSVersionInputRequestOperatorUnknown148 DevicePostureUpdateParamsInputTeamsDevicesOSVersionInputRequestOperator = ">="
	DevicePostureUpdateParamsInputTeamsDevicesOSVersionInputRequestOperatorUnknown149 DevicePostureUpdateParamsInputTeamsDevicesOSVersionInputRequestOperator = "=="
)

type DevicePostureUpdateParamsInputTeamsDevicesSentineloneInputRequest 

type DevicePostureUpdateParamsInputTeamsDevicesSentineloneInputRequest struct {
	// Operating system
	OperatingSystem param.Field[DevicePostureUpdateParamsInputTeamsDevicesSentineloneInputRequestOperatingSystem] `json:"operating_system,required"`
	// File path.
	Path param.Field[string] `json:"path,required"`
	// SHA-256.
	Sha256 param.Field[string] `json:"sha256"`
	// Signing certificate thumbprint.
	Thumbprint param.Field[string] `json:"thumbprint"`
}

func (DevicePostureUpdateParamsInputTeamsDevicesSentineloneInputRequest) MarshalJSON 

func (r DevicePostureUpdateParamsInputTeamsDevicesSentineloneInputRequest) MarshalJSON() (data []byte, err error)

type DevicePostureUpdateParamsInputTeamsDevicesSentineloneInputRequestOperatingSystem 

type DevicePostureUpdateParamsInputTeamsDevicesSentineloneInputRequestOperatingSystem string

Operating system 

const (
	DevicePostureUpdateParamsInputTeamsDevicesSentineloneInputRequestOperatingSystemWindows DevicePostureUpdateParamsInputTeamsDevicesSentineloneInputRequestOperatingSystem = "windows"
	DevicePostureUpdateParamsInputTeamsDevicesSentineloneInputRequestOperatingSystemLinux   DevicePostureUpdateParamsInputTeamsDevicesSentineloneInputRequestOperatingSystem = "linux"
	DevicePostureUpdateParamsInputTeamsDevicesSentineloneInputRequestOperatingSystemMac     DevicePostureUpdateParamsInputTeamsDevicesSentineloneInputRequestOperatingSystem = "mac"
)

type DevicePostureUpdateParamsInputTeamsDevicesSentineloneS2sInputRequest 

type DevicePostureUpdateParamsInputTeamsDevicesSentineloneS2sInputRequest struct {
	// Posture Integration ID.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// The Number of active threats.
	ActiveThreats param.Field[float64] `json:"active_threats"`
	// Whether device is infected.
	Infected param.Field[bool] `json:"infected"`
	// Whether device is active.
	IsActive param.Field[bool] `json:"is_active"`
	// Network status of device.
	NetworkStatus param.Field[DevicePostureUpdateParamsInputTeamsDevicesSentineloneS2sInputRequestNetworkStatus] `json:"network_status"`
	// operator
	Operator param.Field[DevicePostureUpdateParamsInputTeamsDevicesSentineloneS2sInputRequestOperator] `json:"operator"`
}

func (DevicePostureUpdateParamsInputTeamsDevicesSentineloneS2sInputRequest) MarshalJSON 

func (r DevicePostureUpdateParamsInputTeamsDevicesSentineloneS2sInputRequest) MarshalJSON() (data []byte, err error)

type DevicePostureUpdateParamsInputTeamsDevicesSentineloneS2sInputRequestNetworkStatus 

type DevicePostureUpdateParamsInputTeamsDevicesSentineloneS2sInputRequestNetworkStatus string

Network status of device. 

const (
	DevicePostureUpdateParamsInputTeamsDevicesSentineloneS2sInputRequestNetworkStatusConnected     DevicePostureUpdateParamsInputTeamsDevicesSentineloneS2sInputRequestNetworkStatus = "connected"
	DevicePostureUpdateParamsInputTeamsDevicesSentineloneS2sInputRequestNetworkStatusDisconnected  DevicePostureUpdateParamsInputTeamsDevicesSentineloneS2sInputRequestNetworkStatus = "disconnected"
	DevicePostureUpdateParamsInputTeamsDevicesSentineloneS2sInputRequestNetworkStatusDisconnecting DevicePostureUpdateParamsInputTeamsDevicesSentineloneS2sInputRequestNetworkStatus = "disconnecting"
	DevicePostureUpdateParamsInputTeamsDevicesSentineloneS2sInputRequestNetworkStatusConnecting    DevicePostureUpdateParamsInputTeamsDevicesSentineloneS2sInputRequestNetworkStatus = "connecting"
)

type DevicePostureUpdateParamsInputTeamsDevicesSentineloneS2sInputRequestOperator 

type DevicePostureUpdateParamsInputTeamsDevicesSentineloneS2sInputRequestOperator string

operator 

const (
	DevicePostureUpdateParamsInputTeamsDevicesSentineloneS2sInputRequestOperatorUnknown205 DevicePostureUpdateParamsInputTeamsDevicesSentineloneS2sInputRequestOperator = "<"
	DevicePostureUpdateParamsInputTeamsDevicesSentineloneS2sInputRequestOperatorUnknown206 DevicePostureUpdateParamsInputTeamsDevicesSentineloneS2sInputRequestOperator = "<="
	DevicePostureUpdateParamsInputTeamsDevicesSentineloneS2sInputRequestOperatorUnknown207 DevicePostureUpdateParamsInputTeamsDevicesSentineloneS2sInputRequestOperator = ">"
	DevicePostureUpdateParamsInputTeamsDevicesSentineloneS2sInputRequestOperatorUnknown208 DevicePostureUpdateParamsInputTeamsDevicesSentineloneS2sInputRequestOperator = ">="
	DevicePostureUpdateParamsInputTeamsDevicesSentineloneS2sInputRequestOperatorUnknown209 DevicePostureUpdateParamsInputTeamsDevicesSentineloneS2sInputRequestOperator = "=="
)

type DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequest 

type DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequest struct {
	// Posture Integration ID.
	ConnectionID param.Field[string] `json:"connection_id,required"`
	// For more details on eid last seen, refer to the Tanium documentation.
	EidLastSeen param.Field[string] `json:"eid_last_seen"`
	// Operator to evaluate risk_level or eid_last_seen.
	Operator param.Field[DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestOperator] `json:"operator"`
	// For more details on risk level, refer to the Tanium documentation.
	RiskLevel param.Field[DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestRiskLevel] `json:"risk_level"`
	// Score Operator
	ScoreOperator param.Field[DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestScoreOperator] `json:"scoreOperator"`
	// For more details on total score, refer to the Tanium documentation.
	TotalScore param.Field[float64] `json:"total_score"`
}

func (DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequest) MarshalJSON 

func (r DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequest) MarshalJSON() (data []byte, err error)

type DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestOperator 

type DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestOperator string

Operator to evaluate risk_level or eid_last_seen. 

const (
	DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestOperatorUnknown185 DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestOperator = "<"
	DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestOperatorUnknown186 DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestOperator = "<="
	DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestOperatorUnknown187 DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestOperator = ">"
	DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestOperatorUnknown188 DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestOperator = ">="
	DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestOperatorUnknown189 DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestOperator = "=="
)

type DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestRiskLevel 

type DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestRiskLevel string

For more details on risk level, refer to the Tanium documentation. 

const (
	DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestRiskLevelLow      DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestRiskLevel = "low"
	DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestRiskLevelMedium   DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestRiskLevel = "medium"
	DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestRiskLevelHigh     DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestRiskLevel = "high"
	DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestRiskLevelCritical DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestRiskLevel = "critical"
)

type DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestScoreOperator 

type DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestScoreOperator string

Score Operator 

const (
	DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestScoreOperatorUnknown195 DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestScoreOperator = "<"
	DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestScoreOperatorUnknown196 DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestScoreOperator = "<="
	DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestScoreOperatorUnknown197 DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestScoreOperator = ">"
	DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestScoreOperatorUnknown198 DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestScoreOperator = ">="
	DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestScoreOperatorUnknown199 DevicePostureUpdateParamsInputTeamsDevicesTaniumInputRequestScoreOperator = "=="
)

type DevicePostureUpdateParamsInputTeamsDevicesUniqueClientIDInputRequest 

type DevicePostureUpdateParamsInputTeamsDevicesUniqueClientIDInputRequest struct {
	// List ID.
	ID param.Field[string] `json:"id,required"`
	// Operating System
	OperatingSystem param.Field[DevicePostureUpdateParamsInputTeamsDevicesUniqueClientIDInputRequestOperatingSystem] `json:"operating_system,required"`
}

func (DevicePostureUpdateParamsInputTeamsDevicesUniqueClientIDInputRequest) MarshalJSON 

func (r DevicePostureUpdateParamsInputTeamsDevicesUniqueClientIDInputRequest) MarshalJSON() (data []byte, err error)

type DevicePostureUpdateParamsInputTeamsDevicesUniqueClientIDInputRequestOperatingSystem 

type DevicePostureUpdateParamsInputTeamsDevicesUniqueClientIDInputRequestOperatingSystem string

Operating System 

const (
	DevicePostureUpdateParamsInputTeamsDevicesUniqueClientIDInputRequestOperatingSystemAndroid  DevicePostureUpdateParamsInputTeamsDevicesUniqueClientIDInputRequestOperatingSystem = "android"
	DevicePostureUpdateParamsInputTeamsDevicesUniqueClientIDInputRequestOperatingSystemIos      DevicePostureUpdateParamsInputTeamsDevicesUniqueClientIDInputRequestOperatingSystem = "ios"
	DevicePostureUpdateParamsInputTeamsDevicesUniqueClientIDInputRequestOperatingSystemChromeos DevicePostureUpdateParamsInputTeamsDevicesUniqueClientIDInputRequestOperatingSystem = "chromeos"
)

type DevicePostureUpdateParamsInputTeamsDevicesWorkspaceOneInputRequest 

type DevicePostureUpdateParamsInputTeamsDevicesWorkspaceOneInputRequest struct {
	// Compliance Status
	ComplianceStatus param.Field[DevicePostureUpdateParamsInputTeamsDevicesWorkspaceOneInputRequestComplianceStatus] `json:"compliance_status,required"`
	// Posture Integration ID.
	ConnectionID param.Field[string] `json:"connection_id,required"`
}

func (DevicePostureUpdateParamsInputTeamsDevicesWorkspaceOneInputRequest) MarshalJSON 

func (r DevicePostureUpdateParamsInputTeamsDevicesWorkspaceOneInputRequest) MarshalJSON() (data []byte, err error)

type DevicePostureUpdateParamsInputTeamsDevicesWorkspaceOneInputRequestComplianceStatus 

type DevicePostureUpdateParamsInputTeamsDevicesWorkspaceOneInputRequestComplianceStatus string

Compliance Status 

const (
	DevicePostureUpdateParamsInputTeamsDevicesWorkspaceOneInputRequestComplianceStatusCompliant    DevicePostureUpdateParamsInputTeamsDevicesWorkspaceOneInputRequestComplianceStatus = "compliant"
	DevicePostureUpdateParamsInputTeamsDevicesWorkspaceOneInputRequestComplianceStatusNoncompliant DevicePostureUpdateParamsInputTeamsDevicesWorkspaceOneInputRequestComplianceStatus = "noncompliant"
	DevicePostureUpdateParamsInputTeamsDevicesWorkspaceOneInputRequestComplianceStatusUnknown      DevicePostureUpdateParamsInputTeamsDevicesWorkspaceOneInputRequestComplianceStatus = "unknown"
)

type DevicePostureUpdateParamsMatch 

type DevicePostureUpdateParamsMatch struct {
	Platform param.Field[DevicePostureUpdateParamsMatchPlatform] `json:"platform"`
}

func (DevicePostureUpdateParamsMatch) MarshalJSON 

func (r DevicePostureUpdateParamsMatch) MarshalJSON() (data []byte, err error)

type DevicePostureUpdateParamsMatchPlatform 

type DevicePostureUpdateParamsMatchPlatform string
const (
	DevicePostureUpdateParamsMatchPlatformWindows DevicePostureUpdateParamsMatchPlatform = "windows"
	DevicePostureUpdateParamsMatchPlatformMac     DevicePostureUpdateParamsMatchPlatform = "mac"
	DevicePostureUpdateParamsMatchPlatformLinux   DevicePostureUpdateParamsMatchPlatform = "linux"
	DevicePostureUpdateParamsMatchPlatformAndroid DevicePostureUpdateParamsMatchPlatform = "android"
	DevicePostureUpdateParamsMatchPlatformIos     DevicePostureUpdateParamsMatchPlatform = "ios"
)

type DevicePostureUpdateParamsType 

type DevicePostureUpdateParamsType string

The type of device posture rule. 

const (
	DevicePostureUpdateParamsTypeFile              DevicePostureUpdateParamsType = "file"
	DevicePostureUpdateParamsTypeApplication       DevicePostureUpdateParamsType = "application"
	DevicePostureUpdateParamsTypeTanium            DevicePostureUpdateParamsType = "tanium"
	DevicePostureUpdateParamsTypeGateway           DevicePostureUpdateParamsType = "gateway"
	DevicePostureUpdateParamsTypeWARP              DevicePostureUpdateParamsType = "warp"
	DevicePostureUpdateParamsTypeDiskEncryption    DevicePostureUpdateParamsType = "disk_encryption"
	DevicePostureUpdateParamsTypeSentinelone       DevicePostureUpdateParamsType = "sentinelone"
	DevicePostureUpdateParamsTypeCarbonblack       DevicePostureUpdateParamsType = "carbonblack"
	DevicePostureUpdateParamsTypeFirewall          DevicePostureUpdateParamsType = "firewall"
	DevicePostureUpdateParamsTypeOSVersion         DevicePostureUpdateParamsType = "os_version"
	DevicePostureUpdateParamsTypeDomainJoined      DevicePostureUpdateParamsType = "domain_joined"
	DevicePostureUpdateParamsTypeClientCertificate DevicePostureUpdateParamsType = "client_certificate"
	DevicePostureUpdateParamsTypeUniqueClientID    DevicePostureUpdateParamsType = "unique_client_id"
	DevicePostureUpdateParamsTypeKolide            DevicePostureUpdateParamsType = "kolide"
	DevicePostureUpdateParamsTypeTaniumS2s         DevicePostureUpdateParamsType = "tanium_s2s"
	DevicePostureUpdateParamsTypeCrowdstrikeS2s    DevicePostureUpdateParamsType = "crowdstrike_s2s"
	DevicePostureUpdateParamsTypeIntune            DevicePostureUpdateParamsType = "intune"
	DevicePostureUpdateParamsTypeWorkspaceOne      DevicePostureUpdateParamsType = "workspace_one"
	DevicePostureUpdateParamsTypeSentineloneS2s    DevicePostureUpdateParamsType = "sentinelone_s2s"
)

type DevicePostureUpdateResponseEnvelope 

type DevicePostureUpdateResponseEnvelope struct {
	Errors   []DevicePostureUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DevicePostureUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   TeamsDevicesDevicePostureRules                `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success DevicePostureUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    devicePostureUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*DevicePostureUpdateResponseEnvelope) UnmarshalJSON 

func (r *DevicePostureUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DevicePostureUpdateResponseEnvelopeErrors 

type DevicePostureUpdateResponseEnvelopeErrors struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    devicePostureUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DevicePostureUpdateResponseEnvelopeErrors) UnmarshalJSON 

func (r *DevicePostureUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DevicePostureUpdateResponseEnvelopeMessages 

type DevicePostureUpdateResponseEnvelopeMessages struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    devicePostureUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DevicePostureUpdateResponseEnvelopeMessages) UnmarshalJSON 

func (r *DevicePostureUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DevicePostureUpdateResponseEnvelopeSuccess 

type DevicePostureUpdateResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DevicePostureUpdateResponseEnvelopeSuccessTrue DevicePostureUpdateResponseEnvelopeSuccess = true
)

type DeviceRevokeNewParams 

type DeviceRevokeNewParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
	// A list of device ids to revoke.
	Body param.Field[[]string] `json:"body,required"`
}

func (DeviceRevokeNewParams) MarshalJSON 

func (r DeviceRevokeNewParams) MarshalJSON() (data []byte, err error)

type DeviceRevokeNewResponse 

type DeviceRevokeNewResponse interface {
	ImplementsZeroTrustDeviceRevokeNewResponse()
}

Union satisfied by zero_trust.DeviceRevokeNewResponseUnknown or shared.UnionString.

type DeviceRevokeNewResponseEnvelope 

type DeviceRevokeNewResponseEnvelope struct {
	Errors   []DeviceRevokeNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DeviceRevokeNewResponseEnvelopeMessages `json:"messages,required"`
	Result   DeviceRevokeNewResponse                   `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success DeviceRevokeNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    deviceRevokeNewResponseEnvelopeJSON    `json:"-"`
}

func (*DeviceRevokeNewResponseEnvelope) UnmarshalJSON 

func (r *DeviceRevokeNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DeviceRevokeNewResponseEnvelopeErrors 

type DeviceRevokeNewResponseEnvelopeErrors struct {
	Code    int64                                     `json:"code,required"`
	Message string                                    `json:"message,required"`
	JSON    deviceRevokeNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DeviceRevokeNewResponseEnvelopeErrors) UnmarshalJSON 

func (r *DeviceRevokeNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DeviceRevokeNewResponseEnvelopeMessages 

type DeviceRevokeNewResponseEnvelopeMessages struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    deviceRevokeNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DeviceRevokeNewResponseEnvelopeMessages) UnmarshalJSON 

func (r *DeviceRevokeNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DeviceRevokeNewResponseEnvelopeSuccess 

type DeviceRevokeNewResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DeviceRevokeNewResponseEnvelopeSuccessTrue DeviceRevokeNewResponseEnvelopeSuccess = true
)

type DeviceRevokeService 

type DeviceRevokeService struct {
	Options []option.RequestOption
}

DeviceRevokeService 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 NewDeviceRevokeService method instead.

func NewDeviceRevokeService 

func NewDeviceRevokeService(opts ...option.RequestOption) (r *DeviceRevokeService)

NewDeviceRevokeService 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 (*DeviceRevokeService) New 

func (r *DeviceRevokeService) New(ctx context.Context, params DeviceRevokeNewParams, opts ...option.RequestOption) (res *DeviceRevokeNewResponse, err error)

Revokes a list of devices.

type DeviceService 

type DeviceService struct {
	Options       []option.RequestOption
	DEXTests      *DeviceDEXTestService
	Networks      *DeviceNetworkService
	Policies      *DevicePolicyService
	Posture       *DevicePostureService
	Revokes       *DeviceRevokeService
	Settings      *DeviceSettingService
	Unrevokes     *DeviceUnrevokeService
	OverrideCodes *DeviceOverrideCodeService
}

DeviceService 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 NewDeviceService method instead.

func NewDeviceService 

func NewDeviceService(opts ...option.RequestOption) (r *DeviceService)

NewDeviceService 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 (*DeviceService) Get 

func (r *DeviceService) Get(ctx context.Context, deviceID string, query DeviceGetParams, opts ...option.RequestOption) (res *DeviceGetResponse, err error)

Fetches details for a single device.

func (*DeviceService) List 

func (r *DeviceService) List(ctx context.Context, query DeviceListParams, opts ...option.RequestOption) (res *[]TeamsDevicesDevices, err error)

Fetches a list of enrolled devices.

type DeviceSettingListParams 

type DeviceSettingListParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type DeviceSettingListResponseEnvelope 

type DeviceSettingListResponseEnvelope struct {
	Errors   []DeviceSettingListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DeviceSettingListResponseEnvelopeMessages `json:"messages,required"`
	Result   TeamsDevicesZeroTrustAccountDeviceSettings  `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success DeviceSettingListResponseEnvelopeSuccess `json:"success,required"`
	JSON    deviceSettingListResponseEnvelopeJSON    `json:"-"`
}

func (*DeviceSettingListResponseEnvelope) UnmarshalJSON 

func (r *DeviceSettingListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DeviceSettingListResponseEnvelopeErrors 

type DeviceSettingListResponseEnvelopeErrors struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    deviceSettingListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DeviceSettingListResponseEnvelopeErrors) UnmarshalJSON 

func (r *DeviceSettingListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DeviceSettingListResponseEnvelopeMessages 

type DeviceSettingListResponseEnvelopeMessages struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    deviceSettingListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DeviceSettingListResponseEnvelopeMessages) UnmarshalJSON 

func (r *DeviceSettingListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DeviceSettingListResponseEnvelopeSuccess 

type DeviceSettingListResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DeviceSettingListResponseEnvelopeSuccessTrue DeviceSettingListResponseEnvelopeSuccess = true
)

type DeviceSettingService 

type DeviceSettingService struct {
	Options []option.RequestOption
}

DeviceSettingService 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 NewDeviceSettingService method instead.

func NewDeviceSettingService 

func NewDeviceSettingService(opts ...option.RequestOption) (r *DeviceSettingService)

NewDeviceSettingService 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 (*DeviceSettingService) List 

func (r *DeviceSettingService) List(ctx context.Context, query DeviceSettingListParams, opts ...option.RequestOption) (res *TeamsDevicesZeroTrustAccountDeviceSettings, err error)

Describes the current device settings for a Zero Trust account.

func (*DeviceSettingService) Update 

func (r *DeviceSettingService) Update(ctx context.Context, params DeviceSettingUpdateParams, opts ...option.RequestOption) (res *TeamsDevicesZeroTrustAccountDeviceSettings, err error)

Updates the current device settings for a Zero Trust account.

type DeviceSettingUpdateParams 

type DeviceSettingUpdateParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
	// Enable gateway proxy filtering on TCP.
	GatewayProxyEnabled param.Field[bool] `json:"gateway_proxy_enabled"`
	// Enable gateway proxy filtering on UDP.
	GatewayUdpProxyEnabled param.Field[bool] `json:"gateway_udp_proxy_enabled"`
	// Enable installation of cloudflare managed root certificate.
	RootCertificateInstallationEnabled param.Field[bool] `json:"root_certificate_installation_enabled"`
	// Enable using CGNAT virtual IPv4.
	UseZtVirtualIP param.Field[bool] `json:"use_zt_virtual_ip"`
}

func (DeviceSettingUpdateParams) MarshalJSON 

func (r DeviceSettingUpdateParams) MarshalJSON() (data []byte, err error)

type DeviceSettingUpdateResponseEnvelope 

type DeviceSettingUpdateResponseEnvelope struct {
	Errors   []DeviceSettingUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DeviceSettingUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   TeamsDevicesZeroTrustAccountDeviceSettings    `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success DeviceSettingUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    deviceSettingUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*DeviceSettingUpdateResponseEnvelope) UnmarshalJSON 

func (r *DeviceSettingUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DeviceSettingUpdateResponseEnvelopeErrors 

type DeviceSettingUpdateResponseEnvelopeErrors struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    deviceSettingUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DeviceSettingUpdateResponseEnvelopeErrors) UnmarshalJSON 

func (r *DeviceSettingUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DeviceSettingUpdateResponseEnvelopeMessages 

type DeviceSettingUpdateResponseEnvelopeMessages struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    deviceSettingUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DeviceSettingUpdateResponseEnvelopeMessages) UnmarshalJSON 

func (r *DeviceSettingUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DeviceSettingUpdateResponseEnvelopeSuccess 

type DeviceSettingUpdateResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DeviceSettingUpdateResponseEnvelopeSuccessTrue DeviceSettingUpdateResponseEnvelopeSuccess = true
)

type DeviceUnrevokeNewParams 

type DeviceUnrevokeNewParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
	// A list of device ids to unrevoke.
	Body param.Field[[]string] `json:"body,required"`
}

func (DeviceUnrevokeNewParams) MarshalJSON 

func (r DeviceUnrevokeNewParams) MarshalJSON() (data []byte, err error)

type DeviceUnrevokeNewResponse 

type DeviceUnrevokeNewResponse interface {
	ImplementsZeroTrustDeviceUnrevokeNewResponse()
}

Union satisfied by zero_trust.DeviceUnrevokeNewResponseUnknown or shared.UnionString.

type DeviceUnrevokeNewResponseEnvelope 

type DeviceUnrevokeNewResponseEnvelope struct {
	Errors   []DeviceUnrevokeNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DeviceUnrevokeNewResponseEnvelopeMessages `json:"messages,required"`
	Result   DeviceUnrevokeNewResponse                   `json:"result,required,nullable"`
	// Whether the API call was successful.
	Success DeviceUnrevokeNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    deviceUnrevokeNewResponseEnvelopeJSON    `json:"-"`
}

func (*DeviceUnrevokeNewResponseEnvelope) UnmarshalJSON 

func (r *DeviceUnrevokeNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DeviceUnrevokeNewResponseEnvelopeErrors 

type DeviceUnrevokeNewResponseEnvelopeErrors struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    deviceUnrevokeNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DeviceUnrevokeNewResponseEnvelopeErrors) UnmarshalJSON 

func (r *DeviceUnrevokeNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DeviceUnrevokeNewResponseEnvelopeMessages 

type DeviceUnrevokeNewResponseEnvelopeMessages struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    deviceUnrevokeNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DeviceUnrevokeNewResponseEnvelopeMessages) UnmarshalJSON 

func (r *DeviceUnrevokeNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DeviceUnrevokeNewResponseEnvelopeSuccess 

type DeviceUnrevokeNewResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	DeviceUnrevokeNewResponseEnvelopeSuccessTrue DeviceUnrevokeNewResponseEnvelopeSuccess = true
)

type DeviceUnrevokeService 

type DeviceUnrevokeService struct {
	Options []option.RequestOption
}

DeviceUnrevokeService 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 NewDeviceUnrevokeService method instead.

func NewDeviceUnrevokeService 

func NewDeviceUnrevokeService(opts ...option.RequestOption) (r *DeviceUnrevokeService)

NewDeviceUnrevokeService 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 (*DeviceUnrevokeService) New 

func (r *DeviceUnrevokeService) New(ctx context.Context, params DeviceUnrevokeNewParams, opts ...option.RequestOption) (res *DeviceUnrevokeNewResponse, err error)

Unrevokes a list of devices.

type DexhttpTestGetParamsInterval 

type DexhttpTestGetParamsInterval string

Time interval for aggregate time slots. 

const (
	DexhttpTestGetParamsIntervalMinute DexhttpTestGetParamsInterval = "minute"
	DexhttpTestGetParamsIntervalHour   DexhttpTestGetParamsInterval = "hour"
)

type DexhttpTestGetResponseEnvelope 

type DexhttpTestGetResponseEnvelope struct {
	Errors   []DexhttpTestGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DexhttpTestGetResponseEnvelopeMessages `json:"messages,required"`
	Result   DigitalExperienceMonitoringHTTPDetails   `json:"result,required"`
	// Whether the API call was successful
	Success DexhttpTestGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    dexhttpTestGetResponseEnvelopeJSON    `json:"-"`
}

func (*DexhttpTestGetResponseEnvelope) UnmarshalJSON 

func (r *DexhttpTestGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DexhttpTestGetResponseEnvelopeErrors 

type DexhttpTestGetResponseEnvelopeErrors struct {
	Code    int64                                    `json:"code,required"`
	Message string                                   `json:"message,required"`
	JSON    dexhttpTestGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DexhttpTestGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *DexhttpTestGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DexhttpTestGetResponseEnvelopeMessages 

type DexhttpTestGetResponseEnvelopeMessages struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    dexhttpTestGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DexhttpTestGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *DexhttpTestGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DexhttpTestGetResponseEnvelopeSuccess 

type DexhttpTestGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	DexhttpTestGetResponseEnvelopeSuccessTrue DexhttpTestGetResponseEnvelopeSuccess = true
)

type DexhttpTestPercentileGetResponseEnvelope 

type DexhttpTestPercentileGetResponseEnvelope struct {
	Errors   []DexhttpTestPercentileGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DexhttpTestPercentileGetResponseEnvelopeMessages `json:"messages,required"`
	Result   DigitalExperienceMonitoringHTTPDetailsPercentiles  `json:"result,required"`
	// Whether the API call was successful
	Success DexhttpTestPercentileGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    dexhttpTestPercentileGetResponseEnvelopeJSON    `json:"-"`
}

func (*DexhttpTestPercentileGetResponseEnvelope) UnmarshalJSON 

func (r *DexhttpTestPercentileGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DexhttpTestPercentileGetResponseEnvelopeErrors 

type DexhttpTestPercentileGetResponseEnvelopeErrors struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    dexhttpTestPercentileGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*DexhttpTestPercentileGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *DexhttpTestPercentileGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type DexhttpTestPercentileGetResponseEnvelopeMessages 

type DexhttpTestPercentileGetResponseEnvelopeMessages struct {
	Code    int64                                                `json:"code,required"`
	Message string                                               `json:"message,required"`
	JSON    dexhttpTestPercentileGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*DexhttpTestPercentileGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *DexhttpTestPercentileGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type DexhttpTestPercentileGetResponseEnvelopeSuccess 

type DexhttpTestPercentileGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	DexhttpTestPercentileGetResponseEnvelopeSuccessTrue DexhttpTestPercentileGetResponseEnvelopeSuccess = true
)

type DigitalExperienceMonitoringDevice 

type DigitalExperienceMonitoringDevice struct {
	// Cloudflare colo
	Colo string `json:"colo,required"`
	// Device identifier (UUID v4)
	DeviceID string `json:"deviceId,required"`
	// Operating system
	Platform string `json:"platform,required"`
	// Network status
	Status string `json:"status,required"`
	// WARP client version
	Version string `json:"version,required"`
	// Device identifier (human readable)
	DeviceName string `json:"deviceName"`
	// User contact email address
	PersonEmail string                                `json:"personEmail"`
	JSON        digitalExperienceMonitoringDeviceJSON `json:"-"`
}

func (*DigitalExperienceMonitoringDevice) UnmarshalJSON 

func (r *DigitalExperienceMonitoringDevice) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringHTTPDetails 

type DigitalExperienceMonitoringHTTPDetails struct {
	// The url of the HTTP synthetic application test
	Host            string                                                  `json:"host"`
	HTTPStats       DigitalExperienceMonitoringHTTPDetailsHTTPStats         `json:"httpStats,nullable"`
	HTTPStatsByColo []DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColo `json:"httpStatsByColo"`
	// The interval at which the HTTP synthetic application test is set to run.
	Interval string                                     `json:"interval"`
	Kind     DigitalExperienceMonitoringHTTPDetailsKind `json:"kind"`
	// The HTTP method to use when running the test
	Method string `json:"method"`
	// The name of the HTTP synthetic application test
	Name string                                     `json:"name"`
	JSON digitalExperienceMonitoringHTTPDetailsJSON `json:"-"`
}

func (*DigitalExperienceMonitoringHTTPDetails) UnmarshalJSON 

func (r *DigitalExperienceMonitoringHTTPDetails) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringHTTPDetailsHTTPStats 

type DigitalExperienceMonitoringHTTPDetailsHTTPStats struct {
	DNSResponseTimeMs    DigitalExperienceMonitoringHTTPDetailsHTTPStatsDNSResponseTimeMs    `json:"dnsResponseTimeMs,required"`
	HTTPStatusCode       []DigitalExperienceMonitoringHTTPDetailsHTTPStatsHTTPStatusCode     `json:"httpStatusCode,required"`
	ResourceFetchTimeMs  DigitalExperienceMonitoringHTTPDetailsHTTPStatsResourceFetchTimeMs  `json:"resourceFetchTimeMs,required"`
	ServerResponseTimeMs DigitalExperienceMonitoringHTTPDetailsHTTPStatsServerResponseTimeMs `json:"serverResponseTimeMs,required"`
	// Count of unique devices that have run this test in the given time period
	UniqueDevicesTotal int64                                               `json:"uniqueDevicesTotal,required"`
	JSON               digitalExperienceMonitoringHTTPDetailsHTTPStatsJSON `json:"-"`
}

func (*DigitalExperienceMonitoringHTTPDetailsHTTPStats) UnmarshalJSON 

func (r *DigitalExperienceMonitoringHTTPDetailsHTTPStats) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColo 

type DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColo struct {
	Colo                 string                                                                    `json:"colo,required"`
	DNSResponseTimeMs    DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColoDNSResponseTimeMs    `json:"dnsResponseTimeMs,required"`
	HTTPStatusCode       []DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColoHTTPStatusCode     `json:"httpStatusCode,required"`
	ResourceFetchTimeMs  DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColoResourceFetchTimeMs  `json:"resourceFetchTimeMs,required"`
	ServerResponseTimeMs DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColoServerResponseTimeMs `json:"serverResponseTimeMs,required"`
	// Count of unique devices that have run this test in the given time period
	UniqueDevicesTotal int64                                                     `json:"uniqueDevicesTotal,required"`
	JSON               digitalExperienceMonitoringHTTPDetailsHTTPStatsByColoJSON `json:"-"`
}

func (*DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColo) UnmarshalJSON 

func (r *DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColo) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColoDNSResponseTimeMs 

type DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColoDNSResponseTimeMs struct {
	Slots []DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColoDNSResponseTimeMsSlot `json:"slots,required"`
	// average observed in the time period
	Avg int64 `json:"avg,nullable"`
	// highest observed in the time period
	Max int64 `json:"max,nullable"`
	// lowest observed in the time period
	Min  int64                                                                      `json:"min,nullable"`
	JSON digitalExperienceMonitoringHTTPDetailsHTTPStatsByColoDNSResponseTimeMsJSON `json:"-"`
}

func (*DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColoDNSResponseTimeMs) UnmarshalJSON 

func (r *DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColoDNSResponseTimeMs) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColoDNSResponseTimeMsSlot 

type DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColoDNSResponseTimeMsSlot struct {
	Timestamp string                                                                         `json:"timestamp,required"`
	Value     int64                                                                          `json:"value,required"`
	JSON      digitalExperienceMonitoringHTTPDetailsHTTPStatsByColoDNSResponseTimeMsSlotJSON `json:"-"`
}

func (*DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColoDNSResponseTimeMsSlot) UnmarshalJSON 

func (r *DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColoDNSResponseTimeMsSlot) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColoHTTPStatusCode 

type DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColoHTTPStatusCode struct {
	Status200 int64                                                                   `json:"status200,required"`
	Status300 int64                                                                   `json:"status300,required"`
	Status400 int64                                                                   `json:"status400,required"`
	Status500 int64                                                                   `json:"status500,required"`
	Timestamp string                                                                  `json:"timestamp,required"`
	JSON      digitalExperienceMonitoringHTTPDetailsHTTPStatsByColoHTTPStatusCodeJSON `json:"-"`
}

func (*DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColoHTTPStatusCode) UnmarshalJSON 

func (r *DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColoHTTPStatusCode) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColoResourceFetchTimeMs 

type DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColoResourceFetchTimeMs struct {
	Slots []DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColoResourceFetchTimeMsSlot `json:"slots,required"`
	// average observed in the time period
	Avg int64 `json:"avg,nullable"`
	// highest observed in the time period
	Max int64 `json:"max,nullable"`
	// lowest observed in the time period
	Min  int64                                                                        `json:"min,nullable"`
	JSON digitalExperienceMonitoringHTTPDetailsHTTPStatsByColoResourceFetchTimeMsJSON `json:"-"`
}

func (*DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColoResourceFetchTimeMs) UnmarshalJSON 

func (r *DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColoResourceFetchTimeMs) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColoResourceFetchTimeMsSlot 

type DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColoResourceFetchTimeMsSlot struct {
	Timestamp string                                                                           `json:"timestamp,required"`
	Value     int64                                                                            `json:"value,required"`
	JSON      digitalExperienceMonitoringHTTPDetailsHTTPStatsByColoResourceFetchTimeMsSlotJSON `json:"-"`
}

func (*DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColoResourceFetchTimeMsSlot) UnmarshalJSON 

func (r *DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColoResourceFetchTimeMsSlot) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColoServerResponseTimeMs 

type DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColoServerResponseTimeMs struct {
	Slots []DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColoServerResponseTimeMsSlot `json:"slots,required"`
	// average observed in the time period
	Avg int64 `json:"avg,nullable"`
	// highest observed in the time period
	Max int64 `json:"max,nullable"`
	// lowest observed in the time period
	Min  int64                                                                         `json:"min,nullable"`
	JSON digitalExperienceMonitoringHTTPDetailsHTTPStatsByColoServerResponseTimeMsJSON `json:"-"`
}

func (*DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColoServerResponseTimeMs) UnmarshalJSON 

func (r *DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColoServerResponseTimeMs) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColoServerResponseTimeMsSlot 

type DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColoServerResponseTimeMsSlot struct {
	Timestamp string                                                                            `json:"timestamp,required"`
	Value     int64                                                                             `json:"value,required"`
	JSON      digitalExperienceMonitoringHTTPDetailsHTTPStatsByColoServerResponseTimeMsSlotJSON `json:"-"`
}

func (*DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColoServerResponseTimeMsSlot) UnmarshalJSON 

func (r *DigitalExperienceMonitoringHTTPDetailsHTTPStatsByColoServerResponseTimeMsSlot) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringHTTPDetailsHTTPStatsDNSResponseTimeMs 

type DigitalExperienceMonitoringHTTPDetailsHTTPStatsDNSResponseTimeMs struct {
	Slots []DigitalExperienceMonitoringHTTPDetailsHTTPStatsDNSResponseTimeMsSlot `json:"slots,required"`
	// average observed in the time period
	Avg int64 `json:"avg,nullable"`
	// highest observed in the time period
	Max int64 `json:"max,nullable"`
	// lowest observed in the time period
	Min  int64                                                                `json:"min,nullable"`
	JSON digitalExperienceMonitoringHTTPDetailsHTTPStatsDNSResponseTimeMsJSON `json:"-"`
}

func (*DigitalExperienceMonitoringHTTPDetailsHTTPStatsDNSResponseTimeMs) UnmarshalJSON 

func (r *DigitalExperienceMonitoringHTTPDetailsHTTPStatsDNSResponseTimeMs) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringHTTPDetailsHTTPStatsDNSResponseTimeMsSlot 

type DigitalExperienceMonitoringHTTPDetailsHTTPStatsDNSResponseTimeMsSlot struct {
	Timestamp string                                                                   `json:"timestamp,required"`
	Value     int64                                                                    `json:"value,required"`
	JSON      digitalExperienceMonitoringHTTPDetailsHTTPStatsDNSResponseTimeMsSlotJSON `json:"-"`
}

func (*DigitalExperienceMonitoringHTTPDetailsHTTPStatsDNSResponseTimeMsSlot) UnmarshalJSON 

func (r *DigitalExperienceMonitoringHTTPDetailsHTTPStatsDNSResponseTimeMsSlot) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringHTTPDetailsHTTPStatsHTTPStatusCode 

type DigitalExperienceMonitoringHTTPDetailsHTTPStatsHTTPStatusCode struct {
	Status200 int64                                                             `json:"status200,required"`
	Status300 int64                                                             `json:"status300,required"`
	Status400 int64                                                             `json:"status400,required"`
	Status500 int64                                                             `json:"status500,required"`
	Timestamp string                                                            `json:"timestamp,required"`
	JSON      digitalExperienceMonitoringHTTPDetailsHTTPStatsHTTPStatusCodeJSON `json:"-"`
}

func (*DigitalExperienceMonitoringHTTPDetailsHTTPStatsHTTPStatusCode) UnmarshalJSON 

func (r *DigitalExperienceMonitoringHTTPDetailsHTTPStatsHTTPStatusCode) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringHTTPDetailsHTTPStatsResourceFetchTimeMs 

type DigitalExperienceMonitoringHTTPDetailsHTTPStatsResourceFetchTimeMs struct {
	Slots []DigitalExperienceMonitoringHTTPDetailsHTTPStatsResourceFetchTimeMsSlot `json:"slots,required"`
	// average observed in the time period
	Avg int64 `json:"avg,nullable"`
	// highest observed in the time period
	Max int64 `json:"max,nullable"`
	// lowest observed in the time period
	Min  int64                                                                  `json:"min,nullable"`
	JSON digitalExperienceMonitoringHTTPDetailsHTTPStatsResourceFetchTimeMsJSON `json:"-"`
}

func (*DigitalExperienceMonitoringHTTPDetailsHTTPStatsResourceFetchTimeMs) UnmarshalJSON 

func (r *DigitalExperienceMonitoringHTTPDetailsHTTPStatsResourceFetchTimeMs) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringHTTPDetailsHTTPStatsResourceFetchTimeMsSlot 

type DigitalExperienceMonitoringHTTPDetailsHTTPStatsResourceFetchTimeMsSlot struct {
	Timestamp string                                                                     `json:"timestamp,required"`
	Value     int64                                                                      `json:"value,required"`
	JSON      digitalExperienceMonitoringHTTPDetailsHTTPStatsResourceFetchTimeMsSlotJSON `json:"-"`
}

func (*DigitalExperienceMonitoringHTTPDetailsHTTPStatsResourceFetchTimeMsSlot) UnmarshalJSON 

func (r *DigitalExperienceMonitoringHTTPDetailsHTTPStatsResourceFetchTimeMsSlot) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringHTTPDetailsHTTPStatsServerResponseTimeMs 

type DigitalExperienceMonitoringHTTPDetailsHTTPStatsServerResponseTimeMs struct {
	Slots []DigitalExperienceMonitoringHTTPDetailsHTTPStatsServerResponseTimeMsSlot `json:"slots,required"`
	// average observed in the time period
	Avg int64 `json:"avg,nullable"`
	// highest observed in the time period
	Max int64 `json:"max,nullable"`
	// lowest observed in the time period
	Min  int64                                                                   `json:"min,nullable"`
	JSON digitalExperienceMonitoringHTTPDetailsHTTPStatsServerResponseTimeMsJSON `json:"-"`
}

func (*DigitalExperienceMonitoringHTTPDetailsHTTPStatsServerResponseTimeMs) UnmarshalJSON 

func (r *DigitalExperienceMonitoringHTTPDetailsHTTPStatsServerResponseTimeMs) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringHTTPDetailsHTTPStatsServerResponseTimeMsSlot 

type DigitalExperienceMonitoringHTTPDetailsHTTPStatsServerResponseTimeMsSlot struct {
	Timestamp string                                                                      `json:"timestamp,required"`
	Value     int64                                                                       `json:"value,required"`
	JSON      digitalExperienceMonitoringHTTPDetailsHTTPStatsServerResponseTimeMsSlotJSON `json:"-"`
}

func (*DigitalExperienceMonitoringHTTPDetailsHTTPStatsServerResponseTimeMsSlot) UnmarshalJSON 

func (r *DigitalExperienceMonitoringHTTPDetailsHTTPStatsServerResponseTimeMsSlot) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringHTTPDetailsKind 

type DigitalExperienceMonitoringHTTPDetailsKind string
const (
	DigitalExperienceMonitoringHTTPDetailsKindHTTP DigitalExperienceMonitoringHTTPDetailsKind = "http"
)

type DigitalExperienceMonitoringHTTPDetailsPercentiles 

type DigitalExperienceMonitoringHTTPDetailsPercentiles struct {
	DNSResponseTimeMs    DigitalExperienceMonitoringHTTPDetailsPercentilesDNSResponseTimeMs    `json:"dnsResponseTimeMs"`
	ResourceFetchTimeMs  DigitalExperienceMonitoringHTTPDetailsPercentilesResourceFetchTimeMs  `json:"resourceFetchTimeMs"`
	ServerResponseTimeMs DigitalExperienceMonitoringHTTPDetailsPercentilesServerResponseTimeMs `json:"serverResponseTimeMs"`
	JSON                 digitalExperienceMonitoringHTTPDetailsPercentilesJSON                 `json:"-"`
}

func (*DigitalExperienceMonitoringHTTPDetailsPercentiles) UnmarshalJSON 

func (r *DigitalExperienceMonitoringHTTPDetailsPercentiles) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringHTTPDetailsPercentilesDNSResponseTimeMs 

type DigitalExperienceMonitoringHTTPDetailsPercentilesDNSResponseTimeMs struct {
	// p50 observed in the time period
	P50 float64 `json:"p50,nullable"`
	// p90 observed in the time period
	P90 float64 `json:"p90,nullable"`
	// p95 observed in the time period
	P95 float64 `json:"p95,nullable"`
	// p99 observed in the time period
	P99  float64                                                                `json:"p99,nullable"`
	JSON digitalExperienceMonitoringHTTPDetailsPercentilesDNSResponseTimeMsJSON `json:"-"`
}

func (*DigitalExperienceMonitoringHTTPDetailsPercentilesDNSResponseTimeMs) UnmarshalJSON 

func (r *DigitalExperienceMonitoringHTTPDetailsPercentilesDNSResponseTimeMs) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringHTTPDetailsPercentilesResourceFetchTimeMs 

type DigitalExperienceMonitoringHTTPDetailsPercentilesResourceFetchTimeMs struct {
	// p50 observed in the time period
	P50 float64 `json:"p50,nullable"`
	// p90 observed in the time period
	P90 float64 `json:"p90,nullable"`
	// p95 observed in the time period
	P95 float64 `json:"p95,nullable"`
	// p99 observed in the time period
	P99  float64                                                                  `json:"p99,nullable"`
	JSON digitalExperienceMonitoringHTTPDetailsPercentilesResourceFetchTimeMsJSON `json:"-"`
}

func (*DigitalExperienceMonitoringHTTPDetailsPercentilesResourceFetchTimeMs) UnmarshalJSON 

func (r *DigitalExperienceMonitoringHTTPDetailsPercentilesResourceFetchTimeMs) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringHTTPDetailsPercentilesServerResponseTimeMs 

type DigitalExperienceMonitoringHTTPDetailsPercentilesServerResponseTimeMs struct {
	// p50 observed in the time period
	P50 float64 `json:"p50,nullable"`
	// p90 observed in the time period
	P90 float64 `json:"p90,nullable"`
	// p95 observed in the time period
	P95 float64 `json:"p95,nullable"`
	// p99 observed in the time period
	P99  float64                                                                   `json:"p99,nullable"`
	JSON digitalExperienceMonitoringHTTPDetailsPercentilesServerResponseTimeMsJSON `json:"-"`
}

func (*DigitalExperienceMonitoringHTTPDetailsPercentilesServerResponseTimeMs) UnmarshalJSON 

func (r *DigitalExperienceMonitoringHTTPDetailsPercentilesServerResponseTimeMs) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTests 

type DigitalExperienceMonitoringTests struct {
	OverviewMetrics DigitalExperienceMonitoringTestsOverviewMetrics `json:"overviewMetrics,required"`
	// array of test results objects.
	Tests []DigitalExperienceMonitoringTestsTest `json:"tests,required"`
	JSON  digitalExperienceMonitoringTestsJSON   `json:"-"`
}

func (*DigitalExperienceMonitoringTests) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTests) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTestsOverviewMetrics 

type DigitalExperienceMonitoringTestsOverviewMetrics struct {
	// number of tests.
	TestsTotal int64 `json:"testsTotal,required"`
	// percentage availability for all traceroutes results in response
	AvgTracerouteAvailabilityPct float64                                             `json:"avgTracerouteAvailabilityPct,nullable"`
	JSON                         digitalExperienceMonitoringTestsOverviewMetricsJSON `json:"-"`
}

func (*DigitalExperienceMonitoringTestsOverviewMetrics) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTestsOverviewMetrics) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTestsTest 

type DigitalExperienceMonitoringTestsTest struct {
	// API Resource UUID tag.
	ID string `json:"id,required"`
	// date the test was created.
	Created string `json:"created,required"`
	// the test description defined during configuration
	Description string `json:"description,required"`
	// if true, then the test will run on targeted devices. Else, the test will not
	// run.
	Enabled bool   `json:"enabled,required"`
	Host    string `json:"host,required"`
	// The interval at which the synthetic application test is set to run.
	Interval string `json:"interval,required"`
	// test type, http or traceroute
	Kind DigitalExperienceMonitoringTestsTestsKind `json:"kind,required"`
	// name given to this test
	Name              string                                                   `json:"name,required"`
	Updated           string                                                   `json:"updated,required"`
	HTTPResults       DigitalExperienceMonitoringTestsTestsHTTPResults         `json:"httpResults,nullable"`
	HTTPResultsByColo []DigitalExperienceMonitoringTestsTestsHTTPResultsByColo `json:"httpResultsByColo"`
	// for HTTP, the method to use when running the test
	Method                  string                                                         `json:"method"`
	TracerouteResults       DigitalExperienceMonitoringTestsTestsTracerouteResults         `json:"tracerouteResults,nullable"`
	TracerouteResultsByColo []DigitalExperienceMonitoringTestsTestsTracerouteResultsByColo `json:"tracerouteResultsByColo"`
	JSON                    digitalExperienceMonitoringTestsTestJSON                       `json:"-"`
}

func (*DigitalExperienceMonitoringTestsTest) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTestsTest) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTestsTestsHTTPResults 

type DigitalExperienceMonitoringTestsTestsHTTPResults struct {
	ResourceFetchTime DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTime `json:"resourceFetchTime,required"`
	JSON              digitalExperienceMonitoringTestsTestsHTTPResultsJSON              `json:"-"`
}

func (*DigitalExperienceMonitoringTestsTestsHTTPResults) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTestsTestsHTTPResults) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTestsTestsHTTPResultsByColo 

type DigitalExperienceMonitoringTestsTestsHTTPResultsByColo struct {
	// Cloudflare colo
	Colo              string                                                                  `json:"colo,required"`
	ResourceFetchTime DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTime `json:"resourceFetchTime,required"`
	JSON              digitalExperienceMonitoringTestsTestsHTTPResultsByColoJSON              `json:"-"`
}

func (*DigitalExperienceMonitoringTestsTestsHTTPResultsByColo) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTestsTestsHTTPResultsByColo) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTime 

type DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTime struct {
	History  []DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeHistory `json:"history,required"`
	AvgMs    int64                                                                            `json:"avgMs,nullable"`
	OverTime DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeOverTime  `json:"overTime,nullable"`
	JSON     digitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeJSON      `json:"-"`
}

func (*DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTime) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTime) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeHistory 

type DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeHistory struct {
	TimePeriod DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeHistoryTimePeriod `json:"timePeriod,required"`
	AvgMs      int64                                                                                    `json:"avgMs,nullable"`
	DeltaPct   float64                                                                                  `json:"deltaPct,nullable"`
	JSON       digitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeHistoryJSON       `json:"-"`
}

func (*DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeHistory) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeHistory) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeHistoryTimePeriod 

type DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeHistoryTimePeriod struct {
	Units DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeHistoryTimePeriodUnits `json:"units,required"`
	Value int64                                                                                         `json:"value,required"`
	JSON  digitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeHistoryTimePeriodJSON  `json:"-"`
}

func (*DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeHistoryTimePeriod) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeHistoryTimePeriod) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeHistoryTimePeriodUnits 

type DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeHistoryTimePeriodUnits string
const (
	DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeHistoryTimePeriodUnitsHours    DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeHistoryTimePeriodUnits = "hours"
	DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeHistoryTimePeriodUnitsDays     DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeHistoryTimePeriodUnits = "days"
	DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeHistoryTimePeriodUnitsTestRuns DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeHistoryTimePeriodUnits = "testRuns"
)

type DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeOverTime 

type DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeOverTime struct {
	TimePeriod DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeOverTimeTimePeriod `json:"timePeriod,required"`
	Values     []DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeOverTimeValue    `json:"values,required"`
	JSON       digitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeOverTimeJSON       `json:"-"`
}

func (*DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeOverTime) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeOverTime) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeOverTimeTimePeriod 

type DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeOverTimeTimePeriod struct {
	Units DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeOverTimeTimePeriodUnits `json:"units,required"`
	Value int64                                                                                          `json:"value,required"`
	JSON  digitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeOverTimeTimePeriodJSON  `json:"-"`
}

func (*DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeOverTimeTimePeriod) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeOverTimeTimePeriod) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeOverTimeTimePeriodUnits 

type DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeOverTimeTimePeriodUnits string
const (
	DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeOverTimeTimePeriodUnitsHours    DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeOverTimeTimePeriodUnits = "hours"
	DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeOverTimeTimePeriodUnitsDays     DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeOverTimeTimePeriodUnits = "days"
	DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeOverTimeTimePeriodUnitsTestRuns DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeOverTimeTimePeriodUnits = "testRuns"
)

type DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeOverTimeValue 

type DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeOverTimeValue struct {
	AvgMs     int64                                                                                    `json:"avgMs,required"`
	Timestamp string                                                                                   `json:"timestamp,required"`
	JSON      digitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeOverTimeValueJSON `json:"-"`
}

func (*DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeOverTimeValue) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTestsTestsHTTPResultsByColoResourceFetchTimeOverTimeValue) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTime 

type DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTime struct {
	History  []DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeHistory `json:"history,required"`
	AvgMs    int64                                                                      `json:"avgMs,nullable"`
	OverTime DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeOverTime  `json:"overTime,nullable"`
	JSON     digitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeJSON      `json:"-"`
}

func (*DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTime) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTime) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeHistory 

type DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeHistory struct {
	TimePeriod DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeHistoryTimePeriod `json:"timePeriod,required"`
	AvgMs      int64                                                                              `json:"avgMs,nullable"`
	DeltaPct   float64                                                                            `json:"deltaPct,nullable"`
	JSON       digitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeHistoryJSON       `json:"-"`
}

func (*DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeHistory) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeHistory) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeHistoryTimePeriod 

type DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeHistoryTimePeriod struct {
	Units DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeHistoryTimePeriodUnits `json:"units,required"`
	Value int64                                                                                   `json:"value,required"`
	JSON  digitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeHistoryTimePeriodJSON  `json:"-"`
}

func (*DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeHistoryTimePeriod) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeHistoryTimePeriod) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeHistoryTimePeriodUnits 

type DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeHistoryTimePeriodUnits string
const (
	DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeHistoryTimePeriodUnitsHours    DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeHistoryTimePeriodUnits = "hours"
	DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeHistoryTimePeriodUnitsDays     DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeHistoryTimePeriodUnits = "days"
	DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeHistoryTimePeriodUnitsTestRuns DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeHistoryTimePeriodUnits = "testRuns"
)

type DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeOverTime 

type DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeOverTime struct {
	TimePeriod DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeOverTimeTimePeriod `json:"timePeriod,required"`
	Values     []DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeOverTimeValue    `json:"values,required"`
	JSON       digitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeOverTimeJSON       `json:"-"`
}

func (*DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeOverTime) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeOverTime) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeOverTimeTimePeriod 

type DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeOverTimeTimePeriod struct {
	Units DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeOverTimeTimePeriodUnits `json:"units,required"`
	Value int64                                                                                    `json:"value,required"`
	JSON  digitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeOverTimeTimePeriodJSON  `json:"-"`
}

func (*DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeOverTimeTimePeriod) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeOverTimeTimePeriod) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeOverTimeTimePeriodUnits 

type DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeOverTimeTimePeriodUnits string
const (
	DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeOverTimeTimePeriodUnitsHours    DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeOverTimeTimePeriodUnits = "hours"
	DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeOverTimeTimePeriodUnitsDays     DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeOverTimeTimePeriodUnits = "days"
	DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeOverTimeTimePeriodUnitsTestRuns DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeOverTimeTimePeriodUnits = "testRuns"
)

type DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeOverTimeValue 

type DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeOverTimeValue struct {
	AvgMs     int64                                                                              `json:"avgMs,required"`
	Timestamp string                                                                             `json:"timestamp,required"`
	JSON      digitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeOverTimeValueJSON `json:"-"`
}

func (*DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeOverTimeValue) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTestsTestsHTTPResultsResourceFetchTimeOverTimeValue) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTestsTestsKind 

type DigitalExperienceMonitoringTestsTestsKind string

test type, http or traceroute 

const (
	DigitalExperienceMonitoringTestsTestsKindHTTP       DigitalExperienceMonitoringTestsTestsKind = "http"
	DigitalExperienceMonitoringTestsTestsKindTraceroute DigitalExperienceMonitoringTestsTestsKind = "traceroute"
)

type DigitalExperienceMonitoringTestsTestsTracerouteResults 

type DigitalExperienceMonitoringTestsTestsTracerouteResults struct {
	RoundTripTime DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTime `json:"roundTripTime,required"`
	JSON          digitalExperienceMonitoringTestsTestsTracerouteResultsJSON          `json:"-"`
}

func (*DigitalExperienceMonitoringTestsTestsTracerouteResults) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTestsTestsTracerouteResults) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTestsTestsTracerouteResultsByColo 

type DigitalExperienceMonitoringTestsTestsTracerouteResultsByColo struct {
	// Cloudflare colo
	Colo          string                                                                    `json:"colo,required"`
	RoundTripTime DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTime `json:"roundTripTime,required"`
	JSON          digitalExperienceMonitoringTestsTestsTracerouteResultsByColoJSON          `json:"-"`
}

func (*DigitalExperienceMonitoringTestsTestsTracerouteResultsByColo) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTestsTestsTracerouteResultsByColo) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTime 

type DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTime struct {
	History  []DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeHistory `json:"history,required"`
	AvgMs    int64                                                                              `json:"avgMs,nullable"`
	OverTime DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeOverTime  `json:"overTime,nullable"`
	JSON     digitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeJSON      `json:"-"`
}

func (*DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTime) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTime) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeHistory 

type DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeHistory struct {
	TimePeriod DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeHistoryTimePeriod `json:"timePeriod,required"`
	AvgMs      int64                                                                                      `json:"avgMs,nullable"`
	DeltaPct   float64                                                                                    `json:"deltaPct,nullable"`
	JSON       digitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeHistoryJSON       `json:"-"`
}

func (*DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeHistory) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeHistory) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeHistoryTimePeriod 

type DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeHistoryTimePeriod struct {
	Units DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeHistoryTimePeriodUnits `json:"units,required"`
	Value int64                                                                                           `json:"value,required"`
	JSON  digitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeHistoryTimePeriodJSON  `json:"-"`
}

func (*DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeHistoryTimePeriod) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeHistoryTimePeriod) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeHistoryTimePeriodUnits 

type DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeHistoryTimePeriodUnits string
const (
	DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeHistoryTimePeriodUnitsHours    DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeHistoryTimePeriodUnits = "hours"
	DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeHistoryTimePeriodUnitsDays     DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeHistoryTimePeriodUnits = "days"
	DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeHistoryTimePeriodUnitsTestRuns DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeHistoryTimePeriodUnits = "testRuns"
)

type DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeOverTime 

type DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeOverTime struct {
	TimePeriod DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeOverTimeTimePeriod `json:"timePeriod,required"`
	Values     []DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeOverTimeValue    `json:"values,required"`
	JSON       digitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeOverTimeJSON       `json:"-"`
}

func (*DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeOverTime) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeOverTime) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeOverTimeTimePeriod 

type DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeOverTimeTimePeriod struct {
	Units DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeOverTimeTimePeriodUnits `json:"units,required"`
	Value int64                                                                                            `json:"value,required"`
	JSON  digitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeOverTimeTimePeriodJSON  `json:"-"`
}

func (*DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeOverTimeTimePeriod) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeOverTimeTimePeriod) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeOverTimeTimePeriodUnits 

type DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeOverTimeTimePeriodUnits string
const (
	DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeOverTimeTimePeriodUnitsHours    DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeOverTimeTimePeriodUnits = "hours"
	DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeOverTimeTimePeriodUnitsDays     DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeOverTimeTimePeriodUnits = "days"
	DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeOverTimeTimePeriodUnitsTestRuns DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeOverTimeTimePeriodUnits = "testRuns"
)

type DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeOverTimeValue 

type DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeOverTimeValue struct {
	AvgMs     int64                                                                                      `json:"avgMs,required"`
	Timestamp string                                                                                     `json:"timestamp,required"`
	JSON      digitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeOverTimeValueJSON `json:"-"`
}

func (*DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeOverTimeValue) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTestsTestsTracerouteResultsByColoRoundTripTimeOverTimeValue) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTime 

type DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTime struct {
	History  []DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeHistory `json:"history,required"`
	AvgMs    int64                                                                        `json:"avgMs,nullable"`
	OverTime DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeOverTime  `json:"overTime,nullable"`
	JSON     digitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeJSON      `json:"-"`
}

func (*DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTime) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTime) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeHistory 

type DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeHistory struct {
	TimePeriod DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeHistoryTimePeriod `json:"timePeriod,required"`
	AvgMs      int64                                                                                `json:"avgMs,nullable"`
	DeltaPct   float64                                                                              `json:"deltaPct,nullable"`
	JSON       digitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeHistoryJSON       `json:"-"`
}

func (*DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeHistory) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeHistory) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeHistoryTimePeriod 

type DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeHistoryTimePeriod struct {
	Units DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeHistoryTimePeriodUnits `json:"units,required"`
	Value int64                                                                                     `json:"value,required"`
	JSON  digitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeHistoryTimePeriodJSON  `json:"-"`
}

func (*DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeHistoryTimePeriod) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeHistoryTimePeriod) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeHistoryTimePeriodUnits 

type DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeHistoryTimePeriodUnits string
const (
	DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeHistoryTimePeriodUnitsHours    DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeHistoryTimePeriodUnits = "hours"
	DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeHistoryTimePeriodUnitsDays     DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeHistoryTimePeriodUnits = "days"
	DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeHistoryTimePeriodUnitsTestRuns DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeHistoryTimePeriodUnits = "testRuns"
)

type DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeOverTime 

type DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeOverTime struct {
	TimePeriod DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeOverTimeTimePeriod `json:"timePeriod,required"`
	Values     []DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeOverTimeValue    `json:"values,required"`
	JSON       digitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeOverTimeJSON       `json:"-"`
}

func (*DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeOverTime) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeOverTime) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeOverTimeTimePeriod 

type DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeOverTimeTimePeriod struct {
	Units DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeOverTimeTimePeriodUnits `json:"units,required"`
	Value int64                                                                                      `json:"value,required"`
	JSON  digitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeOverTimeTimePeriodJSON  `json:"-"`
}

func (*DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeOverTimeTimePeriod) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeOverTimeTimePeriod) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeOverTimeTimePeriodUnits 

type DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeOverTimeTimePeriodUnits string
const (
	DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeOverTimeTimePeriodUnitsHours    DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeOverTimeTimePeriodUnits = "hours"
	DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeOverTimeTimePeriodUnitsDays     DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeOverTimeTimePeriodUnits = "days"
	DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeOverTimeTimePeriodUnitsTestRuns DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeOverTimeTimePeriodUnits = "testRuns"
)

type DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeOverTimeValue 

type DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeOverTimeValue struct {
	AvgMs     int64                                                                                `json:"avgMs,required"`
	Timestamp string                                                                               `json:"timestamp,required"`
	JSON      digitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeOverTimeValueJSON `json:"-"`
}

func (*DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeOverTimeValue) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTestsTestsTracerouteResultsRoundTripTimeOverTimeValue) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTracerouteDetails 

type DigitalExperienceMonitoringTracerouteDetails struct {
	// The host of the Traceroute synthetic application test
	Host string `json:"host,required"`
	// The interval at which the Traceroute synthetic application test is set to run.
	Interval string                                           `json:"interval,required"`
	Kind     DigitalExperienceMonitoringTracerouteDetailsKind `json:"kind,required"`
	// The name of the Traceroute synthetic application test
	Name                  string                                                              `json:"name,required"`
	TracerouteStats       DigitalExperienceMonitoringTracerouteDetailsTracerouteStats         `json:"tracerouteStats,nullable"`
	TracerouteStatsByColo []DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColo `json:"tracerouteStatsByColo"`
	JSON                  digitalExperienceMonitoringTracerouteDetailsJSON                    `json:"-"`
}

func (*DigitalExperienceMonitoringTracerouteDetails) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTracerouteDetails) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTracerouteDetailsKind 

type DigitalExperienceMonitoringTracerouteDetailsKind string
const (
	DigitalExperienceMonitoringTracerouteDetailsKindTraceroute DigitalExperienceMonitoringTracerouteDetailsKind = "traceroute"
)

type DigitalExperienceMonitoringTracerouteDetailsPercentiles 

type DigitalExperienceMonitoringTracerouteDetailsPercentiles struct {
	HopsCount       DigitalExperienceMonitoringTracerouteDetailsPercentilesHopsCount       `json:"hopsCount"`
	PacketLossPct   DigitalExperienceMonitoringTracerouteDetailsPercentilesPacketLossPct   `json:"packetLossPct"`
	RoundTripTimeMs DigitalExperienceMonitoringTracerouteDetailsPercentilesRoundTripTimeMs `json:"roundTripTimeMs"`
	JSON            digitalExperienceMonitoringTracerouteDetailsPercentilesJSON            `json:"-"`
}

func (*DigitalExperienceMonitoringTracerouteDetailsPercentiles) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTracerouteDetailsPercentiles) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTracerouteDetailsPercentilesHopsCount 

type DigitalExperienceMonitoringTracerouteDetailsPercentilesHopsCount struct {
	// p50 observed in the time period
	P50 float64 `json:"p50,nullable"`
	// p90 observed in the time period
	P90 float64 `json:"p90,nullable"`
	// p95 observed in the time period
	P95 float64 `json:"p95,nullable"`
	// p99 observed in the time period
	P99  float64                                                              `json:"p99,nullable"`
	JSON digitalExperienceMonitoringTracerouteDetailsPercentilesHopsCountJSON `json:"-"`
}

func (*DigitalExperienceMonitoringTracerouteDetailsPercentilesHopsCount) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTracerouteDetailsPercentilesHopsCount) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTracerouteDetailsPercentilesPacketLossPct 

type DigitalExperienceMonitoringTracerouteDetailsPercentilesPacketLossPct struct {
	// p50 observed in the time period
	P50 float64 `json:"p50,nullable"`
	// p90 observed in the time period
	P90 float64 `json:"p90,nullable"`
	// p95 observed in the time period
	P95 float64 `json:"p95,nullable"`
	// p99 observed in the time period
	P99  float64                                                                  `json:"p99,nullable"`
	JSON digitalExperienceMonitoringTracerouteDetailsPercentilesPacketLossPctJSON `json:"-"`
}

func (*DigitalExperienceMonitoringTracerouteDetailsPercentilesPacketLossPct) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTracerouteDetailsPercentilesPacketLossPct) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTracerouteDetailsPercentilesRoundTripTimeMs 

type DigitalExperienceMonitoringTracerouteDetailsPercentilesRoundTripTimeMs struct {
	// p50 observed in the time period
	P50 float64 `json:"p50,nullable"`
	// p90 observed in the time period
	P90 float64 `json:"p90,nullable"`
	// p95 observed in the time period
	P95 float64 `json:"p95,nullable"`
	// p99 observed in the time period
	P99  float64                                                                    `json:"p99,nullable"`
	JSON digitalExperienceMonitoringTracerouteDetailsPercentilesRoundTripTimeMsJSON `json:"-"`
}

func (*DigitalExperienceMonitoringTracerouteDetailsPercentilesRoundTripTimeMs) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTracerouteDetailsPercentilesRoundTripTimeMs) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStats 

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStats struct {
	AvailabilityPct DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsAvailabilityPct `json:"availabilityPct,required"`
	HopsCount       DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsHopsCount       `json:"hopsCount,required"`
	PacketLossPct   DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsPacketLossPct   `json:"packetLossPct,required"`
	RoundTripTimeMs DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsRoundTripTimeMs `json:"roundTripTimeMs,required"`
	// Count of unique devices that have run this test in the given time period
	UniqueDevicesTotal int64                                                           `json:"uniqueDevicesTotal,required"`
	JSON               digitalExperienceMonitoringTracerouteDetailsTracerouteStatsJSON `json:"-"`
}

func (*DigitalExperienceMonitoringTracerouteDetailsTracerouteStats) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTracerouteDetailsTracerouteStats) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsAvailabilityPct 

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsAvailabilityPct struct {
	Slots []DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsAvailabilityPctSlot `json:"slots,required"`
	// average observed in the time period
	Avg float64 `json:"avg,nullable"`
	// highest observed in the time period
	Max float64 `json:"max,nullable"`
	// lowest observed in the time period
	Min  float64                                                                        `json:"min,nullable"`
	JSON digitalExperienceMonitoringTracerouteDetailsTracerouteStatsAvailabilityPctJSON `json:"-"`
}

func (*DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsAvailabilityPct) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsAvailabilityPct) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsAvailabilityPctSlot 

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsAvailabilityPctSlot struct {
	Timestamp string                                                                             `json:"timestamp,required"`
	Value     float64                                                                            `json:"value,required"`
	JSON      digitalExperienceMonitoringTracerouteDetailsTracerouteStatsAvailabilityPctSlotJSON `json:"-"`
}

func (*DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsAvailabilityPctSlot) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsAvailabilityPctSlot) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColo 

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColo struct {
	AvailabilityPct DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoAvailabilityPct `json:"availabilityPct,required"`
	Colo            string                                                                           `json:"colo,required"`
	HopsCount       DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoHopsCount       `json:"hopsCount,required"`
	PacketLossPct   DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoPacketLossPct   `json:"packetLossPct,required"`
	RoundTripTimeMs DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoRoundTripTimeMs `json:"roundTripTimeMs,required"`
	// Count of unique devices that have run this test in the given time period
	UniqueDevicesTotal int64                                                                 `json:"uniqueDevicesTotal,required"`
	JSON               digitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoJSON `json:"-"`
}

func (*DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColo) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColo) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoAvailabilityPct 

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoAvailabilityPct struct {
	Slots []DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoAvailabilityPctSlot `json:"slots,required"`
	// average observed in the time period
	Avg float64 `json:"avg,nullable"`
	// highest observed in the time period
	Max float64 `json:"max,nullable"`
	// lowest observed in the time period
	Min  float64                                                                              `json:"min,nullable"`
	JSON digitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoAvailabilityPctJSON `json:"-"`
}

func (*DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoAvailabilityPct) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoAvailabilityPct) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoAvailabilityPctSlot 

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoAvailabilityPctSlot struct {
	Timestamp string                                                                                   `json:"timestamp,required"`
	Value     float64                                                                                  `json:"value,required"`
	JSON      digitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoAvailabilityPctSlotJSON `json:"-"`
}

func (*DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoAvailabilityPctSlot) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoAvailabilityPctSlot) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoHopsCount 

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoHopsCount struct {
	Slots []DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoHopsCountSlot `json:"slots,required"`
	// average observed in the time period
	Avg int64 `json:"avg,nullable"`
	// highest observed in the time period
	Max int64 `json:"max,nullable"`
	// lowest observed in the time period
	Min  int64                                                                          `json:"min,nullable"`
	JSON digitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoHopsCountJSON `json:"-"`
}

func (*DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoHopsCount) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoHopsCount) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoHopsCountSlot 

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoHopsCountSlot struct {
	Timestamp string                                                                             `json:"timestamp,required"`
	Value     int64                                                                              `json:"value,required"`
	JSON      digitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoHopsCountSlotJSON `json:"-"`
}

func (*DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoHopsCountSlot) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoHopsCountSlot) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoPacketLossPct 

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoPacketLossPct struct {
	Slots []DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoPacketLossPctSlot `json:"slots,required"`
	// average observed in the time period
	Avg float64 `json:"avg,nullable"`
	// highest observed in the time period
	Max float64 `json:"max,nullable"`
	// lowest observed in the time period
	Min  float64                                                                            `json:"min,nullable"`
	JSON digitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoPacketLossPctJSON `json:"-"`
}

func (*DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoPacketLossPct) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoPacketLossPct) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoPacketLossPctSlot 

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoPacketLossPctSlot struct {
	Timestamp string                                                                                 `json:"timestamp,required"`
	Value     float64                                                                                `json:"value,required"`
	JSON      digitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoPacketLossPctSlotJSON `json:"-"`
}

func (*DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoPacketLossPctSlot) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoPacketLossPctSlot) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoRoundTripTimeMs 

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoRoundTripTimeMs struct {
	Slots []DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoRoundTripTimeMsSlot `json:"slots,required"`
	// average observed in the time period
	Avg int64 `json:"avg,nullable"`
	// highest observed in the time period
	Max int64 `json:"max,nullable"`
	// lowest observed in the time period
	Min  int64                                                                                `json:"min,nullable"`
	JSON digitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoRoundTripTimeMsJSON `json:"-"`
}

func (*DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoRoundTripTimeMs) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoRoundTripTimeMs) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoRoundTripTimeMsSlot 

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoRoundTripTimeMsSlot struct {
	Timestamp string                                                                                   `json:"timestamp,required"`
	Value     int64                                                                                    `json:"value,required"`
	JSON      digitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoRoundTripTimeMsSlotJSON `json:"-"`
}

func (*DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoRoundTripTimeMsSlot) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsByColoRoundTripTimeMsSlot) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsHopsCount 

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsHopsCount struct {
	Slots []DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsHopsCountSlot `json:"slots,required"`
	// average observed in the time period
	Avg int64 `json:"avg,nullable"`
	// highest observed in the time period
	Max int64 `json:"max,nullable"`
	// lowest observed in the time period
	Min  int64                                                                    `json:"min,nullable"`
	JSON digitalExperienceMonitoringTracerouteDetailsTracerouteStatsHopsCountJSON `json:"-"`
}

func (*DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsHopsCount) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsHopsCount) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsHopsCountSlot 

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsHopsCountSlot struct {
	Timestamp string                                                                       `json:"timestamp,required"`
	Value     int64                                                                        `json:"value,required"`
	JSON      digitalExperienceMonitoringTracerouteDetailsTracerouteStatsHopsCountSlotJSON `json:"-"`
}

func (*DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsHopsCountSlot) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsHopsCountSlot) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsPacketLossPct 

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsPacketLossPct struct {
	Slots []DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsPacketLossPctSlot `json:"slots,required"`
	// average observed in the time period
	Avg float64 `json:"avg,nullable"`
	// highest observed in the time period
	Max float64 `json:"max,nullable"`
	// lowest observed in the time period
	Min  float64                                                                      `json:"min,nullable"`
	JSON digitalExperienceMonitoringTracerouteDetailsTracerouteStatsPacketLossPctJSON `json:"-"`
}

func (*DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsPacketLossPct) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsPacketLossPct) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsPacketLossPctSlot 

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsPacketLossPctSlot struct {
	Timestamp string                                                                           `json:"timestamp,required"`
	Value     float64                                                                          `json:"value,required"`
	JSON      digitalExperienceMonitoringTracerouteDetailsTracerouteStatsPacketLossPctSlotJSON `json:"-"`
}

func (*DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsPacketLossPctSlot) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsPacketLossPctSlot) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsRoundTripTimeMs 

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsRoundTripTimeMs struct {
	Slots []DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsRoundTripTimeMsSlot `json:"slots,required"`
	// average observed in the time period
	Avg int64 `json:"avg,nullable"`
	// highest observed in the time period
	Max int64 `json:"max,nullable"`
	// lowest observed in the time period
	Min  int64                                                                          `json:"min,nullable"`
	JSON digitalExperienceMonitoringTracerouteDetailsTracerouteStatsRoundTripTimeMsJSON `json:"-"`
}

func (*DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsRoundTripTimeMs) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsRoundTripTimeMs) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsRoundTripTimeMsSlot 

type DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsRoundTripTimeMsSlot struct {
	Timestamp string                                                                             `json:"timestamp,required"`
	Value     int64                                                                              `json:"value,required"`
	JSON      digitalExperienceMonitoringTracerouteDetailsTracerouteStatsRoundTripTimeMsSlotJSON `json:"-"`
}

func (*DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsRoundTripTimeMsSlot) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTracerouteDetailsTracerouteStatsRoundTripTimeMsSlot) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTracerouteTestNetworkPath 

type DigitalExperienceMonitoringTracerouteTestNetworkPath struct {
	// API Resource UUID tag.
	ID         string `json:"id,required"`
	DeviceName string `json:"deviceName"`
	// The interval at which the Traceroute synthetic application test is set to run.
	Interval    string                                                          `json:"interval"`
	Kind        DigitalExperienceMonitoringTracerouteTestNetworkPathKind        `json:"kind"`
	Name        string                                                          `json:"name"`
	NetworkPath DigitalExperienceMonitoringTracerouteTestNetworkPathNetworkPath `json:"networkPath,nullable"`
	// The host of the Traceroute synthetic application test
	URL  string                                                   `json:"url"`
	JSON digitalExperienceMonitoringTracerouteTestNetworkPathJSON `json:"-"`
}

func (*DigitalExperienceMonitoringTracerouteTestNetworkPath) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTracerouteTestNetworkPath) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTracerouteTestNetworkPathKind 

type DigitalExperienceMonitoringTracerouteTestNetworkPathKind string
const (
	DigitalExperienceMonitoringTracerouteTestNetworkPathKindTraceroute DigitalExperienceMonitoringTracerouteTestNetworkPathKind = "traceroute"
)

type DigitalExperienceMonitoringTracerouteTestNetworkPathNetworkPath 

type DigitalExperienceMonitoringTracerouteTestNetworkPathNetworkPath struct {
	Slots []DigitalExperienceMonitoringTracerouteTestNetworkPathNetworkPathSlot `json:"slots,required"`
	// Specifies the sampling applied, if any, to the slots response. When sampled,
	// results shown represent the first test run to the start of each sampling
	// interval.
	Sampling DigitalExperienceMonitoringTracerouteTestNetworkPathNetworkPathSampling `json:"sampling,nullable"`
	JSON     digitalExperienceMonitoringTracerouteTestNetworkPathNetworkPathJSON     `json:"-"`
}

func (*DigitalExperienceMonitoringTracerouteTestNetworkPathNetworkPath) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTracerouteTestNetworkPathNetworkPath) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTracerouteTestNetworkPathNetworkPathSampling 

type DigitalExperienceMonitoringTracerouteTestNetworkPathNetworkPathSampling struct {
	Unit  DigitalExperienceMonitoringTracerouteTestNetworkPathNetworkPathSamplingUnit `json:"unit,required"`
	Value int64                                                                       `json:"value,required"`
	JSON  digitalExperienceMonitoringTracerouteTestNetworkPathNetworkPathSamplingJSON `json:"-"`
}

Specifies the sampling applied, if any, to the slots response. When sampled, results shown represent the first test run to the start of each sampling interval.

func (*DigitalExperienceMonitoringTracerouteTestNetworkPathNetworkPathSampling) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTracerouteTestNetworkPathNetworkPathSampling) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTracerouteTestNetworkPathNetworkPathSamplingUnit 

type DigitalExperienceMonitoringTracerouteTestNetworkPathNetworkPathSamplingUnit string
const (
	DigitalExperienceMonitoringTracerouteTestNetworkPathNetworkPathSamplingUnitHours DigitalExperienceMonitoringTracerouteTestNetworkPathNetworkPathSamplingUnit = "hours"
)

type DigitalExperienceMonitoringTracerouteTestNetworkPathNetworkPathSlot 

type DigitalExperienceMonitoringTracerouteTestNetworkPathNetworkPathSlot struct {
	// API Resource UUID tag.
	ID string `json:"id,required"`
	// Round trip time in ms of the client to app mile
	ClientToAppRTTMs int64 `json:"clientToAppRttMs,required,nullable"`
	// Round trip time in ms of the client to Cloudflare egress mile
	ClientToCfEgressRTTMs int64 `json:"clientToCfEgressRttMs,required,nullable"`
	// Round trip time in ms of the client to Cloudflare ingress mile
	ClientToCfIngressRTTMs int64  `json:"clientToCfIngressRttMs,required,nullable"`
	Timestamp              string `json:"timestamp,required"`
	// Round trip time in ms of the client to ISP mile
	ClientToIspRTTMs int64                                                                   `json:"clientToIspRttMs,nullable"`
	JSON             digitalExperienceMonitoringTracerouteTestNetworkPathNetworkPathSlotJSON `json:"-"`
}

func (*DigitalExperienceMonitoringTracerouteTestNetworkPathNetworkPathSlot) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTracerouteTestNetworkPathNetworkPathSlot) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTracerouteTestResultNetworkPath 

type DigitalExperienceMonitoringTracerouteTestResultNetworkPath struct {
	// an array of the hops taken by the device to reach the end destination
	Hops []DigitalExperienceMonitoringTracerouteTestResultNetworkPathHop `json:"hops,required"`
	// API Resource UUID tag.
	ResultID string `json:"resultId,required"`
	// date time of this traceroute test
	TimeStart string `json:"time_start,required"`
	// name of the device associated with this network path response
	DeviceName string `json:"deviceName"`
	// API Resource UUID tag.
	TestID string `json:"testId"`
	// name of the tracroute test
	TestName string                                                         `json:"testName"`
	JSON     digitalExperienceMonitoringTracerouteTestResultNetworkPathJSON `json:"-"`
}

func (*DigitalExperienceMonitoringTracerouteTestResultNetworkPath) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTracerouteTestResultNetworkPath) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTracerouteTestResultNetworkPathHop 

type DigitalExperienceMonitoringTracerouteTestResultNetworkPathHop struct {
	TTL           int64                                                                  `json:"ttl,required"`
	ASN           int64                                                                  `json:"asn,nullable"`
	Aso           string                                                                 `json:"aso,nullable"`
	IPAddress     string                                                                 `json:"ipAddress,nullable"`
	Location      DigitalExperienceMonitoringTracerouteTestResultNetworkPathHopsLocation `json:"location,nullable"`
	Mile          DigitalExperienceMonitoringTracerouteTestResultNetworkPathHopsMile     `json:"mile,nullable"`
	Name          string                                                                 `json:"name,nullable"`
	PacketLossPct float64                                                                `json:"packetLossPct,nullable"`
	RTTMs         int64                                                                  `json:"rttMs,nullable"`
	JSON          digitalExperienceMonitoringTracerouteTestResultNetworkPathHopJSON      `json:"-"`
}

func (*DigitalExperienceMonitoringTracerouteTestResultNetworkPathHop) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTracerouteTestResultNetworkPathHop) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTracerouteTestResultNetworkPathHopsLocation 

type DigitalExperienceMonitoringTracerouteTestResultNetworkPathHopsLocation struct {
	City  string                                                                     `json:"city,nullable"`
	State string                                                                     `json:"state,nullable"`
	Zip   string                                                                     `json:"zip,nullable"`
	JSON  digitalExperienceMonitoringTracerouteTestResultNetworkPathHopsLocationJSON `json:"-"`
}

func (*DigitalExperienceMonitoringTracerouteTestResultNetworkPathHopsLocation) UnmarshalJSON 

func (r *DigitalExperienceMonitoringTracerouteTestResultNetworkPathHopsLocation) UnmarshalJSON(data []byte) (err error)

type DigitalExperienceMonitoringTracerouteTestResultNetworkPathHopsMile 

type DigitalExperienceMonitoringTracerouteTestResultNetworkPathHopsMile string
const (
	DigitalExperienceMonitoringTracerouteTestResultNetworkPathHopsMileClientToApp       DigitalExperienceMonitoringTracerouteTestResultNetworkPathHopsMile = "client-to-app"
	DigitalExperienceMonitoringTracerouteTestResultNetworkPathHopsMileClientToCfEgress  DigitalExperienceMonitoringTracerouteTestResultNetworkPathHopsMile = "client-to-cf-egress"
	DigitalExperienceMonitoringTracerouteTestResultNetworkPathHopsMileClientToCfIngress DigitalExperienceMonitoringTracerouteTestResultNetworkPathHopsMile = "client-to-cf-ingress"
	DigitalExperienceMonitoringTracerouteTestResultNetworkPathHopsMileClientToIsp       DigitalExperienceMonitoringTracerouteTestResultNetworkPathHopsMile = "client-to-isp"
)

type DigitalExperienceMonitoringUniqueDevices 

type DigitalExperienceMonitoringUniqueDevices struct {
	// total number of unique devices
	UniqueDevicesTotal int64                                        `json:"uniqueDevicesTotal,required"`
	JSON               digitalExperienceMonitoringUniqueDevicesJSON `json:"-"`
}

func (*DigitalExperienceMonitoringUniqueDevices) UnmarshalJSON 

func (r *DigitalExperienceMonitoringUniqueDevices) UnmarshalJSON(data []byte) (err error)

type Error 

type Error = apierror.Error

type GatewayAppTypeListParams 

type GatewayAppTypeListParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
}

type GatewayAppTypeListResponseEnvelope 

type GatewayAppTypeListResponseEnvelope struct {
	Errors   []GatewayAppTypeListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []GatewayAppTypeListResponseEnvelopeMessages `json:"messages,required"`
	Result   []ZeroTrustGatewayAppTypes                   `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    GatewayAppTypeListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo GatewayAppTypeListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       gatewayAppTypeListResponseEnvelopeJSON       `json:"-"`
}

func (*GatewayAppTypeListResponseEnvelope) UnmarshalJSON 

func (r *GatewayAppTypeListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type GatewayAppTypeListResponseEnvelopeErrors 

type GatewayAppTypeListResponseEnvelopeErrors struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    gatewayAppTypeListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*GatewayAppTypeListResponseEnvelopeErrors) UnmarshalJSON 

func (r *GatewayAppTypeListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type GatewayAppTypeListResponseEnvelopeMessages 

type GatewayAppTypeListResponseEnvelopeMessages struct {
	Code    int64                                          `json:"code,required"`
	Message string                                         `json:"message,required"`
	JSON    gatewayAppTypeListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*GatewayAppTypeListResponseEnvelopeMessages) UnmarshalJSON 

func (r *GatewayAppTypeListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type GatewayAppTypeListResponseEnvelopeResultInfo 

type GatewayAppTypeListResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                          `json:"total_count"`
	JSON       gatewayAppTypeListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*GatewayAppTypeListResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *GatewayAppTypeListResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type GatewayAppTypeListResponseEnvelopeSuccess 

type GatewayAppTypeListResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	GatewayAppTypeListResponseEnvelopeSuccessTrue GatewayAppTypeListResponseEnvelopeSuccess = true
)

type GatewayAppTypeService 

type GatewayAppTypeService struct {
	Options []option.RequestOption
}

GatewayAppTypeService 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 NewGatewayAppTypeService method instead.

func NewGatewayAppTypeService 

func NewGatewayAppTypeService(opts ...option.RequestOption) (r *GatewayAppTypeService)

NewGatewayAppTypeService 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 (*GatewayAppTypeService) List 

func (r *GatewayAppTypeService) List(ctx context.Context, query GatewayAppTypeListParams, opts ...option.RequestOption) (res *[]ZeroTrustGatewayAppTypes, err error)

Fetches all application and application type mappings.

type GatewayAuditSSHSettingGetParams 

type GatewayAuditSSHSettingGetParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type GatewayAuditSSHSettingGetResponseEnvelope 

type GatewayAuditSSHSettingGetResponseEnvelope struct {
	Errors   []GatewayAuditSSHSettingGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []GatewayAuditSSHSettingGetResponseEnvelopeMessages `json:"messages,required"`
	Result   ZeroTrustGatewaySettings                            `json:"result,required"`
	// Whether the API call was successful
	Success GatewayAuditSSHSettingGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    gatewayAuditSSHSettingGetResponseEnvelopeJSON    `json:"-"`
}

func (*GatewayAuditSSHSettingGetResponseEnvelope) UnmarshalJSON 

func (r *GatewayAuditSSHSettingGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type GatewayAuditSSHSettingGetResponseEnvelopeErrors 

type GatewayAuditSSHSettingGetResponseEnvelopeErrors struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    gatewayAuditSSHSettingGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*GatewayAuditSSHSettingGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *GatewayAuditSSHSettingGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type GatewayAuditSSHSettingGetResponseEnvelopeMessages 

type GatewayAuditSSHSettingGetResponseEnvelopeMessages struct {
	Code    int64                                                 `json:"code,required"`
	Message string                                                `json:"message,required"`
	JSON    gatewayAuditSSHSettingGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*GatewayAuditSSHSettingGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *GatewayAuditSSHSettingGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type GatewayAuditSSHSettingGetResponseEnvelopeSuccess 

type GatewayAuditSSHSettingGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	GatewayAuditSSHSettingGetResponseEnvelopeSuccessTrue GatewayAuditSSHSettingGetResponseEnvelopeSuccess = true
)

type GatewayAuditSSHSettingService 

type GatewayAuditSSHSettingService struct {
	Options []option.RequestOption
}

GatewayAuditSSHSettingService 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 NewGatewayAuditSSHSettingService method instead.

func NewGatewayAuditSSHSettingService 

func NewGatewayAuditSSHSettingService(opts ...option.RequestOption) (r *GatewayAuditSSHSettingService)

NewGatewayAuditSSHSettingService 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 (*GatewayAuditSSHSettingService) Get 

func (r *GatewayAuditSSHSettingService) Get(ctx context.Context, query GatewayAuditSSHSettingGetParams, opts ...option.RequestOption) (res *ZeroTrustGatewaySettings, err error)

Get all Zero Trust Audit SSH settings for an account.

func (*GatewayAuditSSHSettingService) Update 

func (r *GatewayAuditSSHSettingService) Update(ctx context.Context, params GatewayAuditSSHSettingUpdateParams, opts ...option.RequestOption) (res *ZeroTrustGatewaySettings, err error)

Updates Zero Trust Audit SSH settings.

type GatewayAuditSSHSettingUpdateParams 

type GatewayAuditSSHSettingUpdateParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
	// SSH encryption public key
	PublicKey param.Field[string] `json:"public_key,required"`
	// Seed ID
	SeedID param.Field[string] `json:"seed_id"`
}

func (GatewayAuditSSHSettingUpdateParams) MarshalJSON 

func (r GatewayAuditSSHSettingUpdateParams) MarshalJSON() (data []byte, err error)

type GatewayAuditSSHSettingUpdateResponseEnvelope 

type GatewayAuditSSHSettingUpdateResponseEnvelope struct {
	Errors   []GatewayAuditSSHSettingUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []GatewayAuditSSHSettingUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   ZeroTrustGatewaySettings                               `json:"result,required"`
	// Whether the API call was successful
	Success GatewayAuditSSHSettingUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    gatewayAuditSSHSettingUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*GatewayAuditSSHSettingUpdateResponseEnvelope) UnmarshalJSON 

func (r *GatewayAuditSSHSettingUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type GatewayAuditSSHSettingUpdateResponseEnvelopeErrors 

type GatewayAuditSSHSettingUpdateResponseEnvelopeErrors struct {
	Code    int64                                                  `json:"code,required"`
	Message string                                                 `json:"message,required"`
	JSON    gatewayAuditSSHSettingUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*GatewayAuditSSHSettingUpdateResponseEnvelopeErrors) UnmarshalJSON 

func (r *GatewayAuditSSHSettingUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type GatewayAuditSSHSettingUpdateResponseEnvelopeMessages 

type GatewayAuditSSHSettingUpdateResponseEnvelopeMessages struct {
	Code    int64                                                    `json:"code,required"`
	Message string                                                   `json:"message,required"`
	JSON    gatewayAuditSSHSettingUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*GatewayAuditSSHSettingUpdateResponseEnvelopeMessages) UnmarshalJSON 

func (r *GatewayAuditSSHSettingUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type GatewayAuditSSHSettingUpdateResponseEnvelopeSuccess 

type GatewayAuditSSHSettingUpdateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	GatewayAuditSSHSettingUpdateResponseEnvelopeSuccessTrue GatewayAuditSSHSettingUpdateResponseEnvelopeSuccess = true
)

type GatewayCategoryListParams 

type GatewayCategoryListParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
}

type GatewayCategoryListResponseEnvelope 

type GatewayCategoryListResponseEnvelope struct {
	Errors   []GatewayCategoryListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []GatewayCategoryListResponseEnvelopeMessages `json:"messages,required"`
	Result   []ZeroTrustGatewayCategories                  `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    GatewayCategoryListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo GatewayCategoryListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       gatewayCategoryListResponseEnvelopeJSON       `json:"-"`
}

func (*GatewayCategoryListResponseEnvelope) UnmarshalJSON 

func (r *GatewayCategoryListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type GatewayCategoryListResponseEnvelopeErrors 

type GatewayCategoryListResponseEnvelopeErrors struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    gatewayCategoryListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*GatewayCategoryListResponseEnvelopeErrors) UnmarshalJSON 

func (r *GatewayCategoryListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type GatewayCategoryListResponseEnvelopeMessages 

type GatewayCategoryListResponseEnvelopeMessages struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    gatewayCategoryListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*GatewayCategoryListResponseEnvelopeMessages) UnmarshalJSON 

func (r *GatewayCategoryListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type GatewayCategoryListResponseEnvelopeResultInfo 

type GatewayCategoryListResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                           `json:"total_count"`
	JSON       gatewayCategoryListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*GatewayCategoryListResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *GatewayCategoryListResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type GatewayCategoryListResponseEnvelopeSuccess 

type GatewayCategoryListResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	GatewayCategoryListResponseEnvelopeSuccessTrue GatewayCategoryListResponseEnvelopeSuccess = true
)

type GatewayCategoryService 

type GatewayCategoryService struct {
	Options []option.RequestOption
}

GatewayCategoryService 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 NewGatewayCategoryService method instead.

func NewGatewayCategoryService 

func NewGatewayCategoryService(opts ...option.RequestOption) (r *GatewayCategoryService)

NewGatewayCategoryService 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 (*GatewayCategoryService) List 

func (r *GatewayCategoryService) List(ctx context.Context, query GatewayCategoryListParams, opts ...option.RequestOption) (res *[]ZeroTrustGatewayCategories, err error)

Fetches a list of all categories.

type GatewayConfigurationEditParams 

type GatewayConfigurationEditParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
	// account settings.
	Settings param.Field[GatewayConfigurationEditParamsSettings] `json:"settings"`
}

func (GatewayConfigurationEditParams) MarshalJSON 

func (r GatewayConfigurationEditParams) MarshalJSON() (data []byte, err error)

type GatewayConfigurationEditParamsSettings 

type GatewayConfigurationEditParamsSettings struct {
	// Activity log settings.
	ActivityLog param.Field[GatewayConfigurationEditParamsSettingsActivityLog] `json:"activity_log"`
	// Anti-virus settings.
	Antivirus param.Field[GatewayConfigurationEditParamsSettingsAntivirus] `json:"antivirus"`
	// Block page layout settings.
	BlockPage param.Field[GatewayConfigurationEditParamsSettingsBlockPage] `json:"block_page"`
	// DLP body scanning settings.
	BodyScanning param.Field[GatewayConfigurationEditParamsSettingsBodyScanning] `json:"body_scanning"`
	// Browser isolation settings.
	BrowserIsolation param.Field[GatewayConfigurationEditParamsSettingsBrowserIsolation] `json:"browser_isolation"`
	// Custom certificate settings for BYO-PKI.
	CustomCertificate param.Field[GatewayConfigurationEditParamsSettingsCustomCertificate] `json:"custom_certificate"`
	// Extended e-mail matching settings.
	ExtendedEmailMatching param.Field[GatewayConfigurationEditParamsSettingsExtendedEmailMatching] `json:"extended_email_matching"`
	// FIPS settings.
	Fips param.Field[GatewayConfigurationEditParamsSettingsFips] `json:"fips"`
	// Protocol Detection settings.
	ProtocolDetection param.Field[GatewayConfigurationEditParamsSettingsProtocolDetection] `json:"protocol_detection"`
	// TLS interception settings.
	TLSDecrypt param.Field[GatewayConfigurationEditParamsSettingsTLSDecrypt] `json:"tls_decrypt"`
}

account settings.

func (GatewayConfigurationEditParamsSettings) MarshalJSON 

func (r GatewayConfigurationEditParamsSettings) MarshalJSON() (data []byte, err error)

type GatewayConfigurationEditParamsSettingsActivityLog 

type GatewayConfigurationEditParamsSettingsActivityLog struct {
	// Enable activity logging.
	Enabled param.Field[bool] `json:"enabled"`
}

Activity log settings.

func (GatewayConfigurationEditParamsSettingsActivityLog) MarshalJSON 

func (r GatewayConfigurationEditParamsSettingsActivityLog) MarshalJSON() (data []byte, err error)

type GatewayConfigurationEditParamsSettingsAntivirus 

type GatewayConfigurationEditParamsSettingsAntivirus struct {
	// Enable anti-virus scanning on downloads.
	EnabledDownloadPhase param.Field[bool] `json:"enabled_download_phase"`
	// Enable anti-virus scanning on uploads.
	EnabledUploadPhase param.Field[bool] `json:"enabled_upload_phase"`
	// Block requests for files that cannot be scanned.
	FailClosed param.Field[bool] `json:"fail_closed"`
	// Configure a message to display on the user's device when an antivirus search is
	// performed.
	NotificationSettings param.Field[GatewayConfigurationEditParamsSettingsAntivirusNotificationSettings] `json:"notification_settings"`
}

Anti-virus settings.

func (GatewayConfigurationEditParamsSettingsAntivirus) MarshalJSON 

func (r GatewayConfigurationEditParamsSettingsAntivirus) MarshalJSON() (data []byte, err error)

type GatewayConfigurationEditParamsSettingsAntivirusNotificationSettings 

type GatewayConfigurationEditParamsSettingsAntivirusNotificationSettings struct {
	// Set notification on
	Enabled param.Field[bool] `json:"enabled"`
	// Customize the message shown in the notification.
	Msg param.Field[string] `json:"msg"`
	// Optional URL to direct users to additional information. If not set, the
	// notification will open a block page.
	SupportURL param.Field[string] `json:"support_url"`
}

Configure a message to display on the user's device when an antivirus search is performed.

func (GatewayConfigurationEditParamsSettingsAntivirusNotificationSettings) MarshalJSON 

func (r GatewayConfigurationEditParamsSettingsAntivirusNotificationSettings) MarshalJSON() (data []byte, err error)

type GatewayConfigurationEditParamsSettingsBlockPage 

type GatewayConfigurationEditParamsSettingsBlockPage struct {
	// Block page background color in #rrggbb format.
	BackgroundColor param.Field[string] `json:"background_color"`
	// Enable only cipher suites and TLS versions compliant with FIPS 140-2.
	Enabled param.Field[bool] `json:"enabled"`
	// Block page footer text.
	FooterText param.Field[string] `json:"footer_text"`
	// Block page header text.
	HeaderText param.Field[string] `json:"header_text"`
	// Full URL to the logo file.
	LogoPath param.Field[string] `json:"logo_path"`
	// Admin email for users to contact.
	MailtoAddress param.Field[string] `json:"mailto_address"`
	// Subject line for emails created from block page.
	MailtoSubject param.Field[string] `json:"mailto_subject"`
	// Block page title.
	Name param.Field[string] `json:"name"`
	// Suppress detailed info at the bottom of the block page.
	SuppressFooter param.Field[bool] `json:"suppress_footer"`
}

Block page layout settings.

func (GatewayConfigurationEditParamsSettingsBlockPage) MarshalJSON 

func (r GatewayConfigurationEditParamsSettingsBlockPage) MarshalJSON() (data []byte, err error)

type GatewayConfigurationEditParamsSettingsBodyScanning 

type GatewayConfigurationEditParamsSettingsBodyScanning struct {
	// Set the inspection mode to either `deep` or `shallow`.
	InspectionMode param.Field[string] `json:"inspection_mode"`
}

DLP body scanning settings.

func (GatewayConfigurationEditParamsSettingsBodyScanning) MarshalJSON 

func (r GatewayConfigurationEditParamsSettingsBodyScanning) MarshalJSON() (data []byte, err error)

type GatewayConfigurationEditParamsSettingsBrowserIsolation 

type GatewayConfigurationEditParamsSettingsBrowserIsolation struct {
	// Enable non-identity onramp support for Browser Isolation.
	NonIdentityEnabled param.Field[bool] `json:"non_identity_enabled"`
	// Enable Clientless Browser Isolation.
	URLBrowserIsolationEnabled param.Field[bool] `json:"url_browser_isolation_enabled"`
}

Browser isolation settings.

func (GatewayConfigurationEditParamsSettingsBrowserIsolation) MarshalJSON 

func (r GatewayConfigurationEditParamsSettingsBrowserIsolation) MarshalJSON() (data []byte, err error)

type GatewayConfigurationEditParamsSettingsCustomCertificate 

type GatewayConfigurationEditParamsSettingsCustomCertificate struct {
	// Enable use of custom certificate authority for signing Gateway traffic.
	Enabled param.Field[bool] `json:"enabled,required"`
	// UUID of certificate (ID from MTLS certificate store).
	ID param.Field[string] `json:"id"`
}

Custom certificate settings for BYO-PKI.

func (GatewayConfigurationEditParamsSettingsCustomCertificate) MarshalJSON 

func (r GatewayConfigurationEditParamsSettingsCustomCertificate) MarshalJSON() (data []byte, err error)

type GatewayConfigurationEditParamsSettingsExtendedEmailMatching 

type GatewayConfigurationEditParamsSettingsExtendedEmailMatching struct {
	// Enable matching all variants of user emails (with + or . modifiers) used as
	// criteria in Firewall policies.
	Enabled param.Field[bool] `json:"enabled"`
}

Extended e-mail matching settings.

func (GatewayConfigurationEditParamsSettingsExtendedEmailMatching) MarshalJSON 

func (r GatewayConfigurationEditParamsSettingsExtendedEmailMatching) MarshalJSON() (data []byte, err error)

type GatewayConfigurationEditParamsSettingsFips 

type GatewayConfigurationEditParamsSettingsFips struct {
	// Enable only cipher suites and TLS versions compliant with FIPS 140-2.
	TLS param.Field[bool] `json:"tls"`
}

FIPS settings.

func (GatewayConfigurationEditParamsSettingsFips) MarshalJSON 

func (r GatewayConfigurationEditParamsSettingsFips) MarshalJSON() (data []byte, err error)

type GatewayConfigurationEditParamsSettingsProtocolDetection 

type GatewayConfigurationEditParamsSettingsProtocolDetection struct {
	// Enable detecting protocol on initial bytes of client traffic.
	Enabled param.Field[bool] `json:"enabled"`
}

Protocol Detection settings.

func (GatewayConfigurationEditParamsSettingsProtocolDetection) MarshalJSON 

func (r GatewayConfigurationEditParamsSettingsProtocolDetection) MarshalJSON() (data []byte, err error)

type GatewayConfigurationEditParamsSettingsTLSDecrypt 

type GatewayConfigurationEditParamsSettingsTLSDecrypt struct {
	// Enable inspecting encrypted HTTP traffic.
	Enabled param.Field[bool] `json:"enabled"`
}

TLS interception settings.

func (GatewayConfigurationEditParamsSettingsTLSDecrypt) MarshalJSON 

func (r GatewayConfigurationEditParamsSettingsTLSDecrypt) MarshalJSON() (data []byte, err error)

type GatewayConfigurationEditResponse 

type GatewayConfigurationEditResponse struct {
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// account settings.
	Settings  GatewayConfigurationEditResponseSettings `json:"settings"`
	UpdatedAt time.Time                                `json:"updated_at" format:"date-time"`
	JSON      gatewayConfigurationEditResponseJSON     `json:"-"`
}

account settings.

func (*GatewayConfigurationEditResponse) UnmarshalJSON 

func (r *GatewayConfigurationEditResponse) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationEditResponseEnvelope 

type GatewayConfigurationEditResponseEnvelope struct {
	Errors   []GatewayConfigurationEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []GatewayConfigurationEditResponseEnvelopeMessages `json:"messages,required"`
	// account settings.
	Result GatewayConfigurationEditResponse `json:"result,required"`
	// Whether the API call was successful
	Success GatewayConfigurationEditResponseEnvelopeSuccess `json:"success,required"`
	JSON    gatewayConfigurationEditResponseEnvelopeJSON    `json:"-"`
}

func (*GatewayConfigurationEditResponseEnvelope) UnmarshalJSON 

func (r *GatewayConfigurationEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationEditResponseEnvelopeErrors 

type GatewayConfigurationEditResponseEnvelopeErrors struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    gatewayConfigurationEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*GatewayConfigurationEditResponseEnvelopeErrors) UnmarshalJSON 

func (r *GatewayConfigurationEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationEditResponseEnvelopeMessages 

type GatewayConfigurationEditResponseEnvelopeMessages struct {
	Code    int64                                                `json:"code,required"`
	Message string                                               `json:"message,required"`
	JSON    gatewayConfigurationEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*GatewayConfigurationEditResponseEnvelopeMessages) UnmarshalJSON 

func (r *GatewayConfigurationEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationEditResponseEnvelopeSuccess 

type GatewayConfigurationEditResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	GatewayConfigurationEditResponseEnvelopeSuccessTrue GatewayConfigurationEditResponseEnvelopeSuccess = true
)

type GatewayConfigurationEditResponseSettings 

type GatewayConfigurationEditResponseSettings struct {
	// Activity log settings.
	ActivityLog GatewayConfigurationEditResponseSettingsActivityLog `json:"activity_log"`
	// Anti-virus settings.
	Antivirus GatewayConfigurationEditResponseSettingsAntivirus `json:"antivirus"`
	// Block page layout settings.
	BlockPage GatewayConfigurationEditResponseSettingsBlockPage `json:"block_page"`
	// DLP body scanning settings.
	BodyScanning GatewayConfigurationEditResponseSettingsBodyScanning `json:"body_scanning"`
	// Browser isolation settings.
	BrowserIsolation GatewayConfigurationEditResponseSettingsBrowserIsolation `json:"browser_isolation"`
	// Custom certificate settings for BYO-PKI.
	CustomCertificate GatewayConfigurationEditResponseSettingsCustomCertificate `json:"custom_certificate"`
	// Extended e-mail matching settings.
	ExtendedEmailMatching GatewayConfigurationEditResponseSettingsExtendedEmailMatching `json:"extended_email_matching"`
	// FIPS settings.
	Fips GatewayConfigurationEditResponseSettingsFips `json:"fips"`
	// Protocol Detection settings.
	ProtocolDetection GatewayConfigurationEditResponseSettingsProtocolDetection `json:"protocol_detection"`
	// TLS interception settings.
	TLSDecrypt GatewayConfigurationEditResponseSettingsTLSDecrypt `json:"tls_decrypt"`
	JSON       gatewayConfigurationEditResponseSettingsJSON       `json:"-"`
}

account settings.

func (*GatewayConfigurationEditResponseSettings) UnmarshalJSON 

func (r *GatewayConfigurationEditResponseSettings) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationEditResponseSettingsActivityLog 

type GatewayConfigurationEditResponseSettingsActivityLog struct {
	// Enable activity logging.
	Enabled bool                                                    `json:"enabled"`
	JSON    gatewayConfigurationEditResponseSettingsActivityLogJSON `json:"-"`
}

Activity log settings.

func (*GatewayConfigurationEditResponseSettingsActivityLog) UnmarshalJSON 

func (r *GatewayConfigurationEditResponseSettingsActivityLog) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationEditResponseSettingsAntivirus 

type GatewayConfigurationEditResponseSettingsAntivirus struct {
	// Enable anti-virus scanning on downloads.
	EnabledDownloadPhase bool `json:"enabled_download_phase"`
	// Enable anti-virus scanning on uploads.
	EnabledUploadPhase bool `json:"enabled_upload_phase"`
	// Block requests for files that cannot be scanned.
	FailClosed bool `json:"fail_closed"`
	// Configure a message to display on the user's device when an antivirus search is
	// performed.
	NotificationSettings GatewayConfigurationEditResponseSettingsAntivirusNotificationSettings `json:"notification_settings"`
	JSON                 gatewayConfigurationEditResponseSettingsAntivirusJSON                 `json:"-"`
}

Anti-virus settings.

func (*GatewayConfigurationEditResponseSettingsAntivirus) UnmarshalJSON 

func (r *GatewayConfigurationEditResponseSettingsAntivirus) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationEditResponseSettingsAntivirusNotificationSettings 

type GatewayConfigurationEditResponseSettingsAntivirusNotificationSettings struct {
	// Set notification on
	Enabled bool `json:"enabled"`
	// Customize the message shown in the notification.
	Msg string `json:"msg"`
	// Optional URL to direct users to additional information. If not set, the
	// notification will open a block page.
	SupportURL string                                                                    `json:"support_url"`
	JSON       gatewayConfigurationEditResponseSettingsAntivirusNotificationSettingsJSON `json:"-"`
}

Configure a message to display on the user's device when an antivirus search is performed.

func (*GatewayConfigurationEditResponseSettingsAntivirusNotificationSettings) UnmarshalJSON 

func (r *GatewayConfigurationEditResponseSettingsAntivirusNotificationSettings) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationEditResponseSettingsBlockPage 

type GatewayConfigurationEditResponseSettingsBlockPage struct {
	// Block page background color in #rrggbb format.
	BackgroundColor string `json:"background_color"`
	// Enable only cipher suites and TLS versions compliant with FIPS 140-2.
	Enabled bool `json:"enabled"`
	// Block page footer text.
	FooterText string `json:"footer_text"`
	// Block page header text.
	HeaderText string `json:"header_text"`
	// Full URL to the logo file.
	LogoPath string `json:"logo_path"`
	// Admin email for users to contact.
	MailtoAddress string `json:"mailto_address"`
	// Subject line for emails created from block page.
	MailtoSubject string `json:"mailto_subject"`
	// Block page title.
	Name string `json:"name"`
	// Suppress detailed info at the bottom of the block page.
	SuppressFooter bool                                                  `json:"suppress_footer"`
	JSON           gatewayConfigurationEditResponseSettingsBlockPageJSON `json:"-"`
}

Block page layout settings.

func (*GatewayConfigurationEditResponseSettingsBlockPage) UnmarshalJSON 

func (r *GatewayConfigurationEditResponseSettingsBlockPage) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationEditResponseSettingsBodyScanning 

type GatewayConfigurationEditResponseSettingsBodyScanning struct {
	// Set the inspection mode to either `deep` or `shallow`.
	InspectionMode string                                                   `json:"inspection_mode"`
	JSON           gatewayConfigurationEditResponseSettingsBodyScanningJSON `json:"-"`
}

DLP body scanning settings.

func (*GatewayConfigurationEditResponseSettingsBodyScanning) UnmarshalJSON 

func (r *GatewayConfigurationEditResponseSettingsBodyScanning) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationEditResponseSettingsBrowserIsolation 

type GatewayConfigurationEditResponseSettingsBrowserIsolation struct {
	// Enable non-identity onramp support for Browser Isolation.
	NonIdentityEnabled bool `json:"non_identity_enabled"`
	// Enable Clientless Browser Isolation.
	URLBrowserIsolationEnabled bool                                                         `json:"url_browser_isolation_enabled"`
	JSON                       gatewayConfigurationEditResponseSettingsBrowserIsolationJSON `json:"-"`
}

Browser isolation settings.

func (*GatewayConfigurationEditResponseSettingsBrowserIsolation) UnmarshalJSON 

func (r *GatewayConfigurationEditResponseSettingsBrowserIsolation) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationEditResponseSettingsCustomCertificate 

type GatewayConfigurationEditResponseSettingsCustomCertificate struct {
	// Enable use of custom certificate authority for signing Gateway traffic.
	Enabled bool `json:"enabled,required"`
	// UUID of certificate (ID from MTLS certificate store).
	ID string `json:"id"`
	// Certificate status (internal).
	BindingStatus string                                                        `json:"binding_status"`
	UpdatedAt     time.Time                                                     `json:"updated_at" format:"date-time"`
	JSON          gatewayConfigurationEditResponseSettingsCustomCertificateJSON `json:"-"`
}

Custom certificate settings for BYO-PKI.

func (*GatewayConfigurationEditResponseSettingsCustomCertificate) UnmarshalJSON 

func (r *GatewayConfigurationEditResponseSettingsCustomCertificate) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationEditResponseSettingsExtendedEmailMatching 

type GatewayConfigurationEditResponseSettingsExtendedEmailMatching struct {
	// Enable matching all variants of user emails (with + or . modifiers) used as
	// criteria in Firewall policies.
	Enabled bool                                                              `json:"enabled"`
	JSON    gatewayConfigurationEditResponseSettingsExtendedEmailMatchingJSON `json:"-"`
}

Extended e-mail matching settings.

func (*GatewayConfigurationEditResponseSettingsExtendedEmailMatching) UnmarshalJSON 

func (r *GatewayConfigurationEditResponseSettingsExtendedEmailMatching) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationEditResponseSettingsFips 

type GatewayConfigurationEditResponseSettingsFips struct {
	// Enable only cipher suites and TLS versions compliant with FIPS 140-2.
	TLS  bool                                             `json:"tls"`
	JSON gatewayConfigurationEditResponseSettingsFipsJSON `json:"-"`
}

FIPS settings.

func (*GatewayConfigurationEditResponseSettingsFips) UnmarshalJSON 

func (r *GatewayConfigurationEditResponseSettingsFips) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationEditResponseSettingsProtocolDetection 

type GatewayConfigurationEditResponseSettingsProtocolDetection struct {
	// Enable detecting protocol on initial bytes of client traffic.
	Enabled bool                                                          `json:"enabled"`
	JSON    gatewayConfigurationEditResponseSettingsProtocolDetectionJSON `json:"-"`
}

Protocol Detection settings.

func (*GatewayConfigurationEditResponseSettingsProtocolDetection) UnmarshalJSON 

func (r *GatewayConfigurationEditResponseSettingsProtocolDetection) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationEditResponseSettingsTLSDecrypt 

type GatewayConfigurationEditResponseSettingsTLSDecrypt struct {
	// Enable inspecting encrypted HTTP traffic.
	Enabled bool                                                   `json:"enabled"`
	JSON    gatewayConfigurationEditResponseSettingsTLSDecryptJSON `json:"-"`
}

TLS interception settings.

func (*GatewayConfigurationEditResponseSettingsTLSDecrypt) UnmarshalJSON 

func (r *GatewayConfigurationEditResponseSettingsTLSDecrypt) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationGetParams 

type GatewayConfigurationGetParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type GatewayConfigurationGetResponse 

type GatewayConfigurationGetResponse struct {
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// account settings.
	Settings  GatewayConfigurationGetResponseSettings `json:"settings"`
	UpdatedAt time.Time                               `json:"updated_at" format:"date-time"`
	JSON      gatewayConfigurationGetResponseJSON     `json:"-"`
}

account settings.

func (*GatewayConfigurationGetResponse) UnmarshalJSON 

func (r *GatewayConfigurationGetResponse) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationGetResponseEnvelope 

type GatewayConfigurationGetResponseEnvelope struct {
	Errors   []GatewayConfigurationGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []GatewayConfigurationGetResponseEnvelopeMessages `json:"messages,required"`
	// account settings.
	Result GatewayConfigurationGetResponse `json:"result,required"`
	// Whether the API call was successful
	Success GatewayConfigurationGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    gatewayConfigurationGetResponseEnvelopeJSON    `json:"-"`
}

func (*GatewayConfigurationGetResponseEnvelope) UnmarshalJSON 

func (r *GatewayConfigurationGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationGetResponseEnvelopeErrors 

type GatewayConfigurationGetResponseEnvelopeErrors struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    gatewayConfigurationGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*GatewayConfigurationGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *GatewayConfigurationGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationGetResponseEnvelopeMessages 

type GatewayConfigurationGetResponseEnvelopeMessages struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    gatewayConfigurationGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*GatewayConfigurationGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *GatewayConfigurationGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationGetResponseEnvelopeSuccess 

type GatewayConfigurationGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	GatewayConfigurationGetResponseEnvelopeSuccessTrue GatewayConfigurationGetResponseEnvelopeSuccess = true
)

type GatewayConfigurationGetResponseSettings 

type GatewayConfigurationGetResponseSettings struct {
	// Activity log settings.
	ActivityLog GatewayConfigurationGetResponseSettingsActivityLog `json:"activity_log"`
	// Anti-virus settings.
	Antivirus GatewayConfigurationGetResponseSettingsAntivirus `json:"antivirus"`
	// Block page layout settings.
	BlockPage GatewayConfigurationGetResponseSettingsBlockPage `json:"block_page"`
	// DLP body scanning settings.
	BodyScanning GatewayConfigurationGetResponseSettingsBodyScanning `json:"body_scanning"`
	// Browser isolation settings.
	BrowserIsolation GatewayConfigurationGetResponseSettingsBrowserIsolation `json:"browser_isolation"`
	// Custom certificate settings for BYO-PKI.
	CustomCertificate GatewayConfigurationGetResponseSettingsCustomCertificate `json:"custom_certificate"`
	// Extended e-mail matching settings.
	ExtendedEmailMatching GatewayConfigurationGetResponseSettingsExtendedEmailMatching `json:"extended_email_matching"`
	// FIPS settings.
	Fips GatewayConfigurationGetResponseSettingsFips `json:"fips"`
	// Protocol Detection settings.
	ProtocolDetection GatewayConfigurationGetResponseSettingsProtocolDetection `json:"protocol_detection"`
	// TLS interception settings.
	TLSDecrypt GatewayConfigurationGetResponseSettingsTLSDecrypt `json:"tls_decrypt"`
	JSON       gatewayConfigurationGetResponseSettingsJSON       `json:"-"`
}

account settings.

func (*GatewayConfigurationGetResponseSettings) UnmarshalJSON 

func (r *GatewayConfigurationGetResponseSettings) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationGetResponseSettingsActivityLog 

type GatewayConfigurationGetResponseSettingsActivityLog struct {
	// Enable activity logging.
	Enabled bool                                                   `json:"enabled"`
	JSON    gatewayConfigurationGetResponseSettingsActivityLogJSON `json:"-"`
}

Activity log settings.

func (*GatewayConfigurationGetResponseSettingsActivityLog) UnmarshalJSON 

func (r *GatewayConfigurationGetResponseSettingsActivityLog) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationGetResponseSettingsAntivirus 

type GatewayConfigurationGetResponseSettingsAntivirus struct {
	// Enable anti-virus scanning on downloads.
	EnabledDownloadPhase bool `json:"enabled_download_phase"`
	// Enable anti-virus scanning on uploads.
	EnabledUploadPhase bool `json:"enabled_upload_phase"`
	// Block requests for files that cannot be scanned.
	FailClosed bool `json:"fail_closed"`
	// Configure a message to display on the user's device when an antivirus search is
	// performed.
	NotificationSettings GatewayConfigurationGetResponseSettingsAntivirusNotificationSettings `json:"notification_settings"`
	JSON                 gatewayConfigurationGetResponseSettingsAntivirusJSON                 `json:"-"`
}

Anti-virus settings.

func (*GatewayConfigurationGetResponseSettingsAntivirus) UnmarshalJSON 

func (r *GatewayConfigurationGetResponseSettingsAntivirus) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationGetResponseSettingsAntivirusNotificationSettings 

type GatewayConfigurationGetResponseSettingsAntivirusNotificationSettings struct {
	// Set notification on
	Enabled bool `json:"enabled"`
	// Customize the message shown in the notification.
	Msg string `json:"msg"`
	// Optional URL to direct users to additional information. If not set, the
	// notification will open a block page.
	SupportURL string                                                                   `json:"support_url"`
	JSON       gatewayConfigurationGetResponseSettingsAntivirusNotificationSettingsJSON `json:"-"`
}

Configure a message to display on the user's device when an antivirus search is performed.

func (*GatewayConfigurationGetResponseSettingsAntivirusNotificationSettings) UnmarshalJSON 

func (r *GatewayConfigurationGetResponseSettingsAntivirusNotificationSettings) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationGetResponseSettingsBlockPage 

type GatewayConfigurationGetResponseSettingsBlockPage struct {
	// Block page background color in #rrggbb format.
	BackgroundColor string `json:"background_color"`
	// Enable only cipher suites and TLS versions compliant with FIPS 140-2.
	Enabled bool `json:"enabled"`
	// Block page footer text.
	FooterText string `json:"footer_text"`
	// Block page header text.
	HeaderText string `json:"header_text"`
	// Full URL to the logo file.
	LogoPath string `json:"logo_path"`
	// Admin email for users to contact.
	MailtoAddress string `json:"mailto_address"`
	// Subject line for emails created from block page.
	MailtoSubject string `json:"mailto_subject"`
	// Block page title.
	Name string `json:"name"`
	// Suppress detailed info at the bottom of the block page.
	SuppressFooter bool                                                 `json:"suppress_footer"`
	JSON           gatewayConfigurationGetResponseSettingsBlockPageJSON `json:"-"`
}

Block page layout settings.

func (*GatewayConfigurationGetResponseSettingsBlockPage) UnmarshalJSON 

func (r *GatewayConfigurationGetResponseSettingsBlockPage) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationGetResponseSettingsBodyScanning 

type GatewayConfigurationGetResponseSettingsBodyScanning struct {
	// Set the inspection mode to either `deep` or `shallow`.
	InspectionMode string                                                  `json:"inspection_mode"`
	JSON           gatewayConfigurationGetResponseSettingsBodyScanningJSON `json:"-"`
}

DLP body scanning settings.

func (*GatewayConfigurationGetResponseSettingsBodyScanning) UnmarshalJSON 

func (r *GatewayConfigurationGetResponseSettingsBodyScanning) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationGetResponseSettingsBrowserIsolation 

type GatewayConfigurationGetResponseSettingsBrowserIsolation struct {
	// Enable non-identity onramp support for Browser Isolation.
	NonIdentityEnabled bool `json:"non_identity_enabled"`
	// Enable Clientless Browser Isolation.
	URLBrowserIsolationEnabled bool                                                        `json:"url_browser_isolation_enabled"`
	JSON                       gatewayConfigurationGetResponseSettingsBrowserIsolationJSON `json:"-"`
}

Browser isolation settings.

func (*GatewayConfigurationGetResponseSettingsBrowserIsolation) UnmarshalJSON 

func (r *GatewayConfigurationGetResponseSettingsBrowserIsolation) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationGetResponseSettingsCustomCertificate 

type GatewayConfigurationGetResponseSettingsCustomCertificate struct {
	// Enable use of custom certificate authority for signing Gateway traffic.
	Enabled bool `json:"enabled,required"`
	// UUID of certificate (ID from MTLS certificate store).
	ID string `json:"id"`
	// Certificate status (internal).
	BindingStatus string                                                       `json:"binding_status"`
	UpdatedAt     time.Time                                                    `json:"updated_at" format:"date-time"`
	JSON          gatewayConfigurationGetResponseSettingsCustomCertificateJSON `json:"-"`
}

Custom certificate settings for BYO-PKI.

func (*GatewayConfigurationGetResponseSettingsCustomCertificate) UnmarshalJSON 

func (r *GatewayConfigurationGetResponseSettingsCustomCertificate) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationGetResponseSettingsExtendedEmailMatching 

type GatewayConfigurationGetResponseSettingsExtendedEmailMatching struct {
	// Enable matching all variants of user emails (with + or . modifiers) used as
	// criteria in Firewall policies.
	Enabled bool                                                             `json:"enabled"`
	JSON    gatewayConfigurationGetResponseSettingsExtendedEmailMatchingJSON `json:"-"`
}

Extended e-mail matching settings.

func (*GatewayConfigurationGetResponseSettingsExtendedEmailMatching) UnmarshalJSON 

func (r *GatewayConfigurationGetResponseSettingsExtendedEmailMatching) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationGetResponseSettingsFips 

type GatewayConfigurationGetResponseSettingsFips struct {
	// Enable only cipher suites and TLS versions compliant with FIPS 140-2.
	TLS  bool                                            `json:"tls"`
	JSON gatewayConfigurationGetResponseSettingsFipsJSON `json:"-"`
}

FIPS settings.

func (*GatewayConfigurationGetResponseSettingsFips) UnmarshalJSON 

func (r *GatewayConfigurationGetResponseSettingsFips) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationGetResponseSettingsProtocolDetection 

type GatewayConfigurationGetResponseSettingsProtocolDetection struct {
	// Enable detecting protocol on initial bytes of client traffic.
	Enabled bool                                                         `json:"enabled"`
	JSON    gatewayConfigurationGetResponseSettingsProtocolDetectionJSON `json:"-"`
}

Protocol Detection settings.

func (*GatewayConfigurationGetResponseSettingsProtocolDetection) UnmarshalJSON 

func (r *GatewayConfigurationGetResponseSettingsProtocolDetection) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationGetResponseSettingsTLSDecrypt 

type GatewayConfigurationGetResponseSettingsTLSDecrypt struct {
	// Enable inspecting encrypted HTTP traffic.
	Enabled bool                                                  `json:"enabled"`
	JSON    gatewayConfigurationGetResponseSettingsTLSDecryptJSON `json:"-"`
}

TLS interception settings.

func (*GatewayConfigurationGetResponseSettingsTLSDecrypt) UnmarshalJSON 

func (r *GatewayConfigurationGetResponseSettingsTLSDecrypt) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationService 

type GatewayConfigurationService struct {
	Options []option.RequestOption
}

GatewayConfigurationService 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 NewGatewayConfigurationService method instead.

func NewGatewayConfigurationService 

func NewGatewayConfigurationService(opts ...option.RequestOption) (r *GatewayConfigurationService)

NewGatewayConfigurationService 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 (*GatewayConfigurationService) Edit 

func (r *GatewayConfigurationService) Edit(ctx context.Context, params GatewayConfigurationEditParams, opts ...option.RequestOption) (res *GatewayConfigurationEditResponse, err error)

Patches the current Zero Trust account configuration. This endpoint can update a single subcollection of settings such as `antivirus`, `tls_decrypt`, `activity_log`, `block_page`, `browser_isolation`, `fips`, `body_scanning`, or `custom_certificate`, without updating the entire configuration object. Returns an error if any collection of settings is not properly configured.

func (*GatewayConfigurationService) Get 

func (r *GatewayConfigurationService) Get(ctx context.Context, query GatewayConfigurationGetParams, opts ...option.RequestOption) (res *GatewayConfigurationGetResponse, err error)

Fetches the current Zero Trust account configuration.

func (*GatewayConfigurationService) Update 

func (r *GatewayConfigurationService) Update(ctx context.Context, params GatewayConfigurationUpdateParams, opts ...option.RequestOption) (res *GatewayConfigurationUpdateResponse, err error)

Updates the current Zero Trust account configuration.

type GatewayConfigurationUpdateParams 

type GatewayConfigurationUpdateParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
	// account settings.
	Settings param.Field[GatewayConfigurationUpdateParamsSettings] `json:"settings"`
}

func (GatewayConfigurationUpdateParams) MarshalJSON 

func (r GatewayConfigurationUpdateParams) MarshalJSON() (data []byte, err error)

type GatewayConfigurationUpdateParamsSettings 

type GatewayConfigurationUpdateParamsSettings struct {
	// Activity log settings.
	ActivityLog param.Field[GatewayConfigurationUpdateParamsSettingsActivityLog] `json:"activity_log"`
	// Anti-virus settings.
	Antivirus param.Field[GatewayConfigurationUpdateParamsSettingsAntivirus] `json:"antivirus"`
	// Block page layout settings.
	BlockPage param.Field[GatewayConfigurationUpdateParamsSettingsBlockPage] `json:"block_page"`
	// DLP body scanning settings.
	BodyScanning param.Field[GatewayConfigurationUpdateParamsSettingsBodyScanning] `json:"body_scanning"`
	// Browser isolation settings.
	BrowserIsolation param.Field[GatewayConfigurationUpdateParamsSettingsBrowserIsolation] `json:"browser_isolation"`
	// Custom certificate settings for BYO-PKI.
	CustomCertificate param.Field[GatewayConfigurationUpdateParamsSettingsCustomCertificate] `json:"custom_certificate"`
	// Extended e-mail matching settings.
	ExtendedEmailMatching param.Field[GatewayConfigurationUpdateParamsSettingsExtendedEmailMatching] `json:"extended_email_matching"`
	// FIPS settings.
	Fips param.Field[GatewayConfigurationUpdateParamsSettingsFips] `json:"fips"`
	// Protocol Detection settings.
	ProtocolDetection param.Field[GatewayConfigurationUpdateParamsSettingsProtocolDetection] `json:"protocol_detection"`
	// TLS interception settings.
	TLSDecrypt param.Field[GatewayConfigurationUpdateParamsSettingsTLSDecrypt] `json:"tls_decrypt"`
}

account settings.

func (GatewayConfigurationUpdateParamsSettings) MarshalJSON 

func (r GatewayConfigurationUpdateParamsSettings) MarshalJSON() (data []byte, err error)

type GatewayConfigurationUpdateParamsSettingsActivityLog 

type GatewayConfigurationUpdateParamsSettingsActivityLog struct {
	// Enable activity logging.
	Enabled param.Field[bool] `json:"enabled"`
}

Activity log settings.

func (GatewayConfigurationUpdateParamsSettingsActivityLog) MarshalJSON 

func (r GatewayConfigurationUpdateParamsSettingsActivityLog) MarshalJSON() (data []byte, err error)

type GatewayConfigurationUpdateParamsSettingsAntivirus 

type GatewayConfigurationUpdateParamsSettingsAntivirus struct {
	// Enable anti-virus scanning on downloads.
	EnabledDownloadPhase param.Field[bool] `json:"enabled_download_phase"`
	// Enable anti-virus scanning on uploads.
	EnabledUploadPhase param.Field[bool] `json:"enabled_upload_phase"`
	// Block requests for files that cannot be scanned.
	FailClosed param.Field[bool] `json:"fail_closed"`
	// Configure a message to display on the user's device when an antivirus search is
	// performed.
	NotificationSettings param.Field[GatewayConfigurationUpdateParamsSettingsAntivirusNotificationSettings] `json:"notification_settings"`
}

Anti-virus settings.

func (GatewayConfigurationUpdateParamsSettingsAntivirus) MarshalJSON 

func (r GatewayConfigurationUpdateParamsSettingsAntivirus) MarshalJSON() (data []byte, err error)

type GatewayConfigurationUpdateParamsSettingsAntivirusNotificationSettings 

type GatewayConfigurationUpdateParamsSettingsAntivirusNotificationSettings struct {
	// Set notification on
	Enabled param.Field[bool] `json:"enabled"`
	// Customize the message shown in the notification.
	Msg param.Field[string] `json:"msg"`
	// Optional URL to direct users to additional information. If not set, the
	// notification will open a block page.
	SupportURL param.Field[string] `json:"support_url"`
}

Configure a message to display on the user's device when an antivirus search is performed.

func (GatewayConfigurationUpdateParamsSettingsAntivirusNotificationSettings) MarshalJSON 

func (r GatewayConfigurationUpdateParamsSettingsAntivirusNotificationSettings) MarshalJSON() (data []byte, err error)

type GatewayConfigurationUpdateParamsSettingsBlockPage 

type GatewayConfigurationUpdateParamsSettingsBlockPage struct {
	// Block page background color in #rrggbb format.
	BackgroundColor param.Field[string] `json:"background_color"`
	// Enable only cipher suites and TLS versions compliant with FIPS 140-2.
	Enabled param.Field[bool] `json:"enabled"`
	// Block page footer text.
	FooterText param.Field[string] `json:"footer_text"`
	// Block page header text.
	HeaderText param.Field[string] `json:"header_text"`
	// Full URL to the logo file.
	LogoPath param.Field[string] `json:"logo_path"`
	// Admin email for users to contact.
	MailtoAddress param.Field[string] `json:"mailto_address"`
	// Subject line for emails created from block page.
	MailtoSubject param.Field[string] `json:"mailto_subject"`
	// Block page title.
	Name param.Field[string] `json:"name"`
	// Suppress detailed info at the bottom of the block page.
	SuppressFooter param.Field[bool] `json:"suppress_footer"`
}

Block page layout settings.

func (GatewayConfigurationUpdateParamsSettingsBlockPage) MarshalJSON 

func (r GatewayConfigurationUpdateParamsSettingsBlockPage) MarshalJSON() (data []byte, err error)

type GatewayConfigurationUpdateParamsSettingsBodyScanning 

type GatewayConfigurationUpdateParamsSettingsBodyScanning struct {
	// Set the inspection mode to either `deep` or `shallow`.
	InspectionMode param.Field[string] `json:"inspection_mode"`
}

DLP body scanning settings.

func (GatewayConfigurationUpdateParamsSettingsBodyScanning) MarshalJSON 

func (r GatewayConfigurationUpdateParamsSettingsBodyScanning) MarshalJSON() (data []byte, err error)

type GatewayConfigurationUpdateParamsSettingsBrowserIsolation 

type GatewayConfigurationUpdateParamsSettingsBrowserIsolation struct {
	// Enable non-identity onramp support for Browser Isolation.
	NonIdentityEnabled param.Field[bool] `json:"non_identity_enabled"`
	// Enable Clientless Browser Isolation.
	URLBrowserIsolationEnabled param.Field[bool] `json:"url_browser_isolation_enabled"`
}

Browser isolation settings.

func (GatewayConfigurationUpdateParamsSettingsBrowserIsolation) MarshalJSON 

func (r GatewayConfigurationUpdateParamsSettingsBrowserIsolation) MarshalJSON() (data []byte, err error)

type GatewayConfigurationUpdateParamsSettingsCustomCertificate 

type GatewayConfigurationUpdateParamsSettingsCustomCertificate struct {
	// Enable use of custom certificate authority for signing Gateway traffic.
	Enabled param.Field[bool] `json:"enabled,required"`
	// UUID of certificate (ID from MTLS certificate store).
	ID param.Field[string] `json:"id"`
}

Custom certificate settings for BYO-PKI.

func (GatewayConfigurationUpdateParamsSettingsCustomCertificate) MarshalJSON 

func (r GatewayConfigurationUpdateParamsSettingsCustomCertificate) MarshalJSON() (data []byte, err error)

type GatewayConfigurationUpdateParamsSettingsExtendedEmailMatching 

type GatewayConfigurationUpdateParamsSettingsExtendedEmailMatching struct {
	// Enable matching all variants of user emails (with + or . modifiers) used as
	// criteria in Firewall policies.
	Enabled param.Field[bool] `json:"enabled"`
}

Extended e-mail matching settings.

func (GatewayConfigurationUpdateParamsSettingsExtendedEmailMatching) MarshalJSON 

func (r GatewayConfigurationUpdateParamsSettingsExtendedEmailMatching) MarshalJSON() (data []byte, err error)

type GatewayConfigurationUpdateParamsSettingsFips 

type GatewayConfigurationUpdateParamsSettingsFips struct {
	// Enable only cipher suites and TLS versions compliant with FIPS 140-2.
	TLS param.Field[bool] `json:"tls"`
}

FIPS settings.

func (GatewayConfigurationUpdateParamsSettingsFips) MarshalJSON 

func (r GatewayConfigurationUpdateParamsSettingsFips) MarshalJSON() (data []byte, err error)

type GatewayConfigurationUpdateParamsSettingsProtocolDetection 

type GatewayConfigurationUpdateParamsSettingsProtocolDetection struct {
	// Enable detecting protocol on initial bytes of client traffic.
	Enabled param.Field[bool] `json:"enabled"`
}

Protocol Detection settings.

func (GatewayConfigurationUpdateParamsSettingsProtocolDetection) MarshalJSON 

func (r GatewayConfigurationUpdateParamsSettingsProtocolDetection) MarshalJSON() (data []byte, err error)

type GatewayConfigurationUpdateParamsSettingsTLSDecrypt 

type GatewayConfigurationUpdateParamsSettingsTLSDecrypt struct {
	// Enable inspecting encrypted HTTP traffic.
	Enabled param.Field[bool] `json:"enabled"`
}

TLS interception settings.

func (GatewayConfigurationUpdateParamsSettingsTLSDecrypt) MarshalJSON 

func (r GatewayConfigurationUpdateParamsSettingsTLSDecrypt) MarshalJSON() (data []byte, err error)

type GatewayConfigurationUpdateResponse 

type GatewayConfigurationUpdateResponse struct {
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// account settings.
	Settings  GatewayConfigurationUpdateResponseSettings `json:"settings"`
	UpdatedAt time.Time                                  `json:"updated_at" format:"date-time"`
	JSON      gatewayConfigurationUpdateResponseJSON     `json:"-"`
}

account settings.

func (*GatewayConfigurationUpdateResponse) UnmarshalJSON 

func (r *GatewayConfigurationUpdateResponse) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationUpdateResponseEnvelope 

type GatewayConfigurationUpdateResponseEnvelope struct {
	Errors   []GatewayConfigurationUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []GatewayConfigurationUpdateResponseEnvelopeMessages `json:"messages,required"`
	// account settings.
	Result GatewayConfigurationUpdateResponse `json:"result,required"`
	// Whether the API call was successful
	Success GatewayConfigurationUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    gatewayConfigurationUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*GatewayConfigurationUpdateResponseEnvelope) UnmarshalJSON 

func (r *GatewayConfigurationUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationUpdateResponseEnvelopeErrors 

type GatewayConfigurationUpdateResponseEnvelopeErrors struct {
	Code    int64                                                `json:"code,required"`
	Message string                                               `json:"message,required"`
	JSON    gatewayConfigurationUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*GatewayConfigurationUpdateResponseEnvelopeErrors) UnmarshalJSON 

func (r *GatewayConfigurationUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationUpdateResponseEnvelopeMessages 

type GatewayConfigurationUpdateResponseEnvelopeMessages struct {
	Code    int64                                                  `json:"code,required"`
	Message string                                                 `json:"message,required"`
	JSON    gatewayConfigurationUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*GatewayConfigurationUpdateResponseEnvelopeMessages) UnmarshalJSON 

func (r *GatewayConfigurationUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationUpdateResponseEnvelopeSuccess 

type GatewayConfigurationUpdateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	GatewayConfigurationUpdateResponseEnvelopeSuccessTrue GatewayConfigurationUpdateResponseEnvelopeSuccess = true
)

type GatewayConfigurationUpdateResponseSettings 

type GatewayConfigurationUpdateResponseSettings struct {
	// Activity log settings.
	ActivityLog GatewayConfigurationUpdateResponseSettingsActivityLog `json:"activity_log"`
	// Anti-virus settings.
	Antivirus GatewayConfigurationUpdateResponseSettingsAntivirus `json:"antivirus"`
	// Block page layout settings.
	BlockPage GatewayConfigurationUpdateResponseSettingsBlockPage `json:"block_page"`
	// DLP body scanning settings.
	BodyScanning GatewayConfigurationUpdateResponseSettingsBodyScanning `json:"body_scanning"`
	// Browser isolation settings.
	BrowserIsolation GatewayConfigurationUpdateResponseSettingsBrowserIsolation `json:"browser_isolation"`
	// Custom certificate settings for BYO-PKI.
	CustomCertificate GatewayConfigurationUpdateResponseSettingsCustomCertificate `json:"custom_certificate"`
	// Extended e-mail matching settings.
	ExtendedEmailMatching GatewayConfigurationUpdateResponseSettingsExtendedEmailMatching `json:"extended_email_matching"`
	// FIPS settings.
	Fips GatewayConfigurationUpdateResponseSettingsFips `json:"fips"`
	// Protocol Detection settings.
	ProtocolDetection GatewayConfigurationUpdateResponseSettingsProtocolDetection `json:"protocol_detection"`
	// TLS interception settings.
	TLSDecrypt GatewayConfigurationUpdateResponseSettingsTLSDecrypt `json:"tls_decrypt"`
	JSON       gatewayConfigurationUpdateResponseSettingsJSON       `json:"-"`
}

account settings.

func (*GatewayConfigurationUpdateResponseSettings) UnmarshalJSON 

func (r *GatewayConfigurationUpdateResponseSettings) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationUpdateResponseSettingsActivityLog 

type GatewayConfigurationUpdateResponseSettingsActivityLog struct {
	// Enable activity logging.
	Enabled bool                                                      `json:"enabled"`
	JSON    gatewayConfigurationUpdateResponseSettingsActivityLogJSON `json:"-"`
}

Activity log settings.

func (*GatewayConfigurationUpdateResponseSettingsActivityLog) UnmarshalJSON 

func (r *GatewayConfigurationUpdateResponseSettingsActivityLog) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationUpdateResponseSettingsAntivirus 

type GatewayConfigurationUpdateResponseSettingsAntivirus struct {
	// Enable anti-virus scanning on downloads.
	EnabledDownloadPhase bool `json:"enabled_download_phase"`
	// Enable anti-virus scanning on uploads.
	EnabledUploadPhase bool `json:"enabled_upload_phase"`
	// Block requests for files that cannot be scanned.
	FailClosed bool `json:"fail_closed"`
	// Configure a message to display on the user's device when an antivirus search is
	// performed.
	NotificationSettings GatewayConfigurationUpdateResponseSettingsAntivirusNotificationSettings `json:"notification_settings"`
	JSON                 gatewayConfigurationUpdateResponseSettingsAntivirusJSON                 `json:"-"`
}

Anti-virus settings.

func (*GatewayConfigurationUpdateResponseSettingsAntivirus) UnmarshalJSON 

func (r *GatewayConfigurationUpdateResponseSettingsAntivirus) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationUpdateResponseSettingsAntivirusNotificationSettings 

type GatewayConfigurationUpdateResponseSettingsAntivirusNotificationSettings struct {
	// Set notification on
	Enabled bool `json:"enabled"`
	// Customize the message shown in the notification.
	Msg string `json:"msg"`
	// Optional URL to direct users to additional information. If not set, the
	// notification will open a block page.
	SupportURL string                                                                      `json:"support_url"`
	JSON       gatewayConfigurationUpdateResponseSettingsAntivirusNotificationSettingsJSON `json:"-"`
}

Configure a message to display on the user's device when an antivirus search is performed.

func (*GatewayConfigurationUpdateResponseSettingsAntivirusNotificationSettings) UnmarshalJSON 

func (r *GatewayConfigurationUpdateResponseSettingsAntivirusNotificationSettings) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationUpdateResponseSettingsBlockPage 

type GatewayConfigurationUpdateResponseSettingsBlockPage struct {
	// Block page background color in #rrggbb format.
	BackgroundColor string `json:"background_color"`
	// Enable only cipher suites and TLS versions compliant with FIPS 140-2.
	Enabled bool `json:"enabled"`
	// Block page footer text.
	FooterText string `json:"footer_text"`
	// Block page header text.
	HeaderText string `json:"header_text"`
	// Full URL to the logo file.
	LogoPath string `json:"logo_path"`
	// Admin email for users to contact.
	MailtoAddress string `json:"mailto_address"`
	// Subject line for emails created from block page.
	MailtoSubject string `json:"mailto_subject"`
	// Block page title.
	Name string `json:"name"`
	// Suppress detailed info at the bottom of the block page.
	SuppressFooter bool                                                    `json:"suppress_footer"`
	JSON           gatewayConfigurationUpdateResponseSettingsBlockPageJSON `json:"-"`
}

Block page layout settings.

func (*GatewayConfigurationUpdateResponseSettingsBlockPage) UnmarshalJSON 

func (r *GatewayConfigurationUpdateResponseSettingsBlockPage) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationUpdateResponseSettingsBodyScanning 

type GatewayConfigurationUpdateResponseSettingsBodyScanning struct {
	// Set the inspection mode to either `deep` or `shallow`.
	InspectionMode string                                                     `json:"inspection_mode"`
	JSON           gatewayConfigurationUpdateResponseSettingsBodyScanningJSON `json:"-"`
}

DLP body scanning settings.

func (*GatewayConfigurationUpdateResponseSettingsBodyScanning) UnmarshalJSON 

func (r *GatewayConfigurationUpdateResponseSettingsBodyScanning) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationUpdateResponseSettingsBrowserIsolation 

type GatewayConfigurationUpdateResponseSettingsBrowserIsolation struct {
	// Enable non-identity onramp support for Browser Isolation.
	NonIdentityEnabled bool `json:"non_identity_enabled"`
	// Enable Clientless Browser Isolation.
	URLBrowserIsolationEnabled bool                                                           `json:"url_browser_isolation_enabled"`
	JSON                       gatewayConfigurationUpdateResponseSettingsBrowserIsolationJSON `json:"-"`
}

Browser isolation settings.

func (*GatewayConfigurationUpdateResponseSettingsBrowserIsolation) UnmarshalJSON 

func (r *GatewayConfigurationUpdateResponseSettingsBrowserIsolation) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationUpdateResponseSettingsCustomCertificate 

type GatewayConfigurationUpdateResponseSettingsCustomCertificate struct {
	// Enable use of custom certificate authority for signing Gateway traffic.
	Enabled bool `json:"enabled,required"`
	// UUID of certificate (ID from MTLS certificate store).
	ID string `json:"id"`
	// Certificate status (internal).
	BindingStatus string                                                          `json:"binding_status"`
	UpdatedAt     time.Time                                                       `json:"updated_at" format:"date-time"`
	JSON          gatewayConfigurationUpdateResponseSettingsCustomCertificateJSON `json:"-"`
}

Custom certificate settings for BYO-PKI.

func (*GatewayConfigurationUpdateResponseSettingsCustomCertificate) UnmarshalJSON 

func (r *GatewayConfigurationUpdateResponseSettingsCustomCertificate) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationUpdateResponseSettingsExtendedEmailMatching 

type GatewayConfigurationUpdateResponseSettingsExtendedEmailMatching struct {
	// Enable matching all variants of user emails (with + or . modifiers) used as
	// criteria in Firewall policies.
	Enabled bool                                                                `json:"enabled"`
	JSON    gatewayConfigurationUpdateResponseSettingsExtendedEmailMatchingJSON `json:"-"`
}

Extended e-mail matching settings.

func (*GatewayConfigurationUpdateResponseSettingsExtendedEmailMatching) UnmarshalJSON 

func (r *GatewayConfigurationUpdateResponseSettingsExtendedEmailMatching) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationUpdateResponseSettingsFips 

type GatewayConfigurationUpdateResponseSettingsFips struct {
	// Enable only cipher suites and TLS versions compliant with FIPS 140-2.
	TLS  bool                                               `json:"tls"`
	JSON gatewayConfigurationUpdateResponseSettingsFipsJSON `json:"-"`
}

FIPS settings.

func (*GatewayConfigurationUpdateResponseSettingsFips) UnmarshalJSON 

func (r *GatewayConfigurationUpdateResponseSettingsFips) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationUpdateResponseSettingsProtocolDetection 

type GatewayConfigurationUpdateResponseSettingsProtocolDetection struct {
	// Enable detecting protocol on initial bytes of client traffic.
	Enabled bool                                                            `json:"enabled"`
	JSON    gatewayConfigurationUpdateResponseSettingsProtocolDetectionJSON `json:"-"`
}

Protocol Detection settings.

func (*GatewayConfigurationUpdateResponseSettingsProtocolDetection) UnmarshalJSON 

func (r *GatewayConfigurationUpdateResponseSettingsProtocolDetection) UnmarshalJSON(data []byte) (err error)

type GatewayConfigurationUpdateResponseSettingsTLSDecrypt 

type GatewayConfigurationUpdateResponseSettingsTLSDecrypt struct {
	// Enable inspecting encrypted HTTP traffic.
	Enabled bool                                                     `json:"enabled"`
	JSON    gatewayConfigurationUpdateResponseSettingsTLSDecryptJSON `json:"-"`
}

TLS interception settings.

func (*GatewayConfigurationUpdateResponseSettingsTLSDecrypt) UnmarshalJSON 

func (r *GatewayConfigurationUpdateResponseSettingsTLSDecrypt) UnmarshalJSON(data []byte) (err error)

type GatewayListDeleteParams 

type GatewayListDeleteParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type GatewayListDeleteResponse 

type GatewayListDeleteResponse interface {
	ImplementsZeroTrustGatewayListDeleteResponse()
}

Union satisfied by zero_trust.GatewayListDeleteResponseUnknown or shared.UnionString.

type GatewayListDeleteResponseEnvelope 

type GatewayListDeleteResponseEnvelope struct {
	Errors   []GatewayListDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []GatewayListDeleteResponseEnvelopeMessages `json:"messages,required"`
	Result   GatewayListDeleteResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success GatewayListDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    gatewayListDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*GatewayListDeleteResponseEnvelope) UnmarshalJSON 

func (r *GatewayListDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type GatewayListDeleteResponseEnvelopeErrors 

type GatewayListDeleteResponseEnvelopeErrors struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    gatewayListDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*GatewayListDeleteResponseEnvelopeErrors) UnmarshalJSON 

func (r *GatewayListDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type GatewayListDeleteResponseEnvelopeMessages 

type GatewayListDeleteResponseEnvelopeMessages struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    gatewayListDeleteResponseEnvelopeMessagesJSON `json:"-"`
}

func (*GatewayListDeleteResponseEnvelopeMessages) UnmarshalJSON 

func (r *GatewayListDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type GatewayListDeleteResponseEnvelopeSuccess 

type GatewayListDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	GatewayListDeleteResponseEnvelopeSuccessTrue GatewayListDeleteResponseEnvelopeSuccess = true
)

type GatewayListEditParams 

type GatewayListEditParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
	// The items in the list.
	Append param.Field[[]GatewayListEditParamsAppend] `json:"append"`
	// A list of the item values you want to remove.
	Remove param.Field[[]string] `json:"remove"`
}

func (GatewayListEditParams) MarshalJSON 

func (r GatewayListEditParams) MarshalJSON() (data []byte, err error)

type GatewayListEditParamsAppend 

type GatewayListEditParamsAppend struct {
	// The value of the item in a list.
	Value param.Field[string] `json:"value"`
}

func (GatewayListEditParamsAppend) MarshalJSON 

func (r GatewayListEditParamsAppend) MarshalJSON() (data []byte, err error)

type GatewayListEditResponseEnvelope 

type GatewayListEditResponseEnvelope struct {
	Errors   []GatewayListEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []GatewayListEditResponseEnvelopeMessages `json:"messages,required"`
	Result   ZeroTrustGatewayLists                     `json:"result,required"`
	// Whether the API call was successful
	Success GatewayListEditResponseEnvelopeSuccess `json:"success,required"`
	JSON    gatewayListEditResponseEnvelopeJSON    `json:"-"`
}

func (*GatewayListEditResponseEnvelope) UnmarshalJSON 

func (r *GatewayListEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type GatewayListEditResponseEnvelopeErrors 

type GatewayListEditResponseEnvelopeErrors struct {
	Code    int64                                     `json:"code,required"`
	Message string                                    `json:"message,required"`
	JSON    gatewayListEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*GatewayListEditResponseEnvelopeErrors) UnmarshalJSON 

func (r *GatewayListEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type GatewayListEditResponseEnvelopeMessages 

type GatewayListEditResponseEnvelopeMessages struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    gatewayListEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*GatewayListEditResponseEnvelopeMessages) UnmarshalJSON 

func (r *GatewayListEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type GatewayListEditResponseEnvelopeSuccess 

type GatewayListEditResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	GatewayListEditResponseEnvelopeSuccessTrue GatewayListEditResponseEnvelopeSuccess = true
)

type GatewayListGetParams 

type GatewayListGetParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type GatewayListGetResponseEnvelope 

type GatewayListGetResponseEnvelope struct {
	Errors   []GatewayListGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []GatewayListGetResponseEnvelopeMessages `json:"messages,required"`
	Result   ZeroTrustGatewayLists                    `json:"result,required"`
	// Whether the API call was successful
	Success GatewayListGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    gatewayListGetResponseEnvelopeJSON    `json:"-"`
}

func (*GatewayListGetResponseEnvelope) UnmarshalJSON 

func (r *GatewayListGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type GatewayListGetResponseEnvelopeErrors 

type GatewayListGetResponseEnvelopeErrors struct {
	Code    int64                                    `json:"code,required"`
	Message string                                   `json:"message,required"`
	JSON    gatewayListGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*GatewayListGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *GatewayListGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type GatewayListGetResponseEnvelopeMessages 

type GatewayListGetResponseEnvelopeMessages struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    gatewayListGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*GatewayListGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *GatewayListGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type GatewayListGetResponseEnvelopeSuccess 

type GatewayListGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	GatewayListGetResponseEnvelopeSuccessTrue GatewayListGetResponseEnvelopeSuccess = true
)

type GatewayListItemListParams 

type GatewayListItemListParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type GatewayListItemListResponse 

type GatewayListItemListResponse struct {
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// The value of the item in a list.
	Value string                          `json:"value"`
	JSON  gatewayListItemListResponseJSON `json:"-"`
}

func (*GatewayListItemListResponse) UnmarshalJSON 

func (r *GatewayListItemListResponse) UnmarshalJSON(data []byte) (err error)

type GatewayListItemListResponseEnvelope 

type GatewayListItemListResponseEnvelope struct {
	Errors   []GatewayListItemListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []GatewayListItemListResponseEnvelopeMessages `json:"messages,required"`
	Result   [][]GatewayListItemListResponse               `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    GatewayListItemListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo GatewayListItemListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       gatewayListItemListResponseEnvelopeJSON       `json:"-"`
}

func (*GatewayListItemListResponseEnvelope) UnmarshalJSON 

func (r *GatewayListItemListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type GatewayListItemListResponseEnvelopeErrors 

type GatewayListItemListResponseEnvelopeErrors struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    gatewayListItemListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*GatewayListItemListResponseEnvelopeErrors) UnmarshalJSON 

func (r *GatewayListItemListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type GatewayListItemListResponseEnvelopeMessages 

type GatewayListItemListResponseEnvelopeMessages struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    gatewayListItemListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*GatewayListItemListResponseEnvelopeMessages) UnmarshalJSON 

func (r *GatewayListItemListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type GatewayListItemListResponseEnvelopeResultInfo 

type GatewayListItemListResponseEnvelopeResultInfo struct {
	// Total results returned based on your search parameters.
	Count float64 `json:"count"`
	// Current page within paginated list of results.
	Page float64 `json:"page"`
	// Number of results per page of results.
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters.
	TotalCount float64                                           `json:"total_count"`
	JSON       gatewayListItemListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*GatewayListItemListResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *GatewayListItemListResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type GatewayListItemListResponseEnvelopeSuccess 

type GatewayListItemListResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	GatewayListItemListResponseEnvelopeSuccessTrue GatewayListItemListResponseEnvelopeSuccess = true
)

type GatewayListItemService 

type GatewayListItemService struct {
	Options []option.RequestOption
}

GatewayListItemService 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 NewGatewayListItemService method instead.

func NewGatewayListItemService 

func NewGatewayListItemService(opts ...option.RequestOption) (r *GatewayListItemService)

NewGatewayListItemService 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 (*GatewayListItemService) List 

func (r *GatewayListItemService) List(ctx context.Context, listID string, query GatewayListItemListParams, opts ...option.RequestOption) (res *[][]GatewayListItemListResponse, err error)

Fetches all items in a single Zero Trust list.

type GatewayListListParams 

type GatewayListListParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type GatewayListListResponseEnvelope 

type GatewayListListResponseEnvelope struct {
	Errors   []GatewayListListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []GatewayListListResponseEnvelopeMessages `json:"messages,required"`
	Result   []ZeroTrustGatewayLists                   `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    GatewayListListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo GatewayListListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       gatewayListListResponseEnvelopeJSON       `json:"-"`
}

func (*GatewayListListResponseEnvelope) UnmarshalJSON 

func (r *GatewayListListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type GatewayListListResponseEnvelopeErrors 

type GatewayListListResponseEnvelopeErrors struct {
	Code    int64                                     `json:"code,required"`
	Message string                                    `json:"message,required"`
	JSON    gatewayListListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*GatewayListListResponseEnvelopeErrors) UnmarshalJSON 

func (r *GatewayListListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type GatewayListListResponseEnvelopeMessages 

type GatewayListListResponseEnvelopeMessages struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    gatewayListListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*GatewayListListResponseEnvelopeMessages) UnmarshalJSON 

func (r *GatewayListListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type GatewayListListResponseEnvelopeResultInfo 

type GatewayListListResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                       `json:"total_count"`
	JSON       gatewayListListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*GatewayListListResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *GatewayListListResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type GatewayListListResponseEnvelopeSuccess 

type GatewayListListResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	GatewayListListResponseEnvelopeSuccessTrue GatewayListListResponseEnvelopeSuccess = true
)

type GatewayListNewParams 

type GatewayListNewParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
	// The name of the list.
	Name param.Field[string] `json:"name,required"`
	// The type of list.
	Type param.Field[GatewayListNewParamsType] `json:"type,required"`
	// The description of the list.
	Description param.Field[string] `json:"description"`
	// The items in the list.
	Items param.Field[[]GatewayListNewParamsItem] `json:"items"`
}

func (GatewayListNewParams) MarshalJSON 

func (r GatewayListNewParams) MarshalJSON() (data []byte, err error)

type GatewayListNewParamsItem 

type GatewayListNewParamsItem struct {
	// The value of the item in a list.
	Value param.Field[string] `json:"value"`
}

func (GatewayListNewParamsItem) MarshalJSON 

func (r GatewayListNewParamsItem) MarshalJSON() (data []byte, err error)

type GatewayListNewParamsType 

type GatewayListNewParamsType string

The type of list. 

const (
	GatewayListNewParamsTypeSerial GatewayListNewParamsType = "SERIAL"
	GatewayListNewParamsTypeURL    GatewayListNewParamsType = "URL"
	GatewayListNewParamsTypeDomain GatewayListNewParamsType = "DOMAIN"
	GatewayListNewParamsTypeEmail  GatewayListNewParamsType = "EMAIL"
	GatewayListNewParamsTypeIP     GatewayListNewParamsType = "IP"
)

type GatewayListNewResponse 

type GatewayListNewResponse struct {
	// API Resource UUID tag.
	ID        string    `json:"id"`
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// The description of the list.
	Description string `json:"description"`
	// The items in the list.
	Items []GatewayListNewResponseItem `json:"items"`
	// The name of the list.
	Name string `json:"name"`
	// The type of list.
	Type      GatewayListNewResponseType `json:"type"`
	UpdatedAt time.Time                  `json:"updated_at" format:"date-time"`
	JSON      gatewayListNewResponseJSON `json:"-"`
}

func (*GatewayListNewResponse) UnmarshalJSON 

func (r *GatewayListNewResponse) UnmarshalJSON(data []byte) (err error)

type GatewayListNewResponseEnvelope 

type GatewayListNewResponseEnvelope struct {
	Errors   []GatewayListNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []GatewayListNewResponseEnvelopeMessages `json:"messages,required"`
	Result   GatewayListNewResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success GatewayListNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    gatewayListNewResponseEnvelopeJSON    `json:"-"`
}

func (*GatewayListNewResponseEnvelope) UnmarshalJSON 

func (r *GatewayListNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type GatewayListNewResponseEnvelopeErrors 

type GatewayListNewResponseEnvelopeErrors struct {
	Code    int64                                    `json:"code,required"`
	Message string                                   `json:"message,required"`
	JSON    gatewayListNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*GatewayListNewResponseEnvelopeErrors) UnmarshalJSON 

func (r *GatewayListNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type GatewayListNewResponseEnvelopeMessages 

type GatewayListNewResponseEnvelopeMessages struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    gatewayListNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*GatewayListNewResponseEnvelopeMessages) UnmarshalJSON 

func (r *GatewayListNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type GatewayListNewResponseEnvelopeSuccess 

type GatewayListNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	GatewayListNewResponseEnvelopeSuccessTrue GatewayListNewResponseEnvelopeSuccess = true
)

type GatewayListNewResponseItem 

type GatewayListNewResponseItem struct {
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// The value of the item in a list.
	Value string                         `json:"value"`
	JSON  gatewayListNewResponseItemJSON `json:"-"`
}

func (*GatewayListNewResponseItem) UnmarshalJSON 

func (r *GatewayListNewResponseItem) UnmarshalJSON(data []byte) (err error)

type GatewayListNewResponseType 

type GatewayListNewResponseType string

The type of list. 

const (
	GatewayListNewResponseTypeSerial GatewayListNewResponseType = "SERIAL"
	GatewayListNewResponseTypeURL    GatewayListNewResponseType = "URL"
	GatewayListNewResponseTypeDomain GatewayListNewResponseType = "DOMAIN"
	GatewayListNewResponseTypeEmail  GatewayListNewResponseType = "EMAIL"
	GatewayListNewResponseTypeIP     GatewayListNewResponseType = "IP"
)

type GatewayListParams 

type GatewayListParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type GatewayListResponse 

type GatewayListResponse struct {
	// Cloudflare account ID.
	ID string `json:"id"`
	// Gateway internal ID.
	GatewayTag string `json:"gateway_tag"`
	// The name of the provider. Usually Cloudflare.
	ProviderName string                  `json:"provider_name"`
	JSON         gatewayListResponseJSON `json:"-"`
}

func (*GatewayListResponse) UnmarshalJSON 

func (r *GatewayListResponse) UnmarshalJSON(data []byte) (err error)

type GatewayListResponseEnvelope 

type GatewayListResponseEnvelope struct {
	Errors   []GatewayListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []GatewayListResponseEnvelopeMessages `json:"messages,required"`
	Result   GatewayListResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success GatewayListResponseEnvelopeSuccess `json:"success,required"`
	JSON    gatewayListResponseEnvelopeJSON    `json:"-"`
}

func (*GatewayListResponseEnvelope) UnmarshalJSON 

func (r *GatewayListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type GatewayListResponseEnvelopeErrors 

type GatewayListResponseEnvelopeErrors struct {
	Code    int64                                 `json:"code,required"`
	Message string                                `json:"message,required"`
	JSON    gatewayListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*GatewayListResponseEnvelopeErrors) UnmarshalJSON 

func (r *GatewayListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type GatewayListResponseEnvelopeMessages 

type GatewayListResponseEnvelopeMessages struct {
	Code    int64                                   `json:"code,required"`
	Message string                                  `json:"message,required"`
	JSON    gatewayListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*GatewayListResponseEnvelopeMessages) UnmarshalJSON 

func (r *GatewayListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type GatewayListResponseEnvelopeSuccess 

type GatewayListResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	GatewayListResponseEnvelopeSuccessTrue GatewayListResponseEnvelopeSuccess = true
)

type GatewayListService 

type GatewayListService struct {
	Options []option.RequestOption
	Items   *GatewayListItemService
}

GatewayListService 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 NewGatewayListService method instead.

func NewGatewayListService 

func NewGatewayListService(opts ...option.RequestOption) (r *GatewayListService)

NewGatewayListService 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 (*GatewayListService) Delete 

func (r *GatewayListService) Delete(ctx context.Context, listID string, body GatewayListDeleteParams, opts ...option.RequestOption) (res *GatewayListDeleteResponse, err error)

Deletes a Zero Trust list.

func (*GatewayListService) Edit 

func (r *GatewayListService) Edit(ctx context.Context, listID string, params GatewayListEditParams, opts ...option.RequestOption) (res *ZeroTrustGatewayLists, err error)

Appends or removes an item from a configured Zero Trust list.

func (*GatewayListService) Get 

func (r *GatewayListService) Get(ctx context.Context, listID string, query GatewayListGetParams, opts ...option.RequestOption) (res *ZeroTrustGatewayLists, err error)

Fetches a single Zero Trust list.

func (*GatewayListService) List 

func (r *GatewayListService) List(ctx context.Context, query GatewayListListParams, opts ...option.RequestOption) (res *[]ZeroTrustGatewayLists, err error)

Fetches all Zero Trust lists for an account.

func (*GatewayListService) New 

func (r *GatewayListService) New(ctx context.Context, params GatewayListNewParams, opts ...option.RequestOption) (res *GatewayListNewResponse, err error)

Creates a new Zero Trust list.

func (*GatewayListService) Update 

func (r *GatewayListService) Update(ctx context.Context, listID string, params GatewayListUpdateParams, opts ...option.RequestOption) (res *ZeroTrustGatewayLists, err error)

Updates a configured Zero Trust list.

type GatewayListUpdateParams 

type GatewayListUpdateParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
	// The name of the list.
	Name param.Field[string] `json:"name,required"`
	// The description of the list.
	Description param.Field[string] `json:"description"`
}

func (GatewayListUpdateParams) MarshalJSON 

func (r GatewayListUpdateParams) MarshalJSON() (data []byte, err error)

type GatewayListUpdateResponseEnvelope 

type GatewayListUpdateResponseEnvelope struct {
	Errors   []GatewayListUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []GatewayListUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   ZeroTrustGatewayLists                       `json:"result,required"`
	// Whether the API call was successful
	Success GatewayListUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    gatewayListUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*GatewayListUpdateResponseEnvelope) UnmarshalJSON 

func (r *GatewayListUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type GatewayListUpdateResponseEnvelopeErrors 

type GatewayListUpdateResponseEnvelopeErrors struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    gatewayListUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*GatewayListUpdateResponseEnvelopeErrors) UnmarshalJSON 

func (r *GatewayListUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type GatewayListUpdateResponseEnvelopeMessages 

type GatewayListUpdateResponseEnvelopeMessages struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    gatewayListUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*GatewayListUpdateResponseEnvelopeMessages) UnmarshalJSON 

func (r *GatewayListUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type GatewayListUpdateResponseEnvelopeSuccess 

type GatewayListUpdateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	GatewayListUpdateResponseEnvelopeSuccessTrue GatewayListUpdateResponseEnvelopeSuccess = true
)

type GatewayLocationDeleteParams 

type GatewayLocationDeleteParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type GatewayLocationDeleteResponse 

type GatewayLocationDeleteResponse interface {
	ImplementsZeroTrustGatewayLocationDeleteResponse()
}

Union satisfied by zero_trust.GatewayLocationDeleteResponseUnknown or shared.UnionString.

type GatewayLocationDeleteResponseEnvelope 

type GatewayLocationDeleteResponseEnvelope struct {
	Errors   []GatewayLocationDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []GatewayLocationDeleteResponseEnvelopeMessages `json:"messages,required"`
	Result   GatewayLocationDeleteResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success GatewayLocationDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    gatewayLocationDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*GatewayLocationDeleteResponseEnvelope) UnmarshalJSON 

func (r *GatewayLocationDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type GatewayLocationDeleteResponseEnvelopeErrors 

type GatewayLocationDeleteResponseEnvelopeErrors struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    gatewayLocationDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*GatewayLocationDeleteResponseEnvelopeErrors) UnmarshalJSON 

func (r *GatewayLocationDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type GatewayLocationDeleteResponseEnvelopeMessages 

type GatewayLocationDeleteResponseEnvelopeMessages struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    gatewayLocationDeleteResponseEnvelopeMessagesJSON `json:"-"`
}

func (*GatewayLocationDeleteResponseEnvelopeMessages) UnmarshalJSON 

func (r *GatewayLocationDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type GatewayLocationDeleteResponseEnvelopeSuccess 

type GatewayLocationDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	GatewayLocationDeleteResponseEnvelopeSuccessTrue GatewayLocationDeleteResponseEnvelopeSuccess = true
)

type GatewayLocationGetParams 

type GatewayLocationGetParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type GatewayLocationGetResponseEnvelope 

type GatewayLocationGetResponseEnvelope struct {
	Errors   []GatewayLocationGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []GatewayLocationGetResponseEnvelopeMessages `json:"messages,required"`
	Result   ZeroTrustGatewayLocations                    `json:"result,required"`
	// Whether the API call was successful
	Success GatewayLocationGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    gatewayLocationGetResponseEnvelopeJSON    `json:"-"`
}

func (*GatewayLocationGetResponseEnvelope) UnmarshalJSON 

func (r *GatewayLocationGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type GatewayLocationGetResponseEnvelopeErrors 

type GatewayLocationGetResponseEnvelopeErrors struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    gatewayLocationGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*GatewayLocationGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *GatewayLocationGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type GatewayLocationGetResponseEnvelopeMessages 

type GatewayLocationGetResponseEnvelopeMessages struct {
	Code    int64                                          `json:"code,required"`
	Message string                                         `json:"message,required"`
	JSON    gatewayLocationGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*GatewayLocationGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *GatewayLocationGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type GatewayLocationGetResponseEnvelopeSuccess 

type GatewayLocationGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	GatewayLocationGetResponseEnvelopeSuccessTrue GatewayLocationGetResponseEnvelopeSuccess = true
)

type GatewayLocationListParams 

type GatewayLocationListParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type GatewayLocationListResponseEnvelope 

type GatewayLocationListResponseEnvelope struct {
	Errors   []GatewayLocationListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []GatewayLocationListResponseEnvelopeMessages `json:"messages,required"`
	Result   []ZeroTrustGatewayLocations                   `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    GatewayLocationListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo GatewayLocationListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       gatewayLocationListResponseEnvelopeJSON       `json:"-"`
}

func (*GatewayLocationListResponseEnvelope) UnmarshalJSON 

func (r *GatewayLocationListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type GatewayLocationListResponseEnvelopeErrors 

type GatewayLocationListResponseEnvelopeErrors struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    gatewayLocationListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*GatewayLocationListResponseEnvelopeErrors) UnmarshalJSON 

func (r *GatewayLocationListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type GatewayLocationListResponseEnvelopeMessages 

type GatewayLocationListResponseEnvelopeMessages struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    gatewayLocationListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*GatewayLocationListResponseEnvelopeMessages) UnmarshalJSON 

func (r *GatewayLocationListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type GatewayLocationListResponseEnvelopeResultInfo 

type GatewayLocationListResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                           `json:"total_count"`
	JSON       gatewayLocationListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*GatewayLocationListResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *GatewayLocationListResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type GatewayLocationListResponseEnvelopeSuccess 

type GatewayLocationListResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	GatewayLocationListResponseEnvelopeSuccessTrue GatewayLocationListResponseEnvelopeSuccess = true
)

type GatewayLocationNewParams 

type GatewayLocationNewParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
	// The name of the location.
	Name param.Field[string] `json:"name,required"`
	// True if the location is the default location.
	ClientDefault param.Field[bool] `json:"client_default"`
	// True if the location needs to resolve EDNS queries.
	EcsSupport param.Field[bool] `json:"ecs_support"`
	// A list of network ranges that requests from this location would originate from.
	Networks param.Field[[]GatewayLocationNewParamsNetwork] `json:"networks"`
}

func (GatewayLocationNewParams) MarshalJSON 

func (r GatewayLocationNewParams) MarshalJSON() (data []byte, err error)

type GatewayLocationNewParamsNetwork added in v2.4.0 

type GatewayLocationNewParamsNetwork struct {
	// The IPv4 address or IPv4 CIDR. IPv4 CIDRs are limited to a maximum of /24.
	Network param.Field[string] `json:"network,required"`
}

func (GatewayLocationNewParamsNetwork) MarshalJSON added in v2.4.0 

func (r GatewayLocationNewParamsNetwork) MarshalJSON() (data []byte, err error)

type GatewayLocationNewResponseEnvelope 

type GatewayLocationNewResponseEnvelope struct {
	Errors   []GatewayLocationNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []GatewayLocationNewResponseEnvelopeMessages `json:"messages,required"`
	Result   ZeroTrustGatewayLocations                    `json:"result,required"`
	// Whether the API call was successful
	Success GatewayLocationNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    gatewayLocationNewResponseEnvelopeJSON    `json:"-"`
}

func (*GatewayLocationNewResponseEnvelope) UnmarshalJSON 

func (r *GatewayLocationNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type GatewayLocationNewResponseEnvelopeErrors 

type GatewayLocationNewResponseEnvelopeErrors struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    gatewayLocationNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*GatewayLocationNewResponseEnvelopeErrors) UnmarshalJSON 

func (r *GatewayLocationNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type GatewayLocationNewResponseEnvelopeMessages 

type GatewayLocationNewResponseEnvelopeMessages struct {
	Code    int64                                          `json:"code,required"`
	Message string                                         `json:"message,required"`
	JSON    gatewayLocationNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*GatewayLocationNewResponseEnvelopeMessages) UnmarshalJSON 

func (r *GatewayLocationNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type GatewayLocationNewResponseEnvelopeSuccess 

type GatewayLocationNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	GatewayLocationNewResponseEnvelopeSuccessTrue GatewayLocationNewResponseEnvelopeSuccess = true
)

type GatewayLocationService 

type GatewayLocationService struct {
	Options []option.RequestOption
}

GatewayLocationService 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 NewGatewayLocationService method instead.

func NewGatewayLocationService 

func NewGatewayLocationService(opts ...option.RequestOption) (r *GatewayLocationService)

NewGatewayLocationService 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 (*GatewayLocationService) Delete 

func (r *GatewayLocationService) Delete(ctx context.Context, locationID interface{}, body GatewayLocationDeleteParams, opts ...option.RequestOption) (res *GatewayLocationDeleteResponse, err error)

Deletes a configured Zero Trust Gateway location.

func (*GatewayLocationService) Get 

func (r *GatewayLocationService) Get(ctx context.Context, locationID interface{}, query GatewayLocationGetParams, opts ...option.RequestOption) (res *ZeroTrustGatewayLocations, err error)

Fetches a single Zero Trust Gateway location.

func (*GatewayLocationService) List 

func (r *GatewayLocationService) List(ctx context.Context, query GatewayLocationListParams, opts ...option.RequestOption) (res *[]ZeroTrustGatewayLocations, err error)

Fetches Zero Trust Gateway locations for an account.

func (*GatewayLocationService) New 

func (r *GatewayLocationService) New(ctx context.Context, params GatewayLocationNewParams, opts ...option.RequestOption) (res *ZeroTrustGatewayLocations, err error)

Creates a new Zero Trust Gateway location.

func (*GatewayLocationService) Update 

func (r *GatewayLocationService) Update(ctx context.Context, locationID interface{}, params GatewayLocationUpdateParams, opts ...option.RequestOption) (res *ZeroTrustGatewayLocations, err error)

Updates a configured Zero Trust Gateway location.

type GatewayLocationUpdateParams 

type GatewayLocationUpdateParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
	// The name of the location.
	Name param.Field[string] `json:"name,required"`
	// True if the location is the default location.
	ClientDefault param.Field[bool] `json:"client_default"`
	// True if the location needs to resolve EDNS queries.
	EcsSupport param.Field[bool] `json:"ecs_support"`
	// A list of network ranges that requests from this location would originate from.
	Networks param.Field[[]GatewayLocationUpdateParamsNetwork] `json:"networks"`
}

func (GatewayLocationUpdateParams) MarshalJSON 

func (r GatewayLocationUpdateParams) MarshalJSON() (data []byte, err error)

type GatewayLocationUpdateParamsNetwork added in v2.4.0 

type GatewayLocationUpdateParamsNetwork struct {
	// The IPv4 address or IPv4 CIDR. IPv4 CIDRs are limited to a maximum of /24.
	Network param.Field[string] `json:"network,required"`
}

func (GatewayLocationUpdateParamsNetwork) MarshalJSON added in v2.4.0 

func (r GatewayLocationUpdateParamsNetwork) MarshalJSON() (data []byte, err error)

type GatewayLocationUpdateResponseEnvelope 

type GatewayLocationUpdateResponseEnvelope struct {
	Errors   []GatewayLocationUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []GatewayLocationUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   ZeroTrustGatewayLocations                       `json:"result,required"`
	// Whether the API call was successful
	Success GatewayLocationUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    gatewayLocationUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*GatewayLocationUpdateResponseEnvelope) UnmarshalJSON 

func (r *GatewayLocationUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type GatewayLocationUpdateResponseEnvelopeErrors 

type GatewayLocationUpdateResponseEnvelopeErrors struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    gatewayLocationUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*GatewayLocationUpdateResponseEnvelopeErrors) UnmarshalJSON 

func (r *GatewayLocationUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type GatewayLocationUpdateResponseEnvelopeMessages 

type GatewayLocationUpdateResponseEnvelopeMessages struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    gatewayLocationUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*GatewayLocationUpdateResponseEnvelopeMessages) UnmarshalJSON 

func (r *GatewayLocationUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type GatewayLocationUpdateResponseEnvelopeSuccess 

type GatewayLocationUpdateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	GatewayLocationUpdateResponseEnvelopeSuccessTrue GatewayLocationUpdateResponseEnvelopeSuccess = true
)

type GatewayLoggingGetParams 

type GatewayLoggingGetParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type GatewayLoggingGetResponseEnvelope 

type GatewayLoggingGetResponseEnvelope struct {
	Errors   []GatewayLoggingGetResponseEnvelopeErrors     `json:"errors,required"`
	Messages []GatewayLoggingGetResponseEnvelopeMessages   `json:"messages,required"`
	Result   ZeroTrustGatewayGatewayAccountLoggingSettings `json:"result,required"`
	// Whether the API call was successful
	Success GatewayLoggingGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    gatewayLoggingGetResponseEnvelopeJSON    `json:"-"`
}

func (*GatewayLoggingGetResponseEnvelope) UnmarshalJSON 

func (r *GatewayLoggingGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type GatewayLoggingGetResponseEnvelopeErrors 

type GatewayLoggingGetResponseEnvelopeErrors struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    gatewayLoggingGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*GatewayLoggingGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *GatewayLoggingGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type GatewayLoggingGetResponseEnvelopeMessages 

type GatewayLoggingGetResponseEnvelopeMessages struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    gatewayLoggingGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*GatewayLoggingGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *GatewayLoggingGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type GatewayLoggingGetResponseEnvelopeSuccess 

type GatewayLoggingGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	GatewayLoggingGetResponseEnvelopeSuccessTrue GatewayLoggingGetResponseEnvelopeSuccess = true
)

type GatewayLoggingService 

type GatewayLoggingService struct {
	Options []option.RequestOption
}

GatewayLoggingService 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 NewGatewayLoggingService method instead.

func NewGatewayLoggingService 

func NewGatewayLoggingService(opts ...option.RequestOption) (r *GatewayLoggingService)

NewGatewayLoggingService 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 (*GatewayLoggingService) Get 

func (r *GatewayLoggingService) Get(ctx context.Context, query GatewayLoggingGetParams, opts ...option.RequestOption) (res *ZeroTrustGatewayGatewayAccountLoggingSettings, err error)

Fetches the current logging settings for Zero Trust account.

func (*GatewayLoggingService) Update 

func (r *GatewayLoggingService) Update(ctx context.Context, params GatewayLoggingUpdateParams, opts ...option.RequestOption) (res *ZeroTrustGatewayGatewayAccountLoggingSettings, err error)

Updates logging settings for the current Zero Trust account.

type GatewayLoggingUpdateParams 

type GatewayLoggingUpdateParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
	// Redact personally identifiable information from activity logging (PII fields
	// are: source IP, user email, user ID, device ID, URL, referrer, user agent).
	RedactPii param.Field[bool] `json:"redact_pii"`
	// Logging settings by rule type.
	SettingsByRuleType param.Field[GatewayLoggingUpdateParamsSettingsByRuleType] `json:"settings_by_rule_type"`
}

func (GatewayLoggingUpdateParams) MarshalJSON 

func (r GatewayLoggingUpdateParams) MarshalJSON() (data []byte, err error)

type GatewayLoggingUpdateParamsSettingsByRuleType 

type GatewayLoggingUpdateParamsSettingsByRuleType struct {
	// Logging settings for DNS firewall.
	DNS param.Field[interface{}] `json:"dns"`
	// Logging settings for HTTP/HTTPS firewall.
	HTTP param.Field[interface{}] `json:"http"`
	// Logging settings for Network firewall.
	L4 param.Field[interface{}] `json:"l4"`
}

Logging settings by rule type.

func (GatewayLoggingUpdateParamsSettingsByRuleType) MarshalJSON 

func (r GatewayLoggingUpdateParamsSettingsByRuleType) MarshalJSON() (data []byte, err error)

type GatewayLoggingUpdateResponseEnvelope 

type GatewayLoggingUpdateResponseEnvelope struct {
	Errors   []GatewayLoggingUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []GatewayLoggingUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   ZeroTrustGatewayGatewayAccountLoggingSettings  `json:"result,required"`
	// Whether the API call was successful
	Success GatewayLoggingUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    gatewayLoggingUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*GatewayLoggingUpdateResponseEnvelope) UnmarshalJSON 

func (r *GatewayLoggingUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type GatewayLoggingUpdateResponseEnvelopeErrors 

type GatewayLoggingUpdateResponseEnvelopeErrors struct {
	Code    int64                                          `json:"code,required"`
	Message string                                         `json:"message,required"`
	JSON    gatewayLoggingUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*GatewayLoggingUpdateResponseEnvelopeErrors) UnmarshalJSON 

func (r *GatewayLoggingUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type GatewayLoggingUpdateResponseEnvelopeMessages 

type GatewayLoggingUpdateResponseEnvelopeMessages struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    gatewayLoggingUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*GatewayLoggingUpdateResponseEnvelopeMessages) UnmarshalJSON 

func (r *GatewayLoggingUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type GatewayLoggingUpdateResponseEnvelopeSuccess 

type GatewayLoggingUpdateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	GatewayLoggingUpdateResponseEnvelopeSuccessTrue GatewayLoggingUpdateResponseEnvelopeSuccess = true
)

type GatewayNewParams 

type GatewayNewParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type GatewayNewResponse 

type GatewayNewResponse struct {
	// Cloudflare account ID.
	ID string `json:"id"`
	// Gateway internal ID.
	GatewayTag string `json:"gateway_tag"`
	// The name of the provider. Usually Cloudflare.
	ProviderName string                 `json:"provider_name"`
	JSON         gatewayNewResponseJSON `json:"-"`
}

func (*GatewayNewResponse) UnmarshalJSON 

func (r *GatewayNewResponse) UnmarshalJSON(data []byte) (err error)

type GatewayNewResponseEnvelope 

type GatewayNewResponseEnvelope struct {
	Errors   []GatewayNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []GatewayNewResponseEnvelopeMessages `json:"messages,required"`
	Result   GatewayNewResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success GatewayNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    gatewayNewResponseEnvelopeJSON    `json:"-"`
}

func (*GatewayNewResponseEnvelope) UnmarshalJSON 

func (r *GatewayNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type GatewayNewResponseEnvelopeErrors 

type GatewayNewResponseEnvelopeErrors struct {
	Code    int64                                `json:"code,required"`
	Message string                               `json:"message,required"`
	JSON    gatewayNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*GatewayNewResponseEnvelopeErrors) UnmarshalJSON 

func (r *GatewayNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type GatewayNewResponseEnvelopeMessages 

type GatewayNewResponseEnvelopeMessages struct {
	Code    int64                                  `json:"code,required"`
	Message string                                 `json:"message,required"`
	JSON    gatewayNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*GatewayNewResponseEnvelopeMessages) UnmarshalJSON 

func (r *GatewayNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type GatewayNewResponseEnvelopeSuccess 

type GatewayNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	GatewayNewResponseEnvelopeSuccessTrue GatewayNewResponseEnvelopeSuccess = true
)

type GatewayProxyEndpointDeleteParams 

type GatewayProxyEndpointDeleteParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type GatewayProxyEndpointDeleteResponse 

type GatewayProxyEndpointDeleteResponse interface {
	ImplementsZeroTrustGatewayProxyEndpointDeleteResponse()
}

Union satisfied by zero_trust.GatewayProxyEndpointDeleteResponseUnknown or shared.UnionString.

type GatewayProxyEndpointDeleteResponseEnvelope 

type GatewayProxyEndpointDeleteResponseEnvelope struct {
	Errors   []GatewayProxyEndpointDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []GatewayProxyEndpointDeleteResponseEnvelopeMessages `json:"messages,required"`
	Result   GatewayProxyEndpointDeleteResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success GatewayProxyEndpointDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    gatewayProxyEndpointDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*GatewayProxyEndpointDeleteResponseEnvelope) UnmarshalJSON 

func (r *GatewayProxyEndpointDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type GatewayProxyEndpointDeleteResponseEnvelopeErrors 

type GatewayProxyEndpointDeleteResponseEnvelopeErrors struct {
	Code    int64                                                `json:"code,required"`
	Message string                                               `json:"message,required"`
	JSON    gatewayProxyEndpointDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*GatewayProxyEndpointDeleteResponseEnvelopeErrors) UnmarshalJSON 

func (r *GatewayProxyEndpointDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type GatewayProxyEndpointDeleteResponseEnvelopeMessages 

type GatewayProxyEndpointDeleteResponseEnvelopeMessages struct {
	Code    int64                                                  `json:"code,required"`
	Message string                                                 `json:"message,required"`
	JSON    gatewayProxyEndpointDeleteResponseEnvelopeMessagesJSON `json:"-"`
}

func (*GatewayProxyEndpointDeleteResponseEnvelopeMessages) UnmarshalJSON 

func (r *GatewayProxyEndpointDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type GatewayProxyEndpointDeleteResponseEnvelopeSuccess 

type GatewayProxyEndpointDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	GatewayProxyEndpointDeleteResponseEnvelopeSuccessTrue GatewayProxyEndpointDeleteResponseEnvelopeSuccess = true
)

type GatewayProxyEndpointEditParams 

type GatewayProxyEndpointEditParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
	// A list of CIDRs to restrict ingress connections.
	IPs param.Field[[]string] `json:"ips"`
	// The name of the proxy endpoint.
	Name param.Field[string] `json:"name"`
	// The subdomain to be used as the destination in the proxy client.
	Subdomain param.Field[string] `json:"subdomain"`
}

func (GatewayProxyEndpointEditParams) MarshalJSON 

func (r GatewayProxyEndpointEditParams) MarshalJSON() (data []byte, err error)

type GatewayProxyEndpointEditResponseEnvelope 

type GatewayProxyEndpointEditResponseEnvelope struct {
	Errors   []GatewayProxyEndpointEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []GatewayProxyEndpointEditResponseEnvelopeMessages `json:"messages,required"`
	Result   ZeroTrustGatewayProxyEndpoints                     `json:"result,required"`
	// Whether the API call was successful
	Success GatewayProxyEndpointEditResponseEnvelopeSuccess `json:"success,required"`
	JSON    gatewayProxyEndpointEditResponseEnvelopeJSON    `json:"-"`
}

func (*GatewayProxyEndpointEditResponseEnvelope) UnmarshalJSON 

func (r *GatewayProxyEndpointEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type GatewayProxyEndpointEditResponseEnvelopeErrors 

type GatewayProxyEndpointEditResponseEnvelopeErrors struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    gatewayProxyEndpointEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*GatewayProxyEndpointEditResponseEnvelopeErrors) UnmarshalJSON 

func (r *GatewayProxyEndpointEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type GatewayProxyEndpointEditResponseEnvelopeMessages 

type GatewayProxyEndpointEditResponseEnvelopeMessages struct {
	Code    int64                                                `json:"code,required"`
	Message string                                               `json:"message,required"`
	JSON    gatewayProxyEndpointEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*GatewayProxyEndpointEditResponseEnvelopeMessages) UnmarshalJSON 

func (r *GatewayProxyEndpointEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type GatewayProxyEndpointEditResponseEnvelopeSuccess 

type GatewayProxyEndpointEditResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	GatewayProxyEndpointEditResponseEnvelopeSuccessTrue GatewayProxyEndpointEditResponseEnvelopeSuccess = true
)

type GatewayProxyEndpointGetParams 

type GatewayProxyEndpointGetParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type GatewayProxyEndpointGetResponseEnvelope 

type GatewayProxyEndpointGetResponseEnvelope struct {
	Errors   []GatewayProxyEndpointGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []GatewayProxyEndpointGetResponseEnvelopeMessages `json:"messages,required"`
	Result   ZeroTrustGatewayProxyEndpoints                    `json:"result,required"`
	// Whether the API call was successful
	Success GatewayProxyEndpointGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    gatewayProxyEndpointGetResponseEnvelopeJSON    `json:"-"`
}

func (*GatewayProxyEndpointGetResponseEnvelope) UnmarshalJSON 

func (r *GatewayProxyEndpointGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type GatewayProxyEndpointGetResponseEnvelopeErrors 

type GatewayProxyEndpointGetResponseEnvelopeErrors struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    gatewayProxyEndpointGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*GatewayProxyEndpointGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *GatewayProxyEndpointGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type GatewayProxyEndpointGetResponseEnvelopeMessages 

type GatewayProxyEndpointGetResponseEnvelopeMessages struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    gatewayProxyEndpointGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*GatewayProxyEndpointGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *GatewayProxyEndpointGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type GatewayProxyEndpointGetResponseEnvelopeSuccess 

type GatewayProxyEndpointGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	GatewayProxyEndpointGetResponseEnvelopeSuccessTrue GatewayProxyEndpointGetResponseEnvelopeSuccess = true
)

type GatewayProxyEndpointListParams 

type GatewayProxyEndpointListParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type GatewayProxyEndpointListResponseEnvelope added in v2.3.0 

type GatewayProxyEndpointListResponseEnvelope struct {
	Errors   []GatewayProxyEndpointListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []GatewayProxyEndpointListResponseEnvelopeMessages `json:"messages,required"`
	Result   []ZeroTrustGatewayProxyEndpoints                   `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    GatewayProxyEndpointListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo GatewayProxyEndpointListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       gatewayProxyEndpointListResponseEnvelopeJSON       `json:"-"`
}

func (*GatewayProxyEndpointListResponseEnvelope) UnmarshalJSON added in v2.3.0 

func (r *GatewayProxyEndpointListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type GatewayProxyEndpointListResponseEnvelopeErrors 

type GatewayProxyEndpointListResponseEnvelopeErrors struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    gatewayProxyEndpointListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*GatewayProxyEndpointListResponseEnvelopeErrors) UnmarshalJSON 

func (r *GatewayProxyEndpointListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type GatewayProxyEndpointListResponseEnvelopeMessages 

type GatewayProxyEndpointListResponseEnvelopeMessages struct {
	Code    int64                                                `json:"code,required"`
	Message string                                               `json:"message,required"`
	JSON    gatewayProxyEndpointListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*GatewayProxyEndpointListResponseEnvelopeMessages) UnmarshalJSON 

func (r *GatewayProxyEndpointListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type GatewayProxyEndpointListResponseEnvelopeResultInfo 

type GatewayProxyEndpointListResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                                `json:"total_count"`
	JSON       gatewayProxyEndpointListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*GatewayProxyEndpointListResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *GatewayProxyEndpointListResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type GatewayProxyEndpointListResponseEnvelopeSuccess added in v2.3.0 

type GatewayProxyEndpointListResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	GatewayProxyEndpointListResponseEnvelopeSuccessTrue GatewayProxyEndpointListResponseEnvelopeSuccess = true
)

type GatewayProxyEndpointNewParams 

type GatewayProxyEndpointNewParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
	// A list of CIDRs to restrict ingress connections.
	IPs param.Field[[]string] `json:"ips,required"`
	// The name of the proxy endpoint.
	Name param.Field[string] `json:"name,required"`
	// The subdomain to be used as the destination in the proxy client.
	Subdomain param.Field[string] `json:"subdomain"`
}

func (GatewayProxyEndpointNewParams) MarshalJSON 

func (r GatewayProxyEndpointNewParams) MarshalJSON() (data []byte, err error)

type GatewayProxyEndpointNewResponseEnvelope 

type GatewayProxyEndpointNewResponseEnvelope struct {
	Errors   []GatewayProxyEndpointNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []GatewayProxyEndpointNewResponseEnvelopeMessages `json:"messages,required"`
	Result   ZeroTrustGatewayProxyEndpoints                    `json:"result,required"`
	// Whether the API call was successful
	Success GatewayProxyEndpointNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    gatewayProxyEndpointNewResponseEnvelopeJSON    `json:"-"`
}

func (*GatewayProxyEndpointNewResponseEnvelope) UnmarshalJSON 

func (r *GatewayProxyEndpointNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type GatewayProxyEndpointNewResponseEnvelopeErrors 

type GatewayProxyEndpointNewResponseEnvelopeErrors struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    gatewayProxyEndpointNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*GatewayProxyEndpointNewResponseEnvelopeErrors) UnmarshalJSON 

func (r *GatewayProxyEndpointNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type GatewayProxyEndpointNewResponseEnvelopeMessages 

type GatewayProxyEndpointNewResponseEnvelopeMessages struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    gatewayProxyEndpointNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*GatewayProxyEndpointNewResponseEnvelopeMessages) UnmarshalJSON 

func (r *GatewayProxyEndpointNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type GatewayProxyEndpointNewResponseEnvelopeSuccess 

type GatewayProxyEndpointNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	GatewayProxyEndpointNewResponseEnvelopeSuccessTrue GatewayProxyEndpointNewResponseEnvelopeSuccess = true
)

type GatewayProxyEndpointService 

type GatewayProxyEndpointService struct {
	Options []option.RequestOption
}

GatewayProxyEndpointService 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 NewGatewayProxyEndpointService method instead.

func NewGatewayProxyEndpointService 

func NewGatewayProxyEndpointService(opts ...option.RequestOption) (r *GatewayProxyEndpointService)

NewGatewayProxyEndpointService 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 (*GatewayProxyEndpointService) Delete 

func (r *GatewayProxyEndpointService) Delete(ctx context.Context, proxyEndpointID interface{}, body GatewayProxyEndpointDeleteParams, opts ...option.RequestOption) (res *GatewayProxyEndpointDeleteResponse, err error)

Deletes a configured Zero Trust Gateway proxy endpoint.

func (*GatewayProxyEndpointService) Edit 

func (r *GatewayProxyEndpointService) Edit(ctx context.Context, proxyEndpointID interface{}, params GatewayProxyEndpointEditParams, opts ...option.RequestOption) (res *ZeroTrustGatewayProxyEndpoints, err error)

Updates a configured Zero Trust Gateway proxy endpoint.

func (*GatewayProxyEndpointService) Get 

func (r *GatewayProxyEndpointService) Get(ctx context.Context, proxyEndpointID interface{}, query GatewayProxyEndpointGetParams, opts ...option.RequestOption) (res *ZeroTrustGatewayProxyEndpoints, err error)

Fetches all Zero Trust Gateway proxy endpoints for an account.

func (*GatewayProxyEndpointService) List 

func (r *GatewayProxyEndpointService) List(ctx context.Context, query GatewayProxyEndpointListParams, opts ...option.RequestOption) (res *[]ZeroTrustGatewayProxyEndpoints, err error)

Fetches a single Zero Trust Gateway proxy endpoint.

func (*GatewayProxyEndpointService) New 

func (r *GatewayProxyEndpointService) New(ctx context.Context, params GatewayProxyEndpointNewParams, opts ...option.RequestOption) (res *ZeroTrustGatewayProxyEndpoints, err error)

Creates a new Zero Trust Gateway proxy endpoint.

type GatewayRuleDeleteParams 

type GatewayRuleDeleteParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type GatewayRuleDeleteResponse 

type GatewayRuleDeleteResponse interface {
	ImplementsZeroTrustGatewayRuleDeleteResponse()
}

Union satisfied by zero_trust.GatewayRuleDeleteResponseUnknown or shared.UnionString.

type GatewayRuleDeleteResponseEnvelope 

type GatewayRuleDeleteResponseEnvelope struct {
	Errors   []GatewayRuleDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []GatewayRuleDeleteResponseEnvelopeMessages `json:"messages,required"`
	Result   GatewayRuleDeleteResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success GatewayRuleDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    gatewayRuleDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*GatewayRuleDeleteResponseEnvelope) UnmarshalJSON 

func (r *GatewayRuleDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type GatewayRuleDeleteResponseEnvelopeErrors 

type GatewayRuleDeleteResponseEnvelopeErrors struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    gatewayRuleDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*GatewayRuleDeleteResponseEnvelopeErrors) UnmarshalJSON 

func (r *GatewayRuleDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type GatewayRuleDeleteResponseEnvelopeMessages 

type GatewayRuleDeleteResponseEnvelopeMessages struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    gatewayRuleDeleteResponseEnvelopeMessagesJSON `json:"-"`
}

func (*GatewayRuleDeleteResponseEnvelopeMessages) UnmarshalJSON 

func (r *GatewayRuleDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type GatewayRuleDeleteResponseEnvelopeSuccess 

type GatewayRuleDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	GatewayRuleDeleteResponseEnvelopeSuccessTrue GatewayRuleDeleteResponseEnvelopeSuccess = true
)

type GatewayRuleGetParams 

type GatewayRuleGetParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type GatewayRuleGetResponseEnvelope 

type GatewayRuleGetResponseEnvelope struct {
	Errors   []GatewayRuleGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []GatewayRuleGetResponseEnvelopeMessages `json:"messages,required"`
	Result   ZeroTrustGatewayRules                    `json:"result,required"`
	// Whether the API call was successful
	Success GatewayRuleGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    gatewayRuleGetResponseEnvelopeJSON    `json:"-"`
}

func (*GatewayRuleGetResponseEnvelope) UnmarshalJSON 

func (r *GatewayRuleGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type GatewayRuleGetResponseEnvelopeErrors 

type GatewayRuleGetResponseEnvelopeErrors struct {
	Code    int64                                    `json:"code,required"`
	Message string                                   `json:"message,required"`
	JSON    gatewayRuleGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*GatewayRuleGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *GatewayRuleGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type GatewayRuleGetResponseEnvelopeMessages 

type GatewayRuleGetResponseEnvelopeMessages struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    gatewayRuleGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*GatewayRuleGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *GatewayRuleGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type GatewayRuleGetResponseEnvelopeSuccess 

type GatewayRuleGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	GatewayRuleGetResponseEnvelopeSuccessTrue GatewayRuleGetResponseEnvelopeSuccess = true
)

type GatewayRuleListParams 

type GatewayRuleListParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
}

type GatewayRuleListResponseEnvelope 

type GatewayRuleListResponseEnvelope struct {
	Errors   []GatewayRuleListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []GatewayRuleListResponseEnvelopeMessages `json:"messages,required"`
	Result   []ZeroTrustGatewayRules                   `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    GatewayRuleListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo GatewayRuleListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       gatewayRuleListResponseEnvelopeJSON       `json:"-"`
}

func (*GatewayRuleListResponseEnvelope) UnmarshalJSON 

func (r *GatewayRuleListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type GatewayRuleListResponseEnvelopeErrors 

type GatewayRuleListResponseEnvelopeErrors struct {
	Code    int64                                     `json:"code,required"`
	Message string                                    `json:"message,required"`
	JSON    gatewayRuleListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*GatewayRuleListResponseEnvelopeErrors) UnmarshalJSON 

func (r *GatewayRuleListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type GatewayRuleListResponseEnvelopeMessages 

type GatewayRuleListResponseEnvelopeMessages struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    gatewayRuleListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*GatewayRuleListResponseEnvelopeMessages) UnmarshalJSON 

func (r *GatewayRuleListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type GatewayRuleListResponseEnvelopeResultInfo 

type GatewayRuleListResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                       `json:"total_count"`
	JSON       gatewayRuleListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*GatewayRuleListResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *GatewayRuleListResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type GatewayRuleListResponseEnvelopeSuccess 

type GatewayRuleListResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	GatewayRuleListResponseEnvelopeSuccessTrue GatewayRuleListResponseEnvelopeSuccess = true
)

type GatewayRuleNewParams 

type GatewayRuleNewParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
	// The action to preform when the associated traffic, identity, and device posture
	// expressions are either absent or evaluate to `true`.
	Action param.Field[GatewayRuleNewParamsAction] `json:"action,required"`
	// The name of the rule.
	Name param.Field[string] `json:"name,required"`
	// The description of the rule.
	Description param.Field[string] `json:"description"`
	// The wirefilter expression used for device posture check matching.
	DevicePosture param.Field[string] `json:"device_posture"`
	// True if the rule is enabled.
	Enabled param.Field[bool] `json:"enabled"`
	// The protocol or layer to evaluate the traffic, identity, and device posture
	// expressions.
	Filters param.Field[[]GatewayRuleNewParamsFilter] `json:"filters"`
	// The wirefilter expression used for identity matching.
	Identity param.Field[string] `json:"identity"`
	// Precedence sets the order of your rules. Lower values indicate higher
	// precedence. At each processing phase, applicable rules are evaluated in
	// ascending order of this value.
	Precedence param.Field[int64] `json:"precedence"`
	// Additional settings that modify the rule's action.
	RuleSettings param.Field[GatewayRuleNewParamsRuleSettings] `json:"rule_settings"`
	// The schedule for activating DNS policies. This does not apply to HTTP or network
	// policies.
	Schedule param.Field[GatewayRuleNewParamsSchedule] `json:"schedule"`
	// The wirefilter expression used for traffic matching.
	Traffic param.Field[string] `json:"traffic"`
}

func (GatewayRuleNewParams) MarshalJSON 

func (r GatewayRuleNewParams) MarshalJSON() (data []byte, err error)

type GatewayRuleNewParamsAction 

type GatewayRuleNewParamsAction string

The action to preform when the associated traffic, identity, and device posture expressions are either absent or evaluate to `true`. 

const (
	GatewayRuleNewParamsActionOn           GatewayRuleNewParamsAction = "on"
	GatewayRuleNewParamsActionOff          GatewayRuleNewParamsAction = "off"
	GatewayRuleNewParamsActionAllow        GatewayRuleNewParamsAction = "allow"
	GatewayRuleNewParamsActionBlock        GatewayRuleNewParamsAction = "block"
	GatewayRuleNewParamsActionScan         GatewayRuleNewParamsAction = "scan"
	GatewayRuleNewParamsActionNoscan       GatewayRuleNewParamsAction = "noscan"
	GatewayRuleNewParamsActionSafesearch   GatewayRuleNewParamsAction = "safesearch"
	GatewayRuleNewParamsActionYtrestricted GatewayRuleNewParamsAction = "ytrestricted"
	GatewayRuleNewParamsActionIsolate      GatewayRuleNewParamsAction = "isolate"
	GatewayRuleNewParamsActionNoisolate    GatewayRuleNewParamsAction = "noisolate"
	GatewayRuleNewParamsActionOverride     GatewayRuleNewParamsAction = "override"
	GatewayRuleNewParamsActionL4Override   GatewayRuleNewParamsAction = "l4_override"
	GatewayRuleNewParamsActionEgress       GatewayRuleNewParamsAction = "egress"
	GatewayRuleNewParamsActionAuditSSH     GatewayRuleNewParamsAction = "audit_ssh"
)

type GatewayRuleNewParamsFilter 

type GatewayRuleNewParamsFilter string

The protocol or layer to use. 

const (
	GatewayRuleNewParamsFilterHTTP   GatewayRuleNewParamsFilter = "http"
	GatewayRuleNewParamsFilterDNS    GatewayRuleNewParamsFilter = "dns"
	GatewayRuleNewParamsFilterL4     GatewayRuleNewParamsFilter = "l4"
	GatewayRuleNewParamsFilterEgress GatewayRuleNewParamsFilter = "egress"
)

type GatewayRuleNewParamsRuleSettings 

type GatewayRuleNewParamsRuleSettings struct {
	// Add custom headers to allowed requests, in the form of key-value pairs. Keys are
	// header names, pointing to an array with its header value(s).
	AddHeaders param.Field[interface{}] `json:"add_headers"`
	// Set by parent MSP accounts to enable their children to bypass this rule.
	AllowChildBypass param.Field[bool] `json:"allow_child_bypass"`
	// Settings for the Audit SSH action.
	AuditSSH param.Field[GatewayRuleNewParamsRuleSettingsAuditSSH] `json:"audit_ssh"`
	// Configure how browser isolation behaves.
	BisoAdminControls param.Field[GatewayRuleNewParamsRuleSettingsBisoAdminControls] `json:"biso_admin_controls"`
	// Enable the custom block page.
	BlockPageEnabled param.Field[bool] `json:"block_page_enabled"`
	// The text describing why this block occurred, displayed on the custom block page
	// (if enabled).
	BlockReason param.Field[string] `json:"block_reason"`
	// Set by children MSP accounts to bypass their parent's rules.
	BypassParentRule param.Field[bool] `json:"bypass_parent_rule"`
	// Configure how session check behaves.
	CheckSession param.Field[GatewayRuleNewParamsRuleSettingsCheckSession] `json:"check_session"`
	// Add your own custom resolvers to route queries that match the resolver policy.
	// Cannot be used when resolve_dns_through_cloudflare is set. DNS queries will
	// route to the address closest to their origin.
	DNSResolvers param.Field[GatewayRuleNewParamsRuleSettingsDNSResolvers] `json:"dns_resolvers"`
	// Configure how Gateway Proxy traffic egresses. You can enable this setting for
	// rules with Egress actions and filters, or omit it to indicate local egress via
	// WARP IPs.
	Egress param.Field[GatewayRuleNewParamsRuleSettingsEgress] `json:"egress"`
	// INSECURE - disable DNSSEC validation (for Allow actions).
	InsecureDisableDNSSECValidation param.Field[bool] `json:"insecure_disable_dnssec_validation"`
	// Set to true to enable IPs in DNS resolver category blocks. By default categories
	// only block based on domain names.
	IPCategories param.Field[bool] `json:"ip_categories"`
	// Set to true to include IPs in DNS resolver indicator feed blocks. By default
	// indicator feeds only block based on domain names.
	IPIndicatorFeeds param.Field[bool] `json:"ip_indicator_feeds"`
	// Send matching traffic to the supplied destination IP address and port.
	L4override param.Field[GatewayRuleNewParamsRuleSettingsL4override] `json:"l4override"`
	// Configure a notification to display on the user's device when this rule is
	// matched.
	NotificationSettings param.Field[GatewayRuleNewParamsRuleSettingsNotificationSettings] `json:"notification_settings"`
	// Override matching DNS queries with a hostname.
	OverrideHost param.Field[string] `json:"override_host"`
	// Override matching DNS queries with an IP or set of IPs.
	OverrideIPs param.Field[[]string] `json:"override_ips"`
	// Configure DLP payload logging.
	PayloadLog param.Field[GatewayRuleNewParamsRuleSettingsPayloadLog] `json:"payload_log"`
	// Enable to send queries that match the policy to Cloudflare's default 1.1.1.1 DNS
	// resolver. Cannot be set when dns_resolvers are specified.
	ResolveDNSThroughCloudflare param.Field[bool] `json:"resolve_dns_through_cloudflare"`
	// Configure behavior when an upstream cert is invalid or an SSL error occurs.
	UntrustedCert param.Field[GatewayRuleNewParamsRuleSettingsUntrustedCert] `json:"untrusted_cert"`
}

Additional settings that modify the rule's action.

func (GatewayRuleNewParamsRuleSettings) MarshalJSON 

func (r GatewayRuleNewParamsRuleSettings) MarshalJSON() (data []byte, err error)

type GatewayRuleNewParamsRuleSettingsAuditSSH 

type GatewayRuleNewParamsRuleSettingsAuditSSH struct {
	// Enable to turn on SSH command logging.
	CommandLogging param.Field[bool] `json:"command_logging"`
}

Settings for the Audit SSH action.

func (GatewayRuleNewParamsRuleSettingsAuditSSH) MarshalJSON 

func (r GatewayRuleNewParamsRuleSettingsAuditSSH) MarshalJSON() (data []byte, err error)

type GatewayRuleNewParamsRuleSettingsBisoAdminControls 

type GatewayRuleNewParamsRuleSettingsBisoAdminControls struct {
	// Set to true to enable copy-pasting.
	Dcp param.Field[bool] `json:"dcp"`
	// Set to true to enable downloading.
	Dd param.Field[bool] `json:"dd"`
	// Set to true to enable keyboard usage.
	Dk param.Field[bool] `json:"dk"`
	// Set to true to enable printing.
	Dp param.Field[bool] `json:"dp"`
	// Set to true to enable uploading.
	Du param.Field[bool] `json:"du"`
}

Configure how browser isolation behaves.

func (GatewayRuleNewParamsRuleSettingsBisoAdminControls) MarshalJSON 

func (r GatewayRuleNewParamsRuleSettingsBisoAdminControls) MarshalJSON() (data []byte, err error)

type GatewayRuleNewParamsRuleSettingsCheckSession 

type GatewayRuleNewParamsRuleSettingsCheckSession struct {
	// Configure how fresh the session needs to be to be considered valid.
	Duration param.Field[string] `json:"duration"`
	// Set to true to enable session enforcement.
	Enforce param.Field[bool] `json:"enforce"`
}

Configure how session check behaves.

func (GatewayRuleNewParamsRuleSettingsCheckSession) MarshalJSON 

func (r GatewayRuleNewParamsRuleSettingsCheckSession) MarshalJSON() (data []byte, err error)

type GatewayRuleNewParamsRuleSettingsDNSResolvers 

type GatewayRuleNewParamsRuleSettingsDNSResolvers struct {
	IPV4 param.Field[[]GatewayRuleNewParamsRuleSettingsDNSResolversIPV4] `json:"ipv4"`
	IPV6 param.Field[[]GatewayRuleNewParamsRuleSettingsDNSResolversIPV6] `json:"ipv6"`
}

Add your own custom resolvers to route queries that match the resolver policy. Cannot be used when resolve_dns_through_cloudflare is set. DNS queries will route to the address closest to their origin.

func (GatewayRuleNewParamsRuleSettingsDNSResolvers) MarshalJSON 

func (r GatewayRuleNewParamsRuleSettingsDNSResolvers) MarshalJSON() (data []byte, err error)

type GatewayRuleNewParamsRuleSettingsDNSResolversIPV4 

type GatewayRuleNewParamsRuleSettingsDNSResolversIPV4 struct {
	// IP address of upstream resolver.
	IP param.Field[string] `json:"ip,required"`
	// A port number to use for upstream resolver.
	Port param.Field[int64] `json:"port"`
	// Whether to connect to this resolver over a private network. Must be set when
	// vnet_id is set.
	RouteThroughPrivateNetwork param.Field[bool] `json:"route_through_private_network"`
	// Optionally specify a virtual network for this resolver. Uses default virtual
	// network id if omitted.
	VnetID param.Field[string] `json:"vnet_id"`
}

func (GatewayRuleNewParamsRuleSettingsDNSResolversIPV4) MarshalJSON 

func (r GatewayRuleNewParamsRuleSettingsDNSResolversIPV4) MarshalJSON() (data []byte, err error)

type GatewayRuleNewParamsRuleSettingsDNSResolversIPV6 

type GatewayRuleNewParamsRuleSettingsDNSResolversIPV6 struct {
	// IP address of upstream resolver.
	IP param.Field[string] `json:"ip,required"`
	// A port number to use for upstream resolver.
	Port param.Field[int64] `json:"port"`
	// Whether to connect to this resolver over a private network. Must be set when
	// vnet_id is set.
	RouteThroughPrivateNetwork param.Field[bool] `json:"route_through_private_network"`
	// Optionally specify a virtual network for this resolver. Uses default virtual
	// network id if omitted.
	VnetID param.Field[string] `json:"vnet_id"`
}

func (GatewayRuleNewParamsRuleSettingsDNSResolversIPV6) MarshalJSON 

func (r GatewayRuleNewParamsRuleSettingsDNSResolversIPV6) MarshalJSON() (data []byte, err error)

type GatewayRuleNewParamsRuleSettingsEgress 

type GatewayRuleNewParamsRuleSettingsEgress struct {
	// The IPv4 address to be used for egress.
	IPV4 param.Field[string] `json:"ipv4"`
	// The fallback IPv4 address to be used for egress in the event of an error
	// egressing with the primary IPv4. Can be '0.0.0.0' to indicate local egress via
	// WARP IPs.
	IPV4Fallback param.Field[string] `json:"ipv4_fallback"`
	// The IPv6 range to be used for egress.
	IPV6 param.Field[string] `json:"ipv6"`
}

Configure how Gateway Proxy traffic egresses. You can enable this setting for rules with Egress actions and filters, or omit it to indicate local egress via WARP IPs.

func (GatewayRuleNewParamsRuleSettingsEgress) MarshalJSON 

func (r GatewayRuleNewParamsRuleSettingsEgress) MarshalJSON() (data []byte, err error)

type GatewayRuleNewParamsRuleSettingsL4override 

type GatewayRuleNewParamsRuleSettingsL4override struct {
	// IPv4 or IPv6 address.
	IP param.Field[string] `json:"ip"`
	// A port number to use for TCP/UDP overrides.
	Port param.Field[int64] `json:"port"`
}

Send matching traffic to the supplied destination IP address and port.

func (GatewayRuleNewParamsRuleSettingsL4override) MarshalJSON 

func (r GatewayRuleNewParamsRuleSettingsL4override) MarshalJSON() (data []byte, err error)

type GatewayRuleNewParamsRuleSettingsNotificationSettings 

type GatewayRuleNewParamsRuleSettingsNotificationSettings struct {
	// Set notification on
	Enabled param.Field[bool] `json:"enabled"`
	// Customize the message shown in the notification.
	Msg param.Field[string] `json:"msg"`
	// Optional URL to direct users to additional information. If not set, the
	// notification will open a block page.
	SupportURL param.Field[string] `json:"support_url"`
}

Configure a notification to display on the user's device when this rule is matched.

func (GatewayRuleNewParamsRuleSettingsNotificationSettings) MarshalJSON 

func (r GatewayRuleNewParamsRuleSettingsNotificationSettings) MarshalJSON() (data []byte, err error)

type GatewayRuleNewParamsRuleSettingsPayloadLog 

type GatewayRuleNewParamsRuleSettingsPayloadLog struct {
	// Set to true to enable DLP payload logging for this rule.
	Enabled param.Field[bool] `json:"enabled"`
}

Configure DLP payload logging.

func (GatewayRuleNewParamsRuleSettingsPayloadLog) MarshalJSON 

func (r GatewayRuleNewParamsRuleSettingsPayloadLog) MarshalJSON() (data []byte, err error)

type GatewayRuleNewParamsRuleSettingsUntrustedCert 

type GatewayRuleNewParamsRuleSettingsUntrustedCert struct {
	// The action performed when an untrusted certificate is seen. The default action
	// is an error with HTTP code 526.
	Action param.Field[GatewayRuleNewParamsRuleSettingsUntrustedCertAction] `json:"action"`
}

Configure behavior when an upstream cert is invalid or an SSL error occurs.

func (GatewayRuleNewParamsRuleSettingsUntrustedCert) MarshalJSON 

func (r GatewayRuleNewParamsRuleSettingsUntrustedCert) MarshalJSON() (data []byte, err error)

type GatewayRuleNewParamsRuleSettingsUntrustedCertAction 

type GatewayRuleNewParamsRuleSettingsUntrustedCertAction string

The action performed when an untrusted certificate is seen. The default action is an error with HTTP code 526. 

const (
	GatewayRuleNewParamsRuleSettingsUntrustedCertActionPassThrough GatewayRuleNewParamsRuleSettingsUntrustedCertAction = "pass_through"
	GatewayRuleNewParamsRuleSettingsUntrustedCertActionBlock       GatewayRuleNewParamsRuleSettingsUntrustedCertAction = "block"
	GatewayRuleNewParamsRuleSettingsUntrustedCertActionError       GatewayRuleNewParamsRuleSettingsUntrustedCertAction = "error"
)

type GatewayRuleNewParamsSchedule 

type GatewayRuleNewParamsSchedule struct {
	// The time intervals when the rule will be active on Fridays, in increasing order
	// from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on
	// Fridays.
	Fri param.Field[string] `json:"fri"`
	// The time intervals when the rule will be active on Mondays, in increasing order
	// from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on
	// Mondays.
	Mon param.Field[string] `json:"mon"`
	// The time intervals when the rule will be active on Saturdays, in increasing
	// order from 00:00-24:00. If this parameter is omitted, the rule will be
	// deactivated on Saturdays.
	Sat param.Field[string] `json:"sat"`
	// The time intervals when the rule will be active on Sundays, in increasing order
	// from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on
	// Sundays.
	Sun param.Field[string] `json:"sun"`
	// The time intervals when the rule will be active on Thursdays, in increasing
	// order from 00:00-24:00. If this parameter is omitted, the rule will be
	// deactivated on Thursdays.
	Thu param.Field[string] `json:"thu"`
	// The time zone the rule will be evaluated against. If a
	// [valid time zone city name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List)
	// is provided, Gateway will always use the current time at that time zone. If this
	// parameter is omitted, then Gateway will use the time zone inferred from the
	// user's source IP to evaluate the rule. If Gateway cannot determine the time zone
	// from the IP, we will fall back to the time zone of the user's connected data
	// center.
	TimeZone param.Field[string] `json:"time_zone"`
	// The time intervals when the rule will be active on Tuesdays, in increasing order
	// from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on
	// Tuesdays.
	Tue param.Field[string] `json:"tue"`
	// The time intervals when the rule will be active on Wednesdays, in increasing
	// order from 00:00-24:00. If this parameter is omitted, the rule will be
	// deactivated on Wednesdays.
	Wed param.Field[string] `json:"wed"`
}

The schedule for activating DNS policies. This does not apply to HTTP or network policies.

func (GatewayRuleNewParamsSchedule) MarshalJSON 

func (r GatewayRuleNewParamsSchedule) MarshalJSON() (data []byte, err error)

type GatewayRuleNewResponseEnvelope 

type GatewayRuleNewResponseEnvelope struct {
	Errors   []GatewayRuleNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []GatewayRuleNewResponseEnvelopeMessages `json:"messages,required"`
	Result   ZeroTrustGatewayRules                    `json:"result,required"`
	// Whether the API call was successful
	Success GatewayRuleNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    gatewayRuleNewResponseEnvelopeJSON    `json:"-"`
}

func (*GatewayRuleNewResponseEnvelope) UnmarshalJSON 

func (r *GatewayRuleNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type GatewayRuleNewResponseEnvelopeErrors 

type GatewayRuleNewResponseEnvelopeErrors struct {
	Code    int64                                    `json:"code,required"`
	Message string                                   `json:"message,required"`
	JSON    gatewayRuleNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*GatewayRuleNewResponseEnvelopeErrors) UnmarshalJSON 

func (r *GatewayRuleNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type GatewayRuleNewResponseEnvelopeMessages 

type GatewayRuleNewResponseEnvelopeMessages struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    gatewayRuleNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*GatewayRuleNewResponseEnvelopeMessages) UnmarshalJSON 

func (r *GatewayRuleNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type GatewayRuleNewResponseEnvelopeSuccess 

type GatewayRuleNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	GatewayRuleNewResponseEnvelopeSuccessTrue GatewayRuleNewResponseEnvelopeSuccess = true
)

type GatewayRuleService 

type GatewayRuleService struct {
	Options []option.RequestOption
}

GatewayRuleService 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 NewGatewayRuleService method instead.

func NewGatewayRuleService 

func NewGatewayRuleService(opts ...option.RequestOption) (r *GatewayRuleService)

NewGatewayRuleService 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 (*GatewayRuleService) Delete 

func (r *GatewayRuleService) Delete(ctx context.Context, ruleID string, body GatewayRuleDeleteParams, opts ...option.RequestOption) (res *GatewayRuleDeleteResponse, err error)

Deletes a Zero Trust Gateway rule.

func (*GatewayRuleService) Get 

func (r *GatewayRuleService) Get(ctx context.Context, ruleID string, query GatewayRuleGetParams, opts ...option.RequestOption) (res *ZeroTrustGatewayRules, err error)

Fetches a single Zero Trust Gateway rule.

func (*GatewayRuleService) List 

func (r *GatewayRuleService) List(ctx context.Context, query GatewayRuleListParams, opts ...option.RequestOption) (res *[]ZeroTrustGatewayRules, err error)

Fetches the Zero Trust Gateway rules for an account.

func (*GatewayRuleService) New 

func (r *GatewayRuleService) New(ctx context.Context, params GatewayRuleNewParams, opts ...option.RequestOption) (res *ZeroTrustGatewayRules, err error)

Creates a new Zero Trust Gateway rule.

func (*GatewayRuleService) Update 

func (r *GatewayRuleService) Update(ctx context.Context, ruleID string, params GatewayRuleUpdateParams, opts ...option.RequestOption) (res *ZeroTrustGatewayRules, err error)

Updates a configured Zero Trust Gateway rule.

type GatewayRuleUpdateParams 

type GatewayRuleUpdateParams struct {
	AccountID param.Field[interface{}] `path:"account_id,required"`
	// The action to preform when the associated traffic, identity, and device posture
	// expressions are either absent or evaluate to `true`.
	Action param.Field[GatewayRuleUpdateParamsAction] `json:"action,required"`
	// The name of the rule.
	Name param.Field[string] `json:"name,required"`
	// The description of the rule.
	Description param.Field[string] `json:"description"`
	// The wirefilter expression used for device posture check matching.
	DevicePosture param.Field[string] `json:"device_posture"`
	// True if the rule is enabled.
	Enabled param.Field[bool] `json:"enabled"`
	// The protocol or layer to evaluate the traffic, identity, and device posture
	// expressions.
	Filters param.Field[[]GatewayRuleUpdateParamsFilter] `json:"filters"`
	// The wirefilter expression used for identity matching.
	Identity param.Field[string] `json:"identity"`
	// Precedence sets the order of your rules. Lower values indicate higher
	// precedence. At each processing phase, applicable rules are evaluated in
	// ascending order of this value.
	Precedence param.Field[int64] `json:"precedence"`
	// Additional settings that modify the rule's action.
	RuleSettings param.Field[GatewayRuleUpdateParamsRuleSettings] `json:"rule_settings"`
	// The schedule for activating DNS policies. This does not apply to HTTP or network
	// policies.
	Schedule param.Field[GatewayRuleUpdateParamsSchedule] `json:"schedule"`
	// The wirefilter expression used for traffic matching.
	Traffic param.Field[string] `json:"traffic"`
}

func (GatewayRuleUpdateParams) MarshalJSON 

func (r GatewayRuleUpdateParams) MarshalJSON() (data []byte, err error)

type GatewayRuleUpdateParamsAction 

type GatewayRuleUpdateParamsAction string

The action to preform when the associated traffic, identity, and device posture expressions are either absent or evaluate to `true`. 

const (
	GatewayRuleUpdateParamsActionOn           GatewayRuleUpdateParamsAction = "on"
	GatewayRuleUpdateParamsActionOff          GatewayRuleUpdateParamsAction = "off"
	GatewayRuleUpdateParamsActionAllow        GatewayRuleUpdateParamsAction = "allow"
	GatewayRuleUpdateParamsActionBlock        GatewayRuleUpdateParamsAction = "block"
	GatewayRuleUpdateParamsActionScan         GatewayRuleUpdateParamsAction = "scan"
	GatewayRuleUpdateParamsActionNoscan       GatewayRuleUpdateParamsAction = "noscan"
	GatewayRuleUpdateParamsActionSafesearch   GatewayRuleUpdateParamsAction = "safesearch"
	GatewayRuleUpdateParamsActionYtrestricted GatewayRuleUpdateParamsAction = "ytrestricted"
	GatewayRuleUpdateParamsActionIsolate      GatewayRuleUpdateParamsAction = "isolate"
	GatewayRuleUpdateParamsActionNoisolate    GatewayRuleUpdateParamsAction = "noisolate"
	GatewayRuleUpdateParamsActionOverride     GatewayRuleUpdateParamsAction = "override"
	GatewayRuleUpdateParamsActionL4Override   GatewayRuleUpdateParamsAction = "l4_override"
	GatewayRuleUpdateParamsActionEgress       GatewayRuleUpdateParamsAction = "egress"
	GatewayRuleUpdateParamsActionAuditSSH     GatewayRuleUpdateParamsAction = "audit_ssh"
)

type GatewayRuleUpdateParamsFilter 

type GatewayRuleUpdateParamsFilter string

The protocol or layer to use. 

const (
	GatewayRuleUpdateParamsFilterHTTP   GatewayRuleUpdateParamsFilter = "http"
	GatewayRuleUpdateParamsFilterDNS    GatewayRuleUpdateParamsFilter = "dns"
	GatewayRuleUpdateParamsFilterL4     GatewayRuleUpdateParamsFilter = "l4"
	GatewayRuleUpdateParamsFilterEgress GatewayRuleUpdateParamsFilter = "egress"
)

type GatewayRuleUpdateParamsRuleSettings 

type GatewayRuleUpdateParamsRuleSettings struct {
	// Add custom headers to allowed requests, in the form of key-value pairs. Keys are
	// header names, pointing to an array with its header value(s).
	AddHeaders param.Field[interface{}] `json:"add_headers"`
	// Set by parent MSP accounts to enable their children to bypass this rule.
	AllowChildBypass param.Field[bool] `json:"allow_child_bypass"`
	// Settings for the Audit SSH action.
	AuditSSH param.Field[GatewayRuleUpdateParamsRuleSettingsAuditSSH] `json:"audit_ssh"`
	// Configure how browser isolation behaves.
	BisoAdminControls param.Field[GatewayRuleUpdateParamsRuleSettingsBisoAdminControls] `json:"biso_admin_controls"`
	// Enable the custom block page.
	BlockPageEnabled param.Field[bool] `json:"block_page_enabled"`
	// The text describing why this block occurred, displayed on the custom block page
	// (if enabled).
	BlockReason param.Field[string] `json:"block_reason"`
	// Set by children MSP accounts to bypass their parent's rules.
	BypassParentRule param.Field[bool] `json:"bypass_parent_rule"`
	// Configure how session check behaves.
	CheckSession param.Field[GatewayRuleUpdateParamsRuleSettingsCheckSession] `json:"check_session"`
	// Add your own custom resolvers to route queries that match the resolver policy.
	// Cannot be used when resolve_dns_through_cloudflare is set. DNS queries will
	// route to the address closest to their origin.
	DNSResolvers param.Field[GatewayRuleUpdateParamsRuleSettingsDNSResolvers] `json:"dns_resolvers"`
	// Configure how Gateway Proxy traffic egresses. You can enable this setting for
	// rules with Egress actions and filters, or omit it to indicate local egress via
	// WARP IPs.
	Egress param.Field[GatewayRuleUpdateParamsRuleSettingsEgress] `json:"egress"`
	// INSECURE - disable DNSSEC validation (for Allow actions).
	InsecureDisableDNSSECValidation param.Field[bool] `json:"insecure_disable_dnssec_validation"`
	// Set to true to enable IPs in DNS resolver category blocks. By default categories
	// only block based on domain names.
	IPCategories param.Field[bool] `json:"ip_categories"`
	// Set to true to include IPs in DNS resolver indicator feed blocks. By default
	// indicator feeds only block based on domain names.
	IPIndicatorFeeds param.Field[bool] `json:"ip_indicator_feeds"`
	// Send matching traffic to the supplied destination IP address and port.
	L4override param.Field[GatewayRuleUpdateParamsRuleSettingsL4override] `json:"l4override"`
	// Configure a notification to display on the user's device when this rule is
	// matched.
	NotificationSettings param.Field[GatewayRuleUpdateParamsRuleSettingsNotificationSettings] `json:"notification_settings"`
	// Override matching DNS queries with a hostname.
	OverrideHost param.Field[string] `json:"override_host"`
	// Override matching DNS queries with an IP or set of IPs.
	OverrideIPs param.Field[[]string] `json:"override_ips"`
	// Configure DLP payload logging.
	PayloadLog param.Field[GatewayRuleUpdateParamsRuleSettingsPayloadLog] `json:"payload_log"`
	// Enable to send queries that match the policy to Cloudflare's default 1.1.1.1 DNS
	// resolver. Cannot be set when dns_resolvers are specified.
	ResolveDNSThroughCloudflare param.Field[bool] `json:"resolve_dns_through_cloudflare"`
	// Configure behavior when an upstream cert is invalid or an SSL error occurs.
	UntrustedCert param.Field[GatewayRuleUpdateParamsRuleSettingsUntrustedCert] `json:"untrusted_cert"`
}

Additional settings that modify the rule's action.

func (GatewayRuleUpdateParamsRuleSettings) MarshalJSON 

func (r GatewayRuleUpdateParamsRuleSettings) MarshalJSON() (data []byte, err error)

type GatewayRuleUpdateParamsRuleSettingsAuditSSH 

type GatewayRuleUpdateParamsRuleSettingsAuditSSH struct {
	// Enable to turn on SSH command logging.
	CommandLogging param.Field[bool] `json:"command_logging"`
}

Settings for the Audit SSH action.

func (GatewayRuleUpdateParamsRuleSettingsAuditSSH) MarshalJSON 

func (r GatewayRuleUpdateParamsRuleSettingsAuditSSH) MarshalJSON() (data []byte, err error)

type GatewayRuleUpdateParamsRuleSettingsBisoAdminControls 

type GatewayRuleUpdateParamsRuleSettingsBisoAdminControls struct {
	// Set to true to enable copy-pasting.
	Dcp param.Field[bool] `json:"dcp"`
	// Set to true to enable downloading.
	Dd param.Field[bool] `json:"dd"`
	// Set to true to enable keyboard usage.
	Dk param.Field[bool] `json:"dk"`
	// Set to true to enable printing.
	Dp param.Field[bool] `json:"dp"`
	// Set to true to enable uploading.
	Du param.Field[bool] `json:"du"`
}

Configure how browser isolation behaves.

func (GatewayRuleUpdateParamsRuleSettingsBisoAdminControls) MarshalJSON 

func (r GatewayRuleUpdateParamsRuleSettingsBisoAdminControls) MarshalJSON() (data []byte, err error)

type GatewayRuleUpdateParamsRuleSettingsCheckSession 

type GatewayRuleUpdateParamsRuleSettingsCheckSession struct {
	// Configure how fresh the session needs to be to be considered valid.
	Duration param.Field[string] `json:"duration"`
	// Set to true to enable session enforcement.
	Enforce param.Field[bool] `json:"enforce"`
}

Configure how session check behaves.

func (GatewayRuleUpdateParamsRuleSettingsCheckSession) MarshalJSON 

func (r GatewayRuleUpdateParamsRuleSettingsCheckSession) MarshalJSON() (data []byte, err error)

type GatewayRuleUpdateParamsRuleSettingsDNSResolvers 

type GatewayRuleUpdateParamsRuleSettingsDNSResolvers struct {
	IPV4 param.Field[[]GatewayRuleUpdateParamsRuleSettingsDNSResolversIPV4] `json:"ipv4"`
	IPV6 param.Field[[]GatewayRuleUpdateParamsRuleSettingsDNSResolversIPV6] `json:"ipv6"`
}

Add your own custom resolvers to route queries that match the resolver policy. Cannot be used when resolve_dns_through_cloudflare is set. DNS queries will route to the address closest to their origin.

func (GatewayRuleUpdateParamsRuleSettingsDNSResolvers) MarshalJSON 

func (r GatewayRuleUpdateParamsRuleSettingsDNSResolvers) MarshalJSON() (data []byte, err error)

type GatewayRuleUpdateParamsRuleSettingsDNSResolversIPV4 

type GatewayRuleUpdateParamsRuleSettingsDNSResolversIPV4 struct {
	// IP address of upstream resolver.
	IP param.Field[string] `json:"ip,required"`
	// A port number to use for upstream resolver.
	Port param.Field[int64] `json:"port"`
	// Whether to connect to this resolver over a private network. Must be set when
	// vnet_id is set.
	RouteThroughPrivateNetwork param.Field[bool] `json:"route_through_private_network"`
	// Optionally specify a virtual network for this resolver. Uses default virtual
	// network id if omitted.
	VnetID param.Field[string] `json:"vnet_id"`
}

func (GatewayRuleUpdateParamsRuleSettingsDNSResolversIPV4) MarshalJSON 

func (r GatewayRuleUpdateParamsRuleSettingsDNSResolversIPV4) MarshalJSON() (data []byte, err error)

type GatewayRuleUpdateParamsRuleSettingsDNSResolversIPV6 

type GatewayRuleUpdateParamsRuleSettingsDNSResolversIPV6 struct {
	// IP address of upstream resolver.
	IP param.Field[string] `json:"ip,required"`
	// A port number to use for upstream resolver.
	Port param.Field[int64] `json:"port"`
	// Whether to connect to this resolver over a private network. Must be set when
	// vnet_id is set.
	RouteThroughPrivateNetwork param.Field[bool] `json:"route_through_private_network"`
	// Optionally specify a virtual network for this resolver. Uses default virtual
	// network id if omitted.
	VnetID param.Field[string] `json:"vnet_id"`
}

func (GatewayRuleUpdateParamsRuleSettingsDNSResolversIPV6) MarshalJSON 

func (r GatewayRuleUpdateParamsRuleSettingsDNSResolversIPV6) MarshalJSON() (data []byte, err error)

type GatewayRuleUpdateParamsRuleSettingsEgress 

type GatewayRuleUpdateParamsRuleSettingsEgress struct {
	// The IPv4 address to be used for egress.
	IPV4 param.Field[string] `json:"ipv4"`
	// The fallback IPv4 address to be used for egress in the event of an error
	// egressing with the primary IPv4. Can be '0.0.0.0' to indicate local egress via
	// WARP IPs.
	IPV4Fallback param.Field[string] `json:"ipv4_fallback"`
	// The IPv6 range to be used for egress.
	IPV6 param.Field[string] `json:"ipv6"`
}

Configure how Gateway Proxy traffic egresses. You can enable this setting for rules with Egress actions and filters, or omit it to indicate local egress via WARP IPs.

func (GatewayRuleUpdateParamsRuleSettingsEgress) MarshalJSON 

func (r GatewayRuleUpdateParamsRuleSettingsEgress) MarshalJSON() (data []byte, err error)

type GatewayRuleUpdateParamsRuleSettingsL4override 

type GatewayRuleUpdateParamsRuleSettingsL4override struct {
	// IPv4 or IPv6 address.
	IP param.Field[string] `json:"ip"`
	// A port number to use for TCP/UDP overrides.
	Port param.Field[int64] `json:"port"`
}

Send matching traffic to the supplied destination IP address and port.

func (GatewayRuleUpdateParamsRuleSettingsL4override) MarshalJSON 

func (r GatewayRuleUpdateParamsRuleSettingsL4override) MarshalJSON() (data []byte, err error)

type GatewayRuleUpdateParamsRuleSettingsNotificationSettings 

type GatewayRuleUpdateParamsRuleSettingsNotificationSettings struct {
	// Set notification on
	Enabled param.Field[bool] `json:"enabled"`
	// Customize the message shown in the notification.
	Msg param.Field[string] `json:"msg"`
	// Optional URL to direct users to additional information. If not set, the
	// notification will open a block page.
	SupportURL param.Field[string] `json:"support_url"`
}

Configure a notification to display on the user's device when this rule is matched.

func (GatewayRuleUpdateParamsRuleSettingsNotificationSettings) MarshalJSON 

func (r GatewayRuleUpdateParamsRuleSettingsNotificationSettings) MarshalJSON() (data []byte, err error)

type GatewayRuleUpdateParamsRuleSettingsPayloadLog 

type GatewayRuleUpdateParamsRuleSettingsPayloadLog struct {
	// Set to true to enable DLP payload logging for this rule.
	Enabled param.Field[bool] `json:"enabled"`
}

Configure DLP payload logging.

func (GatewayRuleUpdateParamsRuleSettingsPayloadLog) MarshalJSON 

func (r GatewayRuleUpdateParamsRuleSettingsPayloadLog) MarshalJSON() (data []byte, err error)

type GatewayRuleUpdateParamsRuleSettingsUntrustedCert 

type GatewayRuleUpdateParamsRuleSettingsUntrustedCert struct {
	// The action performed when an untrusted certificate is seen. The default action
	// is an error with HTTP code 526.
	Action param.Field[GatewayRuleUpdateParamsRuleSettingsUntrustedCertAction] `json:"action"`
}

Configure behavior when an upstream cert is invalid or an SSL error occurs.

func (GatewayRuleUpdateParamsRuleSettingsUntrustedCert) MarshalJSON 

func (r GatewayRuleUpdateParamsRuleSettingsUntrustedCert) MarshalJSON() (data []byte, err error)

type GatewayRuleUpdateParamsRuleSettingsUntrustedCertAction 

type GatewayRuleUpdateParamsRuleSettingsUntrustedCertAction string

The action performed when an untrusted certificate is seen. The default action is an error with HTTP code 526. 

const (
	GatewayRuleUpdateParamsRuleSettingsUntrustedCertActionPassThrough GatewayRuleUpdateParamsRuleSettingsUntrustedCertAction = "pass_through"
	GatewayRuleUpdateParamsRuleSettingsUntrustedCertActionBlock       GatewayRuleUpdateParamsRuleSettingsUntrustedCertAction = "block"
	GatewayRuleUpdateParamsRuleSettingsUntrustedCertActionError       GatewayRuleUpdateParamsRuleSettingsUntrustedCertAction = "error"
)

type GatewayRuleUpdateParamsSchedule 

type GatewayRuleUpdateParamsSchedule struct {
	// The time intervals when the rule will be active on Fridays, in increasing order
	// from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on
	// Fridays.
	Fri param.Field[string] `json:"fri"`
	// The time intervals when the rule will be active on Mondays, in increasing order
	// from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on
	// Mondays.
	Mon param.Field[string] `json:"mon"`
	// The time intervals when the rule will be active on Saturdays, in increasing
	// order from 00:00-24:00. If this parameter is omitted, the rule will be
	// deactivated on Saturdays.
	Sat param.Field[string] `json:"sat"`
	// The time intervals when the rule will be active on Sundays, in increasing order
	// from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on
	// Sundays.
	Sun param.Field[string] `json:"sun"`
	// The time intervals when the rule will be active on Thursdays, in increasing
	// order from 00:00-24:00. If this parameter is omitted, the rule will be
	// deactivated on Thursdays.
	Thu param.Field[string] `json:"thu"`
	// The time zone the rule will be evaluated against. If a
	// [valid time zone city name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List)
	// is provided, Gateway will always use the current time at that time zone. If this
	// parameter is omitted, then Gateway will use the time zone inferred from the
	// user's source IP to evaluate the rule. If Gateway cannot determine the time zone
	// from the IP, we will fall back to the time zone of the user's connected data
	// center.
	TimeZone param.Field[string] `json:"time_zone"`
	// The time intervals when the rule will be active on Tuesdays, in increasing order
	// from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on
	// Tuesdays.
	Tue param.Field[string] `json:"tue"`
	// The time intervals when the rule will be active on Wednesdays, in increasing
	// order from 00:00-24:00. If this parameter is omitted, the rule will be
	// deactivated on Wednesdays.
	Wed param.Field[string] `json:"wed"`
}

The schedule for activating DNS policies. This does not apply to HTTP or network policies.

func (GatewayRuleUpdateParamsSchedule) MarshalJSON 

func (r GatewayRuleUpdateParamsSchedule) MarshalJSON() (data []byte, err error)

type GatewayRuleUpdateResponseEnvelope 

type GatewayRuleUpdateResponseEnvelope struct {
	Errors   []GatewayRuleUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []GatewayRuleUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   ZeroTrustGatewayRules                       `json:"result,required"`
	// Whether the API call was successful
	Success GatewayRuleUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    gatewayRuleUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*GatewayRuleUpdateResponseEnvelope) UnmarshalJSON 

func (r *GatewayRuleUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type GatewayRuleUpdateResponseEnvelopeErrors 

type GatewayRuleUpdateResponseEnvelopeErrors struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    gatewayRuleUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*GatewayRuleUpdateResponseEnvelopeErrors) UnmarshalJSON 

func (r *GatewayRuleUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type GatewayRuleUpdateResponseEnvelopeMessages 

type GatewayRuleUpdateResponseEnvelopeMessages struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    gatewayRuleUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*GatewayRuleUpdateResponseEnvelopeMessages) UnmarshalJSON 

func (r *GatewayRuleUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type GatewayRuleUpdateResponseEnvelopeSuccess 

type GatewayRuleUpdateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	GatewayRuleUpdateResponseEnvelopeSuccessTrue GatewayRuleUpdateResponseEnvelopeSuccess = true
)

type GatewayService 

type GatewayService struct {
	Options          []option.RequestOption
	AuditSSHSettings *GatewayAuditSSHSettingService
	Categories       *GatewayCategoryService
	AppTypes         *GatewayAppTypeService
	Configurations   *GatewayConfigurationService
	Lists            *GatewayListService
	Locations        *GatewayLocationService
	Logging          *GatewayLoggingService
	ProxyEndpoints   *GatewayProxyEndpointService
	Rules            *GatewayRuleService
}

GatewayService 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 NewGatewayService method instead.

func NewGatewayService 

func NewGatewayService(opts ...option.RequestOption) (r *GatewayService)

NewGatewayService 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 (*GatewayService) List 

func (r *GatewayService) List(ctx context.Context, query GatewayListParams, opts ...option.RequestOption) (res *GatewayListResponse, err error)

Gets information about the current Zero Trust account.

func (*GatewayService) New 

func (r *GatewayService) New(ctx context.Context, body GatewayNewParams, opts ...option.RequestOption) (res *GatewayNewResponse, err error)

Creates a Zero Trust account with an existing Cloudflare account.

type IdentityProviderDeleteParams 

type IdentityProviderDeleteParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type IdentityProviderDeleteResponse 

type IdentityProviderDeleteResponse struct {
	// UUID
	ID   string                             `json:"id"`
	JSON identityProviderDeleteResponseJSON `json:"-"`
}

func (*IdentityProviderDeleteResponse) UnmarshalJSON 

func (r *IdentityProviderDeleteResponse) UnmarshalJSON(data []byte) (err error)

type IdentityProviderDeleteResponseEnvelope 

type IdentityProviderDeleteResponseEnvelope struct {
	Errors   []IdentityProviderDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []IdentityProviderDeleteResponseEnvelopeMessages `json:"messages,required"`
	Result   IdentityProviderDeleteResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success IdentityProviderDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    identityProviderDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*IdentityProviderDeleteResponseEnvelope) UnmarshalJSON 

func (r *IdentityProviderDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type IdentityProviderDeleteResponseEnvelopeErrors 

type IdentityProviderDeleteResponseEnvelopeErrors struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    identityProviderDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*IdentityProviderDeleteResponseEnvelopeErrors) UnmarshalJSON 

func (r *IdentityProviderDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type IdentityProviderDeleteResponseEnvelopeMessages 

type IdentityProviderDeleteResponseEnvelopeMessages struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    identityProviderDeleteResponseEnvelopeMessagesJSON `json:"-"`
}

func (*IdentityProviderDeleteResponseEnvelopeMessages) UnmarshalJSON 

func (r *IdentityProviderDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type IdentityProviderDeleteResponseEnvelopeSuccess 

type IdentityProviderDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	IdentityProviderDeleteResponseEnvelopeSuccessTrue IdentityProviderDeleteResponseEnvelopeSuccess = true
)

type IdentityProviderGetParams 

type IdentityProviderGetParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type IdentityProviderGetResponseEnvelope 

type IdentityProviderGetResponseEnvelope struct {
	Errors   []IdentityProviderGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []IdentityProviderGetResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessIdentityProviders                       `json:"result,required"`
	// Whether the API call was successful
	Success IdentityProviderGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    identityProviderGetResponseEnvelopeJSON    `json:"-"`
}

func (*IdentityProviderGetResponseEnvelope) UnmarshalJSON 

func (r *IdentityProviderGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type IdentityProviderGetResponseEnvelopeErrors 

type IdentityProviderGetResponseEnvelopeErrors struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    identityProviderGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*IdentityProviderGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *IdentityProviderGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type IdentityProviderGetResponseEnvelopeMessages 

type IdentityProviderGetResponseEnvelopeMessages struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    identityProviderGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*IdentityProviderGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *IdentityProviderGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type IdentityProviderGetResponseEnvelopeSuccess 

type IdentityProviderGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	IdentityProviderGetResponseEnvelopeSuccessTrue IdentityProviderGetResponseEnvelopeSuccess = true
)

type IdentityProviderListParams 

type IdentityProviderListParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type IdentityProviderListResponse 

type IdentityProviderListResponse interface {
	// contains filtered or unexported methods
}

Union satisfied by zero_trust.IdentityProviderListResponseAccessAzureAd, zero_trust.IdentityProviderListResponseAccessCentrify, zero_trust.IdentityProviderListResponseAccessFacebook, zero_trust.IdentityProviderListResponseAccessGitHub, zero_trust.IdentityProviderListResponseAccessGoogle, zero_trust.IdentityProviderListResponseAccessGoogleApps, zero_trust.IdentityProviderListResponseAccessLinkedin, zero_trust.IdentityProviderListResponseAccessOidc, zero_trust.IdentityProviderListResponseAccessOkta, zero_trust.IdentityProviderListResponseAccessOnelogin, zero_trust.IdentityProviderListResponseAccessPingone, zero_trust.IdentityProviderListResponseAccessSaml or zero_trust.IdentityProviderListResponseAccessYandex.

type IdentityProviderListResponseAccessAzureAd 

type IdentityProviderListResponseAccessAzureAd struct {
	// The configuration parameters for the identity provider. To view the required
	// parameters for a specific provider, refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Config IdentityProviderListResponseAccessAzureAdConfig `json:"config,required"`
	// The name of the identity provider, shown to users on the login page.
	Name string `json:"name,required"`
	// The type of identity provider. To determine the value for a specific provider,
	// refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Type IdentityProviderListResponseAccessAzureAdType `json:"type,required"`
	// UUID
	ID string `json:"id"`
	// The configuration settings for enabling a System for Cross-Domain Identity
	// Management (SCIM) with the identity provider.
	ScimConfig IdentityProviderListResponseAccessAzureAdScimConfig `json:"scim_config"`
	JSON       identityProviderListResponseAccessAzureAdJSON       `json:"-"`
}

func (*IdentityProviderListResponseAccessAzureAd) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessAzureAd) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessAzureAdConfig 

type IdentityProviderListResponseAccessAzureAdConfig struct {
	// Custom claims
	Claims []string `json:"claims"`
	// Your OAuth Client ID
	ClientID string `json:"client_id"`
	// Your OAuth Client Secret
	ClientSecret string `json:"client_secret"`
	// Should Cloudflare try to load authentication contexts from your account
	ConditionalAccessEnabled bool `json:"conditional_access_enabled"`
	// Your Azure directory uuid
	DirectoryID string `json:"directory_id"`
	// The claim name for email in the id_token response.
	EmailClaimName string `json:"email_claim_name"`
	// Indicates the type of user interaction that is required. prompt=login forces the
	// user to enter their credentials on that request, negating single-sign on.
	// prompt=none is the opposite. It ensures that the user isn't presented with any
	// interactive prompt. If the request can't be completed silently by using
	// single-sign on, the Microsoft identity platform returns an interaction_required
	// error. prompt=select_account interrupts single sign-on providing account
	// selection experience listing all the accounts either in session or any
	// remembered account or an option to choose to use a different account altogether.
	Prompt IdentityProviderListResponseAccessAzureAdConfigPrompt `json:"prompt"`
	// Should Cloudflare try to load groups from your account
	SupportGroups bool                                                `json:"support_groups"`
	JSON          identityProviderListResponseAccessAzureAdConfigJSON `json:"-"`
}

The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).

func (*IdentityProviderListResponseAccessAzureAdConfig) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessAzureAdConfig) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessAzureAdConfigPrompt 

type IdentityProviderListResponseAccessAzureAdConfigPrompt string

Indicates the type of user interaction that is required. prompt=login forces the user to enter their credentials on that request, negating single-sign on. prompt=none is the opposite. It ensures that the user isn't presented with any interactive prompt. If the request can't be completed silently by using single-sign on, the Microsoft identity platform returns an interaction_required error. prompt=select_account interrupts single sign-on providing account selection experience listing all the accounts either in session or any remembered account or an option to choose to use a different account altogether. 

const (
	IdentityProviderListResponseAccessAzureAdConfigPromptLogin         IdentityProviderListResponseAccessAzureAdConfigPrompt = "login"
	IdentityProviderListResponseAccessAzureAdConfigPromptSelectAccount IdentityProviderListResponseAccessAzureAdConfigPrompt = "select_account"
	IdentityProviderListResponseAccessAzureAdConfigPromptNone          IdentityProviderListResponseAccessAzureAdConfigPrompt = "none"
)

type IdentityProviderListResponseAccessAzureAdScimConfig 

type IdentityProviderListResponseAccessAzureAdScimConfig struct {
	// A flag to enable or disable SCIM for the identity provider.
	Enabled bool `json:"enabled"`
	// A flag to revoke a user's session in Access and force a reauthentication on the
	// user's Gateway session when they have been added or removed from a group in the
	// Identity Provider.
	GroupMemberDeprovision bool `json:"group_member_deprovision"`
	// A flag to remove a user's seat in Zero Trust when they have been deprovisioned
	// in the Identity Provider. This cannot be enabled unless user_deprovision is also
	// enabled.
	SeatDeprovision bool `json:"seat_deprovision"`
	// A read-only token generated when the SCIM integration is enabled for the first
	// time. It is redacted on subsequent requests. If you lose this you will need to
	// refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.
	Secret string `json:"secret"`
	// A flag to enable revoking a user's session in Access and Gateway when they have
	// been deprovisioned in the Identity Provider.
	UserDeprovision bool                                                    `json:"user_deprovision"`
	JSON            identityProviderListResponseAccessAzureAdScimConfigJSON `json:"-"`
}

The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.

func (*IdentityProviderListResponseAccessAzureAdScimConfig) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessAzureAdScimConfig) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessAzureAdType 

type IdentityProviderListResponseAccessAzureAdType string

The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). 

const (
	IdentityProviderListResponseAccessAzureAdTypeOnetimepin IdentityProviderListResponseAccessAzureAdType = "onetimepin"
	IdentityProviderListResponseAccessAzureAdTypeAzureAd    IdentityProviderListResponseAccessAzureAdType = "azureAD"
	IdentityProviderListResponseAccessAzureAdTypeSaml       IdentityProviderListResponseAccessAzureAdType = "saml"
	IdentityProviderListResponseAccessAzureAdTypeCentrify   IdentityProviderListResponseAccessAzureAdType = "centrify"
	IdentityProviderListResponseAccessAzureAdTypeFacebook   IdentityProviderListResponseAccessAzureAdType = "facebook"
	IdentityProviderListResponseAccessAzureAdTypeGitHub     IdentityProviderListResponseAccessAzureAdType = "github"
	IdentityProviderListResponseAccessAzureAdTypeGoogleApps IdentityProviderListResponseAccessAzureAdType = "google-apps"
	IdentityProviderListResponseAccessAzureAdTypeGoogle     IdentityProviderListResponseAccessAzureAdType = "google"
	IdentityProviderListResponseAccessAzureAdTypeLinkedin   IdentityProviderListResponseAccessAzureAdType = "linkedin"
	IdentityProviderListResponseAccessAzureAdTypeOidc       IdentityProviderListResponseAccessAzureAdType = "oidc"
	IdentityProviderListResponseAccessAzureAdTypeOkta       IdentityProviderListResponseAccessAzureAdType = "okta"
	IdentityProviderListResponseAccessAzureAdTypeOnelogin   IdentityProviderListResponseAccessAzureAdType = "onelogin"
	IdentityProviderListResponseAccessAzureAdTypePingone    IdentityProviderListResponseAccessAzureAdType = "pingone"
	IdentityProviderListResponseAccessAzureAdTypeYandex     IdentityProviderListResponseAccessAzureAdType = "yandex"
)

type IdentityProviderListResponseAccessCentrify 

type IdentityProviderListResponseAccessCentrify struct {
	// The configuration parameters for the identity provider. To view the required
	// parameters for a specific provider, refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Config IdentityProviderListResponseAccessCentrifyConfig `json:"config,required"`
	// The name of the identity provider, shown to users on the login page.
	Name string `json:"name,required"`
	// The type of identity provider. To determine the value for a specific provider,
	// refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Type IdentityProviderListResponseAccessCentrifyType `json:"type,required"`
	// UUID
	ID string `json:"id"`
	// The configuration settings for enabling a System for Cross-Domain Identity
	// Management (SCIM) with the identity provider.
	ScimConfig IdentityProviderListResponseAccessCentrifyScimConfig `json:"scim_config"`
	JSON       identityProviderListResponseAccessCentrifyJSON       `json:"-"`
}

func (*IdentityProviderListResponseAccessCentrify) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessCentrify) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessCentrifyConfig 

type IdentityProviderListResponseAccessCentrifyConfig struct {
	// Your centrify account url
	CentrifyAccount string `json:"centrify_account"`
	// Your centrify app id
	CentrifyAppID string `json:"centrify_app_id"`
	// Custom claims
	Claims []string `json:"claims"`
	// Your OAuth Client ID
	ClientID string `json:"client_id"`
	// Your OAuth Client Secret
	ClientSecret string `json:"client_secret"`
	// The claim name for email in the id_token response.
	EmailClaimName string                                               `json:"email_claim_name"`
	JSON           identityProviderListResponseAccessCentrifyConfigJSON `json:"-"`
}

The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).

func (*IdentityProviderListResponseAccessCentrifyConfig) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessCentrifyConfig) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessCentrifyScimConfig 

type IdentityProviderListResponseAccessCentrifyScimConfig struct {
	// A flag to enable or disable SCIM for the identity provider.
	Enabled bool `json:"enabled"`
	// A flag to revoke a user's session in Access and force a reauthentication on the
	// user's Gateway session when they have been added or removed from a group in the
	// Identity Provider.
	GroupMemberDeprovision bool `json:"group_member_deprovision"`
	// A flag to remove a user's seat in Zero Trust when they have been deprovisioned
	// in the Identity Provider. This cannot be enabled unless user_deprovision is also
	// enabled.
	SeatDeprovision bool `json:"seat_deprovision"`
	// A read-only token generated when the SCIM integration is enabled for the first
	// time. It is redacted on subsequent requests. If you lose this you will need to
	// refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.
	Secret string `json:"secret"`
	// A flag to enable revoking a user's session in Access and Gateway when they have
	// been deprovisioned in the Identity Provider.
	UserDeprovision bool                                                     `json:"user_deprovision"`
	JSON            identityProviderListResponseAccessCentrifyScimConfigJSON `json:"-"`
}

The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.

func (*IdentityProviderListResponseAccessCentrifyScimConfig) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessCentrifyScimConfig) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessCentrifyType 

type IdentityProviderListResponseAccessCentrifyType string

The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). 

const (
	IdentityProviderListResponseAccessCentrifyTypeOnetimepin IdentityProviderListResponseAccessCentrifyType = "onetimepin"
	IdentityProviderListResponseAccessCentrifyTypeAzureAd    IdentityProviderListResponseAccessCentrifyType = "azureAD"
	IdentityProviderListResponseAccessCentrifyTypeSaml       IdentityProviderListResponseAccessCentrifyType = "saml"
	IdentityProviderListResponseAccessCentrifyTypeCentrify   IdentityProviderListResponseAccessCentrifyType = "centrify"
	IdentityProviderListResponseAccessCentrifyTypeFacebook   IdentityProviderListResponseAccessCentrifyType = "facebook"
	IdentityProviderListResponseAccessCentrifyTypeGitHub     IdentityProviderListResponseAccessCentrifyType = "github"
	IdentityProviderListResponseAccessCentrifyTypeGoogleApps IdentityProviderListResponseAccessCentrifyType = "google-apps"
	IdentityProviderListResponseAccessCentrifyTypeGoogle     IdentityProviderListResponseAccessCentrifyType = "google"
	IdentityProviderListResponseAccessCentrifyTypeLinkedin   IdentityProviderListResponseAccessCentrifyType = "linkedin"
	IdentityProviderListResponseAccessCentrifyTypeOidc       IdentityProviderListResponseAccessCentrifyType = "oidc"
	IdentityProviderListResponseAccessCentrifyTypeOkta       IdentityProviderListResponseAccessCentrifyType = "okta"
	IdentityProviderListResponseAccessCentrifyTypeOnelogin   IdentityProviderListResponseAccessCentrifyType = "onelogin"
	IdentityProviderListResponseAccessCentrifyTypePingone    IdentityProviderListResponseAccessCentrifyType = "pingone"
	IdentityProviderListResponseAccessCentrifyTypeYandex     IdentityProviderListResponseAccessCentrifyType = "yandex"
)

type IdentityProviderListResponseAccessFacebook 

type IdentityProviderListResponseAccessFacebook struct {
	// The configuration parameters for the identity provider. To view the required
	// parameters for a specific provider, refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Config IdentityProviderListResponseAccessFacebookConfig `json:"config,required"`
	// The name of the identity provider, shown to users on the login page.
	Name string `json:"name,required"`
	// The type of identity provider. To determine the value for a specific provider,
	// refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Type IdentityProviderListResponseAccessFacebookType `json:"type,required"`
	// UUID
	ID string `json:"id"`
	// The configuration settings for enabling a System for Cross-Domain Identity
	// Management (SCIM) with the identity provider.
	ScimConfig IdentityProviderListResponseAccessFacebookScimConfig `json:"scim_config"`
	JSON       identityProviderListResponseAccessFacebookJSON       `json:"-"`
}

func (*IdentityProviderListResponseAccessFacebook) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessFacebook) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessFacebookConfig 

type IdentityProviderListResponseAccessFacebookConfig struct {
	// Your OAuth Client ID
	ClientID string `json:"client_id"`
	// Your OAuth Client Secret
	ClientSecret string                                               `json:"client_secret"`
	JSON         identityProviderListResponseAccessFacebookConfigJSON `json:"-"`
}

The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).

func (*IdentityProviderListResponseAccessFacebookConfig) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessFacebookConfig) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessFacebookScimConfig 

type IdentityProviderListResponseAccessFacebookScimConfig struct {
	// A flag to enable or disable SCIM for the identity provider.
	Enabled bool `json:"enabled"`
	// A flag to revoke a user's session in Access and force a reauthentication on the
	// user's Gateway session when they have been added or removed from a group in the
	// Identity Provider.
	GroupMemberDeprovision bool `json:"group_member_deprovision"`
	// A flag to remove a user's seat in Zero Trust when they have been deprovisioned
	// in the Identity Provider. This cannot be enabled unless user_deprovision is also
	// enabled.
	SeatDeprovision bool `json:"seat_deprovision"`
	// A read-only token generated when the SCIM integration is enabled for the first
	// time. It is redacted on subsequent requests. If you lose this you will need to
	// refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.
	Secret string `json:"secret"`
	// A flag to enable revoking a user's session in Access and Gateway when they have
	// been deprovisioned in the Identity Provider.
	UserDeprovision bool                                                     `json:"user_deprovision"`
	JSON            identityProviderListResponseAccessFacebookScimConfigJSON `json:"-"`
}

The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.

func (*IdentityProviderListResponseAccessFacebookScimConfig) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessFacebookScimConfig) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessFacebookType 

type IdentityProviderListResponseAccessFacebookType string

The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). 

const (
	IdentityProviderListResponseAccessFacebookTypeOnetimepin IdentityProviderListResponseAccessFacebookType = "onetimepin"
	IdentityProviderListResponseAccessFacebookTypeAzureAd    IdentityProviderListResponseAccessFacebookType = "azureAD"
	IdentityProviderListResponseAccessFacebookTypeSaml       IdentityProviderListResponseAccessFacebookType = "saml"
	IdentityProviderListResponseAccessFacebookTypeCentrify   IdentityProviderListResponseAccessFacebookType = "centrify"
	IdentityProviderListResponseAccessFacebookTypeFacebook   IdentityProviderListResponseAccessFacebookType = "facebook"
	IdentityProviderListResponseAccessFacebookTypeGitHub     IdentityProviderListResponseAccessFacebookType = "github"
	IdentityProviderListResponseAccessFacebookTypeGoogleApps IdentityProviderListResponseAccessFacebookType = "google-apps"
	IdentityProviderListResponseAccessFacebookTypeGoogle     IdentityProviderListResponseAccessFacebookType = "google"
	IdentityProviderListResponseAccessFacebookTypeLinkedin   IdentityProviderListResponseAccessFacebookType = "linkedin"
	IdentityProviderListResponseAccessFacebookTypeOidc       IdentityProviderListResponseAccessFacebookType = "oidc"
	IdentityProviderListResponseAccessFacebookTypeOkta       IdentityProviderListResponseAccessFacebookType = "okta"
	IdentityProviderListResponseAccessFacebookTypeOnelogin   IdentityProviderListResponseAccessFacebookType = "onelogin"
	IdentityProviderListResponseAccessFacebookTypePingone    IdentityProviderListResponseAccessFacebookType = "pingone"
	IdentityProviderListResponseAccessFacebookTypeYandex     IdentityProviderListResponseAccessFacebookType = "yandex"
)

type IdentityProviderListResponseAccessGitHub 

type IdentityProviderListResponseAccessGitHub struct {
	// The configuration parameters for the identity provider. To view the required
	// parameters for a specific provider, refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Config IdentityProviderListResponseAccessGitHubConfig `json:"config,required"`
	// The name of the identity provider, shown to users on the login page.
	Name string `json:"name,required"`
	// The type of identity provider. To determine the value for a specific provider,
	// refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Type IdentityProviderListResponseAccessGitHubType `json:"type,required"`
	// UUID
	ID string `json:"id"`
	// The configuration settings for enabling a System for Cross-Domain Identity
	// Management (SCIM) with the identity provider.
	ScimConfig IdentityProviderListResponseAccessGitHubScimConfig `json:"scim_config"`
	JSON       identityProviderListResponseAccessGitHubJSON       `json:"-"`
}

func (*IdentityProviderListResponseAccessGitHub) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessGitHub) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessGitHubConfig 

type IdentityProviderListResponseAccessGitHubConfig struct {
	// Your OAuth Client ID
	ClientID string `json:"client_id"`
	// Your OAuth Client Secret
	ClientSecret string                                             `json:"client_secret"`
	JSON         identityProviderListResponseAccessGitHubConfigJSON `json:"-"`
}

The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).

func (*IdentityProviderListResponseAccessGitHubConfig) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessGitHubConfig) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessGitHubScimConfig 

type IdentityProviderListResponseAccessGitHubScimConfig struct {
	// A flag to enable or disable SCIM for the identity provider.
	Enabled bool `json:"enabled"`
	// A flag to revoke a user's session in Access and force a reauthentication on the
	// user's Gateway session when they have been added or removed from a group in the
	// Identity Provider.
	GroupMemberDeprovision bool `json:"group_member_deprovision"`
	// A flag to remove a user's seat in Zero Trust when they have been deprovisioned
	// in the Identity Provider. This cannot be enabled unless user_deprovision is also
	// enabled.
	SeatDeprovision bool `json:"seat_deprovision"`
	// A read-only token generated when the SCIM integration is enabled for the first
	// time. It is redacted on subsequent requests. If you lose this you will need to
	// refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.
	Secret string `json:"secret"`
	// A flag to enable revoking a user's session in Access and Gateway when they have
	// been deprovisioned in the Identity Provider.
	UserDeprovision bool                                                   `json:"user_deprovision"`
	JSON            identityProviderListResponseAccessGitHubScimConfigJSON `json:"-"`
}

The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.

func (*IdentityProviderListResponseAccessGitHubScimConfig) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessGitHubScimConfig) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessGitHubType 

type IdentityProviderListResponseAccessGitHubType string

The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). 

const (
	IdentityProviderListResponseAccessGitHubTypeOnetimepin IdentityProviderListResponseAccessGitHubType = "onetimepin"
	IdentityProviderListResponseAccessGitHubTypeAzureAd    IdentityProviderListResponseAccessGitHubType = "azureAD"
	IdentityProviderListResponseAccessGitHubTypeSaml       IdentityProviderListResponseAccessGitHubType = "saml"
	IdentityProviderListResponseAccessGitHubTypeCentrify   IdentityProviderListResponseAccessGitHubType = "centrify"
	IdentityProviderListResponseAccessGitHubTypeFacebook   IdentityProviderListResponseAccessGitHubType = "facebook"
	IdentityProviderListResponseAccessGitHubTypeGitHub     IdentityProviderListResponseAccessGitHubType = "github"
	IdentityProviderListResponseAccessGitHubTypeGoogleApps IdentityProviderListResponseAccessGitHubType = "google-apps"
	IdentityProviderListResponseAccessGitHubTypeGoogle     IdentityProviderListResponseAccessGitHubType = "google"
	IdentityProviderListResponseAccessGitHubTypeLinkedin   IdentityProviderListResponseAccessGitHubType = "linkedin"
	IdentityProviderListResponseAccessGitHubTypeOidc       IdentityProviderListResponseAccessGitHubType = "oidc"
	IdentityProviderListResponseAccessGitHubTypeOkta       IdentityProviderListResponseAccessGitHubType = "okta"
	IdentityProviderListResponseAccessGitHubTypeOnelogin   IdentityProviderListResponseAccessGitHubType = "onelogin"
	IdentityProviderListResponseAccessGitHubTypePingone    IdentityProviderListResponseAccessGitHubType = "pingone"
	IdentityProviderListResponseAccessGitHubTypeYandex     IdentityProviderListResponseAccessGitHubType = "yandex"
)

type IdentityProviderListResponseAccessGoogle 

type IdentityProviderListResponseAccessGoogle struct {
	// The configuration parameters for the identity provider. To view the required
	// parameters for a specific provider, refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Config IdentityProviderListResponseAccessGoogleConfig `json:"config,required"`
	// The name of the identity provider, shown to users on the login page.
	Name string `json:"name,required"`
	// The type of identity provider. To determine the value for a specific provider,
	// refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Type IdentityProviderListResponseAccessGoogleType `json:"type,required"`
	// UUID
	ID string `json:"id"`
	// The configuration settings for enabling a System for Cross-Domain Identity
	// Management (SCIM) with the identity provider.
	ScimConfig IdentityProviderListResponseAccessGoogleScimConfig `json:"scim_config"`
	JSON       identityProviderListResponseAccessGoogleJSON       `json:"-"`
}

func (*IdentityProviderListResponseAccessGoogle) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessGoogle) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessGoogleApps 

type IdentityProviderListResponseAccessGoogleApps struct {
	// The configuration parameters for the identity provider. To view the required
	// parameters for a specific provider, refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Config IdentityProviderListResponseAccessGoogleAppsConfig `json:"config,required"`
	// The name of the identity provider, shown to users on the login page.
	Name string `json:"name,required"`
	// The type of identity provider. To determine the value for a specific provider,
	// refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Type IdentityProviderListResponseAccessGoogleAppsType `json:"type,required"`
	// UUID
	ID string `json:"id"`
	// The configuration settings for enabling a System for Cross-Domain Identity
	// Management (SCIM) with the identity provider.
	ScimConfig IdentityProviderListResponseAccessGoogleAppsScimConfig `json:"scim_config"`
	JSON       identityProviderListResponseAccessGoogleAppsJSON       `json:"-"`
}

func (*IdentityProviderListResponseAccessGoogleApps) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessGoogleApps) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessGoogleAppsConfig 

type IdentityProviderListResponseAccessGoogleAppsConfig struct {
	// Your companies TLD
	AppsDomain string `json:"apps_domain"`
	// Custom claims
	Claims []string `json:"claims"`
	// Your OAuth Client ID
	ClientID string `json:"client_id"`
	// Your OAuth Client Secret
	ClientSecret string `json:"client_secret"`
	// The claim name for email in the id_token response.
	EmailClaimName string                                                 `json:"email_claim_name"`
	JSON           identityProviderListResponseAccessGoogleAppsConfigJSON `json:"-"`
}

The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).

func (*IdentityProviderListResponseAccessGoogleAppsConfig) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessGoogleAppsConfig) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessGoogleAppsScimConfig 

type IdentityProviderListResponseAccessGoogleAppsScimConfig struct {
	// A flag to enable or disable SCIM for the identity provider.
	Enabled bool `json:"enabled"`
	// A flag to revoke a user's session in Access and force a reauthentication on the
	// user's Gateway session when they have been added or removed from a group in the
	// Identity Provider.
	GroupMemberDeprovision bool `json:"group_member_deprovision"`
	// A flag to remove a user's seat in Zero Trust when they have been deprovisioned
	// in the Identity Provider. This cannot be enabled unless user_deprovision is also
	// enabled.
	SeatDeprovision bool `json:"seat_deprovision"`
	// A read-only token generated when the SCIM integration is enabled for the first
	// time. It is redacted on subsequent requests. If you lose this you will need to
	// refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.
	Secret string `json:"secret"`
	// A flag to enable revoking a user's session in Access and Gateway when they have
	// been deprovisioned in the Identity Provider.
	UserDeprovision bool                                                       `json:"user_deprovision"`
	JSON            identityProviderListResponseAccessGoogleAppsScimConfigJSON `json:"-"`
}

The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.

func (*IdentityProviderListResponseAccessGoogleAppsScimConfig) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessGoogleAppsScimConfig) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessGoogleAppsType 

type IdentityProviderListResponseAccessGoogleAppsType string

The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). 

const (
	IdentityProviderListResponseAccessGoogleAppsTypeOnetimepin IdentityProviderListResponseAccessGoogleAppsType = "onetimepin"
	IdentityProviderListResponseAccessGoogleAppsTypeAzureAd    IdentityProviderListResponseAccessGoogleAppsType = "azureAD"
	IdentityProviderListResponseAccessGoogleAppsTypeSaml       IdentityProviderListResponseAccessGoogleAppsType = "saml"
	IdentityProviderListResponseAccessGoogleAppsTypeCentrify   IdentityProviderListResponseAccessGoogleAppsType = "centrify"
	IdentityProviderListResponseAccessGoogleAppsTypeFacebook   IdentityProviderListResponseAccessGoogleAppsType = "facebook"
	IdentityProviderListResponseAccessGoogleAppsTypeGitHub     IdentityProviderListResponseAccessGoogleAppsType = "github"
	IdentityProviderListResponseAccessGoogleAppsTypeGoogleApps IdentityProviderListResponseAccessGoogleAppsType = "google-apps"
	IdentityProviderListResponseAccessGoogleAppsTypeGoogle     IdentityProviderListResponseAccessGoogleAppsType = "google"
	IdentityProviderListResponseAccessGoogleAppsTypeLinkedin   IdentityProviderListResponseAccessGoogleAppsType = "linkedin"
	IdentityProviderListResponseAccessGoogleAppsTypeOidc       IdentityProviderListResponseAccessGoogleAppsType = "oidc"
	IdentityProviderListResponseAccessGoogleAppsTypeOkta       IdentityProviderListResponseAccessGoogleAppsType = "okta"
	IdentityProviderListResponseAccessGoogleAppsTypeOnelogin   IdentityProviderListResponseAccessGoogleAppsType = "onelogin"
	IdentityProviderListResponseAccessGoogleAppsTypePingone    IdentityProviderListResponseAccessGoogleAppsType = "pingone"
	IdentityProviderListResponseAccessGoogleAppsTypeYandex     IdentityProviderListResponseAccessGoogleAppsType = "yandex"
)

type IdentityProviderListResponseAccessGoogleConfig 

type IdentityProviderListResponseAccessGoogleConfig struct {
	// Custom claims
	Claims []string `json:"claims"`
	// Your OAuth Client ID
	ClientID string `json:"client_id"`
	// Your OAuth Client Secret
	ClientSecret string `json:"client_secret"`
	// The claim name for email in the id_token response.
	EmailClaimName string                                             `json:"email_claim_name"`
	JSON           identityProviderListResponseAccessGoogleConfigJSON `json:"-"`
}

The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).

func (*IdentityProviderListResponseAccessGoogleConfig) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessGoogleConfig) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessGoogleScimConfig 

type IdentityProviderListResponseAccessGoogleScimConfig struct {
	// A flag to enable or disable SCIM for the identity provider.
	Enabled bool `json:"enabled"`
	// A flag to revoke a user's session in Access and force a reauthentication on the
	// user's Gateway session when they have been added or removed from a group in the
	// Identity Provider.
	GroupMemberDeprovision bool `json:"group_member_deprovision"`
	// A flag to remove a user's seat in Zero Trust when they have been deprovisioned
	// in the Identity Provider. This cannot be enabled unless user_deprovision is also
	// enabled.
	SeatDeprovision bool `json:"seat_deprovision"`
	// A read-only token generated when the SCIM integration is enabled for the first
	// time. It is redacted on subsequent requests. If you lose this you will need to
	// refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.
	Secret string `json:"secret"`
	// A flag to enable revoking a user's session in Access and Gateway when they have
	// been deprovisioned in the Identity Provider.
	UserDeprovision bool                                                   `json:"user_deprovision"`
	JSON            identityProviderListResponseAccessGoogleScimConfigJSON `json:"-"`
}

The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.

func (*IdentityProviderListResponseAccessGoogleScimConfig) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessGoogleScimConfig) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessGoogleType 

type IdentityProviderListResponseAccessGoogleType string

The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). 

const (
	IdentityProviderListResponseAccessGoogleTypeOnetimepin IdentityProviderListResponseAccessGoogleType = "onetimepin"
	IdentityProviderListResponseAccessGoogleTypeAzureAd    IdentityProviderListResponseAccessGoogleType = "azureAD"
	IdentityProviderListResponseAccessGoogleTypeSaml       IdentityProviderListResponseAccessGoogleType = "saml"
	IdentityProviderListResponseAccessGoogleTypeCentrify   IdentityProviderListResponseAccessGoogleType = "centrify"
	IdentityProviderListResponseAccessGoogleTypeFacebook   IdentityProviderListResponseAccessGoogleType = "facebook"
	IdentityProviderListResponseAccessGoogleTypeGitHub     IdentityProviderListResponseAccessGoogleType = "github"
	IdentityProviderListResponseAccessGoogleTypeGoogleApps IdentityProviderListResponseAccessGoogleType = "google-apps"
	IdentityProviderListResponseAccessGoogleTypeGoogle     IdentityProviderListResponseAccessGoogleType = "google"
	IdentityProviderListResponseAccessGoogleTypeLinkedin   IdentityProviderListResponseAccessGoogleType = "linkedin"
	IdentityProviderListResponseAccessGoogleTypeOidc       IdentityProviderListResponseAccessGoogleType = "oidc"
	IdentityProviderListResponseAccessGoogleTypeOkta       IdentityProviderListResponseAccessGoogleType = "okta"
	IdentityProviderListResponseAccessGoogleTypeOnelogin   IdentityProviderListResponseAccessGoogleType = "onelogin"
	IdentityProviderListResponseAccessGoogleTypePingone    IdentityProviderListResponseAccessGoogleType = "pingone"
	IdentityProviderListResponseAccessGoogleTypeYandex     IdentityProviderListResponseAccessGoogleType = "yandex"
)

type IdentityProviderListResponseAccessLinkedin 

type IdentityProviderListResponseAccessLinkedin struct {
	// The configuration parameters for the identity provider. To view the required
	// parameters for a specific provider, refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Config IdentityProviderListResponseAccessLinkedinConfig `json:"config,required"`
	// The name of the identity provider, shown to users on the login page.
	Name string `json:"name,required"`
	// The type of identity provider. To determine the value for a specific provider,
	// refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Type IdentityProviderListResponseAccessLinkedinType `json:"type,required"`
	// UUID
	ID string `json:"id"`
	// The configuration settings for enabling a System for Cross-Domain Identity
	// Management (SCIM) with the identity provider.
	ScimConfig IdentityProviderListResponseAccessLinkedinScimConfig `json:"scim_config"`
	JSON       identityProviderListResponseAccessLinkedinJSON       `json:"-"`
}

func (*IdentityProviderListResponseAccessLinkedin) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessLinkedin) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessLinkedinConfig 

type IdentityProviderListResponseAccessLinkedinConfig struct {
	// Your OAuth Client ID
	ClientID string `json:"client_id"`
	// Your OAuth Client Secret
	ClientSecret string                                               `json:"client_secret"`
	JSON         identityProviderListResponseAccessLinkedinConfigJSON `json:"-"`
}

The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).

func (*IdentityProviderListResponseAccessLinkedinConfig) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessLinkedinConfig) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessLinkedinScimConfig 

type IdentityProviderListResponseAccessLinkedinScimConfig struct {
	// A flag to enable or disable SCIM for the identity provider.
	Enabled bool `json:"enabled"`
	// A flag to revoke a user's session in Access and force a reauthentication on the
	// user's Gateway session when they have been added or removed from a group in the
	// Identity Provider.
	GroupMemberDeprovision bool `json:"group_member_deprovision"`
	// A flag to remove a user's seat in Zero Trust when they have been deprovisioned
	// in the Identity Provider. This cannot be enabled unless user_deprovision is also
	// enabled.
	SeatDeprovision bool `json:"seat_deprovision"`
	// A read-only token generated when the SCIM integration is enabled for the first
	// time. It is redacted on subsequent requests. If you lose this you will need to
	// refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.
	Secret string `json:"secret"`
	// A flag to enable revoking a user's session in Access and Gateway when they have
	// been deprovisioned in the Identity Provider.
	UserDeprovision bool                                                     `json:"user_deprovision"`
	JSON            identityProviderListResponseAccessLinkedinScimConfigJSON `json:"-"`
}

The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.

func (*IdentityProviderListResponseAccessLinkedinScimConfig) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessLinkedinScimConfig) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessLinkedinType 

type IdentityProviderListResponseAccessLinkedinType string

The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). 

const (
	IdentityProviderListResponseAccessLinkedinTypeOnetimepin IdentityProviderListResponseAccessLinkedinType = "onetimepin"
	IdentityProviderListResponseAccessLinkedinTypeAzureAd    IdentityProviderListResponseAccessLinkedinType = "azureAD"
	IdentityProviderListResponseAccessLinkedinTypeSaml       IdentityProviderListResponseAccessLinkedinType = "saml"
	IdentityProviderListResponseAccessLinkedinTypeCentrify   IdentityProviderListResponseAccessLinkedinType = "centrify"
	IdentityProviderListResponseAccessLinkedinTypeFacebook   IdentityProviderListResponseAccessLinkedinType = "facebook"
	IdentityProviderListResponseAccessLinkedinTypeGitHub     IdentityProviderListResponseAccessLinkedinType = "github"
	IdentityProviderListResponseAccessLinkedinTypeGoogleApps IdentityProviderListResponseAccessLinkedinType = "google-apps"
	IdentityProviderListResponseAccessLinkedinTypeGoogle     IdentityProviderListResponseAccessLinkedinType = "google"
	IdentityProviderListResponseAccessLinkedinTypeLinkedin   IdentityProviderListResponseAccessLinkedinType = "linkedin"
	IdentityProviderListResponseAccessLinkedinTypeOidc       IdentityProviderListResponseAccessLinkedinType = "oidc"
	IdentityProviderListResponseAccessLinkedinTypeOkta       IdentityProviderListResponseAccessLinkedinType = "okta"
	IdentityProviderListResponseAccessLinkedinTypeOnelogin   IdentityProviderListResponseAccessLinkedinType = "onelogin"
	IdentityProviderListResponseAccessLinkedinTypePingone    IdentityProviderListResponseAccessLinkedinType = "pingone"
	IdentityProviderListResponseAccessLinkedinTypeYandex     IdentityProviderListResponseAccessLinkedinType = "yandex"
)

type IdentityProviderListResponseAccessOidc 

type IdentityProviderListResponseAccessOidc struct {
	// The configuration parameters for the identity provider. To view the required
	// parameters for a specific provider, refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Config IdentityProviderListResponseAccessOidcConfig `json:"config,required"`
	// The name of the identity provider, shown to users on the login page.
	Name string `json:"name,required"`
	// The type of identity provider. To determine the value for a specific provider,
	// refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Type IdentityProviderListResponseAccessOidcType `json:"type,required"`
	// UUID
	ID string `json:"id"`
	// The configuration settings for enabling a System for Cross-Domain Identity
	// Management (SCIM) with the identity provider.
	ScimConfig IdentityProviderListResponseAccessOidcScimConfig `json:"scim_config"`
	JSON       identityProviderListResponseAccessOidcJSON       `json:"-"`
}

func (*IdentityProviderListResponseAccessOidc) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessOidc) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessOidcConfig 

type IdentityProviderListResponseAccessOidcConfig struct {
	// The authorization_endpoint URL of your IdP
	AuthURL string `json:"auth_url"`
	// The jwks_uri endpoint of your IdP to allow the IdP keys to sign the tokens
	CertsURL string `json:"certs_url"`
	// Custom claims
	Claims []string `json:"claims"`
	// Your OAuth Client ID
	ClientID string `json:"client_id"`
	// Your OAuth Client Secret
	ClientSecret string `json:"client_secret"`
	// The claim name for email in the id_token response.
	EmailClaimName string `json:"email_claim_name"`
	// OAuth scopes
	Scopes []string `json:"scopes"`
	// The token_endpoint URL of your IdP
	TokenURL string                                           `json:"token_url"`
	JSON     identityProviderListResponseAccessOidcConfigJSON `json:"-"`
}

The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).

func (*IdentityProviderListResponseAccessOidcConfig) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessOidcConfig) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessOidcScimConfig 

type IdentityProviderListResponseAccessOidcScimConfig struct {
	// A flag to enable or disable SCIM for the identity provider.
	Enabled bool `json:"enabled"`
	// A flag to revoke a user's session in Access and force a reauthentication on the
	// user's Gateway session when they have been added or removed from a group in the
	// Identity Provider.
	GroupMemberDeprovision bool `json:"group_member_deprovision"`
	// A flag to remove a user's seat in Zero Trust when they have been deprovisioned
	// in the Identity Provider. This cannot be enabled unless user_deprovision is also
	// enabled.
	SeatDeprovision bool `json:"seat_deprovision"`
	// A read-only token generated when the SCIM integration is enabled for the first
	// time. It is redacted on subsequent requests. If you lose this you will need to
	// refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.
	Secret string `json:"secret"`
	// A flag to enable revoking a user's session in Access and Gateway when they have
	// been deprovisioned in the Identity Provider.
	UserDeprovision bool                                                 `json:"user_deprovision"`
	JSON            identityProviderListResponseAccessOidcScimConfigJSON `json:"-"`
}

The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.

func (*IdentityProviderListResponseAccessOidcScimConfig) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessOidcScimConfig) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessOidcType 

type IdentityProviderListResponseAccessOidcType string

The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). 

const (
	IdentityProviderListResponseAccessOidcTypeOnetimepin IdentityProviderListResponseAccessOidcType = "onetimepin"
	IdentityProviderListResponseAccessOidcTypeAzureAd    IdentityProviderListResponseAccessOidcType = "azureAD"
	IdentityProviderListResponseAccessOidcTypeSaml       IdentityProviderListResponseAccessOidcType = "saml"
	IdentityProviderListResponseAccessOidcTypeCentrify   IdentityProviderListResponseAccessOidcType = "centrify"
	IdentityProviderListResponseAccessOidcTypeFacebook   IdentityProviderListResponseAccessOidcType = "facebook"
	IdentityProviderListResponseAccessOidcTypeGitHub     IdentityProviderListResponseAccessOidcType = "github"
	IdentityProviderListResponseAccessOidcTypeGoogleApps IdentityProviderListResponseAccessOidcType = "google-apps"
	IdentityProviderListResponseAccessOidcTypeGoogle     IdentityProviderListResponseAccessOidcType = "google"
	IdentityProviderListResponseAccessOidcTypeLinkedin   IdentityProviderListResponseAccessOidcType = "linkedin"
	IdentityProviderListResponseAccessOidcTypeOidc       IdentityProviderListResponseAccessOidcType = "oidc"
	IdentityProviderListResponseAccessOidcTypeOkta       IdentityProviderListResponseAccessOidcType = "okta"
	IdentityProviderListResponseAccessOidcTypeOnelogin   IdentityProviderListResponseAccessOidcType = "onelogin"
	IdentityProviderListResponseAccessOidcTypePingone    IdentityProviderListResponseAccessOidcType = "pingone"
	IdentityProviderListResponseAccessOidcTypeYandex     IdentityProviderListResponseAccessOidcType = "yandex"
)

type IdentityProviderListResponseAccessOkta 

type IdentityProviderListResponseAccessOkta struct {
	// The configuration parameters for the identity provider. To view the required
	// parameters for a specific provider, refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Config IdentityProviderListResponseAccessOktaConfig `json:"config,required"`
	// The name of the identity provider, shown to users on the login page.
	Name string `json:"name,required"`
	// The type of identity provider. To determine the value for a specific provider,
	// refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Type IdentityProviderListResponseAccessOktaType `json:"type,required"`
	// UUID
	ID string `json:"id"`
	// The configuration settings for enabling a System for Cross-Domain Identity
	// Management (SCIM) with the identity provider.
	ScimConfig IdentityProviderListResponseAccessOktaScimConfig `json:"scim_config"`
	JSON       identityProviderListResponseAccessOktaJSON       `json:"-"`
}

func (*IdentityProviderListResponseAccessOkta) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessOkta) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessOktaConfig 

type IdentityProviderListResponseAccessOktaConfig struct {
	// Your okta authorization server id
	AuthorizationServerID string `json:"authorization_server_id"`
	// Custom claims
	Claims []string `json:"claims"`
	// Your OAuth Client ID
	ClientID string `json:"client_id"`
	// Your OAuth Client Secret
	ClientSecret string `json:"client_secret"`
	// The claim name for email in the id_token response.
	EmailClaimName string `json:"email_claim_name"`
	// Your okta account url
	OktaAccount string                                           `json:"okta_account"`
	JSON        identityProviderListResponseAccessOktaConfigJSON `json:"-"`
}

The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).

func (*IdentityProviderListResponseAccessOktaConfig) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessOktaConfig) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessOktaScimConfig 

type IdentityProviderListResponseAccessOktaScimConfig struct {
	// A flag to enable or disable SCIM for the identity provider.
	Enabled bool `json:"enabled"`
	// A flag to revoke a user's session in Access and force a reauthentication on the
	// user's Gateway session when they have been added or removed from a group in the
	// Identity Provider.
	GroupMemberDeprovision bool `json:"group_member_deprovision"`
	// A flag to remove a user's seat in Zero Trust when they have been deprovisioned
	// in the Identity Provider. This cannot be enabled unless user_deprovision is also
	// enabled.
	SeatDeprovision bool `json:"seat_deprovision"`
	// A read-only token generated when the SCIM integration is enabled for the first
	// time. It is redacted on subsequent requests. If you lose this you will need to
	// refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.
	Secret string `json:"secret"`
	// A flag to enable revoking a user's session in Access and Gateway when they have
	// been deprovisioned in the Identity Provider.
	UserDeprovision bool                                                 `json:"user_deprovision"`
	JSON            identityProviderListResponseAccessOktaScimConfigJSON `json:"-"`
}

The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.

func (*IdentityProviderListResponseAccessOktaScimConfig) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessOktaScimConfig) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessOktaType 

type IdentityProviderListResponseAccessOktaType string

The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). 

const (
	IdentityProviderListResponseAccessOktaTypeOnetimepin IdentityProviderListResponseAccessOktaType = "onetimepin"
	IdentityProviderListResponseAccessOktaTypeAzureAd    IdentityProviderListResponseAccessOktaType = "azureAD"
	IdentityProviderListResponseAccessOktaTypeSaml       IdentityProviderListResponseAccessOktaType = "saml"
	IdentityProviderListResponseAccessOktaTypeCentrify   IdentityProviderListResponseAccessOktaType = "centrify"
	IdentityProviderListResponseAccessOktaTypeFacebook   IdentityProviderListResponseAccessOktaType = "facebook"
	IdentityProviderListResponseAccessOktaTypeGitHub     IdentityProviderListResponseAccessOktaType = "github"
	IdentityProviderListResponseAccessOktaTypeGoogleApps IdentityProviderListResponseAccessOktaType = "google-apps"
	IdentityProviderListResponseAccessOktaTypeGoogle     IdentityProviderListResponseAccessOktaType = "google"
	IdentityProviderListResponseAccessOktaTypeLinkedin   IdentityProviderListResponseAccessOktaType = "linkedin"
	IdentityProviderListResponseAccessOktaTypeOidc       IdentityProviderListResponseAccessOktaType = "oidc"
	IdentityProviderListResponseAccessOktaTypeOkta       IdentityProviderListResponseAccessOktaType = "okta"
	IdentityProviderListResponseAccessOktaTypeOnelogin   IdentityProviderListResponseAccessOktaType = "onelogin"
	IdentityProviderListResponseAccessOktaTypePingone    IdentityProviderListResponseAccessOktaType = "pingone"
	IdentityProviderListResponseAccessOktaTypeYandex     IdentityProviderListResponseAccessOktaType = "yandex"
)

type IdentityProviderListResponseAccessOnelogin 

type IdentityProviderListResponseAccessOnelogin struct {
	// The configuration parameters for the identity provider. To view the required
	// parameters for a specific provider, refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Config IdentityProviderListResponseAccessOneloginConfig `json:"config,required"`
	// The name of the identity provider, shown to users on the login page.
	Name string `json:"name,required"`
	// The type of identity provider. To determine the value for a specific provider,
	// refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Type IdentityProviderListResponseAccessOneloginType `json:"type,required"`
	// UUID
	ID string `json:"id"`
	// The configuration settings for enabling a System for Cross-Domain Identity
	// Management (SCIM) with the identity provider.
	ScimConfig IdentityProviderListResponseAccessOneloginScimConfig `json:"scim_config"`
	JSON       identityProviderListResponseAccessOneloginJSON       `json:"-"`
}

func (*IdentityProviderListResponseAccessOnelogin) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessOnelogin) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessOneloginConfig 

type IdentityProviderListResponseAccessOneloginConfig struct {
	// Custom claims
	Claims []string `json:"claims"`
	// Your OAuth Client ID
	ClientID string `json:"client_id"`
	// Your OAuth Client Secret
	ClientSecret string `json:"client_secret"`
	// The claim name for email in the id_token response.
	EmailClaimName string `json:"email_claim_name"`
	// Your OneLogin account url
	OneloginAccount string                                               `json:"onelogin_account"`
	JSON            identityProviderListResponseAccessOneloginConfigJSON `json:"-"`
}

The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).

func (*IdentityProviderListResponseAccessOneloginConfig) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessOneloginConfig) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessOneloginScimConfig 

type IdentityProviderListResponseAccessOneloginScimConfig struct {
	// A flag to enable or disable SCIM for the identity provider.
	Enabled bool `json:"enabled"`
	// A flag to revoke a user's session in Access and force a reauthentication on the
	// user's Gateway session when they have been added or removed from a group in the
	// Identity Provider.
	GroupMemberDeprovision bool `json:"group_member_deprovision"`
	// A flag to remove a user's seat in Zero Trust when they have been deprovisioned
	// in the Identity Provider. This cannot be enabled unless user_deprovision is also
	// enabled.
	SeatDeprovision bool `json:"seat_deprovision"`
	// A read-only token generated when the SCIM integration is enabled for the first
	// time. It is redacted on subsequent requests. If you lose this you will need to
	// refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.
	Secret string `json:"secret"`
	// A flag to enable revoking a user's session in Access and Gateway when they have
	// been deprovisioned in the Identity Provider.
	UserDeprovision bool                                                     `json:"user_deprovision"`
	JSON            identityProviderListResponseAccessOneloginScimConfigJSON `json:"-"`
}

The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.

func (*IdentityProviderListResponseAccessOneloginScimConfig) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessOneloginScimConfig) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessOneloginType 

type IdentityProviderListResponseAccessOneloginType string

The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). 

const (
	IdentityProviderListResponseAccessOneloginTypeOnetimepin IdentityProviderListResponseAccessOneloginType = "onetimepin"
	IdentityProviderListResponseAccessOneloginTypeAzureAd    IdentityProviderListResponseAccessOneloginType = "azureAD"
	IdentityProviderListResponseAccessOneloginTypeSaml       IdentityProviderListResponseAccessOneloginType = "saml"
	IdentityProviderListResponseAccessOneloginTypeCentrify   IdentityProviderListResponseAccessOneloginType = "centrify"
	IdentityProviderListResponseAccessOneloginTypeFacebook   IdentityProviderListResponseAccessOneloginType = "facebook"
	IdentityProviderListResponseAccessOneloginTypeGitHub     IdentityProviderListResponseAccessOneloginType = "github"
	IdentityProviderListResponseAccessOneloginTypeGoogleApps IdentityProviderListResponseAccessOneloginType = "google-apps"
	IdentityProviderListResponseAccessOneloginTypeGoogle     IdentityProviderListResponseAccessOneloginType = "google"
	IdentityProviderListResponseAccessOneloginTypeLinkedin   IdentityProviderListResponseAccessOneloginType = "linkedin"
	IdentityProviderListResponseAccessOneloginTypeOidc       IdentityProviderListResponseAccessOneloginType = "oidc"
	IdentityProviderListResponseAccessOneloginTypeOkta       IdentityProviderListResponseAccessOneloginType = "okta"
	IdentityProviderListResponseAccessOneloginTypeOnelogin   IdentityProviderListResponseAccessOneloginType = "onelogin"
	IdentityProviderListResponseAccessOneloginTypePingone    IdentityProviderListResponseAccessOneloginType = "pingone"
	IdentityProviderListResponseAccessOneloginTypeYandex     IdentityProviderListResponseAccessOneloginType = "yandex"
)

type IdentityProviderListResponseAccessPingone 

type IdentityProviderListResponseAccessPingone struct {
	// The configuration parameters for the identity provider. To view the required
	// parameters for a specific provider, refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Config IdentityProviderListResponseAccessPingoneConfig `json:"config,required"`
	// The name of the identity provider, shown to users on the login page.
	Name string `json:"name,required"`
	// The type of identity provider. To determine the value for a specific provider,
	// refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Type IdentityProviderListResponseAccessPingoneType `json:"type,required"`
	// UUID
	ID string `json:"id"`
	// The configuration settings for enabling a System for Cross-Domain Identity
	// Management (SCIM) with the identity provider.
	ScimConfig IdentityProviderListResponseAccessPingoneScimConfig `json:"scim_config"`
	JSON       identityProviderListResponseAccessPingoneJSON       `json:"-"`
}

func (*IdentityProviderListResponseAccessPingone) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessPingone) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessPingoneConfig 

type IdentityProviderListResponseAccessPingoneConfig struct {
	// Custom claims
	Claims []string `json:"claims"`
	// Your OAuth Client ID
	ClientID string `json:"client_id"`
	// Your OAuth Client Secret
	ClientSecret string `json:"client_secret"`
	// The claim name for email in the id_token response.
	EmailClaimName string `json:"email_claim_name"`
	// Your PingOne environment identifier
	PingEnvID string                                              `json:"ping_env_id"`
	JSON      identityProviderListResponseAccessPingoneConfigJSON `json:"-"`
}

The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).

func (*IdentityProviderListResponseAccessPingoneConfig) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessPingoneConfig) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessPingoneScimConfig 

type IdentityProviderListResponseAccessPingoneScimConfig struct {
	// A flag to enable or disable SCIM for the identity provider.
	Enabled bool `json:"enabled"`
	// A flag to revoke a user's session in Access and force a reauthentication on the
	// user's Gateway session when they have been added or removed from a group in the
	// Identity Provider.
	GroupMemberDeprovision bool `json:"group_member_deprovision"`
	// A flag to remove a user's seat in Zero Trust when they have been deprovisioned
	// in the Identity Provider. This cannot be enabled unless user_deprovision is also
	// enabled.
	SeatDeprovision bool `json:"seat_deprovision"`
	// A read-only token generated when the SCIM integration is enabled for the first
	// time. It is redacted on subsequent requests. If you lose this you will need to
	// refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.
	Secret string `json:"secret"`
	// A flag to enable revoking a user's session in Access and Gateway when they have
	// been deprovisioned in the Identity Provider.
	UserDeprovision bool                                                    `json:"user_deprovision"`
	JSON            identityProviderListResponseAccessPingoneScimConfigJSON `json:"-"`
}

The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.

func (*IdentityProviderListResponseAccessPingoneScimConfig) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessPingoneScimConfig) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessPingoneType 

type IdentityProviderListResponseAccessPingoneType string

The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). 

const (
	IdentityProviderListResponseAccessPingoneTypeOnetimepin IdentityProviderListResponseAccessPingoneType = "onetimepin"
	IdentityProviderListResponseAccessPingoneTypeAzureAd    IdentityProviderListResponseAccessPingoneType = "azureAD"
	IdentityProviderListResponseAccessPingoneTypeSaml       IdentityProviderListResponseAccessPingoneType = "saml"
	IdentityProviderListResponseAccessPingoneTypeCentrify   IdentityProviderListResponseAccessPingoneType = "centrify"
	IdentityProviderListResponseAccessPingoneTypeFacebook   IdentityProviderListResponseAccessPingoneType = "facebook"
	IdentityProviderListResponseAccessPingoneTypeGitHub     IdentityProviderListResponseAccessPingoneType = "github"
	IdentityProviderListResponseAccessPingoneTypeGoogleApps IdentityProviderListResponseAccessPingoneType = "google-apps"
	IdentityProviderListResponseAccessPingoneTypeGoogle     IdentityProviderListResponseAccessPingoneType = "google"
	IdentityProviderListResponseAccessPingoneTypeLinkedin   IdentityProviderListResponseAccessPingoneType = "linkedin"
	IdentityProviderListResponseAccessPingoneTypeOidc       IdentityProviderListResponseAccessPingoneType = "oidc"
	IdentityProviderListResponseAccessPingoneTypeOkta       IdentityProviderListResponseAccessPingoneType = "okta"
	IdentityProviderListResponseAccessPingoneTypeOnelogin   IdentityProviderListResponseAccessPingoneType = "onelogin"
	IdentityProviderListResponseAccessPingoneTypePingone    IdentityProviderListResponseAccessPingoneType = "pingone"
	IdentityProviderListResponseAccessPingoneTypeYandex     IdentityProviderListResponseAccessPingoneType = "yandex"
)

type IdentityProviderListResponseAccessSaml 

type IdentityProviderListResponseAccessSaml struct {
	// The configuration parameters for the identity provider. To view the required
	// parameters for a specific provider, refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Config IdentityProviderListResponseAccessSamlConfig `json:"config,required"`
	// The name of the identity provider, shown to users on the login page.
	Name string `json:"name,required"`
	// The type of identity provider. To determine the value for a specific provider,
	// refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Type IdentityProviderListResponseAccessSamlType `json:"type,required"`
	// UUID
	ID string `json:"id"`
	// The configuration settings for enabling a System for Cross-Domain Identity
	// Management (SCIM) with the identity provider.
	ScimConfig IdentityProviderListResponseAccessSamlScimConfig `json:"scim_config"`
	JSON       identityProviderListResponseAccessSamlJSON       `json:"-"`
}

func (*IdentityProviderListResponseAccessSaml) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessSaml) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessSamlConfig 

type IdentityProviderListResponseAccessSamlConfig struct {
	// A list of SAML attribute names that will be added to your signed JWT token and
	// can be used in SAML policy rules.
	Attributes []string `json:"attributes"`
	// The attribute name for email in the SAML response.
	EmailAttributeName string `json:"email_attribute_name"`
	// Add a list of attribute names that will be returned in the response header from
	// the Access callback.
	HeaderAttributes []IdentityProviderListResponseAccessSamlConfigHeaderAttribute `json:"header_attributes"`
	// X509 certificate to verify the signature in the SAML authentication response
	IdpPublicCerts []string `json:"idp_public_certs"`
	// IdP Entity ID or Issuer URL
	IssuerURL string `json:"issuer_url"`
	// Sign the SAML authentication request with Access credentials. To verify the
	// signature, use the public key from the Access certs endpoints.
	SignRequest bool `json:"sign_request"`
	// URL to send the SAML authentication requests to
	SSOTargetURL string                                           `json:"sso_target_url"`
	JSON         identityProviderListResponseAccessSamlConfigJSON `json:"-"`
}

The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).

func (*IdentityProviderListResponseAccessSamlConfig) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessSamlConfig) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessSamlConfigHeaderAttribute 

type IdentityProviderListResponseAccessSamlConfigHeaderAttribute struct {
	// attribute name from the IDP
	AttributeName string `json:"attribute_name"`
	// header that will be added on the request to the origin
	HeaderName string                                                          `json:"header_name"`
	JSON       identityProviderListResponseAccessSamlConfigHeaderAttributeJSON `json:"-"`
}

func (*IdentityProviderListResponseAccessSamlConfigHeaderAttribute) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessSamlConfigHeaderAttribute) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessSamlScimConfig 

type IdentityProviderListResponseAccessSamlScimConfig struct {
	// A flag to enable or disable SCIM for the identity provider.
	Enabled bool `json:"enabled"`
	// A flag to revoke a user's session in Access and force a reauthentication on the
	// user's Gateway session when they have been added or removed from a group in the
	// Identity Provider.
	GroupMemberDeprovision bool `json:"group_member_deprovision"`
	// A flag to remove a user's seat in Zero Trust when they have been deprovisioned
	// in the Identity Provider. This cannot be enabled unless user_deprovision is also
	// enabled.
	SeatDeprovision bool `json:"seat_deprovision"`
	// A read-only token generated when the SCIM integration is enabled for the first
	// time. It is redacted on subsequent requests. If you lose this you will need to
	// refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.
	Secret string `json:"secret"`
	// A flag to enable revoking a user's session in Access and Gateway when they have
	// been deprovisioned in the Identity Provider.
	UserDeprovision bool                                                 `json:"user_deprovision"`
	JSON            identityProviderListResponseAccessSamlScimConfigJSON `json:"-"`
}

The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.

func (*IdentityProviderListResponseAccessSamlScimConfig) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessSamlScimConfig) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessSamlType 

type IdentityProviderListResponseAccessSamlType string

The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). 

const (
	IdentityProviderListResponseAccessSamlTypeOnetimepin IdentityProviderListResponseAccessSamlType = "onetimepin"
	IdentityProviderListResponseAccessSamlTypeAzureAd    IdentityProviderListResponseAccessSamlType = "azureAD"
	IdentityProviderListResponseAccessSamlTypeSaml       IdentityProviderListResponseAccessSamlType = "saml"
	IdentityProviderListResponseAccessSamlTypeCentrify   IdentityProviderListResponseAccessSamlType = "centrify"
	IdentityProviderListResponseAccessSamlTypeFacebook   IdentityProviderListResponseAccessSamlType = "facebook"
	IdentityProviderListResponseAccessSamlTypeGitHub     IdentityProviderListResponseAccessSamlType = "github"
	IdentityProviderListResponseAccessSamlTypeGoogleApps IdentityProviderListResponseAccessSamlType = "google-apps"
	IdentityProviderListResponseAccessSamlTypeGoogle     IdentityProviderListResponseAccessSamlType = "google"
	IdentityProviderListResponseAccessSamlTypeLinkedin   IdentityProviderListResponseAccessSamlType = "linkedin"
	IdentityProviderListResponseAccessSamlTypeOidc       IdentityProviderListResponseAccessSamlType = "oidc"
	IdentityProviderListResponseAccessSamlTypeOkta       IdentityProviderListResponseAccessSamlType = "okta"
	IdentityProviderListResponseAccessSamlTypeOnelogin   IdentityProviderListResponseAccessSamlType = "onelogin"
	IdentityProviderListResponseAccessSamlTypePingone    IdentityProviderListResponseAccessSamlType = "pingone"
	IdentityProviderListResponseAccessSamlTypeYandex     IdentityProviderListResponseAccessSamlType = "yandex"
)

type IdentityProviderListResponseAccessYandex 

type IdentityProviderListResponseAccessYandex struct {
	// The configuration parameters for the identity provider. To view the required
	// parameters for a specific provider, refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Config IdentityProviderListResponseAccessYandexConfig `json:"config,required"`
	// The name of the identity provider, shown to users on the login page.
	Name string `json:"name,required"`
	// The type of identity provider. To determine the value for a specific provider,
	// refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Type IdentityProviderListResponseAccessYandexType `json:"type,required"`
	// UUID
	ID string `json:"id"`
	// The configuration settings for enabling a System for Cross-Domain Identity
	// Management (SCIM) with the identity provider.
	ScimConfig IdentityProviderListResponseAccessYandexScimConfig `json:"scim_config"`
	JSON       identityProviderListResponseAccessYandexJSON       `json:"-"`
}

func (*IdentityProviderListResponseAccessYandex) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessYandex) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessYandexConfig 

type IdentityProviderListResponseAccessYandexConfig struct {
	// Your OAuth Client ID
	ClientID string `json:"client_id"`
	// Your OAuth Client Secret
	ClientSecret string                                             `json:"client_secret"`
	JSON         identityProviderListResponseAccessYandexConfigJSON `json:"-"`
}

The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).

func (*IdentityProviderListResponseAccessYandexConfig) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessYandexConfig) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessYandexScimConfig 

type IdentityProviderListResponseAccessYandexScimConfig struct {
	// A flag to enable or disable SCIM for the identity provider.
	Enabled bool `json:"enabled"`
	// A flag to revoke a user's session in Access and force a reauthentication on the
	// user's Gateway session when they have been added or removed from a group in the
	// Identity Provider.
	GroupMemberDeprovision bool `json:"group_member_deprovision"`
	// A flag to remove a user's seat in Zero Trust when they have been deprovisioned
	// in the Identity Provider. This cannot be enabled unless user_deprovision is also
	// enabled.
	SeatDeprovision bool `json:"seat_deprovision"`
	// A read-only token generated when the SCIM integration is enabled for the first
	// time. It is redacted on subsequent requests. If you lose this you will need to
	// refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.
	Secret string `json:"secret"`
	// A flag to enable revoking a user's session in Access and Gateway when they have
	// been deprovisioned in the Identity Provider.
	UserDeprovision bool                                                   `json:"user_deprovision"`
	JSON            identityProviderListResponseAccessYandexScimConfigJSON `json:"-"`
}

The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.

func (*IdentityProviderListResponseAccessYandexScimConfig) UnmarshalJSON 

func (r *IdentityProviderListResponseAccessYandexScimConfig) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseAccessYandexType 

type IdentityProviderListResponseAccessYandexType string

The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). 

const (
	IdentityProviderListResponseAccessYandexTypeOnetimepin IdentityProviderListResponseAccessYandexType = "onetimepin"
	IdentityProviderListResponseAccessYandexTypeAzureAd    IdentityProviderListResponseAccessYandexType = "azureAD"
	IdentityProviderListResponseAccessYandexTypeSaml       IdentityProviderListResponseAccessYandexType = "saml"
	IdentityProviderListResponseAccessYandexTypeCentrify   IdentityProviderListResponseAccessYandexType = "centrify"
	IdentityProviderListResponseAccessYandexTypeFacebook   IdentityProviderListResponseAccessYandexType = "facebook"
	IdentityProviderListResponseAccessYandexTypeGitHub     IdentityProviderListResponseAccessYandexType = "github"
	IdentityProviderListResponseAccessYandexTypeGoogleApps IdentityProviderListResponseAccessYandexType = "google-apps"
	IdentityProviderListResponseAccessYandexTypeGoogle     IdentityProviderListResponseAccessYandexType = "google"
	IdentityProviderListResponseAccessYandexTypeLinkedin   IdentityProviderListResponseAccessYandexType = "linkedin"
	IdentityProviderListResponseAccessYandexTypeOidc       IdentityProviderListResponseAccessYandexType = "oidc"
	IdentityProviderListResponseAccessYandexTypeOkta       IdentityProviderListResponseAccessYandexType = "okta"
	IdentityProviderListResponseAccessYandexTypeOnelogin   IdentityProviderListResponseAccessYandexType = "onelogin"
	IdentityProviderListResponseAccessYandexTypePingone    IdentityProviderListResponseAccessYandexType = "pingone"
	IdentityProviderListResponseAccessYandexTypeYandex     IdentityProviderListResponseAccessYandexType = "yandex"
)

type IdentityProviderListResponseEnvelope 

type IdentityProviderListResponseEnvelope struct {
	Errors   []IdentityProviderListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []IdentityProviderListResponseEnvelopeMessages `json:"messages,required"`
	Result   []IdentityProviderListResponse                 `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    IdentityProviderListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo IdentityProviderListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       identityProviderListResponseEnvelopeJSON       `json:"-"`
}

func (*IdentityProviderListResponseEnvelope) UnmarshalJSON 

func (r *IdentityProviderListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseEnvelopeErrors 

type IdentityProviderListResponseEnvelopeErrors struct {
	Code    int64                                          `json:"code,required"`
	Message string                                         `json:"message,required"`
	JSON    identityProviderListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*IdentityProviderListResponseEnvelopeErrors) UnmarshalJSON 

func (r *IdentityProviderListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseEnvelopeMessages 

type IdentityProviderListResponseEnvelopeMessages struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    identityProviderListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*IdentityProviderListResponseEnvelopeMessages) UnmarshalJSON 

func (r *IdentityProviderListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseEnvelopeResultInfo 

type IdentityProviderListResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                            `json:"total_count"`
	JSON       identityProviderListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*IdentityProviderListResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *IdentityProviderListResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type IdentityProviderListResponseEnvelopeSuccess 

type IdentityProviderListResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	IdentityProviderListResponseEnvelopeSuccessTrue IdentityProviderListResponseEnvelopeSuccess = true
)

type IdentityProviderNewParams 

type IdentityProviderNewParams struct {
	Config param.Field[IdentityProviderNewParamsConfig] `json:"config,required"`
	// The name of the identity provider, shown to users on the login page.
	Name param.Field[string] `json:"name,required"`
	// The type of identity provider. To determine the value for a specific provider,
	// refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Type param.Field[IdentityProviderNewParamsType] `json:"type,required"`
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID     param.Field[string]                              `path:"zone_id"`
	ScimConfig param.Field[IdentityProviderNewParamsScimConfig] `json:"scim_config"`
}

func (IdentityProviderNewParams) MarshalJSON 

func (r IdentityProviderNewParams) MarshalJSON() (data []byte, err error)

type IdentityProviderNewParamsConfig 

type IdentityProviderNewParamsConfig struct {
	// Your companies TLD
	AppsDomain param.Field[string] `json:"apps_domain"`
	// A list of SAML attribute names that will be added to your signed JWT token and
	// can be used in SAML policy rules.
	Attributes param.Field[[]string] `json:"attributes"`
	// The authorization_endpoint URL of your IdP
	AuthURL param.Field[string] `json:"auth_url"`
	// Your okta authorization server id
	AuthorizationServerID param.Field[string] `json:"authorization_server_id"`
	// Your centrify account url
	CentrifyAccount param.Field[string] `json:"centrify_account"`
	// Your centrify app id
	CentrifyAppID param.Field[string] `json:"centrify_app_id"`
	// The jwks_uri endpoint of your IdP to allow the IdP keys to sign the tokens
	CertsURL param.Field[string] `json:"certs_url"`
	// Custom claims
	Claims param.Field[[]string] `json:"claims"`
	// Your OAuth Client ID
	ClientID param.Field[string] `json:"client_id"`
	// Your OAuth Client Secret
	ClientSecret param.Field[string] `json:"client_secret"`
	// Should Cloudflare try to load authentication contexts from your account
	ConditionalAccessEnabled param.Field[bool] `json:"conditional_access_enabled"`
	// Your Azure directory uuid
	DirectoryID param.Field[string] `json:"directory_id"`
	// The attribute name for email in the SAML response.
	EmailAttributeName param.Field[string] `json:"email_attribute_name"`
	// The claim name for email in the id_token response.
	EmailClaimName param.Field[string] `json:"email_claim_name"`
	// Add a list of attribute names that will be returned in the response header from
	// the Access callback.
	HeaderAttributes param.Field[[]IdentityProviderNewParamsConfigHeaderAttribute] `json:"header_attributes"`
	// X509 certificate to verify the signature in the SAML authentication response
	IdpPublicCerts param.Field[[]string] `json:"idp_public_certs"`
	// IdP Entity ID or Issuer URL
	IssuerURL param.Field[string] `json:"issuer_url"`
	// Your okta account url
	OktaAccount param.Field[string] `json:"okta_account"`
	// Your OneLogin account url
	OneloginAccount param.Field[string] `json:"onelogin_account"`
	// Your PingOne environment identifier
	PingEnvID param.Field[string] `json:"ping_env_id"`
	// Indicates the type of user interaction that is required. prompt=login forces the
	// user to enter their credentials on that request, negating single-sign on.
	// prompt=none is the opposite. It ensures that the user isn't presented with any
	// interactive prompt. If the request can't be completed silently by using
	// single-sign on, the Microsoft identity platform returns an interaction_required
	// error. prompt=select_account interrupts single sign-on providing account
	// selection experience listing all the accounts either in session or any
	// remembered account or an option to choose to use a different account altogether.
	Prompt param.Field[IdentityProviderNewParamsConfigPrompt] `json:"prompt"`
	// OAuth scopes
	Scopes param.Field[[]string] `json:"scopes"`
	// Sign the SAML authentication request with Access credentials. To verify the
	// signature, use the public key from the Access certs endpoints.
	SignRequest param.Field[bool] `json:"sign_request"`
	// URL to send the SAML authentication requests to
	SSOTargetURL param.Field[string] `json:"sso_target_url"`
	// Should Cloudflare try to load groups from your account
	SupportGroups param.Field[bool] `json:"support_groups"`
	// The token_endpoint URL of your IdP
	TokenURL param.Field[string] `json:"token_url"`
}

func (IdentityProviderNewParamsConfig) MarshalJSON 

func (r IdentityProviderNewParamsConfig) MarshalJSON() (data []byte, err error)

type IdentityProviderNewParamsConfigHeaderAttribute 

type IdentityProviderNewParamsConfigHeaderAttribute struct {
	// attribute name from the IDP
	AttributeName param.Field[string] `json:"attribute_name"`
	// header that will be added on the request to the origin
	HeaderName param.Field[string] `json:"header_name"`
}

func (IdentityProviderNewParamsConfigHeaderAttribute) MarshalJSON 

func (r IdentityProviderNewParamsConfigHeaderAttribute) MarshalJSON() (data []byte, err error)

type IdentityProviderNewParamsConfigPrompt 

type IdentityProviderNewParamsConfigPrompt string

Indicates the type of user interaction that is required. prompt=login forces the user to enter their credentials on that request, negating single-sign on. prompt=none is the opposite. It ensures that the user isn't presented with any interactive prompt. If the request can't be completed silently by using single-sign on, the Microsoft identity platform returns an interaction_required error. prompt=select_account interrupts single sign-on providing account selection experience listing all the accounts either in session or any remembered account or an option to choose to use a different account altogether. 

const (
	IdentityProviderNewParamsConfigPromptLogin         IdentityProviderNewParamsConfigPrompt = "login"
	IdentityProviderNewParamsConfigPromptSelectAccount IdentityProviderNewParamsConfigPrompt = "select_account"
	IdentityProviderNewParamsConfigPromptNone          IdentityProviderNewParamsConfigPrompt = "none"
)

type IdentityProviderNewParamsScimConfig 

type IdentityProviderNewParamsScimConfig struct {
	// A flag to enable or disable SCIM for the identity provider.
	Enabled param.Field[bool] `json:"enabled"`
	// A flag to revoke a user's session in Access and force a reauthentication on the
	// user's Gateway session when they have been added or removed from a group in the
	// Identity Provider.
	GroupMemberDeprovision param.Field[bool] `json:"group_member_deprovision"`
	// A flag to remove a user's seat in Zero Trust when they have been deprovisioned
	// in the Identity Provider. This cannot be enabled unless user_deprovision is also
	// enabled.
	SeatDeprovision param.Field[bool] `json:"seat_deprovision"`
	// A read-only token generated when the SCIM integration is enabled for the first
	// time. It is redacted on subsequent requests. If you lose this you will need to
	// refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.
	Secret param.Field[string] `json:"secret"`
	// A flag to enable revoking a user's session in Access and Gateway when they have
	// been deprovisioned in the Identity Provider.
	UserDeprovision param.Field[bool] `json:"user_deprovision"`
}

func (IdentityProviderNewParamsScimConfig) MarshalJSON 

func (r IdentityProviderNewParamsScimConfig) MarshalJSON() (data []byte, err error)

type IdentityProviderNewParamsType 

type IdentityProviderNewParamsType string

The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). 

const (
	IdentityProviderNewParamsTypeOnetimepin IdentityProviderNewParamsType = "onetimepin"
	IdentityProviderNewParamsTypeAzureAd    IdentityProviderNewParamsType = "azureAD"
	IdentityProviderNewParamsTypeSaml       IdentityProviderNewParamsType = "saml"
	IdentityProviderNewParamsTypeCentrify   IdentityProviderNewParamsType = "centrify"
	IdentityProviderNewParamsTypeFacebook   IdentityProviderNewParamsType = "facebook"
	IdentityProviderNewParamsTypeGitHub     IdentityProviderNewParamsType = "github"
	IdentityProviderNewParamsTypeGoogleApps IdentityProviderNewParamsType = "google-apps"
	IdentityProviderNewParamsTypeGoogle     IdentityProviderNewParamsType = "google"
	IdentityProviderNewParamsTypeLinkedin   IdentityProviderNewParamsType = "linkedin"
	IdentityProviderNewParamsTypeOidc       IdentityProviderNewParamsType = "oidc"
	IdentityProviderNewParamsTypeOkta       IdentityProviderNewParamsType = "okta"
	IdentityProviderNewParamsTypeOnelogin   IdentityProviderNewParamsType = "onelogin"
	IdentityProviderNewParamsTypePingone    IdentityProviderNewParamsType = "pingone"
	IdentityProviderNewParamsTypeYandex     IdentityProviderNewParamsType = "yandex"
)

type IdentityProviderNewResponseEnvelope 

type IdentityProviderNewResponseEnvelope struct {
	Errors   []IdentityProviderNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []IdentityProviderNewResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessIdentityProviders                       `json:"result,required"`
	// Whether the API call was successful
	Success IdentityProviderNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    identityProviderNewResponseEnvelopeJSON    `json:"-"`
}

func (*IdentityProviderNewResponseEnvelope) UnmarshalJSON 

func (r *IdentityProviderNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type IdentityProviderNewResponseEnvelopeErrors 

type IdentityProviderNewResponseEnvelopeErrors struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    identityProviderNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*IdentityProviderNewResponseEnvelopeErrors) UnmarshalJSON 

func (r *IdentityProviderNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type IdentityProviderNewResponseEnvelopeMessages 

type IdentityProviderNewResponseEnvelopeMessages struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    identityProviderNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*IdentityProviderNewResponseEnvelopeMessages) UnmarshalJSON 

func (r *IdentityProviderNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type IdentityProviderNewResponseEnvelopeSuccess 

type IdentityProviderNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	IdentityProviderNewResponseEnvelopeSuccessTrue IdentityProviderNewResponseEnvelopeSuccess = true
)

type IdentityProviderService 

type IdentityProviderService struct {
	Options []option.RequestOption
}

IdentityProviderService 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 NewIdentityProviderService method instead.

func NewIdentityProviderService 

func NewIdentityProviderService(opts ...option.RequestOption) (r *IdentityProviderService)

NewIdentityProviderService 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 (*IdentityProviderService) Delete 

func (r *IdentityProviderService) Delete(ctx context.Context, uuid string, body IdentityProviderDeleteParams, opts ...option.RequestOption) (res *IdentityProviderDeleteResponse, err error)

Deletes an identity provider from Access.

func (*IdentityProviderService) Get 

func (r *IdentityProviderService) Get(ctx context.Context, uuid string, query IdentityProviderGetParams, opts ...option.RequestOption) (res *AccessIdentityProviders, err error)

Fetches a configured identity provider.

func (*IdentityProviderService) List 

func (r *IdentityProviderService) List(ctx context.Context, query IdentityProviderListParams, opts ...option.RequestOption) (res *[]IdentityProviderListResponse, err error)

Lists all configured identity providers.

func (*IdentityProviderService) New 

func (r *IdentityProviderService) New(ctx context.Context, params IdentityProviderNewParams, opts ...option.RequestOption) (res *AccessIdentityProviders, err error)

Adds a new identity provider to Access.

func (*IdentityProviderService) Update 

func (r *IdentityProviderService) Update(ctx context.Context, uuid string, params IdentityProviderUpdateParams, opts ...option.RequestOption) (res *AccessIdentityProviders, err error)

Updates a configured identity provider.

type IdentityProviderUpdateParams 

type IdentityProviderUpdateParams struct {
	Config param.Field[IdentityProviderUpdateParamsConfig] `json:"config,required"`
	// The name of the identity provider, shown to users on the login page.
	Name param.Field[string] `json:"name,required"`
	// The type of identity provider. To determine the value for a specific provider,
	// refer to our
	// [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
	Type param.Field[IdentityProviderUpdateParamsType] `json:"type,required"`
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID     param.Field[string]                                 `path:"zone_id"`
	ScimConfig param.Field[IdentityProviderUpdateParamsScimConfig] `json:"scim_config"`
}

func (IdentityProviderUpdateParams) MarshalJSON 

func (r IdentityProviderUpdateParams) MarshalJSON() (data []byte, err error)

type IdentityProviderUpdateParamsConfig 

type IdentityProviderUpdateParamsConfig struct {
	// Your companies TLD
	AppsDomain param.Field[string] `json:"apps_domain"`
	// A list of SAML attribute names that will be added to your signed JWT token and
	// can be used in SAML policy rules.
	Attributes param.Field[[]string] `json:"attributes"`
	// The authorization_endpoint URL of your IdP
	AuthURL param.Field[string] `json:"auth_url"`
	// Your okta authorization server id
	AuthorizationServerID param.Field[string] `json:"authorization_server_id"`
	// Your centrify account url
	CentrifyAccount param.Field[string] `json:"centrify_account"`
	// Your centrify app id
	CentrifyAppID param.Field[string] `json:"centrify_app_id"`
	// The jwks_uri endpoint of your IdP to allow the IdP keys to sign the tokens
	CertsURL param.Field[string] `json:"certs_url"`
	// Custom claims
	Claims param.Field[[]string] `json:"claims"`
	// Your OAuth Client ID
	ClientID param.Field[string] `json:"client_id"`
	// Your OAuth Client Secret
	ClientSecret param.Field[string] `json:"client_secret"`
	// Should Cloudflare try to load authentication contexts from your account
	ConditionalAccessEnabled param.Field[bool] `json:"conditional_access_enabled"`
	// Your Azure directory uuid
	DirectoryID param.Field[string] `json:"directory_id"`
	// The attribute name for email in the SAML response.
	EmailAttributeName param.Field[string] `json:"email_attribute_name"`
	// The claim name for email in the id_token response.
	EmailClaimName param.Field[string] `json:"email_claim_name"`
	// Add a list of attribute names that will be returned in the response header from
	// the Access callback.
	HeaderAttributes param.Field[[]IdentityProviderUpdateParamsConfigHeaderAttribute] `json:"header_attributes"`
	// X509 certificate to verify the signature in the SAML authentication response
	IdpPublicCerts param.Field[[]string] `json:"idp_public_certs"`
	// IdP Entity ID or Issuer URL
	IssuerURL param.Field[string] `json:"issuer_url"`
	// Your okta account url
	OktaAccount param.Field[string] `json:"okta_account"`
	// Your OneLogin account url
	OneloginAccount param.Field[string] `json:"onelogin_account"`
	// Your PingOne environment identifier
	PingEnvID param.Field[string] `json:"ping_env_id"`
	// Indicates the type of user interaction that is required. prompt=login forces the
	// user to enter their credentials on that request, negating single-sign on.
	// prompt=none is the opposite. It ensures that the user isn't presented with any
	// interactive prompt. If the request can't be completed silently by using
	// single-sign on, the Microsoft identity platform returns an interaction_required
	// error. prompt=select_account interrupts single sign-on providing account
	// selection experience listing all the accounts either in session or any
	// remembered account or an option to choose to use a different account altogether.
	Prompt param.Field[IdentityProviderUpdateParamsConfigPrompt] `json:"prompt"`
	// OAuth scopes
	Scopes param.Field[[]string] `json:"scopes"`
	// Sign the SAML authentication request with Access credentials. To verify the
	// signature, use the public key from the Access certs endpoints.
	SignRequest param.Field[bool] `json:"sign_request"`
	// URL to send the SAML authentication requests to
	SSOTargetURL param.Field[string] `json:"sso_target_url"`
	// Should Cloudflare try to load groups from your account
	SupportGroups param.Field[bool] `json:"support_groups"`
	// The token_endpoint URL of your IdP
	TokenURL param.Field[string] `json:"token_url"`
}

func (IdentityProviderUpdateParamsConfig) MarshalJSON 

func (r IdentityProviderUpdateParamsConfig) MarshalJSON() (data []byte, err error)

type IdentityProviderUpdateParamsConfigHeaderAttribute 

type IdentityProviderUpdateParamsConfigHeaderAttribute struct {
	// attribute name from the IDP
	AttributeName param.Field[string] `json:"attribute_name"`
	// header that will be added on the request to the origin
	HeaderName param.Field[string] `json:"header_name"`
}

func (IdentityProviderUpdateParamsConfigHeaderAttribute) MarshalJSON 

func (r IdentityProviderUpdateParamsConfigHeaderAttribute) MarshalJSON() (data []byte, err error)

type IdentityProviderUpdateParamsConfigPrompt 

type IdentityProviderUpdateParamsConfigPrompt string

Indicates the type of user interaction that is required. prompt=login forces the user to enter their credentials on that request, negating single-sign on. prompt=none is the opposite. It ensures that the user isn't presented with any interactive prompt. If the request can't be completed silently by using single-sign on, the Microsoft identity platform returns an interaction_required error. prompt=select_account interrupts single sign-on providing account selection experience listing all the accounts either in session or any remembered account or an option to choose to use a different account altogether. 

const (
	IdentityProviderUpdateParamsConfigPromptLogin         IdentityProviderUpdateParamsConfigPrompt = "login"
	IdentityProviderUpdateParamsConfigPromptSelectAccount IdentityProviderUpdateParamsConfigPrompt = "select_account"
	IdentityProviderUpdateParamsConfigPromptNone          IdentityProviderUpdateParamsConfigPrompt = "none"
)

type IdentityProviderUpdateParamsScimConfig 

type IdentityProviderUpdateParamsScimConfig struct {
	// A flag to enable or disable SCIM for the identity provider.
	Enabled param.Field[bool] `json:"enabled"`
	// A flag to revoke a user's session in Access and force a reauthentication on the
	// user's Gateway session when they have been added or removed from a group in the
	// Identity Provider.
	GroupMemberDeprovision param.Field[bool] `json:"group_member_deprovision"`
	// A flag to remove a user's seat in Zero Trust when they have been deprovisioned
	// in the Identity Provider. This cannot be enabled unless user_deprovision is also
	// enabled.
	SeatDeprovision param.Field[bool] `json:"seat_deprovision"`
	// A read-only token generated when the SCIM integration is enabled for the first
	// time. It is redacted on subsequent requests. If you lose this you will need to
	// refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.
	Secret param.Field[string] `json:"secret"`
	// A flag to enable revoking a user's session in Access and Gateway when they have
	// been deprovisioned in the Identity Provider.
	UserDeprovision param.Field[bool] `json:"user_deprovision"`
}

func (IdentityProviderUpdateParamsScimConfig) MarshalJSON 

func (r IdentityProviderUpdateParamsScimConfig) MarshalJSON() (data []byte, err error)

type IdentityProviderUpdateParamsType 

type IdentityProviderUpdateParamsType string

The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). 

const (
	IdentityProviderUpdateParamsTypeOnetimepin IdentityProviderUpdateParamsType = "onetimepin"
	IdentityProviderUpdateParamsTypeAzureAd    IdentityProviderUpdateParamsType = "azureAD"
	IdentityProviderUpdateParamsTypeSaml       IdentityProviderUpdateParamsType = "saml"
	IdentityProviderUpdateParamsTypeCentrify   IdentityProviderUpdateParamsType = "centrify"
	IdentityProviderUpdateParamsTypeFacebook   IdentityProviderUpdateParamsType = "facebook"
	IdentityProviderUpdateParamsTypeGitHub     IdentityProviderUpdateParamsType = "github"
	IdentityProviderUpdateParamsTypeGoogleApps IdentityProviderUpdateParamsType = "google-apps"
	IdentityProviderUpdateParamsTypeGoogle     IdentityProviderUpdateParamsType = "google"
	IdentityProviderUpdateParamsTypeLinkedin   IdentityProviderUpdateParamsType = "linkedin"
	IdentityProviderUpdateParamsTypeOidc       IdentityProviderUpdateParamsType = "oidc"
	IdentityProviderUpdateParamsTypeOkta       IdentityProviderUpdateParamsType = "okta"
	IdentityProviderUpdateParamsTypeOnelogin   IdentityProviderUpdateParamsType = "onelogin"
	IdentityProviderUpdateParamsTypePingone    IdentityProviderUpdateParamsType = "pingone"
	IdentityProviderUpdateParamsTypeYandex     IdentityProviderUpdateParamsType = "yandex"
)

type IdentityProviderUpdateResponseEnvelope 

type IdentityProviderUpdateResponseEnvelope struct {
	Errors   []IdentityProviderUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []IdentityProviderUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessIdentityProviders                          `json:"result,required"`
	// Whether the API call was successful
	Success IdentityProviderUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    identityProviderUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*IdentityProviderUpdateResponseEnvelope) UnmarshalJSON 

func (r *IdentityProviderUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type IdentityProviderUpdateResponseEnvelopeErrors 

type IdentityProviderUpdateResponseEnvelopeErrors struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    identityProviderUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*IdentityProviderUpdateResponseEnvelopeErrors) UnmarshalJSON 

func (r *IdentityProviderUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type IdentityProviderUpdateResponseEnvelopeMessages 

type IdentityProviderUpdateResponseEnvelopeMessages struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    identityProviderUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*IdentityProviderUpdateResponseEnvelopeMessages) UnmarshalJSON 

func (r *IdentityProviderUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type IdentityProviderUpdateResponseEnvelopeSuccess 

type IdentityProviderUpdateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	IdentityProviderUpdateResponseEnvelopeSuccessTrue IdentityProviderUpdateResponseEnvelopeSuccess = true
)

type NetworkRouteDeleteParams 

type NetworkRouteDeleteParams struct {
	// Cloudflare account ID
	AccountID param.Field[string] `path:"account_id,required"`
}

type NetworkRouteDeleteResponseEnvelope 

type NetworkRouteDeleteResponseEnvelope struct {
	Errors   []NetworkRouteDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []NetworkRouteDeleteResponseEnvelopeMessages `json:"messages,required"`
	Result   TunnelRoute                                  `json:"result,required"`
	// Whether the API call was successful
	Success NetworkRouteDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    networkRouteDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*NetworkRouteDeleteResponseEnvelope) UnmarshalJSON 

func (r *NetworkRouteDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NetworkRouteDeleteResponseEnvelopeErrors 

type NetworkRouteDeleteResponseEnvelopeErrors struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    networkRouteDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*NetworkRouteDeleteResponseEnvelopeErrors) UnmarshalJSON 

func (r *NetworkRouteDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type NetworkRouteDeleteResponseEnvelopeMessages 

type NetworkRouteDeleteResponseEnvelopeMessages struct {
	Code    int64                                          `json:"code,required"`
	Message string                                         `json:"message,required"`
	JSON    networkRouteDeleteResponseEnvelopeMessagesJSON `json:"-"`
}

func (*NetworkRouteDeleteResponseEnvelopeMessages) UnmarshalJSON 

func (r *NetworkRouteDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type NetworkRouteDeleteResponseEnvelopeSuccess 

type NetworkRouteDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	NetworkRouteDeleteResponseEnvelopeSuccessTrue NetworkRouteDeleteResponseEnvelopeSuccess = true
)

type NetworkRouteEditParams 

type NetworkRouteEditParams struct {
	// Cloudflare account ID
	AccountID param.Field[string] `path:"account_id,required"`
	// Optional remark describing the route.
	Comment param.Field[string] `json:"comment"`
	// The private IPv4 or IPv6 range connected by the route, in CIDR notation.
	Network param.Field[string] `json:"network"`
	// The type of tunnel.
	TunType param.Field[NetworkRouteEditParamsTunType] `json:"tun_type"`
	// UUID of the Cloudflare Tunnel serving the route.
	TunnelID param.Field[interface{}] `json:"tunnel_id"`
	// UUID of the Tunnel Virtual Network this route belongs to. If no virtual networks
	// are configured, the route is assigned to the default virtual network of the
	// account.
	VirtualNetworkID param.Field[interface{}] `json:"virtual_network_id"`
}

func (NetworkRouteEditParams) MarshalJSON 

func (r NetworkRouteEditParams) MarshalJSON() (data []byte, err error)

type NetworkRouteEditParamsTunType 

type NetworkRouteEditParamsTunType string

The type of tunnel. 

const (
	NetworkRouteEditParamsTunTypeCfdTunnel     NetworkRouteEditParamsTunType = "cfd_tunnel"
	NetworkRouteEditParamsTunTypeWARPConnector NetworkRouteEditParamsTunType = "warp_connector"
	NetworkRouteEditParamsTunTypeIPSec         NetworkRouteEditParamsTunType = "ip_sec"
	NetworkRouteEditParamsTunTypeGRE           NetworkRouteEditParamsTunType = "gre"
	NetworkRouteEditParamsTunTypeCni           NetworkRouteEditParamsTunType = "cni"
)

type NetworkRouteEditResponseEnvelope 

type NetworkRouteEditResponseEnvelope struct {
	Errors   []NetworkRouteEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []NetworkRouteEditResponseEnvelopeMessages `json:"messages,required"`
	Result   TunnelRoute                                `json:"result,required"`
	// Whether the API call was successful
	Success NetworkRouteEditResponseEnvelopeSuccess `json:"success,required"`
	JSON    networkRouteEditResponseEnvelopeJSON    `json:"-"`
}

func (*NetworkRouteEditResponseEnvelope) UnmarshalJSON 

func (r *NetworkRouteEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NetworkRouteEditResponseEnvelopeErrors 

type NetworkRouteEditResponseEnvelopeErrors struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    networkRouteEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*NetworkRouteEditResponseEnvelopeErrors) UnmarshalJSON 

func (r *NetworkRouteEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type NetworkRouteEditResponseEnvelopeMessages 

type NetworkRouteEditResponseEnvelopeMessages struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    networkRouteEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*NetworkRouteEditResponseEnvelopeMessages) UnmarshalJSON 

func (r *NetworkRouteEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type NetworkRouteEditResponseEnvelopeSuccess 

type NetworkRouteEditResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	NetworkRouteEditResponseEnvelopeSuccessTrue NetworkRouteEditResponseEnvelopeSuccess = true
)

type NetworkRouteIPGetParams 

type NetworkRouteIPGetParams struct {
	// Cloudflare account ID
	AccountID param.Field[string] `path:"account_id,required"`
	// UUID of the Tunnel Virtual Network this route belongs to. If no virtual networks
	// are configured, the route is assigned to the default virtual network of the
	// account.
	VirtualNetworkID param.Field[interface{}] `query:"virtual_network_id"`
}

func (NetworkRouteIPGetParams) URLQuery 

func (r NetworkRouteIPGetParams) URLQuery() (v url.Values)

URLQuery serializes NetworkRouteIPGetParams's query parameters as `url.Values`.

type NetworkRouteIPGetResponseEnvelope 

type NetworkRouteIPGetResponseEnvelope struct {
	Errors   []NetworkRouteIPGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []NetworkRouteIPGetResponseEnvelopeMessages `json:"messages,required"`
	Result   TunnelTeamnet                               `json:"result,required"`
	// Whether the API call was successful
	Success NetworkRouteIPGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    networkRouteIPGetResponseEnvelopeJSON    `json:"-"`
}

func (*NetworkRouteIPGetResponseEnvelope) UnmarshalJSON 

func (r *NetworkRouteIPGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NetworkRouteIPGetResponseEnvelopeErrors 

type NetworkRouteIPGetResponseEnvelopeErrors struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    networkRouteIPGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*NetworkRouteIPGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *NetworkRouteIPGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type NetworkRouteIPGetResponseEnvelopeMessages 

type NetworkRouteIPGetResponseEnvelopeMessages struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    networkRouteIPGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*NetworkRouteIPGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *NetworkRouteIPGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type NetworkRouteIPGetResponseEnvelopeSuccess 

type NetworkRouteIPGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	NetworkRouteIPGetResponseEnvelopeSuccessTrue NetworkRouteIPGetResponseEnvelopeSuccess = true
)

type NetworkRouteIPService 

type NetworkRouteIPService struct {
	Options []option.RequestOption
}

NetworkRouteIPService 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 NewNetworkRouteIPService method instead.

func NewNetworkRouteIPService 

func NewNetworkRouteIPService(opts ...option.RequestOption) (r *NetworkRouteIPService)

NewNetworkRouteIPService 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 (*NetworkRouteIPService) Get 

func (r *NetworkRouteIPService) Get(ctx context.Context, ip string, params NetworkRouteIPGetParams, opts ...option.RequestOption) (res *TunnelTeamnet, err error)

Fetches routes that contain the given IP address.

type NetworkRouteListParams 

type NetworkRouteListParams struct {
	// Cloudflare account ID
	AccountID param.Field[string] `path:"account_id,required"`
	// Optional remark describing the route.
	Comment param.Field[string] `query:"comment"`
	// If provided, include only routes that were created (and not deleted) before this
	// time.
	ExistedAt param.Field[interface{}] `query:"existed_at"`
	// If `true`, only include deleted routes. If `false`, exclude deleted routes. If
	// empty, all routes will be included.
	IsDeleted param.Field[interface{}] `query:"is_deleted"`
	// If set, only list routes that are contained within this IP range.
	NetworkSubset param.Field[interface{}] `query:"network_subset"`
	// If set, only list routes that contain this IP range.
	NetworkSuperset param.Field[interface{}] `query:"network_superset"`
	// Page number of paginated results.
	Page param.Field[float64] `query:"page"`
	// Number of results to display.
	PerPage param.Field[float64] `query:"per_page"`
	// The types of tunnels to filter separated by a comma.
	TunTypes param.Field[string] `query:"tun_types"`
	// UUID of the Cloudflare Tunnel serving the route.
	TunnelID param.Field[interface{}] `query:"tunnel_id"`
	// UUID of the Tunnel Virtual Network this route belongs to. If no virtual networks
	// are configured, the route is assigned to the default virtual network of the
	// account.
	VirtualNetworkID param.Field[interface{}] `query:"virtual_network_id"`
}

func (NetworkRouteListParams) URLQuery 

func (r NetworkRouteListParams) URLQuery() (v url.Values)

URLQuery serializes NetworkRouteListParams's query parameters as `url.Values`.

type NetworkRouteNetworkDeleteParams 

type NetworkRouteNetworkDeleteParams struct {
	// Cloudflare account ID
	AccountID param.Field[string] `path:"account_id,required"`
	// The type of tunnel.
	TunType param.Field[NetworkRouteNetworkDeleteParamsTunType] `query:"tun_type"`
}

func (NetworkRouteNetworkDeleteParams) URLQuery 

func (r NetworkRouteNetworkDeleteParams) URLQuery() (v url.Values)

URLQuery serializes NetworkRouteNetworkDeleteParams's query parameters as `url.Values`.

type NetworkRouteNetworkDeleteParamsTunType 

type NetworkRouteNetworkDeleteParamsTunType string

The type of tunnel. 

const (
	NetworkRouteNetworkDeleteParamsTunTypeCfdTunnel     NetworkRouteNetworkDeleteParamsTunType = "cfd_tunnel"
	NetworkRouteNetworkDeleteParamsTunTypeWARPConnector NetworkRouteNetworkDeleteParamsTunType = "warp_connector"
	NetworkRouteNetworkDeleteParamsTunTypeIPSec         NetworkRouteNetworkDeleteParamsTunType = "ip_sec"
	NetworkRouteNetworkDeleteParamsTunTypeGRE           NetworkRouteNetworkDeleteParamsTunType = "gre"
	NetworkRouteNetworkDeleteParamsTunTypeCni           NetworkRouteNetworkDeleteParamsTunType = "cni"
)

type NetworkRouteNetworkDeleteResponseEnvelope 

type NetworkRouteNetworkDeleteResponseEnvelope struct {
	Errors   []NetworkRouteNetworkDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []NetworkRouteNetworkDeleteResponseEnvelopeMessages `json:"messages,required"`
	Result   TunnelRoute                                         `json:"result,required"`
	// Whether the API call was successful
	Success NetworkRouteNetworkDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    networkRouteNetworkDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*NetworkRouteNetworkDeleteResponseEnvelope) UnmarshalJSON 

func (r *NetworkRouteNetworkDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NetworkRouteNetworkDeleteResponseEnvelopeErrors 

type NetworkRouteNetworkDeleteResponseEnvelopeErrors struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    networkRouteNetworkDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*NetworkRouteNetworkDeleteResponseEnvelopeErrors) UnmarshalJSON 

func (r *NetworkRouteNetworkDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type NetworkRouteNetworkDeleteResponseEnvelopeMessages 

type NetworkRouteNetworkDeleteResponseEnvelopeMessages struct {
	Code    int64                                                 `json:"code,required"`
	Message string                                                `json:"message,required"`
	JSON    networkRouteNetworkDeleteResponseEnvelopeMessagesJSON `json:"-"`
}

func (*NetworkRouteNetworkDeleteResponseEnvelopeMessages) UnmarshalJSON 

func (r *NetworkRouteNetworkDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type NetworkRouteNetworkDeleteResponseEnvelopeSuccess 

type NetworkRouteNetworkDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	NetworkRouteNetworkDeleteResponseEnvelopeSuccessTrue NetworkRouteNetworkDeleteResponseEnvelopeSuccess = true
)

type NetworkRouteNetworkEditParams 

type NetworkRouteNetworkEditParams struct {
	// Cloudflare account ID
	AccountID param.Field[string] `path:"account_id,required"`
}

type NetworkRouteNetworkEditResponseEnvelope 

type NetworkRouteNetworkEditResponseEnvelope struct {
	Errors   []NetworkRouteNetworkEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []NetworkRouteNetworkEditResponseEnvelopeMessages `json:"messages,required"`
	Result   TunnelRoute                                       `json:"result,required"`
	// Whether the API call was successful
	Success NetworkRouteNetworkEditResponseEnvelopeSuccess `json:"success,required"`
	JSON    networkRouteNetworkEditResponseEnvelopeJSON    `json:"-"`
}

func (*NetworkRouteNetworkEditResponseEnvelope) UnmarshalJSON 

func (r *NetworkRouteNetworkEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NetworkRouteNetworkEditResponseEnvelopeErrors 

type NetworkRouteNetworkEditResponseEnvelopeErrors struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    networkRouteNetworkEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*NetworkRouteNetworkEditResponseEnvelopeErrors) UnmarshalJSON 

func (r *NetworkRouteNetworkEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type NetworkRouteNetworkEditResponseEnvelopeMessages 

type NetworkRouteNetworkEditResponseEnvelopeMessages struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    networkRouteNetworkEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*NetworkRouteNetworkEditResponseEnvelopeMessages) UnmarshalJSON 

func (r *NetworkRouteNetworkEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type NetworkRouteNetworkEditResponseEnvelopeSuccess 

type NetworkRouteNetworkEditResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	NetworkRouteNetworkEditResponseEnvelopeSuccessTrue NetworkRouteNetworkEditResponseEnvelopeSuccess = true
)

type NetworkRouteNetworkNewParams 

type NetworkRouteNetworkNewParams struct {
	// Cloudflare account ID
	AccountID param.Field[string] `path:"account_id,required"`
	// Optional remark describing the route.
	Comment param.Field[string] `json:"comment"`
	// UUID of the Tunnel Virtual Network this route belongs to. If no virtual networks
	// are configured, the route is assigned to the default virtual network of the
	// account.
	VirtualNetworkID param.Field[interface{}] `json:"virtual_network_id"`
}

func (NetworkRouteNetworkNewParams) MarshalJSON 

func (r NetworkRouteNetworkNewParams) MarshalJSON() (data []byte, err error)

type NetworkRouteNetworkNewResponseEnvelope 

type NetworkRouteNetworkNewResponseEnvelope struct {
	Errors   []NetworkRouteNetworkNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []NetworkRouteNetworkNewResponseEnvelopeMessages `json:"messages,required"`
	Result   TunnelRoute                                      `json:"result,required"`
	// Whether the API call was successful
	Success NetworkRouteNetworkNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    networkRouteNetworkNewResponseEnvelopeJSON    `json:"-"`
}

func (*NetworkRouteNetworkNewResponseEnvelope) UnmarshalJSON 

func (r *NetworkRouteNetworkNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NetworkRouteNetworkNewResponseEnvelopeErrors 

type NetworkRouteNetworkNewResponseEnvelopeErrors struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    networkRouteNetworkNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*NetworkRouteNetworkNewResponseEnvelopeErrors) UnmarshalJSON 

func (r *NetworkRouteNetworkNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type NetworkRouteNetworkNewResponseEnvelopeMessages 

type NetworkRouteNetworkNewResponseEnvelopeMessages struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    networkRouteNetworkNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*NetworkRouteNetworkNewResponseEnvelopeMessages) UnmarshalJSON 

func (r *NetworkRouteNetworkNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type NetworkRouteNetworkNewResponseEnvelopeSuccess 

type NetworkRouteNetworkNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	NetworkRouteNetworkNewResponseEnvelopeSuccessTrue NetworkRouteNetworkNewResponseEnvelopeSuccess = true
)

type NetworkRouteNetworkService 

type NetworkRouteNetworkService struct {
	Options []option.RequestOption
}

NetworkRouteNetworkService 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 NewNetworkRouteNetworkService method instead.

func NewNetworkRouteNetworkService 

func NewNetworkRouteNetworkService(opts ...option.RequestOption) (r *NetworkRouteNetworkService)

NewNetworkRouteNetworkService 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 (*NetworkRouteNetworkService) Delete 

func (r *NetworkRouteNetworkService) Delete(ctx context.Context, ipNetworkEncoded string, params NetworkRouteNetworkDeleteParams, opts ...option.RequestOption) (res *TunnelRoute, err error)

Deletes a private network route from an account. The CIDR in `ip_network_encoded` must be written in URL-encoded format. If no virtual_network_id is provided it will delete the route from the default vnet. If no tun_type is provided it will fetch the type from the tunnel_id or if that is missing it will assume Cloudflare Tunnel as default. If tunnel_id is provided it will delete the route from that tunnel, otherwise it will delete the route based on the vnet and tun_type.

func (*NetworkRouteNetworkService) Edit 

func (r *NetworkRouteNetworkService) Edit(ctx context.Context, ipNetworkEncoded string, body NetworkRouteNetworkEditParams, opts ...option.RequestOption) (res *TunnelRoute, err error)

Updates an existing private network route in an account. The CIDR in `ip_network_encoded` must be written in URL-encoded format.

func (*NetworkRouteNetworkService) New 

func (r *NetworkRouteNetworkService) New(ctx context.Context, ipNetworkEncoded string, params NetworkRouteNetworkNewParams, opts ...option.RequestOption) (res *TunnelRoute, err error)

Routes a private network through a Cloudflare Tunnel. The CIDR in `ip_network_encoded` must be written in URL-encoded format.

type NetworkRouteNewParams 

type NetworkRouteNewParams struct {
	// Cloudflare account ID
	AccountID param.Field[string] `path:"account_id,required"`
	// The private IPv4 or IPv6 range connected by the route, in CIDR notation.
	IPNetwork param.Field[string] `json:"ip_network,required"`
	// Optional remark describing the route.
	Comment param.Field[string] `json:"comment"`
	// UUID of the Tunnel Virtual Network this route belongs to. If no virtual networks
	// are configured, the route is assigned to the default virtual network of the
	// account.
	VirtualNetworkID param.Field[interface{}] `json:"virtual_network_id"`
}

func (NetworkRouteNewParams) MarshalJSON 

func (r NetworkRouteNewParams) MarshalJSON() (data []byte, err error)

type NetworkRouteNewResponseEnvelope 

type NetworkRouteNewResponseEnvelope struct {
	Errors   []NetworkRouteNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []NetworkRouteNewResponseEnvelopeMessages `json:"messages,required"`
	Result   TunnelRoute                               `json:"result,required"`
	// Whether the API call was successful
	Success NetworkRouteNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    networkRouteNewResponseEnvelopeJSON    `json:"-"`
}

func (*NetworkRouteNewResponseEnvelope) UnmarshalJSON 

func (r *NetworkRouteNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NetworkRouteNewResponseEnvelopeErrors 

type NetworkRouteNewResponseEnvelopeErrors struct {
	Code    int64                                     `json:"code,required"`
	Message string                                    `json:"message,required"`
	JSON    networkRouteNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*NetworkRouteNewResponseEnvelopeErrors) UnmarshalJSON 

func (r *NetworkRouteNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type NetworkRouteNewResponseEnvelopeMessages 

type NetworkRouteNewResponseEnvelopeMessages struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    networkRouteNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*NetworkRouteNewResponseEnvelopeMessages) UnmarshalJSON 

func (r *NetworkRouteNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type NetworkRouteNewResponseEnvelopeSuccess 

type NetworkRouteNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	NetworkRouteNewResponseEnvelopeSuccessTrue NetworkRouteNewResponseEnvelopeSuccess = true
)

type NetworkRouteService 

type NetworkRouteService struct {
	Options  []option.RequestOption
	IPs      *NetworkRouteIPService
	Networks *NetworkRouteNetworkService
}

NetworkRouteService 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 NewNetworkRouteService method instead.

func NewNetworkRouteService 

func NewNetworkRouteService(opts ...option.RequestOption) (r *NetworkRouteService)

NewNetworkRouteService 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 (*NetworkRouteService) Delete 

func (r *NetworkRouteService) Delete(ctx context.Context, routeID string, body NetworkRouteDeleteParams, opts ...option.RequestOption) (res *TunnelRoute, err error)

Deletes a private network route from an account.

func (*NetworkRouteService) Edit 

func (r *NetworkRouteService) Edit(ctx context.Context, routeID string, params NetworkRouteEditParams, opts ...option.RequestOption) (res *TunnelRoute, err error)

Updates an existing private network route in an account. The fields that are meant to be updated should be provided in the body of the request.

func (*NetworkRouteService) List 

func (r *NetworkRouteService) List(ctx context.Context, params NetworkRouteListParams, opts ...option.RequestOption) (res *shared.V4PagePaginationArray[TunnelTeamnet], err error)

Lists and filters private network routes in an account.

func (*NetworkRouteService) ListAutoPaging 

func (r *NetworkRouteService) ListAutoPaging(ctx context.Context, params NetworkRouteListParams, opts ...option.RequestOption) *shared.V4PagePaginationArrayAutoPager[TunnelTeamnet]

Lists and filters private network routes in an account.

func (*NetworkRouteService) New 

func (r *NetworkRouteService) New(ctx context.Context, params NetworkRouteNewParams, opts ...option.RequestOption) (res *TunnelRoute, err error)

Routes a private network through a Cloudflare Tunnel.

type NetworkService 

type NetworkService struct {
	Options         []option.RequestOption
	Routes          *NetworkRouteService
	VirtualNetworks *NetworkVirtualNetworkService
}

NetworkService 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 NewNetworkService method instead.

func NewNetworkService 

func NewNetworkService(opts ...option.RequestOption) (r *NetworkService)

NewNetworkService 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 NetworkVirtualNetworkDeleteParams 

type NetworkVirtualNetworkDeleteParams struct {
	// Cloudflare account ID
	AccountID param.Field[string] `path:"account_id,required"`
}

type NetworkVirtualNetworkDeleteResponse 

type NetworkVirtualNetworkDeleteResponse interface {
	ImplementsZeroTrustNetworkVirtualNetworkDeleteResponse()
}

Union satisfied by zero_trust.NetworkVirtualNetworkDeleteResponseUnknown, zero_trust.NetworkVirtualNetworkDeleteResponseArray or shared.UnionString.

type NetworkVirtualNetworkDeleteResponseArray 

type NetworkVirtualNetworkDeleteResponseArray []interface{}

func (NetworkVirtualNetworkDeleteResponseArray) ImplementsZeroTrustNetworkVirtualNetworkDeleteResponse 

func (r NetworkVirtualNetworkDeleteResponseArray) ImplementsZeroTrustNetworkVirtualNetworkDeleteResponse()

type NetworkVirtualNetworkDeleteResponseEnvelope 

type NetworkVirtualNetworkDeleteResponseEnvelope struct {
	Errors   []NetworkVirtualNetworkDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []NetworkVirtualNetworkDeleteResponseEnvelopeMessages `json:"messages,required"`
	Result   NetworkVirtualNetworkDeleteResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success NetworkVirtualNetworkDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    networkVirtualNetworkDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*NetworkVirtualNetworkDeleteResponseEnvelope) UnmarshalJSON 

func (r *NetworkVirtualNetworkDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NetworkVirtualNetworkDeleteResponseEnvelopeErrors 

type NetworkVirtualNetworkDeleteResponseEnvelopeErrors struct {
	Code    int64                                                 `json:"code,required"`
	Message string                                                `json:"message,required"`
	JSON    networkVirtualNetworkDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*NetworkVirtualNetworkDeleteResponseEnvelopeErrors) UnmarshalJSON 

func (r *NetworkVirtualNetworkDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type NetworkVirtualNetworkDeleteResponseEnvelopeMessages 

type NetworkVirtualNetworkDeleteResponseEnvelopeMessages struct {
	Code    int64                                                   `json:"code,required"`
	Message string                                                  `json:"message,required"`
	JSON    networkVirtualNetworkDeleteResponseEnvelopeMessagesJSON `json:"-"`
}

func (*NetworkVirtualNetworkDeleteResponseEnvelopeMessages) UnmarshalJSON 

func (r *NetworkVirtualNetworkDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type NetworkVirtualNetworkDeleteResponseEnvelopeSuccess 

type NetworkVirtualNetworkDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	NetworkVirtualNetworkDeleteResponseEnvelopeSuccessTrue NetworkVirtualNetworkDeleteResponseEnvelopeSuccess = true
)

type NetworkVirtualNetworkEditParams 

type NetworkVirtualNetworkEditParams struct {
	// Cloudflare account ID
	AccountID param.Field[string] `path:"account_id,required"`
	// Optional remark describing the virtual network.
	Comment param.Field[string] `json:"comment"`
	// If `true`, this virtual network is the default for the account.
	IsDefaultNetwork param.Field[bool] `json:"is_default_network"`
	// A user-friendly name for the virtual network.
	Name param.Field[string] `json:"name"`
}

func (NetworkVirtualNetworkEditParams) MarshalJSON 

func (r NetworkVirtualNetworkEditParams) MarshalJSON() (data []byte, err error)

type NetworkVirtualNetworkEditResponse 

type NetworkVirtualNetworkEditResponse interface {
	ImplementsZeroTrustNetworkVirtualNetworkEditResponse()
}

Union satisfied by zero_trust.NetworkVirtualNetworkEditResponseUnknown, zero_trust.NetworkVirtualNetworkEditResponseArray or shared.UnionString.

type NetworkVirtualNetworkEditResponseArray 

type NetworkVirtualNetworkEditResponseArray []interface{}

func (NetworkVirtualNetworkEditResponseArray) ImplementsZeroTrustNetworkVirtualNetworkEditResponse 

func (r NetworkVirtualNetworkEditResponseArray) ImplementsZeroTrustNetworkVirtualNetworkEditResponse()

type NetworkVirtualNetworkEditResponseEnvelope 

type NetworkVirtualNetworkEditResponseEnvelope struct {
	Errors   []NetworkVirtualNetworkEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []NetworkVirtualNetworkEditResponseEnvelopeMessages `json:"messages,required"`
	Result   NetworkVirtualNetworkEditResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success NetworkVirtualNetworkEditResponseEnvelopeSuccess `json:"success,required"`
	JSON    networkVirtualNetworkEditResponseEnvelopeJSON    `json:"-"`
}

func (*NetworkVirtualNetworkEditResponseEnvelope) UnmarshalJSON 

func (r *NetworkVirtualNetworkEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NetworkVirtualNetworkEditResponseEnvelopeErrors 

type NetworkVirtualNetworkEditResponseEnvelopeErrors struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    networkVirtualNetworkEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*NetworkVirtualNetworkEditResponseEnvelopeErrors) UnmarshalJSON 

func (r *NetworkVirtualNetworkEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type NetworkVirtualNetworkEditResponseEnvelopeMessages 

type NetworkVirtualNetworkEditResponseEnvelopeMessages struct {
	Code    int64                                                 `json:"code,required"`
	Message string                                                `json:"message,required"`
	JSON    networkVirtualNetworkEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*NetworkVirtualNetworkEditResponseEnvelopeMessages) UnmarshalJSON 

func (r *NetworkVirtualNetworkEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type NetworkVirtualNetworkEditResponseEnvelopeSuccess 

type NetworkVirtualNetworkEditResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	NetworkVirtualNetworkEditResponseEnvelopeSuccessTrue NetworkVirtualNetworkEditResponseEnvelopeSuccess = true
)

type NetworkVirtualNetworkListParams 

type NetworkVirtualNetworkListParams struct {
	// Cloudflare account ID
	AccountID param.Field[string] `path:"account_id,required"`
	// If `true`, only include the default virtual network. If `false`, exclude the
	// default virtual network. If empty, all virtual networks will be included.
	IsDefault param.Field[interface{}] `query:"is_default"`
	// If `true`, only include deleted virtual networks. If `false`, exclude deleted
	// virtual networks. If empty, all virtual networks will be included.
	IsDeleted param.Field[interface{}] `query:"is_deleted"`
	// A user-friendly name for the virtual network.
	Name param.Field[string] `query:"name"`
	// A user-friendly name for the virtual network.
	VnetName param.Field[string] `query:"vnet_name"`
}

func (NetworkVirtualNetworkListParams) URLQuery 

func (r NetworkVirtualNetworkListParams) URLQuery() (v url.Values)

URLQuery serializes NetworkVirtualNetworkListParams's query parameters as `url.Values`.

type NetworkVirtualNetworkListResponseEnvelope 

type NetworkVirtualNetworkListResponseEnvelope struct {
	Errors   []NetworkVirtualNetworkListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []NetworkVirtualNetworkListResponseEnvelopeMessages `json:"messages,required"`
	Result   []TunnelVirtualNetwork                              `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    NetworkVirtualNetworkListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo NetworkVirtualNetworkListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       networkVirtualNetworkListResponseEnvelopeJSON       `json:"-"`
}

func (*NetworkVirtualNetworkListResponseEnvelope) UnmarshalJSON 

func (r *NetworkVirtualNetworkListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NetworkVirtualNetworkListResponseEnvelopeErrors 

type NetworkVirtualNetworkListResponseEnvelopeErrors struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    networkVirtualNetworkListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*NetworkVirtualNetworkListResponseEnvelopeErrors) UnmarshalJSON 

func (r *NetworkVirtualNetworkListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type NetworkVirtualNetworkListResponseEnvelopeMessages 

type NetworkVirtualNetworkListResponseEnvelopeMessages struct {
	Code    int64                                                 `json:"code,required"`
	Message string                                                `json:"message,required"`
	JSON    networkVirtualNetworkListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*NetworkVirtualNetworkListResponseEnvelopeMessages) UnmarshalJSON 

func (r *NetworkVirtualNetworkListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type NetworkVirtualNetworkListResponseEnvelopeResultInfo 

type NetworkVirtualNetworkListResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                                 `json:"total_count"`
	JSON       networkVirtualNetworkListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*NetworkVirtualNetworkListResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *NetworkVirtualNetworkListResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type NetworkVirtualNetworkListResponseEnvelopeSuccess 

type NetworkVirtualNetworkListResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	NetworkVirtualNetworkListResponseEnvelopeSuccessTrue NetworkVirtualNetworkListResponseEnvelopeSuccess = true
)

type NetworkVirtualNetworkNewParams 

type NetworkVirtualNetworkNewParams struct {
	// Cloudflare account ID
	AccountID param.Field[string] `path:"account_id,required"`
	// A user-friendly name for the virtual network.
	Name param.Field[string] `json:"name,required"`
	// Optional remark describing the virtual network.
	Comment param.Field[string] `json:"comment"`
	// If `true`, this virtual network is the default for the account.
	IsDefault param.Field[bool] `json:"is_default"`
}

func (NetworkVirtualNetworkNewParams) MarshalJSON 

func (r NetworkVirtualNetworkNewParams) MarshalJSON() (data []byte, err error)

type NetworkVirtualNetworkNewResponse 

type NetworkVirtualNetworkNewResponse interface {
	ImplementsZeroTrustNetworkVirtualNetworkNewResponse()
}

Union satisfied by zero_trust.NetworkVirtualNetworkNewResponseUnknown, zero_trust.NetworkVirtualNetworkNewResponseArray or shared.UnionString.

type NetworkVirtualNetworkNewResponseArray 

type NetworkVirtualNetworkNewResponseArray []interface{}

func (NetworkVirtualNetworkNewResponseArray) ImplementsZeroTrustNetworkVirtualNetworkNewResponse 

func (r NetworkVirtualNetworkNewResponseArray) ImplementsZeroTrustNetworkVirtualNetworkNewResponse()

type NetworkVirtualNetworkNewResponseEnvelope 

type NetworkVirtualNetworkNewResponseEnvelope struct {
	Errors   []NetworkVirtualNetworkNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []NetworkVirtualNetworkNewResponseEnvelopeMessages `json:"messages,required"`
	Result   NetworkVirtualNetworkNewResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success NetworkVirtualNetworkNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    networkVirtualNetworkNewResponseEnvelopeJSON    `json:"-"`
}

func (*NetworkVirtualNetworkNewResponseEnvelope) UnmarshalJSON 

func (r *NetworkVirtualNetworkNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NetworkVirtualNetworkNewResponseEnvelopeErrors 

type NetworkVirtualNetworkNewResponseEnvelopeErrors struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    networkVirtualNetworkNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*NetworkVirtualNetworkNewResponseEnvelopeErrors) UnmarshalJSON 

func (r *NetworkVirtualNetworkNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type NetworkVirtualNetworkNewResponseEnvelopeMessages 

type NetworkVirtualNetworkNewResponseEnvelopeMessages struct {
	Code    int64                                                `json:"code,required"`
	Message string                                               `json:"message,required"`
	JSON    networkVirtualNetworkNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*NetworkVirtualNetworkNewResponseEnvelopeMessages) UnmarshalJSON 

func (r *NetworkVirtualNetworkNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type NetworkVirtualNetworkNewResponseEnvelopeSuccess 

type NetworkVirtualNetworkNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	NetworkVirtualNetworkNewResponseEnvelopeSuccessTrue NetworkVirtualNetworkNewResponseEnvelopeSuccess = true
)

type NetworkVirtualNetworkService 

type NetworkVirtualNetworkService struct {
	Options []option.RequestOption
}

NetworkVirtualNetworkService 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 NewNetworkVirtualNetworkService method instead.

func NewNetworkVirtualNetworkService 

func NewNetworkVirtualNetworkService(opts ...option.RequestOption) (r *NetworkVirtualNetworkService)

NewNetworkVirtualNetworkService 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 (*NetworkVirtualNetworkService) Delete 

func (r *NetworkVirtualNetworkService) Delete(ctx context.Context, virtualNetworkID string, body NetworkVirtualNetworkDeleteParams, opts ...option.RequestOption) (res *NetworkVirtualNetworkDeleteResponse, err error)

Deletes an existing virtual network.

func (*NetworkVirtualNetworkService) Edit 

func (r *NetworkVirtualNetworkService) Edit(ctx context.Context, virtualNetworkID string, params NetworkVirtualNetworkEditParams, opts ...option.RequestOption) (res *NetworkVirtualNetworkEditResponse, err error)

Updates an existing virtual network.

func (*NetworkVirtualNetworkService) List 

func (r *NetworkVirtualNetworkService) List(ctx context.Context, params NetworkVirtualNetworkListParams, opts ...option.RequestOption) (res *[]TunnelVirtualNetwork, err error)

Lists and filters virtual networks in an account.

func (*NetworkVirtualNetworkService) New 

func (r *NetworkVirtualNetworkService) New(ctx context.Context, params NetworkVirtualNetworkNewParams, opts ...option.RequestOption) (res *NetworkVirtualNetworkNewResponse, err error)

Adds a new virtual network to an account.

type OrganizationListParams 

type OrganizationListParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type OrganizationListResponseEnvelope 

type OrganizationListResponseEnvelope struct {
	Errors   []OrganizationListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []OrganizationListResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessOrganizations                        `json:"result,required"`
	// Whether the API call was successful
	Success OrganizationListResponseEnvelopeSuccess `json:"success,required"`
	JSON    organizationListResponseEnvelopeJSON    `json:"-"`
}

func (*OrganizationListResponseEnvelope) UnmarshalJSON 

func (r *OrganizationListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type OrganizationListResponseEnvelopeErrors 

type OrganizationListResponseEnvelopeErrors struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    organizationListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*OrganizationListResponseEnvelopeErrors) UnmarshalJSON 

func (r *OrganizationListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type OrganizationListResponseEnvelopeMessages 

type OrganizationListResponseEnvelopeMessages struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    organizationListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*OrganizationListResponseEnvelopeMessages) UnmarshalJSON 

func (r *OrganizationListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type OrganizationListResponseEnvelopeSuccess 

type OrganizationListResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	OrganizationListResponseEnvelopeSuccessTrue OrganizationListResponseEnvelopeSuccess = true
)

type OrganizationNewParams 

type OrganizationNewParams struct {
	// The unique subdomain assigned to your Zero Trust organization.
	AuthDomain param.Field[string] `json:"auth_domain,required"`
	// The name of your Zero Trust organization.
	Name param.Field[string] `json:"name,required"`
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
	// When set to true, users can authenticate via WARP for any application in your
	// organization. Application settings will take precedence over this value.
	AllowAuthenticateViaWARP param.Field[bool] `json:"allow_authenticate_via_warp"`
	// When set to `true`, users skip the identity provider selection step during
	// login.
	AutoRedirectToIdentity param.Field[bool] `json:"auto_redirect_to_identity"`
	// Lock all settings as Read-Only in the Dashboard, regardless of user permission.
	// Updates may only be made via the API or Terraform for this account when enabled.
	IsUiReadOnly param.Field[bool]                             `json:"is_ui_read_only"`
	LoginDesign  param.Field[OrganizationNewParamsLoginDesign] `json:"login_design"`
	// The amount of time that tokens issued for applications will be valid. Must be in
	// the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m,
	// h.
	SessionDuration param.Field[string] `json:"session_duration"`
	// A description of the reason why the UI read only field is being toggled.
	UiReadOnlyToggleReason param.Field[string] `json:"ui_read_only_toggle_reason"`
	// The amount of time a user seat is inactive before it expires. When the user seat
	// exceeds the set time of inactivity, the user is removed as an active seat and no
	// longer counts against your Teams seat count. Must be in the format `300ms` or
	// `2h45m`. Valid time units are: `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`.
	UserSeatExpirationInactiveTime param.Field[string] `json:"user_seat_expiration_inactive_time"`
	// The amount of time that tokens issued for applications will be valid. Must be in
	// the format `30m` or `2h45m`. Valid time units are: m, h.
	WARPAuthSessionDuration param.Field[string] `json:"warp_auth_session_duration"`
}

func (OrganizationNewParams) MarshalJSON 

func (r OrganizationNewParams) MarshalJSON() (data []byte, err error)

type OrganizationNewParamsLoginDesign 

type OrganizationNewParamsLoginDesign struct {
	// The background color on your login page.
	BackgroundColor param.Field[string] `json:"background_color"`
	// The text at the bottom of your login page.
	FooterText param.Field[string] `json:"footer_text"`
	// The text at the top of your login page.
	HeaderText param.Field[string] `json:"header_text"`
	// The URL of the logo on your login page.
	LogoPath param.Field[string] `json:"logo_path"`
	// The text color on your login page.
	TextColor param.Field[string] `json:"text_color"`
}

func (OrganizationNewParamsLoginDesign) MarshalJSON 

func (r OrganizationNewParamsLoginDesign) MarshalJSON() (data []byte, err error)

type OrganizationNewResponseEnvelope 

type OrganizationNewResponseEnvelope struct {
	Errors   []OrganizationNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []OrganizationNewResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessOrganizations                       `json:"result,required"`
	// Whether the API call was successful
	Success OrganizationNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    organizationNewResponseEnvelopeJSON    `json:"-"`
}

func (*OrganizationNewResponseEnvelope) UnmarshalJSON 

func (r *OrganizationNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type OrganizationNewResponseEnvelopeErrors 

type OrganizationNewResponseEnvelopeErrors struct {
	Code    int64                                     `json:"code,required"`
	Message string                                    `json:"message,required"`
	JSON    organizationNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*OrganizationNewResponseEnvelopeErrors) UnmarshalJSON 

func (r *OrganizationNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type OrganizationNewResponseEnvelopeMessages 

type OrganizationNewResponseEnvelopeMessages struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    organizationNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*OrganizationNewResponseEnvelopeMessages) UnmarshalJSON 

func (r *OrganizationNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type OrganizationNewResponseEnvelopeSuccess 

type OrganizationNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	OrganizationNewResponseEnvelopeSuccessTrue OrganizationNewResponseEnvelopeSuccess = true
)

type OrganizationRevokeUsersParams 

type OrganizationRevokeUsersParams struct {
	// The email of the user to revoke.
	Email param.Field[string] `json:"email,required"`
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

func (OrganizationRevokeUsersParams) MarshalJSON 

func (r OrganizationRevokeUsersParams) MarshalJSON() (data []byte, err error)

type OrganizationRevokeUsersResponse 

type OrganizationRevokeUsersResponse bool
const (
	OrganizationRevokeUsersResponseTrue  OrganizationRevokeUsersResponse = true
	OrganizationRevokeUsersResponseFalse OrganizationRevokeUsersResponse = false
)

type OrganizationRevokeUsersResponseEnvelope 

type OrganizationRevokeUsersResponseEnvelope struct {
	Result  OrganizationRevokeUsersResponse                `json:"result"`
	Success OrganizationRevokeUsersResponseEnvelopeSuccess `json:"success"`
	JSON    organizationRevokeUsersResponseEnvelopeJSON    `json:"-"`
}

func (*OrganizationRevokeUsersResponseEnvelope) UnmarshalJSON 

func (r *OrganizationRevokeUsersResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type OrganizationRevokeUsersResponseEnvelopeSuccess 

type OrganizationRevokeUsersResponseEnvelopeSuccess bool
const (
	OrganizationRevokeUsersResponseEnvelopeSuccessTrue  OrganizationRevokeUsersResponseEnvelopeSuccess = true
	OrganizationRevokeUsersResponseEnvelopeSuccessFalse OrganizationRevokeUsersResponseEnvelopeSuccess = false
)

type OrganizationService 

type OrganizationService struct {
	Options []option.RequestOption
}

OrganizationService contains methods and other services that help with interacting with the cloudflare API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewOrganizationService method instead.

func NewOrganizationService 

func NewOrganizationService(opts ...option.RequestOption) (r *OrganizationService)

NewOrganizationService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*OrganizationService) List 

func (r *OrganizationService) List(ctx context.Context, query OrganizationListParams, opts ...option.RequestOption) (res *AccessOrganizations, err error)

Returns the configuration for your Zero Trust organization.

func (*OrganizationService) New 

func (r *OrganizationService) New(ctx context.Context, params OrganizationNewParams, opts ...option.RequestOption) (res *AccessOrganizations, err error)

Sets up a Zero Trust organization for your account or zone.

func (*OrganizationService) RevokeUsers 

func (r *OrganizationService) RevokeUsers(ctx context.Context, params OrganizationRevokeUsersParams, opts ...option.RequestOption) (res *OrganizationRevokeUsersResponse, err error)

Revokes a user's access across all applications.

func (*OrganizationService) Update 

func (r *OrganizationService) Update(ctx context.Context, params OrganizationUpdateParams, opts ...option.RequestOption) (res *AccessOrganizations, err error)

Updates the configuration for your Zero Trust organization.

type OrganizationUpdateParams 

type OrganizationUpdateParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
	// When set to true, users can authenticate via WARP for any application in your
	// organization. Application settings will take precedence over this value.
	AllowAuthenticateViaWARP param.Field[bool] `json:"allow_authenticate_via_warp"`
	// The unique subdomain assigned to your Zero Trust organization.
	AuthDomain param.Field[string] `json:"auth_domain"`
	// When set to `true`, users skip the identity provider selection step during
	// login.
	AutoRedirectToIdentity param.Field[bool]                                `json:"auto_redirect_to_identity"`
	CustomPages            param.Field[OrganizationUpdateParamsCustomPages] `json:"custom_pages"`
	// Lock all settings as Read-Only in the Dashboard, regardless of user permission.
	// Updates may only be made via the API or Terraform for this account when enabled.
	IsUiReadOnly param.Field[bool]                                `json:"is_ui_read_only"`
	LoginDesign  param.Field[OrganizationUpdateParamsLoginDesign] `json:"login_design"`
	// The name of your Zero Trust organization.
	Name param.Field[string] `json:"name"`
	// The amount of time that tokens issued for applications will be valid. Must be in
	// the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m,
	// h.
	SessionDuration param.Field[string] `json:"session_duration"`
	// A description of the reason why the UI read only field is being toggled.
	UiReadOnlyToggleReason param.Field[string] `json:"ui_read_only_toggle_reason"`
	// The amount of time a user seat is inactive before it expires. When the user seat
	// exceeds the set time of inactivity, the user is removed as an active seat and no
	// longer counts against your Teams seat count. Must be in the format `300ms` or
	// `2h45m`. Valid time units are: `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`.
	UserSeatExpirationInactiveTime param.Field[string] `json:"user_seat_expiration_inactive_time"`
	// The amount of time that tokens issued for applications will be valid. Must be in
	// the format `30m` or `2h45m`. Valid time units are: m, h.
	WARPAuthSessionDuration param.Field[string] `json:"warp_auth_session_duration"`
}

func (OrganizationUpdateParams) MarshalJSON 

func (r OrganizationUpdateParams) MarshalJSON() (data []byte, err error)

type OrganizationUpdateParamsCustomPages 

type OrganizationUpdateParamsCustomPages struct {
	// The uid of the custom page to use when a user is denied access after failing a
	// non-identity rule.
	Forbidden param.Field[string] `json:"forbidden"`
	// The uid of the custom page to use when a user is denied access.
	IdentityDenied param.Field[string] `json:"identity_denied"`
}

func (OrganizationUpdateParamsCustomPages) MarshalJSON 

func (r OrganizationUpdateParamsCustomPages) MarshalJSON() (data []byte, err error)

type OrganizationUpdateParamsLoginDesign 

type OrganizationUpdateParamsLoginDesign struct {
	// The background color on your login page.
	BackgroundColor param.Field[string] `json:"background_color"`
	// The text at the bottom of your login page.
	FooterText param.Field[string] `json:"footer_text"`
	// The text at the top of your login page.
	HeaderText param.Field[string] `json:"header_text"`
	// The URL of the logo on your login page.
	LogoPath param.Field[string] `json:"logo_path"`
	// The text color on your login page.
	TextColor param.Field[string] `json:"text_color"`
}

func (OrganizationUpdateParamsLoginDesign) MarshalJSON 

func (r OrganizationUpdateParamsLoginDesign) MarshalJSON() (data []byte, err error)

type OrganizationUpdateResponseEnvelope 

type OrganizationUpdateResponseEnvelope struct {
	Errors   []OrganizationUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []OrganizationUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   AccessOrganizations                          `json:"result,required"`
	// Whether the API call was successful
	Success OrganizationUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    organizationUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*OrganizationUpdateResponseEnvelope) UnmarshalJSON 

func (r *OrganizationUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type OrganizationUpdateResponseEnvelopeErrors 

type OrganizationUpdateResponseEnvelopeErrors struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    organizationUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*OrganizationUpdateResponseEnvelopeErrors) UnmarshalJSON 

func (r *OrganizationUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type OrganizationUpdateResponseEnvelopeMessages 

type OrganizationUpdateResponseEnvelopeMessages struct {
	Code    int64                                          `json:"code,required"`
	Message string                                         `json:"message,required"`
	JSON    organizationUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*OrganizationUpdateResponseEnvelopeMessages) UnmarshalJSON 

func (r *OrganizationUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type OrganizationUpdateResponseEnvelopeSuccess 

type OrganizationUpdateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	OrganizationUpdateResponseEnvelopeSuccessTrue OrganizationUpdateResponseEnvelopeSuccess = true
)

type SeatEditParams 

type SeatEditParams struct {
	Body param.Field[[]SeatEditParamsBody] `json:"body,required"`
}

func (SeatEditParams) MarshalJSON 

func (r SeatEditParams) MarshalJSON() (data []byte, err error)

type SeatEditParamsBody 

type SeatEditParamsBody struct {
	// True if the seat is part of Access.
	AccessSeat param.Field[bool] `json:"access_seat,required"`
	// True if the seat is part of Gateway.
	GatewaySeat param.Field[bool] `json:"gateway_seat,required"`
}

func (SeatEditParamsBody) MarshalJSON 

func (r SeatEditParamsBody) MarshalJSON() (data []byte, err error)

type SeatEditResponseEnvelope 

type SeatEditResponseEnvelope struct {
	Errors   []SeatEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SeatEditResponseEnvelopeMessages `json:"messages,required"`
	Result   []AccessSeats                      `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    SeatEditResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo SeatEditResponseEnvelopeResultInfo `json:"result_info"`
	JSON       seatEditResponseEnvelopeJSON       `json:"-"`
}

func (*SeatEditResponseEnvelope) UnmarshalJSON 

func (r *SeatEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SeatEditResponseEnvelopeErrors 

type SeatEditResponseEnvelopeErrors struct {
	Code    int64                              `json:"code,required"`
	Message string                             `json:"message,required"`
	JSON    seatEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SeatEditResponseEnvelopeErrors) UnmarshalJSON 

func (r *SeatEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type SeatEditResponseEnvelopeMessages 

type SeatEditResponseEnvelopeMessages struct {
	Code    int64                                `json:"code,required"`
	Message string                               `json:"message,required"`
	JSON    seatEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SeatEditResponseEnvelopeMessages) UnmarshalJSON 

func (r *SeatEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type SeatEditResponseEnvelopeResultInfo 

type SeatEditResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                `json:"total_count"`
	JSON       seatEditResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*SeatEditResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *SeatEditResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type SeatEditResponseEnvelopeSuccess 

type SeatEditResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	SeatEditResponseEnvelopeSuccessTrue SeatEditResponseEnvelopeSuccess = true
)

type SeatService 

type SeatService struct {
	Options []option.RequestOption
}

SeatService 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 NewSeatService method instead.

func NewSeatService 

func NewSeatService(opts ...option.RequestOption) (r *SeatService)

NewSeatService 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 (*SeatService) Edit 

func (r *SeatService) Edit(ctx context.Context, identifier string, body SeatEditParams, opts ...option.RequestOption) (res *[]AccessSeats, err error)

Removes a user from a Zero Trust seat when both `access_seat` and `gateway_seat` are set to false.

type TeamsDevicesDeviceDEXTestSchemasHTTP 

type TeamsDevicesDeviceDEXTestSchemasHTTP struct {
	// The configuration object which contains the details for the WARP client to
	// conduct the test.
	Data TeamsDevicesDeviceDEXTestSchemasHTTPData `json:"data,required"`
	// Determines whether or not the test is active.
	Enabled bool `json:"enabled,required"`
	// How often the test will run.
	Interval string `json:"interval,required"`
	// The name of the DEX test. Must be unique.
	Name string `json:"name,required"`
	// Additional details about the test.
	Description string                                   `json:"description"`
	JSON        teamsDevicesDeviceDEXTestSchemasHTTPJSON `json:"-"`
}

func (*TeamsDevicesDeviceDEXTestSchemasHTTP) UnmarshalJSON 

func (r *TeamsDevicesDeviceDEXTestSchemasHTTP) UnmarshalJSON(data []byte) (err error)

type TeamsDevicesDeviceDEXTestSchemasHTTPData 

type TeamsDevicesDeviceDEXTestSchemasHTTPData struct {
	// The desired endpoint to test.
	Host string `json:"host"`
	// The type of test.
	Kind string `json:"kind"`
	// The HTTP request method type.
	Method string                                       `json:"method"`
	JSON   teamsDevicesDeviceDEXTestSchemasHTTPDataJSON `json:"-"`
}

The configuration object which contains the details for the WARP client to conduct the test.

func (*TeamsDevicesDeviceDEXTestSchemasHTTPData) UnmarshalJSON 

func (r *TeamsDevicesDeviceDEXTestSchemasHTTPData) UnmarshalJSON(data []byte) (err error)

type TeamsDevicesDeviceManagedNetworks 

type TeamsDevicesDeviceManagedNetworks struct {
	// The configuration object containing information for the WARP client to detect
	// the managed network.
	Config TeamsDevicesDeviceManagedNetworksConfig `json:"config"`
	// The name of the device managed network. This name must be unique.
	Name string `json:"name"`
	// API UUID.
	NetworkID string `json:"network_id"`
	// The type of device managed network.
	Type TeamsDevicesDeviceManagedNetworksType `json:"type"`
	JSON teamsDevicesDeviceManagedNetworksJSON `json:"-"`
}

func (*TeamsDevicesDeviceManagedNetworks) UnmarshalJSON 

func (r *TeamsDevicesDeviceManagedNetworks) UnmarshalJSON(data []byte) (err error)

type TeamsDevicesDeviceManagedNetworksConfig 

type TeamsDevicesDeviceManagedNetworksConfig struct {
	// A network address of the form "host:port" that the WARP client will use to
	// detect the presence of a TLS host.
	TLSSockaddr string `json:"tls_sockaddr,required"`
	// The SHA-256 hash of the TLS certificate presented by the host found at
	// tls_sockaddr. If absent, regular certificate verification (trusted roots, valid
	// timestamp, etc) will be used to validate the certificate.
	Sha256 string                                      `json:"sha256"`
	JSON   teamsDevicesDeviceManagedNetworksConfigJSON `json:"-"`
}

The configuration object containing information for the WARP client to detect the managed network.

func (*TeamsDevicesDeviceManagedNetworksConfig) UnmarshalJSON 

func (r *TeamsDevicesDeviceManagedNetworksConfig) UnmarshalJSON(data []byte) (err error)

type TeamsDevicesDeviceManagedNetworksType 

type TeamsDevicesDeviceManagedNetworksType string

The type of device managed network. 

const (
	TeamsDevicesDeviceManagedNetworksTypeTLS TeamsDevicesDeviceManagedNetworksType = "tls"
)

type TeamsDevicesDevicePostureIntegrations 

type TeamsDevicesDevicePostureIntegrations struct {
	// API UUID.
	ID string `json:"id"`
	// The configuration object containing third-party integration information.
	Config TeamsDevicesDevicePostureIntegrationsConfig `json:"config"`
	// The interval between each posture check with the third-party API. Use `m` for
	// minutes (e.g. `5m`) and `h` for hours (e.g. `12h`).
	Interval string `json:"interval"`
	// The name of the device posture integration.
	Name string `json:"name"`
	// The type of device posture integration.
	Type TeamsDevicesDevicePostureIntegrationsType `json:"type"`
	JSON teamsDevicesDevicePostureIntegrationsJSON `json:"-"`
}

func (*TeamsDevicesDevicePostureIntegrations) UnmarshalJSON 

func (r *TeamsDevicesDevicePostureIntegrations) UnmarshalJSON(data []byte) (err error)

type TeamsDevicesDevicePostureIntegrationsConfig 

type TeamsDevicesDevicePostureIntegrationsConfig struct {
	// The Workspace One API URL provided in the Workspace One Admin Dashboard.
	APIURL string `json:"api_url,required"`
	// The Workspace One Authorization URL depending on your region.
	AuthURL string `json:"auth_url,required"`
	// The Workspace One client ID provided in the Workspace One Admin Dashboard.
	ClientID string                                          `json:"client_id,required"`
	JSON     teamsDevicesDevicePostureIntegrationsConfigJSON `json:"-"`
}

The configuration object containing third-party integration information.

func (*TeamsDevicesDevicePostureIntegrationsConfig) UnmarshalJSON 

func (r *TeamsDevicesDevicePostureIntegrationsConfig) UnmarshalJSON(data []byte) (err error)

type TeamsDevicesDevicePostureIntegrationsType 

type TeamsDevicesDevicePostureIntegrationsType string

The type of device posture integration. 

const (
	TeamsDevicesDevicePostureIntegrationsTypeWorkspaceOne   TeamsDevicesDevicePostureIntegrationsType = "workspace_one"
	TeamsDevicesDevicePostureIntegrationsTypeCrowdstrikeS2s TeamsDevicesDevicePostureIntegrationsType = "crowdstrike_s2s"
	TeamsDevicesDevicePostureIntegrationsTypeUptycs         TeamsDevicesDevicePostureIntegrationsType = "uptycs"
	TeamsDevicesDevicePostureIntegrationsTypeIntune         TeamsDevicesDevicePostureIntegrationsType = "intune"
	TeamsDevicesDevicePostureIntegrationsTypeKolide         TeamsDevicesDevicePostureIntegrationsType = "kolide"
	TeamsDevicesDevicePostureIntegrationsTypeTanium         TeamsDevicesDevicePostureIntegrationsType = "tanium"
	TeamsDevicesDevicePostureIntegrationsTypeSentineloneS2s TeamsDevicesDevicePostureIntegrationsType = "sentinelone_s2s"
)

type TeamsDevicesDevicePostureRules 

type TeamsDevicesDevicePostureRules struct {
	// API UUID.
	ID string `json:"id"`
	// The description of the device posture rule.
	Description string `json:"description"`
	// Sets the expiration time for a posture check result. If empty, the result
	// remains valid until it is overwritten by new data from the WARP client.
	Expiration string `json:"expiration"`
	// The value to be checked against.
	Input TeamsDevicesDevicePostureRulesInput `json:"input"`
	// The conditions that the client must match to run the rule.
	Match []TeamsDevicesDevicePostureRulesMatch `json:"match"`
	// The name of the device posture rule.
	Name string `json:"name"`
	// Polling frequency for the WARP client posture check. Default: `5m` (poll every
	// five minutes). Minimum: `1m`.
	Schedule string `json:"schedule"`
	// The type of device posture rule.
	Type TeamsDevicesDevicePostureRulesType `json:"type"`
	JSON teamsDevicesDevicePostureRulesJSON `json:"-"`
}

func (*TeamsDevicesDevicePostureRules) UnmarshalJSON 

func (r *TeamsDevicesDevicePostureRules) UnmarshalJSON(data []byte) (err error)

type TeamsDevicesDevicePostureRulesInput 

type TeamsDevicesDevicePostureRulesInput interface {
	// contains filtered or unexported methods
}

The value to be checked against.

Union satisfied by zero_trust.TeamsDevicesDevicePostureRulesInputTeamsDevicesFileInputRequest, zero_trust.TeamsDevicesDevicePostureRulesInputTeamsDevicesUniqueClientIDInputRequest, zero_trust.TeamsDevicesDevicePostureRulesInputTeamsDevicesDomainJoinedInputRequest, zero_trust.TeamsDevicesDevicePostureRulesInputTeamsDevicesOSVersionInputRequest, zero_trust.TeamsDevicesDevicePostureRulesInputTeamsDevicesFirewallInputRequest, zero_trust.TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneInputRequest, zero_trust.TeamsDevicesDevicePostureRulesInputTeamsDevicesCarbonblackInputRequest, zero_trust.TeamsDevicesDevicePostureRulesInputTeamsDevicesDiskEncryptionInputRequest, zero_trust.TeamsDevicesDevicePostureRulesInputTeamsDevicesApplicationInputRequest, zero_trust.TeamsDevicesDevicePostureRulesInputTeamsDevicesClientCertificateInputRequest, zero_trust.TeamsDevicesDevicePostureRulesInputTeamsDevicesWorkspaceOneInputRequest, zero_trust.TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequest, zero_trust.TeamsDevicesDevicePostureRulesInputTeamsDevicesIntuneInputRequest, zero_trust.TeamsDevicesDevicePostureRulesInputTeamsDevicesKolideInputRequest, zero_trust.TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequest or zero_trust.TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneS2sInputRequest.

type TeamsDevicesDevicePostureRulesInputTeamsDevicesApplicationInputRequest 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesApplicationInputRequest struct {
	// Operating system
	OperatingSystem TeamsDevicesDevicePostureRulesInputTeamsDevicesApplicationInputRequestOperatingSystem `json:"operating_system,required"`
	// Path for the application.
	Path string `json:"path,required"`
	// SHA-256.
	Sha256 string `json:"sha256"`
	// Signing certificate thumbprint.
	Thumbprint string                                                                     `json:"thumbprint"`
	JSON       teamsDevicesDevicePostureRulesInputTeamsDevicesApplicationInputRequestJSON `json:"-"`
}

func (*TeamsDevicesDevicePostureRulesInputTeamsDevicesApplicationInputRequest) UnmarshalJSON 

func (r *TeamsDevicesDevicePostureRulesInputTeamsDevicesApplicationInputRequest) UnmarshalJSON(data []byte) (err error)

type TeamsDevicesDevicePostureRulesInputTeamsDevicesApplicationInputRequestOperatingSystem 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesApplicationInputRequestOperatingSystem string

Operating system 

const (
	TeamsDevicesDevicePostureRulesInputTeamsDevicesApplicationInputRequestOperatingSystemWindows TeamsDevicesDevicePostureRulesInputTeamsDevicesApplicationInputRequestOperatingSystem = "windows"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesApplicationInputRequestOperatingSystemLinux   TeamsDevicesDevicePostureRulesInputTeamsDevicesApplicationInputRequestOperatingSystem = "linux"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesApplicationInputRequestOperatingSystemMac     TeamsDevicesDevicePostureRulesInputTeamsDevicesApplicationInputRequestOperatingSystem = "mac"
)

type TeamsDevicesDevicePostureRulesInputTeamsDevicesCarbonblackInputRequest 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesCarbonblackInputRequest struct {
	// Operating system
	OperatingSystem TeamsDevicesDevicePostureRulesInputTeamsDevicesCarbonblackInputRequestOperatingSystem `json:"operating_system,required"`
	// File path.
	Path string `json:"path,required"`
	// SHA-256.
	Sha256 string `json:"sha256"`
	// Signing certificate thumbprint.
	Thumbprint string                                                                     `json:"thumbprint"`
	JSON       teamsDevicesDevicePostureRulesInputTeamsDevicesCarbonblackInputRequestJSON `json:"-"`
}

func (*TeamsDevicesDevicePostureRulesInputTeamsDevicesCarbonblackInputRequest) UnmarshalJSON 

func (r *TeamsDevicesDevicePostureRulesInputTeamsDevicesCarbonblackInputRequest) UnmarshalJSON(data []byte) (err error)

type TeamsDevicesDevicePostureRulesInputTeamsDevicesCarbonblackInputRequestOperatingSystem 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesCarbonblackInputRequestOperatingSystem string

Operating system 

const (
	TeamsDevicesDevicePostureRulesInputTeamsDevicesCarbonblackInputRequestOperatingSystemWindows TeamsDevicesDevicePostureRulesInputTeamsDevicesCarbonblackInputRequestOperatingSystem = "windows"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesCarbonblackInputRequestOperatingSystemLinux   TeamsDevicesDevicePostureRulesInputTeamsDevicesCarbonblackInputRequestOperatingSystem = "linux"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesCarbonblackInputRequestOperatingSystemMac     TeamsDevicesDevicePostureRulesInputTeamsDevicesCarbonblackInputRequestOperatingSystem = "mac"
)

type TeamsDevicesDevicePostureRulesInputTeamsDevicesClientCertificateInputRequest 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesClientCertificateInputRequest struct {
	// UUID of Cloudflare managed certificate.
	CertificateID string `json:"certificate_id,required"`
	// Common Name that is protected by the certificate
	Cn   string                                                                           `json:"cn,required"`
	JSON teamsDevicesDevicePostureRulesInputTeamsDevicesClientCertificateInputRequestJSON `json:"-"`
}

func (*TeamsDevicesDevicePostureRulesInputTeamsDevicesClientCertificateInputRequest) UnmarshalJSON 

func (r *TeamsDevicesDevicePostureRulesInputTeamsDevicesClientCertificateInputRequest) UnmarshalJSON(data []byte) (err error)

type TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequest 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequest struct {
	// Posture Integration ID.
	ConnectionID string `json:"connection_id,required"`
	// For more details on last seen, please refer to the Crowdstrike documentation.
	LastSeen string `json:"last_seen"`
	// Operator
	Operator TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestOperator `json:"operator"`
	// Os Version
	OS string `json:"os"`
	// overall
	Overall string `json:"overall"`
	// SensorConfig
	SensorConfig string `json:"sensor_config"`
	// For more details on state, please refer to the Crowdstrike documentation.
	State TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestState `json:"state"`
	// Version
	Version string `json:"version"`
	// Version Operator
	VersionOperator TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestVersionOperator `json:"versionOperator"`
	JSON            teamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestJSON            `json:"-"`
}

func (*TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequest) UnmarshalJSON 

func (r *TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequest) UnmarshalJSON(data []byte) (err error)

type TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestOperator 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestOperator string

Operator 

const (
	TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestOperatorUnknown15 TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestOperator = "<"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestOperatorUnknown16 TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestOperator = "<="
	TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestOperatorUnknown17 TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestOperator = ">"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestOperatorUnknown18 TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestOperator = ">="
	TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestOperatorUnknown19 TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestOperator = "=="
)

type TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestState 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestState string

For more details on state, please refer to the Crowdstrike documentation. 

const (
	TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestStateOnline  TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestState = "online"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestStateOffline TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestState = "offline"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestStateUnknown TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestState = "unknown"
)

type TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestVersionOperator 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestVersionOperator string

Version Operator 

const (
	TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestVersionOperatorUnknown25 TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestVersionOperator = "<"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestVersionOperatorUnknown26 TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestVersionOperator = "<="
	TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestVersionOperatorUnknown27 TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestVersionOperator = ">"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestVersionOperatorUnknown28 TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestVersionOperator = ">="
	TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestVersionOperatorUnknown29 TeamsDevicesDevicePostureRulesInputTeamsDevicesCrowdstrikeInputRequestVersionOperator = "=="
)

type TeamsDevicesDevicePostureRulesInputTeamsDevicesDiskEncryptionInputRequest 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesDiskEncryptionInputRequest struct {
	// List of volume names to be checked for encryption.
	CheckDisks []string `json:"checkDisks"`
	// Whether to check all disks for encryption.
	RequireAll bool                                                                          `json:"requireAll"`
	JSON       teamsDevicesDevicePostureRulesInputTeamsDevicesDiskEncryptionInputRequestJSON `json:"-"`
}

func (*TeamsDevicesDevicePostureRulesInputTeamsDevicesDiskEncryptionInputRequest) UnmarshalJSON 

func (r *TeamsDevicesDevicePostureRulesInputTeamsDevicesDiskEncryptionInputRequest) UnmarshalJSON(data []byte) (err error)

type TeamsDevicesDevicePostureRulesInputTeamsDevicesDomainJoinedInputRequest 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesDomainJoinedInputRequest struct {
	// Operating System
	OperatingSystem TeamsDevicesDevicePostureRulesInputTeamsDevicesDomainJoinedInputRequestOperatingSystem `json:"operating_system,required"`
	// Domain
	Domain string                                                                      `json:"domain"`
	JSON   teamsDevicesDevicePostureRulesInputTeamsDevicesDomainJoinedInputRequestJSON `json:"-"`
}

func (*TeamsDevicesDevicePostureRulesInputTeamsDevicesDomainJoinedInputRequest) UnmarshalJSON 

func (r *TeamsDevicesDevicePostureRulesInputTeamsDevicesDomainJoinedInputRequest) UnmarshalJSON(data []byte) (err error)

type TeamsDevicesDevicePostureRulesInputTeamsDevicesDomainJoinedInputRequestOperatingSystem 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesDomainJoinedInputRequestOperatingSystem string

Operating System 

const (
	TeamsDevicesDevicePostureRulesInputTeamsDevicesDomainJoinedInputRequestOperatingSystemWindows TeamsDevicesDevicePostureRulesInputTeamsDevicesDomainJoinedInputRequestOperatingSystem = "windows"
)

type TeamsDevicesDevicePostureRulesInputTeamsDevicesFileInputRequest 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesFileInputRequest struct {
	// Operating system
	OperatingSystem TeamsDevicesDevicePostureRulesInputTeamsDevicesFileInputRequestOperatingSystem `json:"operating_system,required"`
	// File path.
	Path string `json:"path,required"`
	// Whether or not file exists
	Exists bool `json:"exists"`
	// SHA-256.
	Sha256 string `json:"sha256"`
	// Signing certificate thumbprint.
	Thumbprint string                                                              `json:"thumbprint"`
	JSON       teamsDevicesDevicePostureRulesInputTeamsDevicesFileInputRequestJSON `json:"-"`
}

func (*TeamsDevicesDevicePostureRulesInputTeamsDevicesFileInputRequest) UnmarshalJSON 

func (r *TeamsDevicesDevicePostureRulesInputTeamsDevicesFileInputRequest) UnmarshalJSON(data []byte) (err error)

type TeamsDevicesDevicePostureRulesInputTeamsDevicesFileInputRequestOperatingSystem 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesFileInputRequestOperatingSystem string

Operating system 

const (
	TeamsDevicesDevicePostureRulesInputTeamsDevicesFileInputRequestOperatingSystemWindows TeamsDevicesDevicePostureRulesInputTeamsDevicesFileInputRequestOperatingSystem = "windows"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesFileInputRequestOperatingSystemLinux   TeamsDevicesDevicePostureRulesInputTeamsDevicesFileInputRequestOperatingSystem = "linux"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesFileInputRequestOperatingSystemMac     TeamsDevicesDevicePostureRulesInputTeamsDevicesFileInputRequestOperatingSystem = "mac"
)

type TeamsDevicesDevicePostureRulesInputTeamsDevicesFirewallInputRequest 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesFirewallInputRequest struct {
	// Enabled
	Enabled bool `json:"enabled,required"`
	// Operating System
	OperatingSystem TeamsDevicesDevicePostureRulesInputTeamsDevicesFirewallInputRequestOperatingSystem `json:"operating_system,required"`
	JSON            teamsDevicesDevicePostureRulesInputTeamsDevicesFirewallInputRequestJSON            `json:"-"`
}

func (*TeamsDevicesDevicePostureRulesInputTeamsDevicesFirewallInputRequest) UnmarshalJSON 

func (r *TeamsDevicesDevicePostureRulesInputTeamsDevicesFirewallInputRequest) UnmarshalJSON(data []byte) (err error)

type TeamsDevicesDevicePostureRulesInputTeamsDevicesFirewallInputRequestOperatingSystem 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesFirewallInputRequestOperatingSystem string

Operating System 

const (
	TeamsDevicesDevicePostureRulesInputTeamsDevicesFirewallInputRequestOperatingSystemWindows TeamsDevicesDevicePostureRulesInputTeamsDevicesFirewallInputRequestOperatingSystem = "windows"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesFirewallInputRequestOperatingSystemMac     TeamsDevicesDevicePostureRulesInputTeamsDevicesFirewallInputRequestOperatingSystem = "mac"
)

type TeamsDevicesDevicePostureRulesInputTeamsDevicesIntuneInputRequest 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesIntuneInputRequest struct {
	// Compliance Status
	ComplianceStatus TeamsDevicesDevicePostureRulesInputTeamsDevicesIntuneInputRequestComplianceStatus `json:"compliance_status,required"`
	// Posture Integration ID.
	ConnectionID string                                                                `json:"connection_id,required"`
	JSON         teamsDevicesDevicePostureRulesInputTeamsDevicesIntuneInputRequestJSON `json:"-"`
}

func (*TeamsDevicesDevicePostureRulesInputTeamsDevicesIntuneInputRequest) UnmarshalJSON 

func (r *TeamsDevicesDevicePostureRulesInputTeamsDevicesIntuneInputRequest) UnmarshalJSON(data []byte) (err error)

type TeamsDevicesDevicePostureRulesInputTeamsDevicesIntuneInputRequestComplianceStatus 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesIntuneInputRequestComplianceStatus string

Compliance Status 

const (
	TeamsDevicesDevicePostureRulesInputTeamsDevicesIntuneInputRequestComplianceStatusCompliant     TeamsDevicesDevicePostureRulesInputTeamsDevicesIntuneInputRequestComplianceStatus = "compliant"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesIntuneInputRequestComplianceStatusNoncompliant  TeamsDevicesDevicePostureRulesInputTeamsDevicesIntuneInputRequestComplianceStatus = "noncompliant"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesIntuneInputRequestComplianceStatusUnknown       TeamsDevicesDevicePostureRulesInputTeamsDevicesIntuneInputRequestComplianceStatus = "unknown"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesIntuneInputRequestComplianceStatusNotapplicable TeamsDevicesDevicePostureRulesInputTeamsDevicesIntuneInputRequestComplianceStatus = "notapplicable"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesIntuneInputRequestComplianceStatusIngraceperiod TeamsDevicesDevicePostureRulesInputTeamsDevicesIntuneInputRequestComplianceStatus = "ingraceperiod"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesIntuneInputRequestComplianceStatusError         TeamsDevicesDevicePostureRulesInputTeamsDevicesIntuneInputRequestComplianceStatus = "error"
)

type TeamsDevicesDevicePostureRulesInputTeamsDevicesKolideInputRequest 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesKolideInputRequest struct {
	// Posture Integration ID.
	ConnectionID string `json:"connection_id,required"`
	// Count Operator
	CountOperator TeamsDevicesDevicePostureRulesInputTeamsDevicesKolideInputRequestCountOperator `json:"countOperator,required"`
	// The Number of Issues.
	IssueCount string                                                                `json:"issue_count,required"`
	JSON       teamsDevicesDevicePostureRulesInputTeamsDevicesKolideInputRequestJSON `json:"-"`
}

func (*TeamsDevicesDevicePostureRulesInputTeamsDevicesKolideInputRequest) UnmarshalJSON 

func (r *TeamsDevicesDevicePostureRulesInputTeamsDevicesKolideInputRequest) UnmarshalJSON(data []byte) (err error)

type TeamsDevicesDevicePostureRulesInputTeamsDevicesKolideInputRequestCountOperator 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesKolideInputRequestCountOperator string

Count Operator 

const (
	TeamsDevicesDevicePostureRulesInputTeamsDevicesKolideInputRequestCountOperatorUnknown35 TeamsDevicesDevicePostureRulesInputTeamsDevicesKolideInputRequestCountOperator = "<"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesKolideInputRequestCountOperatorUnknown36 TeamsDevicesDevicePostureRulesInputTeamsDevicesKolideInputRequestCountOperator = "<="
	TeamsDevicesDevicePostureRulesInputTeamsDevicesKolideInputRequestCountOperatorUnknown37 TeamsDevicesDevicePostureRulesInputTeamsDevicesKolideInputRequestCountOperator = ">"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesKolideInputRequestCountOperatorUnknown38 TeamsDevicesDevicePostureRulesInputTeamsDevicesKolideInputRequestCountOperator = ">="
	TeamsDevicesDevicePostureRulesInputTeamsDevicesKolideInputRequestCountOperatorUnknown39 TeamsDevicesDevicePostureRulesInputTeamsDevicesKolideInputRequestCountOperator = "=="
)

type TeamsDevicesDevicePostureRulesInputTeamsDevicesOSVersionInputRequest 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesOSVersionInputRequest struct {
	// Operating System
	OperatingSystem TeamsDevicesDevicePostureRulesInputTeamsDevicesOSVersionInputRequestOperatingSystem `json:"operating_system,required"`
	// Operator
	Operator TeamsDevicesDevicePostureRulesInputTeamsDevicesOSVersionInputRequestOperator `json:"operator,required"`
	// Version of OS
	Version string `json:"version,required"`
	// Operating System Distribution Name (linux only)
	OSDistroName string `json:"os_distro_name"`
	// Version of OS Distribution (linux only)
	OSDistroRevision string `json:"os_distro_revision"`
	// Additional version data. For Mac or iOS, the Product Verison Extra. For Linux,
	// the kernel release version. (Mac, iOS, and Linux only)
	OSVersionExtra string                                                                   `json:"os_version_extra"`
	JSON           teamsDevicesDevicePostureRulesInputTeamsDevicesOSVersionInputRequestJSON `json:"-"`
}

func (*TeamsDevicesDevicePostureRulesInputTeamsDevicesOSVersionInputRequest) UnmarshalJSON 

func (r *TeamsDevicesDevicePostureRulesInputTeamsDevicesOSVersionInputRequest) UnmarshalJSON(data []byte) (err error)

type TeamsDevicesDevicePostureRulesInputTeamsDevicesOSVersionInputRequestOperatingSystem 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesOSVersionInputRequestOperatingSystem string

Operating System 

const (
	TeamsDevicesDevicePostureRulesInputTeamsDevicesOSVersionInputRequestOperatingSystemWindows TeamsDevicesDevicePostureRulesInputTeamsDevicesOSVersionInputRequestOperatingSystem = "windows"
)

type TeamsDevicesDevicePostureRulesInputTeamsDevicesOSVersionInputRequestOperator 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesOSVersionInputRequestOperator string

Operator 

const (
	TeamsDevicesDevicePostureRulesInputTeamsDevicesOSVersionInputRequestOperatorUnknown5 TeamsDevicesDevicePostureRulesInputTeamsDevicesOSVersionInputRequestOperator = "<"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesOSVersionInputRequestOperatorUnknown6 TeamsDevicesDevicePostureRulesInputTeamsDevicesOSVersionInputRequestOperator = "<="
	TeamsDevicesDevicePostureRulesInputTeamsDevicesOSVersionInputRequestOperatorUnknown7 TeamsDevicesDevicePostureRulesInputTeamsDevicesOSVersionInputRequestOperator = ">"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesOSVersionInputRequestOperatorUnknown8 TeamsDevicesDevicePostureRulesInputTeamsDevicesOSVersionInputRequestOperator = ">="
	TeamsDevicesDevicePostureRulesInputTeamsDevicesOSVersionInputRequestOperatorUnknown9 TeamsDevicesDevicePostureRulesInputTeamsDevicesOSVersionInputRequestOperator = "=="
)

type TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneInputRequest 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneInputRequest struct {
	// Operating system
	OperatingSystem TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneInputRequestOperatingSystem `json:"operating_system,required"`
	// File path.
	Path string `json:"path,required"`
	// SHA-256.
	Sha256 string `json:"sha256"`
	// Signing certificate thumbprint.
	Thumbprint string                                                                     `json:"thumbprint"`
	JSON       teamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneInputRequestJSON `json:"-"`
}

func (*TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneInputRequest) UnmarshalJSON 

func (r *TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneInputRequest) UnmarshalJSON(data []byte) (err error)

type TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneInputRequestOperatingSystem 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneInputRequestOperatingSystem string

Operating system 

const (
	TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneInputRequestOperatingSystemWindows TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneInputRequestOperatingSystem = "windows"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneInputRequestOperatingSystemLinux   TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneInputRequestOperatingSystem = "linux"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneInputRequestOperatingSystemMac     TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneInputRequestOperatingSystem = "mac"
)

type TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneS2sInputRequest 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneS2sInputRequest struct {
	// Posture Integration ID.
	ConnectionID string `json:"connection_id,required"`
	// The Number of active threats.
	ActiveThreats float64 `json:"active_threats"`
	// Whether device is infected.
	Infected bool `json:"infected"`
	// Whether device is active.
	IsActive bool `json:"is_active"`
	// Network status of device.
	NetworkStatus TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneS2sInputRequestNetworkStatus `json:"network_status"`
	// operator
	Operator TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneS2sInputRequestOperator `json:"operator"`
	JSON     teamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneS2sInputRequestJSON     `json:"-"`
}

func (*TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneS2sInputRequest) UnmarshalJSON 

func (r *TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneS2sInputRequest) UnmarshalJSON(data []byte) (err error)

type TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneS2sInputRequestNetworkStatus 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneS2sInputRequestNetworkStatus string

Network status of device. 

const (
	TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneS2sInputRequestNetworkStatusConnected     TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneS2sInputRequestNetworkStatus = "connected"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneS2sInputRequestNetworkStatusDisconnected  TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneS2sInputRequestNetworkStatus = "disconnected"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneS2sInputRequestNetworkStatusDisconnecting TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneS2sInputRequestNetworkStatus = "disconnecting"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneS2sInputRequestNetworkStatusConnecting    TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneS2sInputRequestNetworkStatus = "connecting"
)

type TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneS2sInputRequestOperator 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneS2sInputRequestOperator string

operator 

const (
	TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneS2sInputRequestOperatorUnknown65 TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneS2sInputRequestOperator = "<"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneS2sInputRequestOperatorUnknown66 TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneS2sInputRequestOperator = "<="
	TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneS2sInputRequestOperatorUnknown67 TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneS2sInputRequestOperator = ">"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneS2sInputRequestOperatorUnknown68 TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneS2sInputRequestOperator = ">="
	TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneS2sInputRequestOperatorUnknown69 TeamsDevicesDevicePostureRulesInputTeamsDevicesSentineloneS2sInputRequestOperator = "=="
)

type TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequest 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequest struct {
	// Posture Integration ID.
	ConnectionID string `json:"connection_id,required"`
	// For more details on eid last seen, refer to the Tanium documentation.
	EidLastSeen string `json:"eid_last_seen"`
	// Operator to evaluate risk_level or eid_last_seen.
	Operator TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestOperator `json:"operator"`
	// For more details on risk level, refer to the Tanium documentation.
	RiskLevel TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestRiskLevel `json:"risk_level"`
	// Score Operator
	ScoreOperator TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestScoreOperator `json:"scoreOperator"`
	// For more details on total score, refer to the Tanium documentation.
	TotalScore float64                                                               `json:"total_score"`
	JSON       teamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestJSON `json:"-"`
}

func (*TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequest) UnmarshalJSON 

func (r *TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequest) UnmarshalJSON(data []byte) (err error)

type TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestOperator 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestOperator string

Operator to evaluate risk_level or eid_last_seen. 

const (
	TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestOperatorUnknown45 TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestOperator = "<"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestOperatorUnknown46 TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestOperator = "<="
	TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestOperatorUnknown47 TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestOperator = ">"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestOperatorUnknown48 TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestOperator = ">="
	TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestOperatorUnknown49 TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestOperator = "=="
)

type TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestRiskLevel 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestRiskLevel string

For more details on risk level, refer to the Tanium documentation. 

const (
	TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestRiskLevelLow      TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestRiskLevel = "low"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestRiskLevelMedium   TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestRiskLevel = "medium"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestRiskLevelHigh     TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestRiskLevel = "high"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestRiskLevelCritical TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestRiskLevel = "critical"
)

type TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestScoreOperator 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestScoreOperator string

Score Operator 

const (
	TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestScoreOperatorUnknown55 TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestScoreOperator = "<"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestScoreOperatorUnknown56 TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestScoreOperator = "<="
	TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestScoreOperatorUnknown57 TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestScoreOperator = ">"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestScoreOperatorUnknown58 TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestScoreOperator = ">="
	TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestScoreOperatorUnknown59 TeamsDevicesDevicePostureRulesInputTeamsDevicesTaniumInputRequestScoreOperator = "=="
)

type TeamsDevicesDevicePostureRulesInputTeamsDevicesUniqueClientIDInputRequest 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesUniqueClientIDInputRequest struct {
	// List ID.
	ID string `json:"id,required"`
	// Operating System
	OperatingSystem TeamsDevicesDevicePostureRulesInputTeamsDevicesUniqueClientIDInputRequestOperatingSystem `json:"operating_system,required"`
	JSON            teamsDevicesDevicePostureRulesInputTeamsDevicesUniqueClientIDInputRequestJSON            `json:"-"`
}

func (*TeamsDevicesDevicePostureRulesInputTeamsDevicesUniqueClientIDInputRequest) UnmarshalJSON 

func (r *TeamsDevicesDevicePostureRulesInputTeamsDevicesUniqueClientIDInputRequest) UnmarshalJSON(data []byte) (err error)

type TeamsDevicesDevicePostureRulesInputTeamsDevicesUniqueClientIDInputRequestOperatingSystem 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesUniqueClientIDInputRequestOperatingSystem string

Operating System 

const (
	TeamsDevicesDevicePostureRulesInputTeamsDevicesUniqueClientIDInputRequestOperatingSystemAndroid  TeamsDevicesDevicePostureRulesInputTeamsDevicesUniqueClientIDInputRequestOperatingSystem = "android"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesUniqueClientIDInputRequestOperatingSystemIos      TeamsDevicesDevicePostureRulesInputTeamsDevicesUniqueClientIDInputRequestOperatingSystem = "ios"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesUniqueClientIDInputRequestOperatingSystemChromeos TeamsDevicesDevicePostureRulesInputTeamsDevicesUniqueClientIDInputRequestOperatingSystem = "chromeos"
)

type TeamsDevicesDevicePostureRulesInputTeamsDevicesWorkspaceOneInputRequest 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesWorkspaceOneInputRequest struct {
	// Compliance Status
	ComplianceStatus TeamsDevicesDevicePostureRulesInputTeamsDevicesWorkspaceOneInputRequestComplianceStatus `json:"compliance_status,required"`
	// Posture Integration ID.
	ConnectionID string                                                                      `json:"connection_id,required"`
	JSON         teamsDevicesDevicePostureRulesInputTeamsDevicesWorkspaceOneInputRequestJSON `json:"-"`
}

func (*TeamsDevicesDevicePostureRulesInputTeamsDevicesWorkspaceOneInputRequest) UnmarshalJSON 

func (r *TeamsDevicesDevicePostureRulesInputTeamsDevicesWorkspaceOneInputRequest) UnmarshalJSON(data []byte) (err error)

type TeamsDevicesDevicePostureRulesInputTeamsDevicesWorkspaceOneInputRequestComplianceStatus 

type TeamsDevicesDevicePostureRulesInputTeamsDevicesWorkspaceOneInputRequestComplianceStatus string

Compliance Status 

const (
	TeamsDevicesDevicePostureRulesInputTeamsDevicesWorkspaceOneInputRequestComplianceStatusCompliant    TeamsDevicesDevicePostureRulesInputTeamsDevicesWorkspaceOneInputRequestComplianceStatus = "compliant"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesWorkspaceOneInputRequestComplianceStatusNoncompliant TeamsDevicesDevicePostureRulesInputTeamsDevicesWorkspaceOneInputRequestComplianceStatus = "noncompliant"
	TeamsDevicesDevicePostureRulesInputTeamsDevicesWorkspaceOneInputRequestComplianceStatusUnknown      TeamsDevicesDevicePostureRulesInputTeamsDevicesWorkspaceOneInputRequestComplianceStatus = "unknown"
)

type TeamsDevicesDevicePostureRulesMatch 

type TeamsDevicesDevicePostureRulesMatch struct {
	Platform TeamsDevicesDevicePostureRulesMatchPlatform `json:"platform"`
	JSON     teamsDevicesDevicePostureRulesMatchJSON     `json:"-"`
}

func (*TeamsDevicesDevicePostureRulesMatch) UnmarshalJSON 

func (r *TeamsDevicesDevicePostureRulesMatch) UnmarshalJSON(data []byte) (err error)

type TeamsDevicesDevicePostureRulesMatchPlatform 

type TeamsDevicesDevicePostureRulesMatchPlatform string
const (
	TeamsDevicesDevicePostureRulesMatchPlatformWindows TeamsDevicesDevicePostureRulesMatchPlatform = "windows"
	TeamsDevicesDevicePostureRulesMatchPlatformMac     TeamsDevicesDevicePostureRulesMatchPlatform = "mac"
	TeamsDevicesDevicePostureRulesMatchPlatformLinux   TeamsDevicesDevicePostureRulesMatchPlatform = "linux"
	TeamsDevicesDevicePostureRulesMatchPlatformAndroid TeamsDevicesDevicePostureRulesMatchPlatform = "android"
	TeamsDevicesDevicePostureRulesMatchPlatformIos     TeamsDevicesDevicePostureRulesMatchPlatform = "ios"
)

type TeamsDevicesDevicePostureRulesType 

type TeamsDevicesDevicePostureRulesType string

The type of device posture rule. 

const (
	TeamsDevicesDevicePostureRulesTypeFile              TeamsDevicesDevicePostureRulesType = "file"
	TeamsDevicesDevicePostureRulesTypeApplication       TeamsDevicesDevicePostureRulesType = "application"
	TeamsDevicesDevicePostureRulesTypeTanium            TeamsDevicesDevicePostureRulesType = "tanium"
	TeamsDevicesDevicePostureRulesTypeGateway           TeamsDevicesDevicePostureRulesType = "gateway"
	TeamsDevicesDevicePostureRulesTypeWARP              TeamsDevicesDevicePostureRulesType = "warp"
	TeamsDevicesDevicePostureRulesTypeDiskEncryption    TeamsDevicesDevicePostureRulesType = "disk_encryption"
	TeamsDevicesDevicePostureRulesTypeSentinelone       TeamsDevicesDevicePostureRulesType = "sentinelone"
	TeamsDevicesDevicePostureRulesTypeCarbonblack       TeamsDevicesDevicePostureRulesType = "carbonblack"
	TeamsDevicesDevicePostureRulesTypeFirewall          TeamsDevicesDevicePostureRulesType = "firewall"
	TeamsDevicesDevicePostureRulesTypeOSVersion         TeamsDevicesDevicePostureRulesType = "os_version"
	TeamsDevicesDevicePostureRulesTypeDomainJoined      TeamsDevicesDevicePostureRulesType = "domain_joined"
	TeamsDevicesDevicePostureRulesTypeClientCertificate TeamsDevicesDevicePostureRulesType = "client_certificate"
	TeamsDevicesDevicePostureRulesTypeUniqueClientID    TeamsDevicesDevicePostureRulesType = "unique_client_id"
	TeamsDevicesDevicePostureRulesTypeKolide            TeamsDevicesDevicePostureRulesType = "kolide"
	TeamsDevicesDevicePostureRulesTypeTaniumS2s         TeamsDevicesDevicePostureRulesType = "tanium_s2s"
	TeamsDevicesDevicePostureRulesTypeCrowdstrikeS2s    TeamsDevicesDevicePostureRulesType = "crowdstrike_s2s"
	TeamsDevicesDevicePostureRulesTypeIntune            TeamsDevicesDevicePostureRulesType = "intune"
	TeamsDevicesDevicePostureRulesTypeWorkspaceOne      TeamsDevicesDevicePostureRulesType = "workspace_one"
	TeamsDevicesDevicePostureRulesTypeSentineloneS2s    TeamsDevicesDevicePostureRulesType = "sentinelone_s2s"
)

type TeamsDevicesDeviceSettingsPolicy 

type TeamsDevicesDeviceSettingsPolicy struct {
	// Whether to allow the user to switch WARP between modes.
	AllowModeSwitch bool `json:"allow_mode_switch"`
	// Whether to receive update notifications when a new version of the client is
	// available.
	AllowUpdates bool `json:"allow_updates"`
	// Whether to allow devices to leave the organization.
	AllowedToLeave bool `json:"allowed_to_leave"`
	// The amount of time in minutes to reconnect after having been disabled.
	AutoConnect float64 `json:"auto_connect"`
	// Turn on the captive portal after the specified amount of time.
	CaptivePortal float64 `json:"captive_portal"`
	// Whether the policy is the default policy for an account.
	Default bool `json:"default"`
	// A description of the policy.
	Description string `json:"description"`
	// If the `dns_server` field of a fallback domain is not present, the client will
	// fall back to a best guess of the default/system DNS resolvers unless this policy
	// option is set to `true`.
	DisableAutoFallback bool `json:"disable_auto_fallback"`
	// Whether the policy will be applied to matching devices.
	Enabled bool                      `json:"enabled"`
	Exclude []TeamsDevicesSplitTunnel `json:"exclude"`
	// Whether to add Microsoft IPs to Split Tunnel exclusions.
	ExcludeOfficeIPs bool                             `json:"exclude_office_ips"`
	FallbackDomains  []TeamsDevicesFallbackDomain     `json:"fallback_domains"`
	GatewayUniqueID  string                           `json:"gateway_unique_id"`
	Include          []TeamsDevicesSplitTunnelInclude `json:"include"`
	// The amount of time in minutes a user is allowed access to their LAN. A value of
	// 0 will allow LAN access until the next WARP reconnection, such as a reboot or a
	// laptop waking from sleep. Note that this field is omitted from the response if
	// null or unset.
	LanAllowMinutes float64 `json:"lan_allow_minutes"`
	// The size of the subnet for the local access network. Note that this field is
	// omitted from the response if null or unset.
	LanAllowSubnetSize float64 `json:"lan_allow_subnet_size"`
	// The wirefilter expression to match devices.
	Match string `json:"match"`
	// The name of the device settings profile.
	Name string `json:"name"`
	// Device ID.
	PolicyID string `json:"policy_id"`
	// The precedence of the policy. Lower values indicate higher precedence. Policies
	// will be evaluated in ascending order of this field.
	Precedence    float64                                       `json:"precedence"`
	ServiceModeV2 TeamsDevicesDeviceSettingsPolicyServiceModeV2 `json:"service_mode_v2"`
	// The URL to launch when the Send Feedback button is clicked.
	SupportURL string `json:"support_url"`
	// Whether to allow the user to turn off the WARP switch and disconnect the client.
	SwitchLocked bool                                 `json:"switch_locked"`
	JSON         teamsDevicesDeviceSettingsPolicyJSON `json:"-"`
}

func (*TeamsDevicesDeviceSettingsPolicy) UnmarshalJSON 

func (r *TeamsDevicesDeviceSettingsPolicy) UnmarshalJSON(data []byte) (err error)

type TeamsDevicesDeviceSettingsPolicyServiceModeV2 

type TeamsDevicesDeviceSettingsPolicyServiceModeV2 struct {
	// The mode to run the WARP client under.
	Mode string `json:"mode"`
	// The port number when used with proxy mode.
	Port float64                                           `json:"port"`
	JSON teamsDevicesDeviceSettingsPolicyServiceModeV2JSON `json:"-"`
}

func (*TeamsDevicesDeviceSettingsPolicyServiceModeV2) UnmarshalJSON 

func (r *TeamsDevicesDeviceSettingsPolicyServiceModeV2) UnmarshalJSON(data []byte) (err error)

type TeamsDevicesDevices 

type TeamsDevicesDevices struct {
	// Device ID.
	ID string `json:"id"`
	// When the device was created.
	Created time.Time `json:"created" format:"date-time"`
	// True if the device was deleted.
	Deleted    bool                          `json:"deleted"`
	DeviceType TeamsDevicesDevicesDeviceType `json:"device_type"`
	// IPv4 or IPv6 address.
	IP string `json:"ip"`
	// The device's public key.
	Key string `json:"key"`
	// When the device last connected to Cloudflare services.
	LastSeen time.Time `json:"last_seen" format:"date-time"`
	// The device mac address.
	MacAddress string `json:"mac_address"`
	// The device manufacturer name.
	Manufacturer string `json:"manufacturer"`
	// The device model name.
	Model string `json:"model"`
	// The device name.
	Name string `json:"name"`
	// The Linux distro name.
	OSDistroName string `json:"os_distro_name"`
	// The Linux distro revision.
	OSDistroRevision string `json:"os_distro_revision"`
	// The operating system version.
	OSVersion string `json:"os_version"`
	// The operating system version extra parameter.
	OSVersionExtra string `json:"os_version_extra"`
	// When the device was revoked.
	RevokedAt time.Time `json:"revoked_at" format:"date-time"`
	// The device serial number.
	SerialNumber string `json:"serial_number"`
	// When the device was updated.
	Updated time.Time               `json:"updated" format:"date-time"`
	User    TeamsDevicesDevicesUser `json:"user"`
	// The WARP client version.
	Version string                  `json:"version"`
	JSON    teamsDevicesDevicesJSON `json:"-"`
}

func (*TeamsDevicesDevices) UnmarshalJSON 

func (r *TeamsDevicesDevices) UnmarshalJSON(data []byte) (err error)

type TeamsDevicesDevicesDeviceType 

type TeamsDevicesDevicesDeviceType string
const (
	TeamsDevicesDevicesDeviceTypeWindows TeamsDevicesDevicesDeviceType = "windows"
	TeamsDevicesDevicesDeviceTypeMac     TeamsDevicesDevicesDeviceType = "mac"
	TeamsDevicesDevicesDeviceTypeLinux   TeamsDevicesDevicesDeviceType = "linux"
	TeamsDevicesDevicesDeviceTypeAndroid TeamsDevicesDevicesDeviceType = "android"
	TeamsDevicesDevicesDeviceTypeIos     TeamsDevicesDevicesDeviceType = "ios"
)

type TeamsDevicesDevicesUser 

type TeamsDevicesDevicesUser struct {
	// UUID
	ID string `json:"id"`
	// The contact email address of the user.
	Email string `json:"email"`
	// The enrolled device user's name.
	Name string                      `json:"name"`
	JSON teamsDevicesDevicesUserJSON `json:"-"`
}

func (*TeamsDevicesDevicesUser) UnmarshalJSON 

func (r *TeamsDevicesDevicesUser) UnmarshalJSON(data []byte) (err error)

type TeamsDevicesFallbackDomain 

type TeamsDevicesFallbackDomain struct {
	// The domain suffix to match when resolving locally.
	Suffix string `json:"suffix,required"`
	// A description of the fallback domain, displayed in the client UI.
	Description string `json:"description"`
	// A list of IP addresses to handle domain resolution.
	DNSServer []interface{}                  `json:"dns_server"`
	JSON      teamsDevicesFallbackDomainJSON `json:"-"`
}

func (*TeamsDevicesFallbackDomain) UnmarshalJSON 

func (r *TeamsDevicesFallbackDomain) UnmarshalJSON(data []byte) (err error)

type TeamsDevicesFallbackDomainParam 

type TeamsDevicesFallbackDomainParam struct {
	// The domain suffix to match when resolving locally.
	Suffix param.Field[string] `json:"suffix,required"`
	// A description of the fallback domain, displayed in the client UI.
	Description param.Field[string] `json:"description"`
	// A list of IP addresses to handle domain resolution.
	DNSServer param.Field[[]interface{}] `json:"dns_server"`
}

func (TeamsDevicesFallbackDomainParam) MarshalJSON 

func (r TeamsDevicesFallbackDomainParam) MarshalJSON() (data []byte, err error)

type TeamsDevicesSplitTunnel 

type TeamsDevicesSplitTunnel struct {
	// The address in CIDR format to exclude from the tunnel. If `address` is present,
	// `host` must not be present.
	Address string `json:"address,required"`
	// A description of the Split Tunnel item, displayed in the client UI.
	Description string `json:"description,required"`
	// The domain name to exclude from the tunnel. If `host` is present, `address` must
	// not be present.
	Host string                      `json:"host"`
	JSON teamsDevicesSplitTunnelJSON `json:"-"`
}

func (*TeamsDevicesSplitTunnel) UnmarshalJSON 

func (r *TeamsDevicesSplitTunnel) UnmarshalJSON(data []byte) (err error)

type TeamsDevicesSplitTunnelInclude 

type TeamsDevicesSplitTunnelInclude struct {
	// The address in CIDR format to include in the tunnel. If address is present, host
	// must not be present.
	Address string `json:"address,required"`
	// A description of the split tunnel item, displayed in the client UI.
	Description string `json:"description,required"`
	// The domain name to include in the tunnel. If host is present, address must not
	// be present.
	Host string                             `json:"host"`
	JSON teamsDevicesSplitTunnelIncludeJSON `json:"-"`
}

func (*TeamsDevicesSplitTunnelInclude) UnmarshalJSON 

func (r *TeamsDevicesSplitTunnelInclude) UnmarshalJSON(data []byte) (err error)

type TeamsDevicesSplitTunnelIncludeParam 

type TeamsDevicesSplitTunnelIncludeParam struct {
	// The address in CIDR format to include in the tunnel. If address is present, host
	// must not be present.
	Address param.Field[string] `json:"address,required"`
	// A description of the split tunnel item, displayed in the client UI.
	Description param.Field[string] `json:"description,required"`
	// The domain name to include in the tunnel. If host is present, address must not
	// be present.
	Host param.Field[string] `json:"host"`
}

func (TeamsDevicesSplitTunnelIncludeParam) MarshalJSON 

func (r TeamsDevicesSplitTunnelIncludeParam) MarshalJSON() (data []byte, err error)

type TeamsDevicesSplitTunnelParam 

type TeamsDevicesSplitTunnelParam struct {
	// The address in CIDR format to exclude from the tunnel. If `address` is present,
	// `host` must not be present.
	Address param.Field[string] `json:"address,required"`
	// A description of the Split Tunnel item, displayed in the client UI.
	Description param.Field[string] `json:"description,required"`
	// The domain name to exclude from the tunnel. If `host` is present, `address` must
	// not be present.
	Host param.Field[string] `json:"host"`
}

func (TeamsDevicesSplitTunnelParam) MarshalJSON 

func (r TeamsDevicesSplitTunnelParam) MarshalJSON() (data []byte, err error)

type TeamsDevicesZeroTrustAccountDeviceSettings 

type TeamsDevicesZeroTrustAccountDeviceSettings struct {
	// Enable gateway proxy filtering on TCP.
	GatewayProxyEnabled bool `json:"gateway_proxy_enabled"`
	// Enable gateway proxy filtering on UDP.
	GatewayUdpProxyEnabled bool `json:"gateway_udp_proxy_enabled"`
	// Enable installation of cloudflare managed root certificate.
	RootCertificateInstallationEnabled bool `json:"root_certificate_installation_enabled"`
	// Enable using CGNAT virtual IPv4.
	UseZtVirtualIP bool                                           `json:"use_zt_virtual_ip"`
	JSON           teamsDevicesZeroTrustAccountDeviceSettingsJSON `json:"-"`
}

func (*TeamsDevicesZeroTrustAccountDeviceSettings) UnmarshalJSON 

func (r *TeamsDevicesZeroTrustAccountDeviceSettings) UnmarshalJSON(data []byte) (err error)

type TunnelArgoTunnel 

type TunnelArgoTunnel struct {
	// UUID of the tunnel.
	ID string `json:"id,required"`
	// The tunnel connections between your origin and Cloudflare's edge.
	Connections []TunnelArgoTunnelConnection `json:"connections,required"`
	// Timestamp of when the tunnel was created.
	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
	// A user-friendly name for the tunnel.
	Name string `json:"name,required"`
	// Timestamp of when the tunnel was deleted. If `null`, the tunnel has not been
	// deleted.
	DeletedAt time.Time            `json:"deleted_at,nullable" format:"date-time"`
	JSON      tunnelArgoTunnelJSON `json:"-"`
}

func (*TunnelArgoTunnel) UnmarshalJSON 

func (r *TunnelArgoTunnel) UnmarshalJSON(data []byte) (err error)

type TunnelArgoTunnelConnection 

type TunnelArgoTunnelConnection struct {
	// The Cloudflare data center used for this connection.
	ColoName string `json:"colo_name"`
	// Cloudflare continues to track connections for several minutes after they
	// disconnect. This is an optimization to improve latency and reliability of
	// reconnecting. If `true`, the connection has disconnected but is still being
	// tracked. If `false`, the connection is actively serving traffic.
	IsPendingReconnect bool `json:"is_pending_reconnect"`
	// UUID of the Cloudflare Tunnel connection.
	UUID string                         `json:"uuid"`
	JSON tunnelArgoTunnelConnectionJSON `json:"-"`
}

func (*TunnelArgoTunnelConnection) UnmarshalJSON 

func (r *TunnelArgoTunnelConnection) UnmarshalJSON(data []byte) (err error)

type TunnelConfigurationGetParams 

type TunnelConfigurationGetParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
}

type TunnelConfigurationGetResponse 

type TunnelConfigurationGetResponse interface {
	ImplementsZeroTrustTunnelConfigurationGetResponse()
}

Union satisfied by zero_trust.TunnelConfigurationGetResponseUnknown, zero_trust.TunnelConfigurationGetResponseArray or shared.UnionString.

type TunnelConfigurationGetResponseArray 

type TunnelConfigurationGetResponseArray []interface{}

func (TunnelConfigurationGetResponseArray) ImplementsZeroTrustTunnelConfigurationGetResponse 

func (r TunnelConfigurationGetResponseArray) ImplementsZeroTrustTunnelConfigurationGetResponse()

type TunnelConfigurationGetResponseEnvelope 

type TunnelConfigurationGetResponseEnvelope struct {
	Errors   []TunnelConfigurationGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []TunnelConfigurationGetResponseEnvelopeMessages `json:"messages,required"`
	Result   TunnelConfigurationGetResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success TunnelConfigurationGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    tunnelConfigurationGetResponseEnvelopeJSON    `json:"-"`
}

func (*TunnelConfigurationGetResponseEnvelope) UnmarshalJSON 

func (r *TunnelConfigurationGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type TunnelConfigurationGetResponseEnvelopeErrors 

type TunnelConfigurationGetResponseEnvelopeErrors struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    tunnelConfigurationGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*TunnelConfigurationGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *TunnelConfigurationGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type TunnelConfigurationGetResponseEnvelopeMessages 

type TunnelConfigurationGetResponseEnvelopeMessages struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    tunnelConfigurationGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*TunnelConfigurationGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *TunnelConfigurationGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type TunnelConfigurationGetResponseEnvelopeSuccess 

type TunnelConfigurationGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	TunnelConfigurationGetResponseEnvelopeSuccessTrue TunnelConfigurationGetResponseEnvelopeSuccess = true
)

type TunnelConfigurationService 

type TunnelConfigurationService struct {
	Options []option.RequestOption
}

TunnelConfigurationService 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 NewTunnelConfigurationService method instead.

func NewTunnelConfigurationService 

func NewTunnelConfigurationService(opts ...option.RequestOption) (r *TunnelConfigurationService)

NewTunnelConfigurationService 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 (*TunnelConfigurationService) Get 

func (r *TunnelConfigurationService) Get(ctx context.Context, tunnelID string, query TunnelConfigurationGetParams, opts ...option.RequestOption) (res *TunnelConfigurationGetResponse, err error)

Gets the configuration for a remotely-managed tunnel

func (*TunnelConfigurationService) Update 

func (r *TunnelConfigurationService) Update(ctx context.Context, tunnelID string, params TunnelConfigurationUpdateParams, opts ...option.RequestOption) (res *TunnelConfigurationUpdateResponse, err error)

Adds or updates the configuration for a remotely-managed tunnel.

type TunnelConfigurationUpdateParams 

type TunnelConfigurationUpdateParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	// The tunnel configuration and ingress rules.
	Config param.Field[TunnelConfigurationUpdateParamsConfig] `json:"config"`
}

func (TunnelConfigurationUpdateParams) MarshalJSON 

func (r TunnelConfigurationUpdateParams) MarshalJSON() (data []byte, err error)

type TunnelConfigurationUpdateParamsConfig 

type TunnelConfigurationUpdateParamsConfig struct {
	// List of public hostname definitions
	Ingress param.Field[[]TunnelConfigurationUpdateParamsConfigIngress] `json:"ingress"`
	// Configuration parameters of connection between cloudflared and origin server.
	OriginRequest param.Field[TunnelConfigurationUpdateParamsConfigOriginRequest] `json:"originRequest"`
	// Enable private network access from WARP users to private network routes
	WARPRouting param.Field[TunnelConfigurationUpdateParamsConfigWARPRouting] `json:"warp-routing"`
}

The tunnel configuration and ingress rules.

func (TunnelConfigurationUpdateParamsConfig) MarshalJSON 

func (r TunnelConfigurationUpdateParamsConfig) MarshalJSON() (data []byte, err error)

type TunnelConfigurationUpdateParamsConfigIngress 

type TunnelConfigurationUpdateParamsConfigIngress struct {
	// Public hostname for this service.
	Hostname param.Field[string] `json:"hostname,required"`
	// Protocol and address of destination server. Supported protocols: http://,
	// https://, unix://, tcp://, ssh://, rdp://, unix+tls://, smb://. Alternatively
	// can return a HTTP status code http_status:[code] e.g. 'http_status:404'.
	Service param.Field[string] `json:"service,required"`
	// Configuration parameters of connection between cloudflared and origin server.
	OriginRequest param.Field[TunnelConfigurationUpdateParamsConfigIngressOriginRequest] `json:"originRequest"`
	// Requests with this path route to this public hostname.
	Path param.Field[string] `json:"path"`
}

Public hostname

func (TunnelConfigurationUpdateParamsConfigIngress) MarshalJSON 

func (r TunnelConfigurationUpdateParamsConfigIngress) MarshalJSON() (data []byte, err error)

type TunnelConfigurationUpdateParamsConfigIngressOriginRequest 

type TunnelConfigurationUpdateParamsConfigIngressOriginRequest struct {
	// For all L7 requests to this hostname, cloudflared will validate each request's
	// Cf-Access-Jwt-Assertion request header.
	Access param.Field[TunnelConfigurationUpdateParamsConfigIngressOriginRequestAccess] `json:"access"`
	// Path to the certificate authority (CA) for the certificate of your origin. This
	// option should be used only if your certificate is not signed by Cloudflare.
	CAPool param.Field[string] `json:"caPool"`
	// Timeout for establishing a new TCP connection to your origin server. This
	// excludes the time taken to establish TLS, which is controlled by tlsTimeout.
	ConnectTimeout param.Field[int64] `json:"connectTimeout"`
	// Disables chunked transfer encoding. Useful if you are running a WSGI server.
	DisableChunkedEncoding param.Field[bool] `json:"disableChunkedEncoding"`
	// Attempt to connect to origin using HTTP2. Origin must be configured as https.
	HTTP2Origin param.Field[bool] `json:"http2Origin"`
	// Sets the HTTP Host header on requests sent to the local service.
	HTTPHostHeader param.Field[string] `json:"httpHostHeader"`
	// Maximum number of idle keepalive connections between Tunnel and your origin.
	// This does not restrict the total number of concurrent connections.
	KeepAliveConnections param.Field[int64] `json:"keepAliveConnections"`
	// Timeout after which an idle keepalive connection can be discarded.
	KeepAliveTimeout param.Field[int64] `json:"keepAliveTimeout"`
	// Disable the “happy eyeballs” algorithm for IPv4/IPv6 fallback if your local
	// network has misconfigured one of the protocols.
	NoHappyEyeballs param.Field[bool] `json:"noHappyEyeballs"`
	// Disables TLS verification of the certificate presented by your origin. Will
	// allow any certificate from the origin to be accepted.
	NoTLSVerify param.Field[bool] `json:"noTLSVerify"`
	// Hostname that cloudflared should expect from your origin server certificate.
	OriginServerName param.Field[string] `json:"originServerName"`
	// cloudflared starts a proxy server to translate HTTP traffic into TCP when
	// proxying, for example, SSH or RDP. This configures what type of proxy will be
	// started. Valid options are: "" for the regular proxy and "socks" for a SOCKS5
	// proxy.
	ProxyType param.Field[string] `json:"proxyType"`
	// The timeout after which a TCP keepalive packet is sent on a connection between
	// Tunnel and the origin server.
	TcpKeepAlive param.Field[int64] `json:"tcpKeepAlive"`
	// Timeout for completing a TLS handshake to your origin server, if you have chosen
	// to connect Tunnel to an HTTPS server.
	TLSTimeout param.Field[int64] `json:"tlsTimeout"`
}

Configuration parameters of connection between cloudflared and origin server.

func (TunnelConfigurationUpdateParamsConfigIngressOriginRequest) MarshalJSON 

func (r TunnelConfigurationUpdateParamsConfigIngressOriginRequest) MarshalJSON() (data []byte, err error)

type TunnelConfigurationUpdateParamsConfigIngressOriginRequestAccess 

type TunnelConfigurationUpdateParamsConfigIngressOriginRequestAccess struct {
	// Access applications that are allowed to reach this hostname for this Tunnel.
	// Audience tags can be identified in the dashboard or via the List Access policies
	// API.
	AudTag   param.Field[[]string] `json:"audTag,required"`
	TeamName param.Field[string]   `json:"teamName,required"`
	// Deny traffic that has not fulfilled Access authorization.
	Required param.Field[bool] `json:"required"`
}

For all L7 requests to this hostname, cloudflared will validate each request's Cf-Access-Jwt-Assertion request header.

func (TunnelConfigurationUpdateParamsConfigIngressOriginRequestAccess) MarshalJSON 

func (r TunnelConfigurationUpdateParamsConfigIngressOriginRequestAccess) MarshalJSON() (data []byte, err error)

type TunnelConfigurationUpdateParamsConfigOriginRequest 

type TunnelConfigurationUpdateParamsConfigOriginRequest struct {
	// For all L7 requests to this hostname, cloudflared will validate each request's
	// Cf-Access-Jwt-Assertion request header.
	Access param.Field[TunnelConfigurationUpdateParamsConfigOriginRequestAccess] `json:"access"`
	// Path to the certificate authority (CA) for the certificate of your origin. This
	// option should be used only if your certificate is not signed by Cloudflare.
	CAPool param.Field[string] `json:"caPool"`
	// Timeout for establishing a new TCP connection to your origin server. This
	// excludes the time taken to establish TLS, which is controlled by tlsTimeout.
	ConnectTimeout param.Field[int64] `json:"connectTimeout"`
	// Disables chunked transfer encoding. Useful if you are running a WSGI server.
	DisableChunkedEncoding param.Field[bool] `json:"disableChunkedEncoding"`
	// Attempt to connect to origin using HTTP2. Origin must be configured as https.
	HTTP2Origin param.Field[bool] `json:"http2Origin"`
	// Sets the HTTP Host header on requests sent to the local service.
	HTTPHostHeader param.Field[string] `json:"httpHostHeader"`
	// Maximum number of idle keepalive connections between Tunnel and your origin.
	// This does not restrict the total number of concurrent connections.
	KeepAliveConnections param.Field[int64] `json:"keepAliveConnections"`
	// Timeout after which an idle keepalive connection can be discarded.
	KeepAliveTimeout param.Field[int64] `json:"keepAliveTimeout"`
	// Disable the “happy eyeballs” algorithm for IPv4/IPv6 fallback if your local
	// network has misconfigured one of the protocols.
	NoHappyEyeballs param.Field[bool] `json:"noHappyEyeballs"`
	// Disables TLS verification of the certificate presented by your origin. Will
	// allow any certificate from the origin to be accepted.
	NoTLSVerify param.Field[bool] `json:"noTLSVerify"`
	// Hostname that cloudflared should expect from your origin server certificate.
	OriginServerName param.Field[string] `json:"originServerName"`
	// cloudflared starts a proxy server to translate HTTP traffic into TCP when
	// proxying, for example, SSH or RDP. This configures what type of proxy will be
	// started. Valid options are: "" for the regular proxy and "socks" for a SOCKS5
	// proxy.
	ProxyType param.Field[string] `json:"proxyType"`
	// The timeout after which a TCP keepalive packet is sent on a connection between
	// Tunnel and the origin server.
	TcpKeepAlive param.Field[int64] `json:"tcpKeepAlive"`
	// Timeout for completing a TLS handshake to your origin server, if you have chosen
	// to connect Tunnel to an HTTPS server.
	TLSTimeout param.Field[int64] `json:"tlsTimeout"`
}

Configuration parameters of connection between cloudflared and origin server.

func (TunnelConfigurationUpdateParamsConfigOriginRequest) MarshalJSON 

func (r TunnelConfigurationUpdateParamsConfigOriginRequest) MarshalJSON() (data []byte, err error)

type TunnelConfigurationUpdateParamsConfigOriginRequestAccess 

type TunnelConfigurationUpdateParamsConfigOriginRequestAccess struct {
	// Access applications that are allowed to reach this hostname for this Tunnel.
	// Audience tags can be identified in the dashboard or via the List Access policies
	// API.
	AudTag   param.Field[[]string] `json:"audTag,required"`
	TeamName param.Field[string]   `json:"teamName,required"`
	// Deny traffic that has not fulfilled Access authorization.
	Required param.Field[bool] `json:"required"`
}

For all L7 requests to this hostname, cloudflared will validate each request's Cf-Access-Jwt-Assertion request header.

func (TunnelConfigurationUpdateParamsConfigOriginRequestAccess) MarshalJSON 

func (r TunnelConfigurationUpdateParamsConfigOriginRequestAccess) MarshalJSON() (data []byte, err error)

type TunnelConfigurationUpdateParamsConfigWARPRouting 

type TunnelConfigurationUpdateParamsConfigWARPRouting struct {
	Enabled param.Field[bool] `json:"enabled"`
}

Enable private network access from WARP users to private network routes

func (TunnelConfigurationUpdateParamsConfigWARPRouting) MarshalJSON 

func (r TunnelConfigurationUpdateParamsConfigWARPRouting) MarshalJSON() (data []byte, err error)

type TunnelConfigurationUpdateResponse 

type TunnelConfigurationUpdateResponse interface {
	ImplementsZeroTrustTunnelConfigurationUpdateResponse()
}

Union satisfied by zero_trust.TunnelConfigurationUpdateResponseUnknown, zero_trust.TunnelConfigurationUpdateResponseArray or shared.UnionString.

type TunnelConfigurationUpdateResponseArray 

type TunnelConfigurationUpdateResponseArray []interface{}

func (TunnelConfigurationUpdateResponseArray) ImplementsZeroTrustTunnelConfigurationUpdateResponse 

func (r TunnelConfigurationUpdateResponseArray) ImplementsZeroTrustTunnelConfigurationUpdateResponse()

type TunnelConfigurationUpdateResponseEnvelope 

type TunnelConfigurationUpdateResponseEnvelope struct {
	Errors   []TunnelConfigurationUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []TunnelConfigurationUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   TunnelConfigurationUpdateResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success TunnelConfigurationUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    tunnelConfigurationUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*TunnelConfigurationUpdateResponseEnvelope) UnmarshalJSON 

func (r *TunnelConfigurationUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type TunnelConfigurationUpdateResponseEnvelopeErrors 

type TunnelConfigurationUpdateResponseEnvelopeErrors struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    tunnelConfigurationUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*TunnelConfigurationUpdateResponseEnvelopeErrors) UnmarshalJSON 

func (r *TunnelConfigurationUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type TunnelConfigurationUpdateResponseEnvelopeMessages 

type TunnelConfigurationUpdateResponseEnvelopeMessages struct {
	Code    int64                                                 `json:"code,required"`
	Message string                                                `json:"message,required"`
	JSON    tunnelConfigurationUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*TunnelConfigurationUpdateResponseEnvelopeMessages) UnmarshalJSON 

func (r *TunnelConfigurationUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type TunnelConfigurationUpdateResponseEnvelopeSuccess 

type TunnelConfigurationUpdateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	TunnelConfigurationUpdateResponseEnvelopeSuccessTrue TunnelConfigurationUpdateResponseEnvelopeSuccess = true
)

type TunnelConnectionDeleteParams 

type TunnelConnectionDeleteParams struct {
	// Cloudflare account ID
	AccountID param.Field[string]      `path:"account_id,required"`
	Body      param.Field[interface{}] `json:"body,required"`
}

func (TunnelConnectionDeleteParams) MarshalJSON 

func (r TunnelConnectionDeleteParams) MarshalJSON() (data []byte, err error)

type TunnelConnectionDeleteResponse 

type TunnelConnectionDeleteResponse interface {
	ImplementsZeroTrustTunnelConnectionDeleteResponse()
}

Union satisfied by zero_trust.TunnelConnectionDeleteResponseUnknown, zero_trust.TunnelConnectionDeleteResponseArray or shared.UnionString.

type TunnelConnectionDeleteResponseArray 

type TunnelConnectionDeleteResponseArray []interface{}

func (TunnelConnectionDeleteResponseArray) ImplementsZeroTrustTunnelConnectionDeleteResponse 

func (r TunnelConnectionDeleteResponseArray) ImplementsZeroTrustTunnelConnectionDeleteResponse()

type TunnelConnectionDeleteResponseEnvelope 

type TunnelConnectionDeleteResponseEnvelope struct {
	Errors   []TunnelConnectionDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []TunnelConnectionDeleteResponseEnvelopeMessages `json:"messages,required"`
	Result   TunnelConnectionDeleteResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success TunnelConnectionDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    tunnelConnectionDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*TunnelConnectionDeleteResponseEnvelope) UnmarshalJSON 

func (r *TunnelConnectionDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type TunnelConnectionDeleteResponseEnvelopeErrors 

type TunnelConnectionDeleteResponseEnvelopeErrors struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    tunnelConnectionDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*TunnelConnectionDeleteResponseEnvelopeErrors) UnmarshalJSON 

func (r *TunnelConnectionDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type TunnelConnectionDeleteResponseEnvelopeMessages 

type TunnelConnectionDeleteResponseEnvelopeMessages struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    tunnelConnectionDeleteResponseEnvelopeMessagesJSON `json:"-"`
}

func (*TunnelConnectionDeleteResponseEnvelopeMessages) UnmarshalJSON 

func (r *TunnelConnectionDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type TunnelConnectionDeleteResponseEnvelopeSuccess 

type TunnelConnectionDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	TunnelConnectionDeleteResponseEnvelopeSuccessTrue TunnelConnectionDeleteResponseEnvelopeSuccess = true
)

type TunnelConnectionGetParams 

type TunnelConnectionGetParams struct {
	// Cloudflare account ID
	AccountID param.Field[string] `path:"account_id,required"`
}

type TunnelConnectionGetResponseEnvelope 

type TunnelConnectionGetResponseEnvelope struct {
	Errors   []TunnelConnectionGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []TunnelConnectionGetResponseEnvelopeMessages `json:"messages,required"`
	Result   []TunnelTunnelClient                          `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    TunnelConnectionGetResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo TunnelConnectionGetResponseEnvelopeResultInfo `json:"result_info"`
	JSON       tunnelConnectionGetResponseEnvelopeJSON       `json:"-"`
}

func (*TunnelConnectionGetResponseEnvelope) UnmarshalJSON 

func (r *TunnelConnectionGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type TunnelConnectionGetResponseEnvelopeErrors 

type TunnelConnectionGetResponseEnvelopeErrors struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    tunnelConnectionGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*TunnelConnectionGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *TunnelConnectionGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type TunnelConnectionGetResponseEnvelopeMessages 

type TunnelConnectionGetResponseEnvelopeMessages struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    tunnelConnectionGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*TunnelConnectionGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *TunnelConnectionGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type TunnelConnectionGetResponseEnvelopeResultInfo 

type TunnelConnectionGetResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                           `json:"total_count"`
	JSON       tunnelConnectionGetResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*TunnelConnectionGetResponseEnvelopeResultInfo) UnmarshalJSON 

func (r *TunnelConnectionGetResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type TunnelConnectionGetResponseEnvelopeSuccess 

type TunnelConnectionGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	TunnelConnectionGetResponseEnvelopeSuccessTrue TunnelConnectionGetResponseEnvelopeSuccess = true
)

type TunnelConnectionService 

type TunnelConnectionService struct {
	Options []option.RequestOption
}

TunnelConnectionService 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 NewTunnelConnectionService method instead.

func NewTunnelConnectionService 

func NewTunnelConnectionService(opts ...option.RequestOption) (r *TunnelConnectionService)

NewTunnelConnectionService 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 (*TunnelConnectionService) Delete 

func (r *TunnelConnectionService) Delete(ctx context.Context, tunnelID string, params TunnelConnectionDeleteParams, opts ...option.RequestOption) (res *TunnelConnectionDeleteResponse, err error)

Removes connections that are in a disconnected or pending reconnect state. We recommend running this command after shutting down a tunnel.

func (*TunnelConnectionService) Get 

func (r *TunnelConnectionService) Get(ctx context.Context, tunnelID string, query TunnelConnectionGetParams, opts ...option.RequestOption) (res *[]TunnelTunnelClient, err error)

Fetches connection details for a Cloudflare Tunnel.

type TunnelConnectorGetParams 

type TunnelConnectorGetParams struct {
	// Cloudflare account ID
	AccountID param.Field[string] `path:"account_id,required"`
}

type TunnelConnectorGetResponseEnvelope 

type TunnelConnectorGetResponseEnvelope struct {
	Errors   []TunnelConnectorGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []TunnelConnectorGetResponseEnvelopeMessages `json:"messages,required"`
	// A client (typically cloudflared) that maintains connections to a Cloudflare data
	// center.
	Result TunnelTunnelClient `json:"result,required"`
	// Whether the API call was successful
	Success TunnelConnectorGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    tunnelConnectorGetResponseEnvelopeJSON    `json:"-"`
}

func (*TunnelConnectorGetResponseEnvelope) UnmarshalJSON 

func (r *TunnelConnectorGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type TunnelConnectorGetResponseEnvelopeErrors 

type TunnelConnectorGetResponseEnvelopeErrors struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    tunnelConnectorGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*TunnelConnectorGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *TunnelConnectorGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type TunnelConnectorGetResponseEnvelopeMessages 

type TunnelConnectorGetResponseEnvelopeMessages struct {
	Code    int64                                          `json:"code,required"`
	Message string                                         `json:"message,required"`
	JSON    tunnelConnectorGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*TunnelConnectorGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *TunnelConnectorGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type TunnelConnectorGetResponseEnvelopeSuccess 

type TunnelConnectorGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	TunnelConnectorGetResponseEnvelopeSuccessTrue TunnelConnectorGetResponseEnvelopeSuccess = true
)

type TunnelConnectorService 

type TunnelConnectorService struct {
	Options []option.RequestOption
}

TunnelConnectorService 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 NewTunnelConnectorService method instead.

func NewTunnelConnectorService 

func NewTunnelConnectorService(opts ...option.RequestOption) (r *TunnelConnectorService)

NewTunnelConnectorService 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 (*TunnelConnectorService) Get 

func (r *TunnelConnectorService) Get(ctx context.Context, tunnelID string, connectorID string, query TunnelConnectorGetParams, opts ...option.RequestOption) (res *TunnelTunnelClient, err error)

Fetches connector and connection details for a Cloudflare Tunnel.

type TunnelDeleteParams 

type TunnelDeleteParams struct {
	// Cloudflare account ID
	AccountID param.Field[string]      `path:"account_id,required"`
	Body      param.Field[interface{}] `json:"body,required"`
}

func (TunnelDeleteParams) MarshalJSON 

func (r TunnelDeleteParams) MarshalJSON() (data []byte, err error)

type TunnelDeleteResponseEnvelope 

type TunnelDeleteResponseEnvelope struct {
	Errors   []TunnelDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []TunnelDeleteResponseEnvelopeMessages `json:"messages,required"`
	Result   TunnelArgoTunnel                       `json:"result,required"`
	// Whether the API call was successful
	Success TunnelDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    tunnelDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*TunnelDeleteResponseEnvelope) UnmarshalJSON 

func (r *TunnelDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type TunnelDeleteResponseEnvelopeErrors 

type TunnelDeleteResponseEnvelopeErrors struct {
	Code    int64                                  `json:"code,required"`
	Message string                                 `json:"message,required"`
	JSON    tunnelDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*TunnelDeleteResponseEnvelopeErrors) UnmarshalJSON 

func (r *TunnelDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type TunnelDeleteResponseEnvelopeMessages 

type TunnelDeleteResponseEnvelopeMessages struct {
	Code    int64                                    `json:"code,required"`
	Message string                                   `json:"message,required"`
	JSON    tunnelDeleteResponseEnvelopeMessagesJSON `json:"-"`
}

func (*TunnelDeleteResponseEnvelopeMessages) UnmarshalJSON 

func (r *TunnelDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type TunnelDeleteResponseEnvelopeSuccess 

type TunnelDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	TunnelDeleteResponseEnvelopeSuccessTrue TunnelDeleteResponseEnvelopeSuccess = true
)

type TunnelEditParams 

type TunnelEditParams struct {
	// Cloudflare account ID
	AccountID param.Field[string] `path:"account_id,required"`
	// A user-friendly name for the tunnel.
	Name param.Field[string] `json:"name"`
	// Sets the password required to run a locally-managed tunnel. Must be at least 32
	// bytes and encoded as a base64 string.
	TunnelSecret param.Field[string] `json:"tunnel_secret"`
}

func (TunnelEditParams) MarshalJSON 

func (r TunnelEditParams) MarshalJSON() (data []byte, err error)

type TunnelEditResponse 

type TunnelEditResponse interface {
	// contains filtered or unexported methods
}

A Cloudflare Tunnel that connects your origin to Cloudflare's edge.

Union satisfied by zero_trust.TunnelEditResponseTunnelCfdTunnel or zero_trust.TunnelEditResponseTunnelWARPConnectorTunnel.

type TunnelEditResponseEnvelope 

type TunnelEditResponseEnvelope struct {
	Errors   []TunnelEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []TunnelEditResponseEnvelopeMessages `json:"messages,required"`
	// A Cloudflare Tunnel that connects your origin to Cloudflare's edge.
	Result TunnelEditResponse `json:"result,required"`
	// Whether the API call was successful
	Success TunnelEditResponseEnvelopeSuccess `json:"success,required"`
	JSON    tunnelEditResponseEnvelopeJSON    `json:"-"`
}

func (*TunnelEditResponseEnvelope) UnmarshalJSON 

func (r *TunnelEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type TunnelEditResponseEnvelopeErrors 

type TunnelEditResponseEnvelopeErrors struct {
	Code    int64                                `json:"code,required"`
	Message string                               `json:"message,required"`
	JSON    tunnelEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*TunnelEditResponseEnvelopeErrors) UnmarshalJSON 

func (r *TunnelEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type TunnelEditResponseEnvelopeMessages 

type TunnelEditResponseEnvelopeMessages struct {
	Code    int64                                  `json:"code,required"`
	Message string                                 `json:"message,required"`
	JSON    tunnelEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*TunnelEditResponseEnvelopeMessages) UnmarshalJSON 

func (r *TunnelEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type TunnelEditResponseEnvelopeSuccess 

type TunnelEditResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	TunnelEditResponseEnvelopeSuccessTrue TunnelEditResponseEnvelopeSuccess = true
)

type TunnelEditResponseTunnelCfdTunnel 

type TunnelEditResponseTunnelCfdTunnel struct {
	// UUID of the tunnel.
	ID string `json:"id"`
	// Cloudflare account ID
	AccountTag string `json:"account_tag"`
	// The Cloudflare Tunnel connections between your origin and Cloudflare's edge.
	Connections []TunnelEditResponseTunnelCfdTunnelConnection `json:"connections"`
	// Timestamp of when the tunnel established at least one connection to Cloudflare's
	// edge. If `null`, the tunnel is inactive.
	ConnsActiveAt time.Time `json:"conns_active_at,nullable" format:"date-time"`
	// Timestamp of when the tunnel became inactive (no connections to Cloudflare's
	// edge). If `null`, the tunnel is active.
	ConnsInactiveAt time.Time `json:"conns_inactive_at,nullable" format:"date-time"`
	// Timestamp of when the tunnel was created.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Timestamp of when the tunnel was deleted. If `null`, the tunnel has not been
	// deleted.
	DeletedAt time.Time `json:"deleted_at,nullable" format:"date-time"`
	// Metadata associated with the tunnel.
	Metadata interface{} `json:"metadata"`
	// A user-friendly name for the tunnel.
	Name string `json:"name"`
	// If `true`, the tunnel can be configured remotely from the Zero Trust dashboard.
	// If `false`, the tunnel must be configured locally on the origin machine.
	RemoteConfig bool `json:"remote_config"`
	// 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).
	Status string `json:"status"`
	// The type of tunnel.
	TunType TunnelEditResponseTunnelCfdTunnelTunType `json:"tun_type"`
	JSON    tunnelEditResponseTunnelCfdTunnelJSON    `json:"-"`
}

A Cloudflare Tunnel that connects your origin to Cloudflare's edge.

func (*TunnelEditResponseTunnelCfdTunnel) UnmarshalJSON 

func (r *TunnelEditResponseTunnelCfdTunnel) UnmarshalJSON(data []byte) (err error)

type TunnelEditResponseTunnelCfdTunnelConnection 

type TunnelEditResponseTunnelCfdTunnelConnection struct {
	// UUID of the Cloudflare Tunnel connection.
	ID string `json:"id"`
	// UUID of the cloudflared instance.
	ClientID interface{} `json:"client_id"`
	// The cloudflared version used to establish this connection.
	ClientVersion string `json:"client_version"`
	// The Cloudflare data center used for this connection.
	ColoName string `json:"colo_name"`
	// Cloudflare continues to track connections for several minutes after they
	// disconnect. This is an optimization to improve latency and reliability of
	// reconnecting. If `true`, the connection has disconnected but is still being
	// tracked. If `false`, the connection is actively serving traffic.
	IsPendingReconnect bool `json:"is_pending_reconnect"`
	// Timestamp of when the connection was established.
	OpenedAt time.Time `json:"opened_at" format:"date-time"`
	// The public IP address of the host running cloudflared.
	OriginIP string `json:"origin_ip"`
	// UUID of the Cloudflare Tunnel connection.
	UUID string                                          `json:"uuid"`
	JSON tunnelEditResponseTunnelCfdTunnelConnectionJSON `json:"-"`
}

func (*TunnelEditResponseTunnelCfdTunnelConnection) UnmarshalJSON 

func (r *TunnelEditResponseTunnelCfdTunnelConnection) UnmarshalJSON(data []byte) (err error)

type TunnelEditResponseTunnelCfdTunnelTunType 

type TunnelEditResponseTunnelCfdTunnelTunType string

The type of tunnel. 

const (
	TunnelEditResponseTunnelCfdTunnelTunTypeCfdTunnel     TunnelEditResponseTunnelCfdTunnelTunType = "cfd_tunnel"
	TunnelEditResponseTunnelCfdTunnelTunTypeWARPConnector TunnelEditResponseTunnelCfdTunnelTunType = "warp_connector"
	TunnelEditResponseTunnelCfdTunnelTunTypeIPSec         TunnelEditResponseTunnelCfdTunnelTunType = "ip_sec"
	TunnelEditResponseTunnelCfdTunnelTunTypeGRE           TunnelEditResponseTunnelCfdTunnelTunType = "gre"
	TunnelEditResponseTunnelCfdTunnelTunTypeCni           TunnelEditResponseTunnelCfdTunnelTunType = "cni"
)

type TunnelEditResponseTunnelWARPConnectorTunnel 

type TunnelEditResponseTunnelWARPConnectorTunnel struct {
	// UUID of the tunnel.
	ID string `json:"id"`
	// Cloudflare account ID
	AccountTag string `json:"account_tag"`
	// The Cloudflare Tunnel connections between your origin and Cloudflare's edge.
	Connections []TunnelEditResponseTunnelWARPConnectorTunnelConnection `json:"connections"`
	// Timestamp of when the tunnel established at least one connection to Cloudflare's
	// edge. If `null`, the tunnel is inactive.
	ConnsActiveAt time.Time `json:"conns_active_at,nullable" format:"date-time"`
	// Timestamp of when the tunnel became inactive (no connections to Cloudflare's
	// edge). If `null`, the tunnel is active.
	ConnsInactiveAt time.Time `json:"conns_inactive_at,nullable" format:"date-time"`
	// Timestamp of when the tunnel was created.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Timestamp of when the tunnel was deleted. If `null`, the tunnel has not been
	// deleted.
	DeletedAt time.Time `json:"deleted_at,nullable" format:"date-time"`
	// Metadata associated with the tunnel.
	Metadata interface{} `json:"metadata"`
	// A user-friendly name for the tunnel.
	Name string `json:"name"`
	// 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).
	Status string `json:"status"`
	// The type of tunnel.
	TunType TunnelEditResponseTunnelWARPConnectorTunnelTunType `json:"tun_type"`
	JSON    tunnelEditResponseTunnelWARPConnectorTunnelJSON    `json:"-"`
}

A Warp Connector Tunnel that connects your origin to Cloudflare's edge.

func (*TunnelEditResponseTunnelWARPConnectorTunnel) UnmarshalJSON 

func (r *TunnelEditResponseTunnelWARPConnectorTunnel) UnmarshalJSON(data []byte) (err error)

type TunnelEditResponseTunnelWARPConnectorTunnelConnection 

type TunnelEditResponseTunnelWARPConnectorTunnelConnection struct {
	// UUID of the Cloudflare Tunnel connection.
	ID string `json:"id"`
	// UUID of the cloudflared instance.
	ClientID interface{} `json:"client_id"`
	// The cloudflared version used to establish this connection.
	ClientVersion string `json:"client_version"`
	// The Cloudflare data center used for this connection.
	ColoName string `json:"colo_name"`
	// Cloudflare continues to track connections for several minutes after they
	// disconnect. This is an optimization to improve latency and reliability of
	// reconnecting. If `true`, the connection has disconnected but is still being
	// tracked. If `false`, the connection is actively serving traffic.
	IsPendingReconnect bool `json:"is_pending_reconnect"`
	// Timestamp of when the connection was established.
	OpenedAt time.Time `json:"opened_at" format:"date-time"`
	// The public IP address of the host running cloudflared.
	OriginIP string `json:"origin_ip"`
	// UUID of the Cloudflare Tunnel connection.
	UUID string                                                    `json:"uuid"`
	JSON tunnelEditResponseTunnelWARPConnectorTunnelConnectionJSON `json:"-"`
}

func (*TunnelEditResponseTunnelWARPConnectorTunnelConnection) UnmarshalJSON 

func (r *TunnelEditResponseTunnelWARPConnectorTunnelConnection) UnmarshalJSON(data []byte) (err error)

type TunnelEditResponseTunnelWARPConnectorTunnelTunType 

type TunnelEditResponseTunnelWARPConnectorTunnelTunType string

The type of tunnel. 

const (
	TunnelEditResponseTunnelWARPConnectorTunnelTunTypeCfdTunnel     TunnelEditResponseTunnelWARPConnectorTunnelTunType = "cfd_tunnel"
	TunnelEditResponseTunnelWARPConnectorTunnelTunTypeWARPConnector TunnelEditResponseTunnelWARPConnectorTunnelTunType = "warp_connector"
	TunnelEditResponseTunnelWARPConnectorTunnelTunTypeIPSec         TunnelEditResponseTunnelWARPConnectorTunnelTunType = "ip_sec"
	TunnelEditResponseTunnelWARPConnectorTunnelTunTypeGRE           TunnelEditResponseTunnelWARPConnectorTunnelTunType = "gre"
	TunnelEditResponseTunnelWARPConnectorTunnelTunTypeCni           TunnelEditResponseTunnelWARPConnectorTunnelTunType = "cni"
)

type TunnelGetParams 

type TunnelGetParams struct {
	// Cloudflare account ID
	AccountID param.Field[string] `path:"account_id,required"`
}

type TunnelGetResponseEnvelope 

type TunnelGetResponseEnvelope struct {
	Errors   []TunnelGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []TunnelGetResponseEnvelopeMessages `json:"messages,required"`
	Result   TunnelArgoTunnel                    `json:"result,required"`
	// Whether the API call was successful
	Success TunnelGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    tunnelGetResponseEnvelopeJSON    `json:"-"`
}

func (*TunnelGetResponseEnvelope) UnmarshalJSON 

func (r *TunnelGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type TunnelGetResponseEnvelopeErrors 

type TunnelGetResponseEnvelopeErrors struct {
	Code    int64                               `json:"code,required"`
	Message string                              `json:"message,required"`
	JSON    tunnelGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*TunnelGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *TunnelGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type TunnelGetResponseEnvelopeMessages 

type TunnelGetResponseEnvelopeMessages struct {
	Code    int64                                 `json:"code,required"`
	Message string                                `json:"message,required"`
	JSON    tunnelGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*TunnelGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *TunnelGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type TunnelGetResponseEnvelopeSuccess 

type TunnelGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	TunnelGetResponseEnvelopeSuccessTrue TunnelGetResponseEnvelopeSuccess = true
)

type TunnelListParams 

type TunnelListParams struct {
	// Cloudflare account ID
	AccountID     param.Field[string] `path:"account_id,required"`
	ExcludePrefix param.Field[string] `query:"exclude_prefix"`
	// If provided, include only tunnels that were created (and not deleted) before
	// this time.
	ExistedAt     param.Field[time.Time] `query:"existed_at" format:"date-time"`
	IncludePrefix param.Field[string]    `query:"include_prefix"`
	// If `true`, only include deleted tunnels. If `false`, exclude deleted tunnels. If
	// empty, all tunnels will be included.
	IsDeleted param.Field[bool] `query:"is_deleted"`
	// A user-friendly name for the tunnel.
	Name param.Field[string] `query:"name"`
	// Page number of paginated results.
	Page param.Field[float64] `query:"page"`
	// Number of results to display.
	PerPage param.Field[float64] `query:"per_page"`
	// The types of tunnels to filter separated by a comma.
	TunTypes      param.Field[string]    `query:"tun_types"`
	WasActiveAt   param.Field[time.Time] `query:"was_active_at" format:"date-time"`
	WasInactiveAt param.Field[time.Time] `query:"was_inactive_at" format:"date-time"`
}

func (TunnelListParams) URLQuery 

func (r TunnelListParams) URLQuery() (v url.Values)

URLQuery serializes TunnelListParams's query parameters as `url.Values`.

type TunnelListResponse 

type TunnelListResponse interface {
	// contains filtered or unexported methods
}

A Cloudflare Tunnel that connects your origin to Cloudflare's edge.

Union satisfied by zero_trust.TunnelListResponseTunnelCfdTunnel or zero_trust.TunnelListResponseTunnelWARPConnectorTunnel.

type TunnelListResponseTunnelCfdTunnel 

type TunnelListResponseTunnelCfdTunnel struct {
	// UUID of the tunnel.
	ID string `json:"id"`
	// Cloudflare account ID
	AccountTag string `json:"account_tag"`
	// The Cloudflare Tunnel connections between your origin and Cloudflare's edge.
	Connections []TunnelListResponseTunnelCfdTunnelConnection `json:"connections"`
	// Timestamp of when the tunnel established at least one connection to Cloudflare's
	// edge. If `null`, the tunnel is inactive.
	ConnsActiveAt time.Time `json:"conns_active_at,nullable" format:"date-time"`
	// Timestamp of when the tunnel became inactive (no connections to Cloudflare's
	// edge). If `null`, the tunnel is active.
	ConnsInactiveAt time.Time `json:"conns_inactive_at,nullable" format:"date-time"`
	// Timestamp of when the tunnel was created.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Timestamp of when the tunnel was deleted. If `null`, the tunnel has not been
	// deleted.
	DeletedAt time.Time `json:"deleted_at,nullable" format:"date-time"`
	// Metadata associated with the tunnel.
	Metadata interface{} `json:"metadata"`
	// A user-friendly name for the tunnel.
	Name string `json:"name"`
	// If `true`, the tunnel can be configured remotely from the Zero Trust dashboard.
	// If `false`, the tunnel must be configured locally on the origin machine.
	RemoteConfig bool `json:"remote_config"`
	// 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).
	Status string `json:"status"`
	// The type of tunnel.
	TunType TunnelListResponseTunnelCfdTunnelTunType `json:"tun_type"`
	JSON    tunnelListResponseTunnelCfdTunnelJSON    `json:"-"`
}

A Cloudflare Tunnel that connects your origin to Cloudflare's edge.

func (*TunnelListResponseTunnelCfdTunnel) UnmarshalJSON 

func (r *TunnelListResponseTunnelCfdTunnel) UnmarshalJSON(data []byte) (err error)

type TunnelListResponseTunnelCfdTunnelConnection 

type TunnelListResponseTunnelCfdTunnelConnection struct {
	// UUID of the Cloudflare Tunnel connection.
	ID string `json:"id"`
	// UUID of the cloudflared instance.
	ClientID interface{} `json:"client_id"`
	// The cloudflared version used to establish this connection.
	ClientVersion string `json:"client_version"`
	// The Cloudflare data center used for this connection.
	ColoName string `json:"colo_name"`
	// Cloudflare continues to track connections for several minutes after they
	// disconnect. This is an optimization to improve latency and reliability of
	// reconnecting. If `true`, the connection has disconnected but is still being
	// tracked. If `false`, the connection is actively serving traffic.
	IsPendingReconnect bool `json:"is_pending_reconnect"`
	// Timestamp of when the connection was established.
	OpenedAt time.Time `json:"opened_at" format:"date-time"`
	// The public IP address of the host running cloudflared.
	OriginIP string `json:"origin_ip"`
	// UUID of the Cloudflare Tunnel connection.
	UUID string                                          `json:"uuid"`
	JSON tunnelListResponseTunnelCfdTunnelConnectionJSON `json:"-"`
}

func (*TunnelListResponseTunnelCfdTunnelConnection) UnmarshalJSON 

func (r *TunnelListResponseTunnelCfdTunnelConnection) UnmarshalJSON(data []byte) (err error)

type TunnelListResponseTunnelCfdTunnelTunType 

type TunnelListResponseTunnelCfdTunnelTunType string

The type of tunnel. 

const (
	TunnelListResponseTunnelCfdTunnelTunTypeCfdTunnel     TunnelListResponseTunnelCfdTunnelTunType = "cfd_tunnel"
	TunnelListResponseTunnelCfdTunnelTunTypeWARPConnector TunnelListResponseTunnelCfdTunnelTunType = "warp_connector"
	TunnelListResponseTunnelCfdTunnelTunTypeIPSec         TunnelListResponseTunnelCfdTunnelTunType = "ip_sec"
	TunnelListResponseTunnelCfdTunnelTunTypeGRE           TunnelListResponseTunnelCfdTunnelTunType = "gre"
	TunnelListResponseTunnelCfdTunnelTunTypeCni           TunnelListResponseTunnelCfdTunnelTunType = "cni"
)

type TunnelListResponseTunnelWARPConnectorTunnel 

type TunnelListResponseTunnelWARPConnectorTunnel struct {
	// UUID of the tunnel.
	ID string `json:"id"`
	// Cloudflare account ID
	AccountTag string `json:"account_tag"`
	// The Cloudflare Tunnel connections between your origin and Cloudflare's edge.
	Connections []TunnelListResponseTunnelWARPConnectorTunnelConnection `json:"connections"`
	// Timestamp of when the tunnel established at least one connection to Cloudflare's
	// edge. If `null`, the tunnel is inactive.
	ConnsActiveAt time.Time `json:"conns_active_at,nullable" format:"date-time"`
	// Timestamp of when the tunnel became inactive (no connections to Cloudflare's
	// edge). If `null`, the tunnel is active.
	ConnsInactiveAt time.Time `json:"conns_inactive_at,nullable" format:"date-time"`
	// Timestamp of when the tunnel was created.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Timestamp of when the tunnel was deleted. If `null`, the tunnel has not been
	// deleted.
	DeletedAt time.Time `json:"deleted_at,nullable" format:"date-time"`
	// Metadata associated with the tunnel.
	Metadata interface{} `json:"metadata"`
	// A user-friendly name for the tunnel.
	Name string `json:"name"`
	// 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).
	Status string `json:"status"`
	// The type of tunnel.
	TunType TunnelListResponseTunnelWARPConnectorTunnelTunType `json:"tun_type"`
	JSON    tunnelListResponseTunnelWARPConnectorTunnelJSON    `json:"-"`
}

A Warp Connector Tunnel that connects your origin to Cloudflare's edge.

func (*TunnelListResponseTunnelWARPConnectorTunnel) UnmarshalJSON 

func (r *TunnelListResponseTunnelWARPConnectorTunnel) UnmarshalJSON(data []byte) (err error)

type TunnelListResponseTunnelWARPConnectorTunnelConnection 

type TunnelListResponseTunnelWARPConnectorTunnelConnection struct {
	// UUID of the Cloudflare Tunnel connection.
	ID string `json:"id"`
	// UUID of the cloudflared instance.
	ClientID interface{} `json:"client_id"`
	// The cloudflared version used to establish this connection.
	ClientVersion string `json:"client_version"`
	// The Cloudflare data center used for this connection.
	ColoName string `json:"colo_name"`
	// Cloudflare continues to track connections for several minutes after they
	// disconnect. This is an optimization to improve latency and reliability of
	// reconnecting. If `true`, the connection has disconnected but is still being
	// tracked. If `false`, the connection is actively serving traffic.
	IsPendingReconnect bool `json:"is_pending_reconnect"`
	// Timestamp of when the connection was established.
	OpenedAt time.Time `json:"opened_at" format:"date-time"`
	// The public IP address of the host running cloudflared.
	OriginIP string `json:"origin_ip"`
	// UUID of the Cloudflare Tunnel connection.
	UUID string                                                    `json:"uuid"`
	JSON tunnelListResponseTunnelWARPConnectorTunnelConnectionJSON `json:"-"`
}

func (*TunnelListResponseTunnelWARPConnectorTunnelConnection) UnmarshalJSON 

func (r *TunnelListResponseTunnelWARPConnectorTunnelConnection) UnmarshalJSON(data []byte) (err error)

type TunnelListResponseTunnelWARPConnectorTunnelTunType 

type TunnelListResponseTunnelWARPConnectorTunnelTunType string

The type of tunnel. 

const (
	TunnelListResponseTunnelWARPConnectorTunnelTunTypeCfdTunnel     TunnelListResponseTunnelWARPConnectorTunnelTunType = "cfd_tunnel"
	TunnelListResponseTunnelWARPConnectorTunnelTunTypeWARPConnector TunnelListResponseTunnelWARPConnectorTunnelTunType = "warp_connector"
	TunnelListResponseTunnelWARPConnectorTunnelTunTypeIPSec         TunnelListResponseTunnelWARPConnectorTunnelTunType = "ip_sec"
	TunnelListResponseTunnelWARPConnectorTunnelTunTypeGRE           TunnelListResponseTunnelWARPConnectorTunnelTunType = "gre"
	TunnelListResponseTunnelWARPConnectorTunnelTunTypeCni           TunnelListResponseTunnelWARPConnectorTunnelTunType = "cni"
)

type TunnelManagementNewParams 

type TunnelManagementNewParams struct {
	// Cloudflare account ID
	AccountID param.Field[string]                              `path:"account_id,required"`
	Resources param.Field[[]TunnelManagementNewParamsResource] `json:"resources,required"`
}

func (TunnelManagementNewParams) MarshalJSON 

func (r TunnelManagementNewParams) MarshalJSON() (data []byte, err error)

type TunnelManagementNewParamsResource 

type TunnelManagementNewParamsResource string

Management resources the token will have access to. 

const (
	TunnelManagementNewParamsResourceLogs TunnelManagementNewParamsResource = "logs"
)

type TunnelManagementNewResponse 

type TunnelManagementNewResponse interface {
	ImplementsZeroTrustTunnelManagementNewResponse()
}

Union satisfied by zero_trust.TunnelManagementNewResponseUnknown, zero_trust.TunnelManagementNewResponseArray or shared.UnionString.

type TunnelManagementNewResponseArray 

type TunnelManagementNewResponseArray []interface{}

func (TunnelManagementNewResponseArray) ImplementsZeroTrustTunnelManagementNewResponse 

func (r TunnelManagementNewResponseArray) ImplementsZeroTrustTunnelManagementNewResponse()

type TunnelManagementNewResponseEnvelope 

type TunnelManagementNewResponseEnvelope struct {
	Errors   []TunnelManagementNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []TunnelManagementNewResponseEnvelopeMessages `json:"messages,required"`
	Result   TunnelManagementNewResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success TunnelManagementNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    tunnelManagementNewResponseEnvelopeJSON    `json:"-"`
}

func (*TunnelManagementNewResponseEnvelope) UnmarshalJSON 

func (r *TunnelManagementNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type TunnelManagementNewResponseEnvelopeErrors 

type TunnelManagementNewResponseEnvelopeErrors struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    tunnelManagementNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*TunnelManagementNewResponseEnvelopeErrors) UnmarshalJSON 

func (r *TunnelManagementNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type TunnelManagementNewResponseEnvelopeMessages 

type TunnelManagementNewResponseEnvelopeMessages struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    tunnelManagementNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*TunnelManagementNewResponseEnvelopeMessages) UnmarshalJSON 

func (r *TunnelManagementNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type TunnelManagementNewResponseEnvelopeSuccess 

type TunnelManagementNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	TunnelManagementNewResponseEnvelopeSuccessTrue TunnelManagementNewResponseEnvelopeSuccess = true
)

type TunnelManagementService 

type TunnelManagementService struct {
	Options []option.RequestOption
}

TunnelManagementService 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 NewTunnelManagementService method instead.

func NewTunnelManagementService 

func NewTunnelManagementService(opts ...option.RequestOption) (r *TunnelManagementService)

NewTunnelManagementService 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 (*TunnelManagementService) New 

func (r *TunnelManagementService) New(ctx context.Context, tunnelID string, params TunnelManagementNewParams, opts ...option.RequestOption) (res *TunnelManagementNewResponse, err error)

Gets a management token used to access the management resources (i.e. Streaming Logs) of a tunnel.

type TunnelNewParams 

type TunnelNewParams struct {
	// Cloudflare account ID
	AccountID param.Field[string] `path:"account_id,required"`
	// A user-friendly name for the tunnel.
	Name param.Field[string] `json:"name,required"`
	// Sets the password required to run the tunnel. Must be at least 32 bytes and
	// encoded as a base64 string.
	TunnelSecret param.Field[interface{}] `json:"tunnel_secret,required"`
}

func (TunnelNewParams) MarshalJSON 

func (r TunnelNewParams) MarshalJSON() (data []byte, err error)

type TunnelNewResponseEnvelope 

type TunnelNewResponseEnvelope struct {
	Errors   []TunnelNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []TunnelNewResponseEnvelopeMessages `json:"messages,required"`
	Result   TunnelArgoTunnel                    `json:"result,required"`
	// Whether the API call was successful
	Success TunnelNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    tunnelNewResponseEnvelopeJSON    `json:"-"`
}

func (*TunnelNewResponseEnvelope) UnmarshalJSON 

func (r *TunnelNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type TunnelNewResponseEnvelopeErrors 

type TunnelNewResponseEnvelopeErrors struct {
	Code    int64                               `json:"code,required"`
	Message string                              `json:"message,required"`
	JSON    tunnelNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*TunnelNewResponseEnvelopeErrors) UnmarshalJSON 

func (r *TunnelNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type TunnelNewResponseEnvelopeMessages 

type TunnelNewResponseEnvelopeMessages struct {
	Code    int64                                 `json:"code,required"`
	Message string                                `json:"message,required"`
	JSON    tunnelNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*TunnelNewResponseEnvelopeMessages) UnmarshalJSON 

func (r *TunnelNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type TunnelNewResponseEnvelopeSuccess 

type TunnelNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	TunnelNewResponseEnvelopeSuccessTrue TunnelNewResponseEnvelopeSuccess = true
)

type TunnelRoute 

type TunnelRoute struct {
	// UUID of the route.
	ID string `json:"id"`
	// Optional remark describing the route.
	Comment string `json:"comment"`
	// Timestamp of when the route was created.
	CreatedAt interface{} `json:"created_at"`
	// Timestamp of when the route was deleted. If `null`, the route has not been
	// deleted.
	DeletedAt time.Time `json:"deleted_at,nullable" format:"date-time"`
	// The private IPv4 or IPv6 range connected by the route, in CIDR notation.
	Network string `json:"network"`
	// UUID of the Cloudflare Tunnel serving the route.
	TunnelID interface{} `json:"tunnel_id"`
	// UUID of the Tunnel Virtual Network this route belongs to. If no virtual networks
	// are configured, the route is assigned to the default virtual network of the
	// account.
	VirtualNetworkID interface{}     `json:"virtual_network_id"`
	JSON             tunnelRouteJSON `json:"-"`
}

func (*TunnelRoute) UnmarshalJSON 

func (r *TunnelRoute) UnmarshalJSON(data []byte) (err error)

type TunnelService 

type TunnelService struct {
	Options        []option.RequestOption
	Configurations *TunnelConfigurationService
	Connections    *TunnelConnectionService
	Token          *TunnelTokenService
	Connectors     *TunnelConnectorService
	Management     *TunnelManagementService
}

TunnelService 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 NewTunnelService method instead.

func NewTunnelService 

func NewTunnelService(opts ...option.RequestOption) (r *TunnelService)

NewTunnelService 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 (*TunnelService) Delete 

func (r *TunnelService) Delete(ctx context.Context, tunnelID string, params TunnelDeleteParams, opts ...option.RequestOption) (res *TunnelArgoTunnel, err error)

Deletes an Argo Tunnel from an account.

func (*TunnelService) Edit 

func (r *TunnelService) Edit(ctx context.Context, tunnelID string, params TunnelEditParams, opts ...option.RequestOption) (res *TunnelEditResponse, err error)

Updates an existing Cloudflare Tunnel.

func (*TunnelService) Get 

func (r *TunnelService) Get(ctx context.Context, tunnelID string, query TunnelGetParams, opts ...option.RequestOption) (res *TunnelArgoTunnel, err error)

Fetches a single Argo Tunnel.

func (*TunnelService) List 

func (r *TunnelService) List(ctx context.Context, params TunnelListParams, opts ...option.RequestOption) (res *shared.V4PagePaginationArray[TunnelListResponse], err error)

Lists and filters all types of Tunnels in an account.

func (*TunnelService) ListAutoPaging 

func (r *TunnelService) ListAutoPaging(ctx context.Context, params TunnelListParams, opts ...option.RequestOption) *shared.V4PagePaginationArrayAutoPager[TunnelListResponse]

Lists and filters all types of Tunnels in an account.

func (*TunnelService) New 

func (r *TunnelService) New(ctx context.Context, params TunnelNewParams, opts ...option.RequestOption) (res *TunnelArgoTunnel, err error)

Creates a new Argo Tunnel in an account.

type TunnelTeamnet 

type TunnelTeamnet struct {
	// UUID of the route.
	ID string `json:"id"`
	// Optional remark describing the route.
	Comment string `json:"comment"`
	// Timestamp of when the route was created.
	CreatedAt interface{} `json:"created_at"`
	// Timestamp of when the route was deleted. If `null`, the route has not been
	// deleted.
	DeletedAt time.Time `json:"deleted_at,nullable" format:"date-time"`
	// The private IPv4 or IPv6 range connected by the route, in CIDR notation.
	Network string `json:"network"`
	// The type of tunnel.
	TunType TunnelTeamnetTunType `json:"tun_type"`
	// UUID of the Cloudflare Tunnel serving the route.
	TunnelID interface{} `json:"tunnel_id"`
	// The user-friendly name of the Cloudflare Tunnel serving the route.
	TunnelName interface{} `json:"tunnel_name"`
	// UUID of the Tunnel Virtual Network this route belongs to. If no virtual networks
	// are configured, the route is assigned to the default virtual network of the
	// account.
	VirtualNetworkID interface{} `json:"virtual_network_id"`
	// A user-friendly name for the virtual network.
	VirtualNetworkName string            `json:"virtual_network_name"`
	JSON               tunnelTeamnetJSON `json:"-"`
}

func (*TunnelTeamnet) UnmarshalJSON 

func (r *TunnelTeamnet) UnmarshalJSON(data []byte) (err error)

type TunnelTeamnetTunType 

type TunnelTeamnetTunType string

The type of tunnel. 

const (
	TunnelTeamnetTunTypeCfdTunnel     TunnelTeamnetTunType = "cfd_tunnel"
	TunnelTeamnetTunTypeWARPConnector TunnelTeamnetTunType = "warp_connector"
	TunnelTeamnetTunTypeIPSec         TunnelTeamnetTunType = "ip_sec"
	TunnelTeamnetTunTypeGRE           TunnelTeamnetTunType = "gre"
	TunnelTeamnetTunTypeCni           TunnelTeamnetTunType = "cni"
)

type TunnelTokenGetParams 

type TunnelTokenGetParams struct {
	// Cloudflare account ID
	AccountID param.Field[string] `path:"account_id,required"`
}

type TunnelTokenGetResponse 

type TunnelTokenGetResponse interface {
	ImplementsZeroTrustTunnelTokenGetResponse()
}

Union satisfied by zero_trust.TunnelTokenGetResponseUnknown, zero_trust.TunnelTokenGetResponseArray or shared.UnionString.

type TunnelTokenGetResponseArray 

type TunnelTokenGetResponseArray []interface{}

func (TunnelTokenGetResponseArray) ImplementsZeroTrustTunnelTokenGetResponse 

func (r TunnelTokenGetResponseArray) ImplementsZeroTrustTunnelTokenGetResponse()

type TunnelTokenGetResponseEnvelope 

type TunnelTokenGetResponseEnvelope struct {
	Errors   []TunnelTokenGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []TunnelTokenGetResponseEnvelopeMessages `json:"messages,required"`
	Result   TunnelTokenGetResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success TunnelTokenGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    tunnelTokenGetResponseEnvelopeJSON    `json:"-"`
}

func (*TunnelTokenGetResponseEnvelope) UnmarshalJSON 

func (r *TunnelTokenGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type TunnelTokenGetResponseEnvelopeErrors 

type TunnelTokenGetResponseEnvelopeErrors struct {
	Code    int64                                    `json:"code,required"`
	Message string                                   `json:"message,required"`
	JSON    tunnelTokenGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*TunnelTokenGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *TunnelTokenGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type TunnelTokenGetResponseEnvelopeMessages 

type TunnelTokenGetResponseEnvelopeMessages struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    tunnelTokenGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*TunnelTokenGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *TunnelTokenGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type TunnelTokenGetResponseEnvelopeSuccess 

type TunnelTokenGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	TunnelTokenGetResponseEnvelopeSuccessTrue TunnelTokenGetResponseEnvelopeSuccess = true
)

type TunnelTokenService 

type TunnelTokenService struct {
	Options []option.RequestOption
}

TunnelTokenService 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 NewTunnelTokenService method instead.

func NewTunnelTokenService 

func NewTunnelTokenService(opts ...option.RequestOption) (r *TunnelTokenService)

NewTunnelTokenService 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 (*TunnelTokenService) Get 

func (r *TunnelTokenService) Get(ctx context.Context, tunnelID string, query TunnelTokenGetParams, opts ...option.RequestOption) (res *TunnelTokenGetResponse, err error)

Gets the token used to associate cloudflared with a specific tunnel.

type TunnelTunnelClient 

type TunnelTunnelClient struct {
	// UUID of the Cloudflare Tunnel connection.
	ID string `json:"id"`
	// The cloudflared OS architecture used to establish this connection.
	Arch string `json:"arch"`
	// The version of the remote tunnel configuration. Used internally to sync
	// cloudflared with the Zero Trust dashboard.
	ConfigVersion int64 `json:"config_version"`
	// The Cloudflare Tunnel connections between your origin and Cloudflare's edge.
	Conns []TunnelTunnelClientConn `json:"conns"`
	// Features enabled for the Cloudflare Tunnel.
	Features []string `json:"features"`
	// Timestamp of when the tunnel connection was started.
	RunAt time.Time `json:"run_at" format:"date-time"`
	// The cloudflared version used to establish this connection.
	Version string                 `json:"version"`
	JSON    tunnelTunnelClientJSON `json:"-"`
}

A client (typically cloudflared) that maintains connections to a Cloudflare data center.

func (*TunnelTunnelClient) UnmarshalJSON 

func (r *TunnelTunnelClient) UnmarshalJSON(data []byte) (err error)

type TunnelTunnelClientConn 

type TunnelTunnelClientConn struct {
	// UUID of the Cloudflare Tunnel connection.
	ID string `json:"id"`
	// UUID of the cloudflared instance.
	ClientID interface{} `json:"client_id"`
	// The cloudflared version used to establish this connection.
	ClientVersion string `json:"client_version"`
	// The Cloudflare data center used for this connection.
	ColoName string `json:"colo_name"`
	// Cloudflare continues to track connections for several minutes after they
	// disconnect. This is an optimization to improve latency and reliability of
	// reconnecting. If `true`, the connection has disconnected but is still being
	// tracked. If `false`, the connection is actively serving traffic.
	IsPendingReconnect bool `json:"is_pending_reconnect"`
	// Timestamp of when the connection was established.
	OpenedAt time.Time `json:"opened_at" format:"date-time"`
	// The public IP address of the host running cloudflared.
	OriginIP string `json:"origin_ip"`
	// UUID of the Cloudflare Tunnel connection.
	UUID string                     `json:"uuid"`
	JSON tunnelTunnelClientConnJSON `json:"-"`
}

func (*TunnelTunnelClientConn) UnmarshalJSON 

func (r *TunnelTunnelClientConn) UnmarshalJSON(data []byte) (err error)

type TunnelVirtualNetwork 

type TunnelVirtualNetwork struct {
	// UUID of the virtual network.
	ID string `json:"id,required"`
	// Optional remark describing the virtual network.
	Comment string `json:"comment,required"`
	// Timestamp of when the virtual network was created.
	CreatedAt interface{} `json:"created_at,required"`
	// If `true`, this virtual network is the default for the account.
	IsDefaultNetwork bool `json:"is_default_network,required"`
	// A user-friendly name for the virtual network.
	Name string `json:"name,required"`
	// Timestamp of when the virtual network was deleted. If `null`, the virtual
	// network has not been deleted.
	DeletedAt interface{}              `json:"deleted_at"`
	JSON      tunnelVirtualNetworkJSON `json:"-"`
}

func (*TunnelVirtualNetwork) UnmarshalJSON 

func (r *TunnelVirtualNetwork) UnmarshalJSON(data []byte) (err error)

type ZeroTrustGatewayAppTypes 

type ZeroTrustGatewayAppTypes interface {
	// contains filtered or unexported methods
}

Union satisfied by zero_trust.ZeroTrustGatewayAppTypesZeroTrustGatewayApplication or zero_trust.ZeroTrustGatewayAppTypesZeroTrustGatewayApplicationType.

type ZeroTrustGatewayAppTypesZeroTrustGatewayApplication 

type ZeroTrustGatewayAppTypesZeroTrustGatewayApplication struct {
	// The identifier for this application. There is only one application per ID.
	ID int64 `json:"id"`
	// The identifier for the type of this application. There can be many applications
	// with the same type. This refers to the `id` of a returned application type.
	ApplicationTypeID int64     `json:"application_type_id"`
	CreatedAt         time.Time `json:"created_at" format:"date-time"`
	// The name of the application or application type.
	Name string                                                  `json:"name"`
	JSON zeroTrustGatewayAppTypesZeroTrustGatewayApplicationJSON `json:"-"`
}

func (*ZeroTrustGatewayAppTypesZeroTrustGatewayApplication) UnmarshalJSON 

func (r *ZeroTrustGatewayAppTypesZeroTrustGatewayApplication) UnmarshalJSON(data []byte) (err error)

type ZeroTrustGatewayAppTypesZeroTrustGatewayApplicationType 

type ZeroTrustGatewayAppTypesZeroTrustGatewayApplicationType struct {
	// The identifier for the type of this application. There can be many applications
	// with the same type. This refers to the `id` of a returned application type.
	ID        int64     `json:"id"`
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// A short summary of applications with this type.
	Description string `json:"description"`
	// The name of the application or application type.
	Name string                                                      `json:"name"`
	JSON zeroTrustGatewayAppTypesZeroTrustGatewayApplicationTypeJSON `json:"-"`
}

func (*ZeroTrustGatewayAppTypesZeroTrustGatewayApplicationType) UnmarshalJSON 

func (r *ZeroTrustGatewayAppTypesZeroTrustGatewayApplicationType) UnmarshalJSON(data []byte) (err error)

type ZeroTrustGatewayCategories 

type ZeroTrustGatewayCategories struct {
	// The identifier for this category. There is only one category per ID.
	ID int64 `json:"id"`
	// True if the category is in beta and subject to change.
	Beta bool `json:"beta"`
	// Which account types are allowed to create policies based on this category.
	// `blocked` categories are blocked unconditionally for all accounts.
	// `removalPending` categories can be removed from policies but not added.
	// `noBlock` categories cannot be blocked.
	Class ZeroTrustGatewayCategoriesClass `json:"class"`
	// A short summary of domains in the category.
	Description string `json:"description"`
	// The name of the category.
	Name string `json:"name"`
	// All subcategories for this category.
	Subcategories []ZeroTrustGatewayCategoriesSubcategory `json:"subcategories"`
	JSON          zeroTrustGatewayCategoriesJSON          `json:"-"`
}

func (*ZeroTrustGatewayCategories) UnmarshalJSON 

func (r *ZeroTrustGatewayCategories) UnmarshalJSON(data []byte) (err error)

type ZeroTrustGatewayCategoriesClass 

type ZeroTrustGatewayCategoriesClass string

Which account types are allowed to create policies based on this category. `blocked` categories are blocked unconditionally for all accounts. `removalPending` categories can be removed from policies but not added. `noBlock` categories cannot be blocked. 

const (
	ZeroTrustGatewayCategoriesClassFree           ZeroTrustGatewayCategoriesClass = "free"
	ZeroTrustGatewayCategoriesClassPremium        ZeroTrustGatewayCategoriesClass = "premium"
	ZeroTrustGatewayCategoriesClassBlocked        ZeroTrustGatewayCategoriesClass = "blocked"
	ZeroTrustGatewayCategoriesClassRemovalPending ZeroTrustGatewayCategoriesClass = "removalPending"
	ZeroTrustGatewayCategoriesClassNoBlock        ZeroTrustGatewayCategoriesClass = "noBlock"
)

type ZeroTrustGatewayCategoriesSubcategoriesClass 

type ZeroTrustGatewayCategoriesSubcategoriesClass string

Which account types are allowed to create policies based on this category. `blocked` categories are blocked unconditionally for all accounts. `removalPending` categories can be removed from policies but not added. `noBlock` categories cannot be blocked. 

const (
	ZeroTrustGatewayCategoriesSubcategoriesClassFree           ZeroTrustGatewayCategoriesSubcategoriesClass = "free"
	ZeroTrustGatewayCategoriesSubcategoriesClassPremium        ZeroTrustGatewayCategoriesSubcategoriesClass = "premium"
	ZeroTrustGatewayCategoriesSubcategoriesClassBlocked        ZeroTrustGatewayCategoriesSubcategoriesClass = "blocked"
	ZeroTrustGatewayCategoriesSubcategoriesClassRemovalPending ZeroTrustGatewayCategoriesSubcategoriesClass = "removalPending"
	ZeroTrustGatewayCategoriesSubcategoriesClassNoBlock        ZeroTrustGatewayCategoriesSubcategoriesClass = "noBlock"
)

type ZeroTrustGatewayCategoriesSubcategory 

type ZeroTrustGatewayCategoriesSubcategory struct {
	// The identifier for this category. There is only one category per ID.
	ID int64 `json:"id"`
	// True if the category is in beta and subject to change.
	Beta bool `json:"beta"`
	// Which account types are allowed to create policies based on this category.
	// `blocked` categories are blocked unconditionally for all accounts.
	// `removalPending` categories can be removed from policies but not added.
	// `noBlock` categories cannot be blocked.
	Class ZeroTrustGatewayCategoriesSubcategoriesClass `json:"class"`
	// A short summary of domains in the category.
	Description string `json:"description"`
	// The name of the category.
	Name string                                    `json:"name"`
	JSON zeroTrustGatewayCategoriesSubcategoryJSON `json:"-"`
}

func (*ZeroTrustGatewayCategoriesSubcategory) UnmarshalJSON 

func (r *ZeroTrustGatewayCategoriesSubcategory) UnmarshalJSON(data []byte) (err error)

type ZeroTrustGatewayGatewayAccountLoggingSettings 

type ZeroTrustGatewayGatewayAccountLoggingSettings struct {
	// Redact personally identifiable information from activity logging (PII fields
	// are: source IP, user email, user ID, device ID, URL, referrer, user agent).
	RedactPii bool `json:"redact_pii"`
	// Logging settings by rule type.
	SettingsByRuleType ZeroTrustGatewayGatewayAccountLoggingSettingsSettingsByRuleType `json:"settings_by_rule_type"`
	JSON               zeroTrustGatewayGatewayAccountLoggingSettingsJSON               `json:"-"`
}

func (*ZeroTrustGatewayGatewayAccountLoggingSettings) UnmarshalJSON 

func (r *ZeroTrustGatewayGatewayAccountLoggingSettings) UnmarshalJSON(data []byte) (err error)

type ZeroTrustGatewayGatewayAccountLoggingSettingsSettingsByRuleType 

type ZeroTrustGatewayGatewayAccountLoggingSettingsSettingsByRuleType struct {
	// Logging settings for DNS firewall.
	DNS interface{} `json:"dns"`
	// Logging settings for HTTP/HTTPS firewall.
	HTTP interface{} `json:"http"`
	// Logging settings for Network firewall.
	L4   interface{}                                                         `json:"l4"`
	JSON zeroTrustGatewayGatewayAccountLoggingSettingsSettingsByRuleTypeJSON `json:"-"`
}

Logging settings by rule type.

func (*ZeroTrustGatewayGatewayAccountLoggingSettingsSettingsByRuleType) UnmarshalJSON 

func (r *ZeroTrustGatewayGatewayAccountLoggingSettingsSettingsByRuleType) UnmarshalJSON(data []byte) (err error)

type ZeroTrustGatewayLists 

type ZeroTrustGatewayLists struct {
	// API Resource UUID tag.
	ID string `json:"id"`
	// The number of items in the list.
	Count     float64   `json:"count"`
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// The description of the list.
	Description string `json:"description"`
	// The name of the list.
	Name string `json:"name"`
	// The type of list.
	Type      ZeroTrustGatewayListsType `json:"type"`
	UpdatedAt time.Time                 `json:"updated_at" format:"date-time"`
	JSON      zeroTrustGatewayListsJSON `json:"-"`
}

func (*ZeroTrustGatewayLists) UnmarshalJSON 

func (r *ZeroTrustGatewayLists) UnmarshalJSON(data []byte) (err error)

type ZeroTrustGatewayListsType 

type ZeroTrustGatewayListsType string

The type of list. 

const (
	ZeroTrustGatewayListsTypeSerial ZeroTrustGatewayListsType = "SERIAL"
	ZeroTrustGatewayListsTypeURL    ZeroTrustGatewayListsType = "URL"
	ZeroTrustGatewayListsTypeDomain ZeroTrustGatewayListsType = "DOMAIN"
	ZeroTrustGatewayListsTypeEmail  ZeroTrustGatewayListsType = "EMAIL"
	ZeroTrustGatewayListsTypeIP     ZeroTrustGatewayListsType = "IP"
)

type ZeroTrustGatewayLocations 

type ZeroTrustGatewayLocations struct {
	ID interface{} `json:"id"`
	// True if the location is the default location.
	ClientDefault bool      `json:"client_default"`
	CreatedAt     time.Time `json:"created_at" format:"date-time"`
	// The DNS over HTTPS domain to send DNS requests to. This field is auto-generated
	// by Gateway.
	DohSubdomain string `json:"doh_subdomain"`
	// True if the location needs to resolve EDNS queries.
	EcsSupport bool `json:"ecs_support"`
	// IPV6 destination ip assigned to this location. DNS requests sent to this IP will
	// counted as the request under this location. This field is auto-generated by
	// Gateway.
	IP string `json:"ip"`
	// The name of the location.
	Name string `json:"name"`
	// A list of network ranges that requests from this location would originate from.
	Networks  []ZeroTrustGatewayLocationsNetwork `json:"networks"`
	UpdatedAt time.Time                          `json:"updated_at" format:"date-time"`
	JSON      zeroTrustGatewayLocationsJSON      `json:"-"`
}

func (*ZeroTrustGatewayLocations) UnmarshalJSON 

func (r *ZeroTrustGatewayLocations) UnmarshalJSON(data []byte) (err error)

type ZeroTrustGatewayLocationsNetwork 

type ZeroTrustGatewayLocationsNetwork struct {
	// The IPv4 address or IPv4 CIDR. IPv4 CIDRs are limited to a maximum of /24.
	Network string                               `json:"network,required"`
	JSON    zeroTrustGatewayLocationsNetworkJSON `json:"-"`
}

func (*ZeroTrustGatewayLocationsNetwork) UnmarshalJSON 

func (r *ZeroTrustGatewayLocationsNetwork) UnmarshalJSON(data []byte) (err error)

type ZeroTrustGatewayProxyEndpoints 

type ZeroTrustGatewayProxyEndpoints struct {
	ID        interface{} `json:"id"`
	CreatedAt time.Time   `json:"created_at" format:"date-time"`
	// A list of CIDRs to restrict ingress connections.
	IPs []string `json:"ips"`
	// The name of the proxy endpoint.
	Name string `json:"name"`
	// The subdomain to be used as the destination in the proxy client.
	Subdomain string                             `json:"subdomain"`
	UpdatedAt time.Time                          `json:"updated_at" format:"date-time"`
	JSON      zeroTrustGatewayProxyEndpointsJSON `json:"-"`
}

func (*ZeroTrustGatewayProxyEndpoints) UnmarshalJSON 

func (r *ZeroTrustGatewayProxyEndpoints) UnmarshalJSON(data []byte) (err error)

type ZeroTrustGatewayRules 

type ZeroTrustGatewayRules struct {
	// The API resource UUID.
	ID string `json:"id"`
	// The action to preform when the associated traffic, identity, and device posture
	// expressions are either absent or evaluate to `true`.
	Action    ZeroTrustGatewayRulesAction `json:"action"`
	CreatedAt time.Time                   `json:"created_at" format:"date-time"`
	// Date of deletion, if any.
	DeletedAt time.Time `json:"deleted_at,nullable" format:"date-time"`
	// The description of the rule.
	Description string `json:"description"`
	// The wirefilter expression used for device posture check matching.
	DevicePosture string `json:"device_posture"`
	// True if the rule is enabled.
	Enabled bool `json:"enabled"`
	// The protocol or layer to evaluate the traffic, identity, and device posture
	// expressions.
	Filters []ZeroTrustGatewayRulesFilter `json:"filters"`
	// The wirefilter expression used for identity matching.
	Identity string `json:"identity"`
	// The name of the rule.
	Name string `json:"name"`
	// Precedence sets the order of your rules. Lower values indicate higher
	// precedence. At each processing phase, applicable rules are evaluated in
	// ascending order of this value.
	Precedence int64 `json:"precedence"`
	// Additional settings that modify the rule's action.
	RuleSettings ZeroTrustGatewayRulesRuleSettings `json:"rule_settings"`
	// The schedule for activating DNS policies. This does not apply to HTTP or network
	// policies.
	Schedule ZeroTrustGatewayRulesSchedule `json:"schedule"`
	// The wirefilter expression used for traffic matching.
	Traffic   string                    `json:"traffic"`
	UpdatedAt time.Time                 `json:"updated_at" format:"date-time"`
	JSON      zeroTrustGatewayRulesJSON `json:"-"`
}

func (*ZeroTrustGatewayRules) UnmarshalJSON 

func (r *ZeroTrustGatewayRules) UnmarshalJSON(data []byte) (err error)

type ZeroTrustGatewayRulesAction 

type ZeroTrustGatewayRulesAction string

The action to preform when the associated traffic, identity, and device posture expressions are either absent or evaluate to `true`. 

const (
	ZeroTrustGatewayRulesActionOn           ZeroTrustGatewayRulesAction = "on"
	ZeroTrustGatewayRulesActionOff          ZeroTrustGatewayRulesAction = "off"
	ZeroTrustGatewayRulesActionAllow        ZeroTrustGatewayRulesAction = "allow"
	ZeroTrustGatewayRulesActionBlock        ZeroTrustGatewayRulesAction = "block"
	ZeroTrustGatewayRulesActionScan         ZeroTrustGatewayRulesAction = "scan"
	ZeroTrustGatewayRulesActionNoscan       ZeroTrustGatewayRulesAction = "noscan"
	ZeroTrustGatewayRulesActionSafesearch   ZeroTrustGatewayRulesAction = "safesearch"
	ZeroTrustGatewayRulesActionYtrestricted ZeroTrustGatewayRulesAction = "ytrestricted"
	ZeroTrustGatewayRulesActionIsolate      ZeroTrustGatewayRulesAction = "isolate"
	ZeroTrustGatewayRulesActionNoisolate    ZeroTrustGatewayRulesAction = "noisolate"
	ZeroTrustGatewayRulesActionOverride     ZeroTrustGatewayRulesAction = "override"
	ZeroTrustGatewayRulesActionL4Override   ZeroTrustGatewayRulesAction = "l4_override"
	ZeroTrustGatewayRulesActionEgress       ZeroTrustGatewayRulesAction = "egress"
	ZeroTrustGatewayRulesActionAuditSSH     ZeroTrustGatewayRulesAction = "audit_ssh"
)

type ZeroTrustGatewayRulesFilter 

type ZeroTrustGatewayRulesFilter string

The protocol or layer to use. 

const (
	ZeroTrustGatewayRulesFilterHTTP   ZeroTrustGatewayRulesFilter = "http"
	ZeroTrustGatewayRulesFilterDNS    ZeroTrustGatewayRulesFilter = "dns"
	ZeroTrustGatewayRulesFilterL4     ZeroTrustGatewayRulesFilter = "l4"
	ZeroTrustGatewayRulesFilterEgress ZeroTrustGatewayRulesFilter = "egress"
)

type ZeroTrustGatewayRulesRuleSettings 

type ZeroTrustGatewayRulesRuleSettings struct {
	// Add custom headers to allowed requests, in the form of key-value pairs. Keys are
	// header names, pointing to an array with its header value(s).
	AddHeaders interface{} `json:"add_headers"`
	// Set by parent MSP accounts to enable their children to bypass this rule.
	AllowChildBypass bool `json:"allow_child_bypass"`
	// Settings for the Audit SSH action.
	AuditSSH ZeroTrustGatewayRulesRuleSettingsAuditSSH `json:"audit_ssh"`
	// Configure how browser isolation behaves.
	BisoAdminControls ZeroTrustGatewayRulesRuleSettingsBisoAdminControls `json:"biso_admin_controls"`
	// Enable the custom block page.
	BlockPageEnabled bool `json:"block_page_enabled"`
	// The text describing why this block occurred, displayed on the custom block page
	// (if enabled).
	BlockReason string `json:"block_reason"`
	// Set by children MSP accounts to bypass their parent's rules.
	BypassParentRule bool `json:"bypass_parent_rule"`
	// Configure how session check behaves.
	CheckSession ZeroTrustGatewayRulesRuleSettingsCheckSession `json:"check_session"`
	// Add your own custom resolvers to route queries that match the resolver policy.
	// Cannot be used when resolve_dns_through_cloudflare is set. DNS queries will
	// route to the address closest to their origin.
	DNSResolvers ZeroTrustGatewayRulesRuleSettingsDNSResolvers `json:"dns_resolvers"`
	// Configure how Gateway Proxy traffic egresses. You can enable this setting for
	// rules with Egress actions and filters, or omit it to indicate local egress via
	// WARP IPs.
	Egress ZeroTrustGatewayRulesRuleSettingsEgress `json:"egress"`
	// INSECURE - disable DNSSEC validation (for Allow actions).
	InsecureDisableDNSSECValidation bool `json:"insecure_disable_dnssec_validation"`
	// Set to true to enable IPs in DNS resolver category blocks. By default categories
	// only block based on domain names.
	IPCategories bool `json:"ip_categories"`
	// Set to true to include IPs in DNS resolver indicator feed blocks. By default
	// indicator feeds only block based on domain names.
	IPIndicatorFeeds bool `json:"ip_indicator_feeds"`
	// Send matching traffic to the supplied destination IP address and port.
	L4override ZeroTrustGatewayRulesRuleSettingsL4override `json:"l4override"`
	// Configure a notification to display on the user's device when this rule is
	// matched.
	NotificationSettings ZeroTrustGatewayRulesRuleSettingsNotificationSettings `json:"notification_settings"`
	// Override matching DNS queries with a hostname.
	OverrideHost string `json:"override_host"`
	// Override matching DNS queries with an IP or set of IPs.
	OverrideIPs []string `json:"override_ips"`
	// Configure DLP payload logging.
	PayloadLog ZeroTrustGatewayRulesRuleSettingsPayloadLog `json:"payload_log"`
	// Enable to send queries that match the policy to Cloudflare's default 1.1.1.1 DNS
	// resolver. Cannot be set when dns_resolvers are specified.
	ResolveDNSThroughCloudflare bool `json:"resolve_dns_through_cloudflare"`
	// Configure behavior when an upstream cert is invalid or an SSL error occurs.
	UntrustedCert ZeroTrustGatewayRulesRuleSettingsUntrustedCert `json:"untrusted_cert"`
	JSON          zeroTrustGatewayRulesRuleSettingsJSON          `json:"-"`
}

Additional settings that modify the rule's action.

func (*ZeroTrustGatewayRulesRuleSettings) UnmarshalJSON 

func (r *ZeroTrustGatewayRulesRuleSettings) UnmarshalJSON(data []byte) (err error)

type ZeroTrustGatewayRulesRuleSettingsAuditSSH 

type ZeroTrustGatewayRulesRuleSettingsAuditSSH struct {
	// Enable to turn on SSH command logging.
	CommandLogging bool                                          `json:"command_logging"`
	JSON           zeroTrustGatewayRulesRuleSettingsAuditSSHJSON `json:"-"`
}

Settings for the Audit SSH action.

func (*ZeroTrustGatewayRulesRuleSettingsAuditSSH) UnmarshalJSON 

func (r *ZeroTrustGatewayRulesRuleSettingsAuditSSH) UnmarshalJSON(data []byte) (err error)

type ZeroTrustGatewayRulesRuleSettingsBisoAdminControls 

type ZeroTrustGatewayRulesRuleSettingsBisoAdminControls struct {
	// Set to true to enable copy-pasting.
	Dcp bool `json:"dcp"`
	// Set to true to enable downloading.
	Dd bool `json:"dd"`
	// Set to true to enable keyboard usage.
	Dk bool `json:"dk"`
	// Set to true to enable printing.
	Dp bool `json:"dp"`
	// Set to true to enable uploading.
	Du   bool                                                   `json:"du"`
	JSON zeroTrustGatewayRulesRuleSettingsBisoAdminControlsJSON `json:"-"`
}

Configure how browser isolation behaves.

func (*ZeroTrustGatewayRulesRuleSettingsBisoAdminControls) UnmarshalJSON 

func (r *ZeroTrustGatewayRulesRuleSettingsBisoAdminControls) UnmarshalJSON(data []byte) (err error)

type ZeroTrustGatewayRulesRuleSettingsCheckSession 

type ZeroTrustGatewayRulesRuleSettingsCheckSession struct {
	// Configure how fresh the session needs to be to be considered valid.
	Duration string `json:"duration"`
	// Set to true to enable session enforcement.
	Enforce bool                                              `json:"enforce"`
	JSON    zeroTrustGatewayRulesRuleSettingsCheckSessionJSON `json:"-"`
}

Configure how session check behaves.

func (*ZeroTrustGatewayRulesRuleSettingsCheckSession) UnmarshalJSON 

func (r *ZeroTrustGatewayRulesRuleSettingsCheckSession) UnmarshalJSON(data []byte) (err error)

type ZeroTrustGatewayRulesRuleSettingsDNSResolvers 

type ZeroTrustGatewayRulesRuleSettingsDNSResolvers struct {
	IPV4 []ZeroTrustGatewayRulesRuleSettingsDNSResolversIPV4 `json:"ipv4"`
	IPV6 []ZeroTrustGatewayRulesRuleSettingsDNSResolversIPV6 `json:"ipv6"`
	JSON zeroTrustGatewayRulesRuleSettingsDNSResolversJSON   `json:"-"`
}

Add your own custom resolvers to route queries that match the resolver policy. Cannot be used when resolve_dns_through_cloudflare is set. DNS queries will route to the address closest to their origin.

func (*ZeroTrustGatewayRulesRuleSettingsDNSResolvers) UnmarshalJSON 

func (r *ZeroTrustGatewayRulesRuleSettingsDNSResolvers) UnmarshalJSON(data []byte) (err error)

type ZeroTrustGatewayRulesRuleSettingsDNSResolversIPV4 

type ZeroTrustGatewayRulesRuleSettingsDNSResolversIPV4 struct {
	// IP address of upstream resolver.
	IP string `json:"ip,required"`
	// A port number to use for upstream resolver.
	Port int64 `json:"port"`
	// Whether to connect to this resolver over a private network. Must be set when
	// vnet_id is set.
	RouteThroughPrivateNetwork bool `json:"route_through_private_network"`
	// Optionally specify a virtual network for this resolver. Uses default virtual
	// network id if omitted.
	VnetID string                                                `json:"vnet_id"`
	JSON   zeroTrustGatewayRulesRuleSettingsDNSResolversIPV4JSON `json:"-"`
}

func (*ZeroTrustGatewayRulesRuleSettingsDNSResolversIPV4) UnmarshalJSON 

func (r *ZeroTrustGatewayRulesRuleSettingsDNSResolversIPV4) UnmarshalJSON(data []byte) (err error)

type ZeroTrustGatewayRulesRuleSettingsDNSResolversIPV6 

type ZeroTrustGatewayRulesRuleSettingsDNSResolversIPV6 struct {
	// IP address of upstream resolver.
	IP string `json:"ip,required"`
	// A port number to use for upstream resolver.
	Port int64 `json:"port"`
	// Whether to connect to this resolver over a private network. Must be set when
	// vnet_id is set.
	RouteThroughPrivateNetwork bool `json:"route_through_private_network"`
	// Optionally specify a virtual network for this resolver. Uses default virtual
	// network id if omitted.
	VnetID string                                                `json:"vnet_id"`
	JSON   zeroTrustGatewayRulesRuleSettingsDNSResolversIPV6JSON `json:"-"`
}

func (*ZeroTrustGatewayRulesRuleSettingsDNSResolversIPV6) UnmarshalJSON 

func (r *ZeroTrustGatewayRulesRuleSettingsDNSResolversIPV6) UnmarshalJSON(data []byte) (err error)

type ZeroTrustGatewayRulesRuleSettingsEgress 

type ZeroTrustGatewayRulesRuleSettingsEgress struct {
	// The IPv4 address to be used for egress.
	IPV4 string `json:"ipv4"`
	// The fallback IPv4 address to be used for egress in the event of an error
	// egressing with the primary IPv4. Can be '0.0.0.0' to indicate local egress via
	// WARP IPs.
	IPV4Fallback string `json:"ipv4_fallback"`
	// The IPv6 range to be used for egress.
	IPV6 string                                      `json:"ipv6"`
	JSON zeroTrustGatewayRulesRuleSettingsEgressJSON `json:"-"`
}

Configure how Gateway Proxy traffic egresses. You can enable this setting for rules with Egress actions and filters, or omit it to indicate local egress via WARP IPs.

func (*ZeroTrustGatewayRulesRuleSettingsEgress) UnmarshalJSON 

func (r *ZeroTrustGatewayRulesRuleSettingsEgress) UnmarshalJSON(data []byte) (err error)

type ZeroTrustGatewayRulesRuleSettingsL4override 

type ZeroTrustGatewayRulesRuleSettingsL4override struct {
	// IPv4 or IPv6 address.
	IP string `json:"ip"`
	// A port number to use for TCP/UDP overrides.
	Port int64                                           `json:"port"`
	JSON zeroTrustGatewayRulesRuleSettingsL4overrideJSON `json:"-"`
}

Send matching traffic to the supplied destination IP address and port.

func (*ZeroTrustGatewayRulesRuleSettingsL4override) UnmarshalJSON 

func (r *ZeroTrustGatewayRulesRuleSettingsL4override) UnmarshalJSON(data []byte) (err error)

type ZeroTrustGatewayRulesRuleSettingsNotificationSettings 

type ZeroTrustGatewayRulesRuleSettingsNotificationSettings struct {
	// Set notification on
	Enabled bool `json:"enabled"`
	// Customize the message shown in the notification.
	Msg string `json:"msg"`
	// Optional URL to direct users to additional information. If not set, the
	// notification will open a block page.
	SupportURL string                                                    `json:"support_url"`
	JSON       zeroTrustGatewayRulesRuleSettingsNotificationSettingsJSON `json:"-"`
}

Configure a notification to display on the user's device when this rule is matched.

func (*ZeroTrustGatewayRulesRuleSettingsNotificationSettings) UnmarshalJSON 

func (r *ZeroTrustGatewayRulesRuleSettingsNotificationSettings) UnmarshalJSON(data []byte) (err error)

type ZeroTrustGatewayRulesRuleSettingsPayloadLog 

type ZeroTrustGatewayRulesRuleSettingsPayloadLog struct {
	// Set to true to enable DLP payload logging for this rule.
	Enabled bool                                            `json:"enabled"`
	JSON    zeroTrustGatewayRulesRuleSettingsPayloadLogJSON `json:"-"`
}

Configure DLP payload logging.

func (*ZeroTrustGatewayRulesRuleSettingsPayloadLog) UnmarshalJSON 

func (r *ZeroTrustGatewayRulesRuleSettingsPayloadLog) UnmarshalJSON(data []byte) (err error)

type ZeroTrustGatewayRulesRuleSettingsUntrustedCert 

type ZeroTrustGatewayRulesRuleSettingsUntrustedCert struct {
	// The action performed when an untrusted certificate is seen. The default action
	// is an error with HTTP code 526.
	Action ZeroTrustGatewayRulesRuleSettingsUntrustedCertAction `json:"action"`
	JSON   zeroTrustGatewayRulesRuleSettingsUntrustedCertJSON   `json:"-"`
}

Configure behavior when an upstream cert is invalid or an SSL error occurs.

func (*ZeroTrustGatewayRulesRuleSettingsUntrustedCert) UnmarshalJSON 

func (r *ZeroTrustGatewayRulesRuleSettingsUntrustedCert) UnmarshalJSON(data []byte) (err error)

type ZeroTrustGatewayRulesRuleSettingsUntrustedCertAction 

type ZeroTrustGatewayRulesRuleSettingsUntrustedCertAction string

The action performed when an untrusted certificate is seen. The default action is an error with HTTP code 526. 

const (
	ZeroTrustGatewayRulesRuleSettingsUntrustedCertActionPassThrough ZeroTrustGatewayRulesRuleSettingsUntrustedCertAction = "pass_through"
	ZeroTrustGatewayRulesRuleSettingsUntrustedCertActionBlock       ZeroTrustGatewayRulesRuleSettingsUntrustedCertAction = "block"
	ZeroTrustGatewayRulesRuleSettingsUntrustedCertActionError       ZeroTrustGatewayRulesRuleSettingsUntrustedCertAction = "error"
)

type ZeroTrustGatewayRulesSchedule 

type ZeroTrustGatewayRulesSchedule struct {
	// The time intervals when the rule will be active on Fridays, in increasing order
	// from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on
	// Fridays.
	Fri string `json:"fri"`
	// The time intervals when the rule will be active on Mondays, in increasing order
	// from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on
	// Mondays.
	Mon string `json:"mon"`
	// The time intervals when the rule will be active on Saturdays, in increasing
	// order from 00:00-24:00. If this parameter is omitted, the rule will be
	// deactivated on Saturdays.
	Sat string `json:"sat"`
	// The time intervals when the rule will be active on Sundays, in increasing order
	// from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on
	// Sundays.
	Sun string `json:"sun"`
	// The time intervals when the rule will be active on Thursdays, in increasing
	// order from 00:00-24:00. If this parameter is omitted, the rule will be
	// deactivated on Thursdays.
	Thu string `json:"thu"`
	// The time zone the rule will be evaluated against. If a
	// [valid time zone city name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List)
	// is provided, Gateway will always use the current time at that time zone. If this
	// parameter is omitted, then Gateway will use the time zone inferred from the
	// user's source IP to evaluate the rule. If Gateway cannot determine the time zone
	// from the IP, we will fall back to the time zone of the user's connected data
	// center.
	TimeZone string `json:"time_zone"`
	// The time intervals when the rule will be active on Tuesdays, in increasing order
	// from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on
	// Tuesdays.
	Tue string `json:"tue"`
	// The time intervals when the rule will be active on Wednesdays, in increasing
	// order from 00:00-24:00. If this parameter is omitted, the rule will be
	// deactivated on Wednesdays.
	Wed  string                            `json:"wed"`
	JSON zeroTrustGatewayRulesScheduleJSON `json:"-"`
}

The schedule for activating DNS policies. This does not apply to HTTP or network policies.

func (*ZeroTrustGatewayRulesSchedule) UnmarshalJSON 

func (r *ZeroTrustGatewayRulesSchedule) UnmarshalJSON(data []byte) (err error)

type ZeroTrustGatewaySettings 

type ZeroTrustGatewaySettings struct {
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// SSH encryption public key
	PublicKey string `json:"public_key"`
	// Seed ID
	SeedID    string                       `json:"seed_id"`
	UpdatedAt time.Time                    `json:"updated_at" format:"date-time"`
	JSON      zeroTrustGatewaySettingsJSON `json:"-"`
}

func (*ZeroTrustGatewaySettings) UnmarshalJSON 

func (r *ZeroTrustGatewaySettings) UnmarshalJSON(data []byte) (err error)

type ZeroTrustService 

type ZeroTrustService struct {
	Options              []option.RequestOption
	Devices              *DeviceService
	IdentityProviders    *IdentityProviderService
	Organizations        *OrganizationService
	Seats                *SeatService
	Access               *AccessService
	DEX                  *DEXService
	Tunnels              *TunnelService
	ConnectivitySettings *ConnectivitySettingService
	DLP                  *DLPService
	Gateway              *GatewayService
	Networks             *NetworkService
}

ZeroTrustService 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 NewZeroTrustService method instead.

func NewZeroTrustService 

func NewZeroTrustService(opts ...option.RequestOption) (r *ZeroTrustService)

NewZeroTrustService 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.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.