bastionzero

Documentation

Index

• Constants
• func PtrTo[T any](v T) *T
• func ToStringSlice[T ~string](elems []T) []string
• type Client
  • func New(httpClient *http.Client, opts ...ClientOpt) (*Client, error)
  • func NewClient(httpClient *http.Client) *Client
  • func NewFromAPISecret(httpClient *http.Client, apiSecret string, opts ...ClientOpt) (*Client, error)
  • func (c *Client) Do(req *http.Request, v interface{}) (*http.Response, error)
  • func (c *Client) Host() string
  • func (c *Client) NewRequest(ctx context.Context, method, urlStr string, body interface{}) (*http.Request, error)
• type ClientOpt
  • func WithBaseURL(baseUrl string) ClientOpt
  • func WithRequestHeaders(headers map[string]string) ClientOpt
  • func WithUserAgent(userAgent string) ClientOpt

Constants

const (

	// DefaultBaseURL is the default BastionZero API URL the Client communicates
	// with
	DefaultBaseURL = "https://cloud.bastionzero.com/"
)

Functions

func PtrTo

func PtrTo[T any](v T) *T

PtrTo returns a pointer to the provided input.

func ToStringSlice

func ToStringSlice[T ~string](elems []T) []string

ToStringSlice returns a list of strings given any list of a type that is aliased to a string.

Types

type Client

type Client struct {
	Agents               *agents.AgentsService
	ApiKeys              *apikeys.ApiKeysService
	AutodiscoveryScripts *autodiscoveryscripts.AutodiscoveryScriptsService
	Connections          *connections.ConnectionsService
	Environments         *environments.EnvironmentsService
	Events               *events.EventsService
	GitHubActions        *githubactions.GitHubActionsService
	MFA                  *mfa.MFAService
	OktaPublicKeys       *oktapublickeys.OktaPublicKeysService
	Organization         *organization.OrganizationService
	Policies             *policies.PoliciesService
	ServiceAccounts      *serviceaccounts.ServiceAccountsService
	SessionRecordings    *sessionrecordings.SessionRecordingsService
	Subjects             *subjects.SubjectsService
	Targets              *targets.TargetsService
	AllTargets           *targets_disambiguated.AllTargetsService
	Users                *users.UsersService
	// contains filtered or unexported fields
}

Client manages communication with the BastionZero API

func New

func New(httpClient *http.Client, opts ...ClientOpt) (*Client, error)

New returns a new BastionZero API client instance. If httpClient is nil, the default HTTP client provided by the http package is used.

func NewClient

func NewClient(httpClient *http.Client) *Client

NewClient returns a new BastionZero API client, using the given http.Client to perform all requests. If httpClient is nil, the default HTTP client provided by the http package is used.

func NewFromAPISecret

func NewFromAPISecret(httpClient *http.Client, apiSecret string, opts ...ClientOpt) (*Client, error)

NewFromAPISecret returns a new BastionZero API client that authenticates its requests with the given API secret. If httpClient is nil, the default HTTP client provided by the http package is used.

func (*Client) Do

func (c *Client) Do(req *http.Request, v interface{}) (*http.Response, error)

Do sends an API request and returns the API response. The API response is JSON decoded and stored in the value pointed to by v, or returned as an error if an API error has occurred. If v implements the io.Writer interface, the raw response will be written to v, without attempting to decode it.

The error type will be *ErrorResponse if the API response is considered an error

func (*Client) Host

func (c *Client) Host() string

Host returns the BastionZero server URL this client is configured to issue API requests against.

func (*Client) NewRequest

func (c *Client) NewRequest(ctx context.Context, method, urlStr string, body interface{}) (*http.Request, error)

NewRequest creates an API request. A relative URL can be provided in urlStr, which will be resolved to the BaseURL of the Client. Relative URLS should always be specified without a preceding slash. If specified, the value pointed to by body is JSON encoded and included in as the request body if applicable for the provided HTTP method.

type ClientOpt

type ClientOpt clientOpt

ClientOpt are options for New.

func WithBaseURL

func WithBaseURL(baseUrl string) ClientOpt

WithBaseURL is a client option for setting the base URL.

func WithRequestHeaders

func WithRequestHeaders(headers map[string]string) ClientOpt

WithRequestHeaders sets optional HTTP headers on the client that are sent on each HTTP request.

func WithUserAgent

func WithUserAgent(userAgent string) ClientOpt

WithUserAgent is a client option for seting the user agent.