Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

firezone

package module

Go to main page

Versions in this module

v0

deprecated

v0.1.2

Sep 4, 2026

retracted

v0.1.1

Sep 4, 2026

retracted

v0.1.0

Sep 4, 2026

retracted

Changes in this version

+ const Version

+ var ErrMissingID = errors.New("must not be empty")

+ var ErrNilRequest = errors.New("request must not be nil")

+ func IsConflict(err error) bool

+ func IsForbidden(err error) bool

+ func IsNotFound(err error) bool

+ func IsRateLimited(err error) bool

+ func IsUnauthorized(err error) bool

+ func IsValidation(err error) bool

+ func String(s string) *string

+ type APIError struct

+ Detail string

+ RetryAfter time.Duration

+ StatusCode int

+ Title string

+ Type string

+ ValidationErrors map[string][]string

+ func (e *APIError) Error() string

+ type Actor struct

+ AllowEmailOTPSignIn bool

+ CreatedByDirectoryID string

+ Email string

+ ID string

+ InsertedAt time.Time

+ IsDisabled bool

+ LastSeenAt *time.Time

+ Name string

+ Type ActorType

+ UpdatedAt time.Time

+ func (a *Actor) IsSynced() bool

+ type ActorListOptions struct

+ Email string

+ Name string

+ Type ActorType

+ type ActorType string

+ const ActorTypeAccountAdminUser

+ const ActorTypeAccountUser

+ const ActorTypeServiceAccount

+ type ActorsService struct

+ func (s *ActorsService) Create(ctx context.Context, req *CreateActorRequest) (*Actor, error)

+ func (s *ActorsService) Delete(ctx context.Context, id string) error

+ func (s *ActorsService) Disable(ctx context.Context, id string) (*Actor, error)

+ func (s *ActorsService) Enable(ctx context.Context, id string) (*Actor, error)

+ func (s *ActorsService) Get(ctx context.Context, id string) (*Actor, error)

+ func (s *ActorsService) List(ctx context.Context, opts *ActorListOptions) (*Page[Actor], error)

+ func (s *ActorsService) Update(ctx context.Context, id string, req *UpdateActorRequest) (*Actor, error)

+ type AuthProvider struct

+ AccountID string

+ ClientSessionLifetimeSecs *int

+ Context string

+ ID string

+ InsertedAt time.Time

+ IsDisabled bool

+ Issuer string

+ Name string

+ PortalSessionLifetimeSecs *int

+ UpdatedAt time.Time

+ type AuthProviderListOptions struct

+ Name string

+ type Client struct

+ Actors *ActorsService

+ ClientDevices *ClientsService

+ EmailOTPAuthProviders *EmailOTPAuthProvidersService

+ EntraAuthProviders *EntraAuthProvidersService

+ EntraDirectories *EntraDirectoriesService

+ GoogleAuthProviders *GoogleAuthProvidersService

+ GoogleDirectories *GoogleDirectoriesService

+ Groups *GroupsService

+ OIDCAuthProviders *OIDCAuthProvidersService

+ OktaAuthProviders *OktaAuthProvidersService

+ OktaDirectories *OktaDirectoriesService

+ Policies *PoliciesService

+ Resources *ResourcesService

+ Sites *SitesService

+ func NewClient(baseURL, token string, opts ...Option) (*Client, error)

+ type ClientDevice struct

+ ActorID string

+ CreatedAt time.Time

+ DeviceSerial string

+ DeviceUUID string

+ FirezoneID string

+ Hostname string

+ ID string

+ IPv4 string

+ IPv6 string

+ LastSeenAt *time.Time

+ LastSeenRemoteIP string

+ LastSeenVersion string

+ Name string

+ Online bool

+ PublicKey string

+ UpdatedAt time.Time

+ VerifiedAt *time.Time

+ type ClientListOptions struct

+ FirezoneID string

+ Name string

+ type ClientsService struct

+ func (s *ClientsService) Delete(ctx context.Context, id string) error

+ func (s *ClientsService) Get(ctx context.Context, id string) (*ClientDevice, error)

+ func (s *ClientsService) List(ctx context.Context, opts *ClientListOptions) (*Page[ClientDevice], error)

+ func (s *ClientsService) Unverify(ctx context.Context, id string) (*ClientDevice, error)

+ func (s *ClientsService) Update(ctx context.Context, id string, req *UpdateClientRequest) (*ClientDevice, error)

+ func (s *ClientsService) Verify(ctx context.Context, id string) (*ClientDevice, error)

