zpa

Documentation

Index

• Constants
• type AuthToken
• type BackoffConfig
• type Client
  • func NewClient(config *Config) (c *Client)
  • func (client *Client) NewRequestDo(method, url string, options, body, v interface{}) (*http.Response, error)
  • func (client *Client) WithFreshCache()
• type Config
  • func NewConfig(clientID, clientSecret, customerID, cloud, userAgent string) (*Config, error)
  • func (c *Config) GetHTTPClient() *http.Client
  • func (c *Config) SetBackoffConfig(backoffConf BackoffConfig)
  • func (c *Config) WithCache(cache bool)
  • func (c *Config) WithCacheCleanWindow(i time.Duration)
  • func (c *Config) WithCacheTtl(i time.Duration)
• type CredentialsConfig
• type ErrorResponse
  • func (r *ErrorResponse) Error() string
  • func (r ErrorResponse) IsObjectNotFound() bool
• type RateLimiter
  • func NewRateLimiter() *RateLimiter
  • func (rl *RateLimiter) Wait(method string) (bool, time.Duration)

Constants

const (
	ZPA_CLIENT_ID     = "ZPA_CLIENT_ID"
	ZPA_CLIENT_SECRET = "ZPA_CLIENT_SECRET"
	ZPA_CUSTOMER_ID   = "ZPA_CUSTOMER_ID"
	ZPA_CLOUD         = "ZPA_CLOUD"
)

Types

type AuthToken

type AuthToken struct {
	TokenType   string `json:"token_type"`
	AccessToken string `json:"access_token"`
}

type BackoffConfig

type BackoffConfig struct {
	Enabled             bool // Set to true to enable backoff and retry mechanism
	RetryWaitMinSeconds int  // Minimum time to wait
	RetryWaitMaxSeconds int  // Maximum time to wait
	MaxNumOfRetries     int  // Maximum number of retries
}

type Client

type Client struct {
	Config *Config
	// contains filtered or unexported fields
}

func NewClient

func NewClient(config *Config) (c *Client)

NewClient returns a new client for the specified apiKey.

func (*Client) NewRequestDo

func (client *Client) NewRequestDo(method, url string, options, body, v interface{}) (*http.Response, error)

func (*Client) WithFreshCache

func (client *Client) WithFreshCache()

type Config

type Config struct {
	BaseURL *url.URL

	// The logger writer interface to write logging messages to. Defaults to standard out.
	Logger logger.Logger
	// Credentials for basic authentication.
	ClientID, ClientSecret, CustomerID, Cloud string
	// Backoff config
	BackoffConf *BackoffConfig
	AuthToken   *AuthToken
	sync.Mutex
	UserAgent string
	// contains filtered or unexported fields
}

Config contains all the configuration data for the API client

func NewConfig

func NewConfig(clientID, clientSecret, customerID, cloud, userAgent string) (*Config, error)

NewConfig returns a default configuration for the client. By default it will try to read the access and te secret from the environment variable.

Need to implement exponential back off to comply with the API rate limit. https://help.zscaler.com/zpa/about-rate-limiting 20 times in a 10 second interval for a GET call. 10 times in a 10 second interval for any POST/PUT/DELETE call. TODO Add healthCheck method to NewConfig

func (*Config) GetHTTPClient

func (c *Config) GetHTTPClient() *http.Client

func (*Config) SetBackoffConfig

func (c *Config) SetBackoffConfig(backoffConf BackoffConfig)

func (*Config) WithCache

func (c *Config) WithCache(cache bool)

func (*Config) WithCacheCleanWindow

func (c *Config) WithCacheCleanWindow(i time.Duration)

func (*Config) WithCacheTtl

func (c *Config) WithCacheTtl(i time.Duration)

type CredentialsConfig

type CredentialsConfig struct {
	ClientID     string `json:"zpa_client_id"`
	ClientSecret string `json:"zpa_client_secret"`
	CustomerID   string `json:"zpa_customer_id"`
	ZpaCloud     string `json:"zpa_cloud"`
}

type ErrorResponse

type ErrorResponse struct {
	Response *http.Response
	Message  string
}

func (*ErrorResponse) Error

func (r *ErrorResponse) Error() string

func (ErrorResponse) IsObjectNotFound

func (r ErrorResponse) IsObjectNotFound() bool

IsObjectNotFound returns true on missing object error (404 & 400 with response "id": "resource.not.found",).

type RateLimiter

type RateLimiter struct {
	// contains filtered or unexported fields
}

func NewRateLimiter

func NewRateLimiter() *RateLimiter

func (*RateLimiter) Wait

func (rl *RateLimiter) Wait(method string) (bool, time.Duration)