zia

Documentation

Index

• Constants
• type ApiErr
• type Client
  • func NewClient(username, password, apiKey, ziaCloud, userAgent string) (*Client, error)
  • func (c *Client) BulkDelete(endpoint string, payload interface{}) (*http.Response, error)
  • func (c *Client) Create(endpoint string, o interface{}) (interface{}, error)
  • func (c *Client) CreateWithSlicePayload(endpoint string, slice interface{}) ([]byte, error)
  • func (c *Client) Delete(endpoint string) error
  • func (c *Client) GenericRequest(baseUrl, endpoint, method string, body io.Reader, urlParams url.Values, ...) ([]byte, error)
  • func (c *Client) GetContentType() string
  • func (c *Client) GetSandboxToken() string
  • func (c *Client) GetSandboxURL() string
  • func (c *Client) Logout() error
  • func (c *Client) Read(endpoint string, o interface{}) error
  • func (c *Client) Request(endpoint, method string, data []byte, contentType string) ([]byte, error)
  • func (c *Client) Update(endpoint string, o interface{}) (interface{}, error)
  • func (c *Client) UpdateWithPut(endpoint string, o interface{}) (interface{}, error)
  • func (c *Client) UpdateWithSlicePayload(endpoint string, slice interface{}) ([]byte, error)
  • func (c *Client) WithCache(cache bool)
  • func (c *Client) WithCacheCleanWindow(i time.Duration)
  • func (c *Client) WithCacheTtl(i time.Duration)
  • func (client *Client) WithFreshCache()
• type Credentials
• type ErrorResponse
  • func (r *ErrorResponse) Error() string
  • func (r ErrorResponse) IsObjectNotFound() bool
• type Session
  • func MakeAuthRequestZIA(credentials *Credentials, url string, client *http.Client, userAgent string) (*Session, error)

Constants

const (
	JSessionIDTimeout = 30 // minutes.

	MaxNumOfRetries     = 100
	RetryWaitMaxSeconds = 20
	RetryWaitMinSeconds = 5
)

Types

type ApiErr

type ApiErr struct {
	Code    string `json:"code"`
	Message string `json:"message"`
}

type Client

type Client struct {
	sync.Mutex

	URL        string
	HTTPClient *http.Client
	Logger     logger.Logger
	UserAgent  string
	// contains filtered or unexported fields
}

Client ... Client ...

func NewClient

func NewClient(username, password, apiKey, ziaCloud, userAgent string) (*Client, error)

NewClient Returns a Client from credentials passed as parameters.

func (*Client) BulkDelete

func (c *Client) BulkDelete(endpoint string, payload interface{}) (*http.Response, error)

BulkDelete sends an HTTP POST request for bulk deletion and expects a 204 No Content response.

func (*Client) Create

func (c *Client) Create(endpoint string, o interface{}) (interface{}, error)

Create sends an HTTP POST request.

func (*Client) CreateWithSlicePayload

func (c *Client) CreateWithSlicePayload(endpoint string, slice interface{}) ([]byte, error)

func (*Client) Delete

func (c *Client) Delete(endpoint string) error

Delete ...

func (*Client) GenericRequest

func (c *Client) GenericRequest(baseUrl, endpoint, method string, body io.Reader, urlParams url.Values, contentType string) ([]byte, error)

Request ... // Needs to review this function.

func (*Client) GetContentType

func (c *Client) GetContentType() string

func (*Client) GetSandboxToken

func (c *Client) GetSandboxToken() string

func (*Client) GetSandboxURL

func (c *Client) GetSandboxURL() string

func (*Client) Logout

func (c *Client) Logout() error

func (*Client) Read

func (c *Client) Read(endpoint string, o interface{}) error

Read ...

func (*Client) Request

func (c *Client) Request(endpoint, method string, data []byte, contentType string) ([]byte, error)

Request ... // Needs to review this function.

func (*Client) Update

func (c *Client) Update(endpoint string, o interface{}) (interface{}, error)

Update ...

func (*Client) UpdateWithPut

func (c *Client) UpdateWithPut(endpoint string, o interface{}) (interface{}, error)

Update ...

func (*Client) UpdateWithSlicePayload

func (c *Client) UpdateWithSlicePayload(endpoint string, slice interface{}) ([]byte, error)

func (*Client) WithCache

func (c *Client) WithCache(cache bool)

func (*Client) WithCacheCleanWindow

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

func (*Client) WithCacheTtl

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

func (*Client) WithFreshCache

func (client *Client) WithFreshCache()

type Credentials

type Credentials struct {
	Username  string `json:"username"`
	Password  string `json:"password"`
	APIKey    string `json:"apiKey"`
	TimeStamp string `json:"timestamp"`
}

Credentials ...

type ErrorResponse

type ErrorResponse struct {
	Response *http.Response
	Err      error
	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).

type Session

type Session struct {
	AuthType           string `json:"authType"`
	ObfuscateAPIKey    bool   `json:"obfuscateApiKey"`
	PasswordExpiryTime int    `json:"passwordExpiryTime"`
	PasswordExpiryDays int    `json:"passwordExpiryDays"`
	Source             string `json:"source"`
	JSessionID         string `json:"jSessionID,omitempty"`
}

Session ...

func MakeAuthRequestZIA

func MakeAuthRequestZIA(credentials *Credentials, url string, client *http.Client, userAgent string) (*Session, error)

MakeAuthRequestZIA authenticates using the provided credentials and returns the session or an error.