+ type Condition struct

+ Operator ConditionOperator

+ Property ConditionProperty

+ Values []string

+ type ConditionOperator string

+ const ConditionOperatorIs

+ const ConditionOperatorIsIn

+ const ConditionOperatorIsInCIDR

+ const ConditionOperatorIsInDayOfWeekTimeRanges

+ const ConditionOperatorIsNotIn

+ const ConditionOperatorIsNotInCIDR

+ type ConditionProperty string

+ const ConditionPropertyAuthProviderID

+ const ConditionPropertyClientVerified

+ const ConditionPropertyCurrentUTCDatetime

+ const ConditionPropertyRemoteIP

+ const ConditionPropertyRemoteIPLocationRegion

+ type CreateActorRequest struct

+ AllowEmailOTPSignIn *bool

+ Email string

+ Name string

+ Type ActorType

+ type CreateGroupRequest struct

+ Name string

+ type CreatePolicyRequest struct

+ Conditions []Condition

+ Description string

+ FlowLogUploadsEnabled *bool

+ GroupID string

+ ResourceID string

+ type CreateResourceRequest struct

+ Address string

+ AddressDescription string

+ Filters []Filter

+ IPStack IPStack

+ Name string

+ SiteID string

+ Type ResourceType

+ type CreateSiteRequest struct

+ Name string

+ type DirectoryListOptions struct

+ Name string

+ type EmailOTPAuthProvider struct

+ type EmailOTPAuthProvidersService struct

+ func (s *EmailOTPAuthProvidersService) Get(ctx context.Context, id string) (*EmailOTPAuthProvider, error)

+ func (s *EmailOTPAuthProvidersService) List(ctx context.Context, opts *AuthProviderListOptions) (*Page[EmailOTPAuthProvider], error)

+ type EntraAuthProvider struct

+ EmailClaim string

+ IsDefault bool

+ type EntraAuthProvidersService struct

+ func (s *EntraAuthProvidersService) Get(ctx context.Context, id string) (*EntraAuthProvider, error)

+ func (s *EntraAuthProvidersService) List(ctx context.Context, opts *AuthProviderListOptions) (*Page[EntraAuthProvider], error)

+ type EntraDirectoriesService struct

+ func (s *EntraDirectoriesService) Get(ctx context.Context, id string) (*EntraDirectory, error)

+ func (s *EntraDirectoriesService) List(ctx context.Context, opts *DirectoryListOptions) (*Page[EntraDirectory], error)

+ type EntraDirectory struct

+ AccountID string

+ DisabledReason string

+ EmailField string

+ ErrorMessage string

+ ErroredAt *time.Time

+ ID string

+ InsertedAt time.Time

+ IsDisabled bool

+ Name string

+ SyncAllGroups bool

+ SyncedAt *time.Time

+ TenantID string

+ UpdatedAt time.Time

+ type Filter struct

+ Ports []string

+ Protocol FilterProtocol

+ type FilterProtocol string

+ const FilterProtocolICMP

+ const FilterProtocolTCP

+ const FilterProtocolUDP

+ type Gateway struct

+ GatewayTokenID string

+ ID string

+ IPv4 string

+ IPv6 string

+ Name string

+ Online bool

+ RotatedAt *time.Time

+ func (g *Gateway) RotationPending() bool

+ type GatewayListOptions struct

+ IPv4 string

+ IPv6 string

+ Name string

+ type GatewaysService struct

+ func (s *GatewaysService) Delete(ctx context.Context, id string) error

+ func (s *GatewaysService) Get(ctx context.Context, id string) (*Gateway, error)

+ func (s *GatewaysService) List(ctx context.Context, opts *GatewayListOptions) (*Page[Gateway], error)

+ func (s *GatewaysService) Provision(ctx context.Context, req *ProvisionGatewayRequest) (*ProvisionedGateway, error)

+ func (s *GatewaysService) RotateToken(ctx context.Context, id string) (*RotatedGatewayToken, error)

+ func (s *GatewaysService) Update(ctx context.Context, id string, req *UpdateGatewayRequest) (*Gateway, error)

+ type GoogleAuthProvider struct

+ IsDefault bool

+ type GoogleAuthProvidersService struct

+ func (s *GoogleAuthProvidersService) Get(ctx context.Context, id string) (*GoogleAuthProvider, error)

+ func (s *GoogleAuthProvidersService) List(ctx context.Context, opts *AuthProviderListOptions) (*Page[GoogleAuthProvider], error)

+ type GoogleDirectoriesService struct

+ func (s *GoogleDirectoriesService) Get(ctx context.Context, id string) (*GoogleDirectory, error)

+ func (s *GoogleDirectoriesService) List(ctx context.Context, opts *DirectoryListOptions) (*Page[GoogleDirectory], error)

+ type GoogleDirectory struct

+ AccountID string

+ DisabledReason string

+ Domain string

+ ErrorMessage string

+ ErroredAt *time.Time

+ GroupSyncMode string

+ ID string

+ ImpersonationEmail string

+ InsertedAt time.Time

+ IsDisabled bool

+ Name string

+ OrgUnitSyncEnabled bool

+ SyncedAt *time.Time

+ UpdatedAt time.Time

+ type Group struct

+ DirectoryID string

+ Email string

+ EntityType string

+ ID string

+ IdpID string

+ InsertedAt time.Time

+ Name string

+ SyncedAt *time.Time

+ UpdatedAt time.Time

+ func (g *Group) IsSynced() bool

+ type GroupListOptions struct

+ DirectoryID *string

+ EntityType string

+ Name string

+ type GroupMember struct

+ ID string

+ Name string

+ Type ActorType

+ type GroupsService struct

+ func (s *GroupsService) Create(ctx context.Context, req *CreateGroupRequest) (*Group, error)

+ func (s *GroupsService) Delete(ctx context.Context, id string) error

+ func (s *GroupsService) Get(ctx context.Context, id string) (*Group, error)

+ func (s *GroupsService) List(ctx context.Context, opts *GroupListOptions) (*Page[Group], error)

+ func (s *GroupsService) Memberships(groupID string) *MembershipsService

+ func (s *GroupsService) Update(ctx context.Context, id string, req *UpdateGroupRequest) (*Group, error)

+ type IPStack string

+ const IPStackDual

+ const IPStackIPv4Only

+ const IPStackIPv6Only

+ type ListOptions struct

+ Limit int

+ PageCursor string

+ type MembershipsService struct

+ func (s *MembershipsService) List(ctx context.Context, opts *ListOptions) (*Page[GroupMember], error)

+ func (s *MembershipsService) Patch(ctx context.Context, add, remove []string) ([]string, error)

+ func (s *MembershipsService) ReplaceAll(ctx context.Context, actorIDs []string) ([]string, error)

+ type Null struct

+ Valid bool

+ Value T

+ func Clear[T any]() *Null[T]

+ func Set[T any](v T) *Null[T]

+ func (n *Null[T]) UnmarshalJSON(data []byte) error

+ func (n Null[T]) MarshalJSON() ([]byte, error)

+ type OIDCAuthProvider struct

+ ClientID string

+ DiscoveryDocumentURI string

+ EmailVerificationMethod string

+ IsDefault bool

+ type OIDCAuthProvidersService struct

+ func (s *OIDCAuthProvidersService) Get(ctx context.Context, id string) (*OIDCAuthProvider, error)

+ func (s *OIDCAuthProvidersService) List(ctx context.Context, opts *AuthProviderListOptions) (*Page[OIDCAuthProvider], error)

+ type OktaAuthProvider struct

+ ClientID string

+ IsDefault bool

+ OktaDomain string

+ type OktaAuthProvidersService struct

+ func (s *OktaAuthProvidersService) Get(ctx context.Context, id string) (*OktaAuthProvider, error)

+ func (s *OktaAuthProvidersService) List(ctx context.Context, opts *AuthProviderListOptions) (*Page[OktaAuthProvider], error)

+ type OktaDirectoriesService struct

+ func (s *OktaDirectoriesService) Get(ctx context.Context, id string) (*OktaDirectory, error)

+ func (s *OktaDirectoriesService) List(ctx context.Context, opts *DirectoryListOptions) (*Page[OktaDirectory], error)

+ type OktaDirectory struct

+ AccountID string

+ ClientID string

+ DisabledReason string

+ ErrorMessage string

+ ErroredAt *time.Time

+ ID string

+ InsertedAt time.Time

+ IsDisabled bool

+ Kid string

+ Name string

+ OktaDomain string

+ SyncedAt *time.Time

+ UpdatedAt time.Time

+ type Option func(*Client) error

+ func WithHTTPClient(hc *http.Client) Option

+ func WithRequestTimeout(d time.Duration) Option

+ func WithRetry(enabled bool, maxRetries int) Option

+ func WithRetryMaxWait(d time.Duration) Option

+ func WithUserAgent(ua string) Option

+ type Page struct

+ Data []T

+ Metadata PageMetadata

+ type PageMetadata struct

+ Count int

+ Limit int

+ NextPage string

+ PrevPage string

+ type PoliciesService struct

+ func (s *PoliciesService) Create(ctx context.Context, req *CreatePolicyRequest) (*Policy, error)

+ func (s *PoliciesService) Delete(ctx context.Context, id string) error

+ func (s *PoliciesService) Disable(ctx context.Context, id string) (*Policy, error)

+ func (s *PoliciesService) Enable(ctx context.Context, id string) (*Policy, error)

+ func (s *PoliciesService) Get(ctx context.Context, id string) (*Policy, error)

+ func (s *PoliciesService) List(ctx context.Context, opts *PolicyListOptions) (*Page[Policy], error)

+ func (s *PoliciesService) Update(ctx context.Context, id string, req *UpdatePolicyRequest) (*Policy, error)

+ type Policy struct

+ Conditions []Condition

+ Description string

+ FlowLogUploadsEnabled bool

+ GroupID string

+ ID string

+ IsDisabled bool

+ ResourceID string

+ type PolicyListOptions struct

+ GroupID string

+ ResourceID string

+ type PoolMember struct

+ ID string

+ LastSeenAt *time.Time

+ Name string

+ type PoolMembersService struct

+ func (s *PoolMembersService) List(ctx context.Context, opts *ListOptions) (*Page[PoolMember], error)

+ func (s *PoolMembersService) Patch(ctx context.Context, add, remove []string) ([]string, error)

+ func (s *PoolMembersService) ReplaceAll(ctx context.Context, deviceIDs []string) ([]string, error)

+ type ProvisionGatewayRequest struct

+ Name string

+ type ProvisionedGateway struct

+ Token string

+ type Resource struct

+ Address string

+ AddressDescription string

+ Filters []Filter

+ ID string

+ IPStack IPStack

+ Name string

+ SiteID string

+ Type ResourceType

+ type ResourceListOptions struct

+ Address string

+ IPStack IPStack

+ Name string

+ SiteID string

+ Type ResourceType

+ type ResourceType string

+ const ResourceTypeCIDR

+ const ResourceTypeDNS

+ const ResourceTypeIP

+ const ResourceTypeStaticDevicePool

+ type ResourcesService struct

+ func (s *ResourcesService) Create(ctx context.Context, req *CreateResourceRequest) (*Resource, error)

+ func (s *ResourcesService) Delete(ctx context.Context, id string) error

+ func (s *ResourcesService) Get(ctx context.Context, id string) (*Resource, error)

+ func (s *ResourcesService) List(ctx context.Context, opts *ResourceListOptions) (*Page[Resource], error)

+ func (s *ResourcesService) PoolMembers(resourceID string) *PoolMembersService

+ func (s *ResourcesService) Update(ctx context.Context, id string, req *UpdateResourceRequest) (*Resource, error)

+ type RotatedGatewayToken struct

+ ID string

+ Token string

+ type Site struct

+ ID string

+ Name string

+ type SiteListOptions struct

+ Name string

+ type SitesService struct

+ func (s *SitesService) Create(ctx context.Context, req *CreateSiteRequest) (*Site, error)

+ func (s *SitesService) Delete(ctx context.Context, id string) error

+ func (s *SitesService) Gateways(siteID string) *GatewaysService

+ func (s *SitesService) Get(ctx context.Context, id string) (*Site, error)

+ func (s *SitesService) List(ctx context.Context, opts *SiteListOptions) (*Page[Site], error)

+ func (s *SitesService) Update(ctx context.Context, id string, req *UpdateSiteRequest) (*Site, error)

+ type UpdateActorRequest struct

+ AllowEmailOTPSignIn *bool

+ Email *Null[string]

+ IsDisabled *bool

+ Name string

+ Type ActorType

+ type UpdateClientRequest struct

+ Name string

+ type UpdateGatewayRequest struct

+ Name string

+ type UpdateGroupRequest struct

+ Name string

+ type UpdatePolicyRequest struct

+ Conditions *[]Condition

+ Description *Null[string]

+ FlowLogUploadsEnabled *bool

+ GroupID string

+ IsDisabled *bool

+ ResourceID string

+ type UpdateResourceRequest struct

+ Address *Null[string]

+ AddressDescription *Null[string]

+ Filters *[]Filter

+ IPStack *Null[IPStack]

+ Name string

+ SiteID *Null[string]

+ Type ResourceType

+ type UpdateSiteRequest struct

+ Name string