vpncredentials

Documentation

Index

• type Location
• type ManagedBy
• type Service
  • func New(c *zia.Client) *Service
  • func (service *Service) Create(vpnCredentials *VPNCredentials) (*VPNCredentials, *http.Response, error)
  • func (service *Service) Delete(vpnCredentialID int) error
  • func (service *Service) Get(vpnCredentialID int) (*VPNCredentials, error)
  • func (service *Service) GetAll() ([]VPNCredentials, error)
  • func (service *Service) GetByFQDN(vpnCredentialName string) (*VPNCredentials, error)
  • func (service *Service) GetByIP(vpnCredentialIP string) (*VPNCredentials, error)
  • func (service *Service) GetVPNByType(vpnType string) (*VPNCredentials, error)
  • func (service *Service) Update(vpnCredentialID int, vpnCredentials *VPNCredentials) (*VPNCredentials, *http.Response, error)
• type VPNCredentials

Types

type Location

type Location struct {
	ID         int                    `json:"id"`
	Name       string                 `json:"name"`
	Extensions map[string]interface{} `json:"extensions,omitempty"`
}

type ManagedBy

type ManagedBy struct {
	ID         int                    `json:"id"`
	Name       string                 `json:"name"`
	Extensions map[string]interface{} `json:"extensions,omitempty"`
}

type Service

type Service struct {
	Client *zia.Client
}

func New

func New(c *zia.Client) *Service

func (*Service) Create

func (service *Service) Create(vpnCredentials *VPNCredentials) (*VPNCredentials, *http.Response, error)

func (*Service) Delete

func (service *Service) Delete(vpnCredentialID int) error

func (*Service) Get

func (service *Service) Get(vpnCredentialID int) (*VPNCredentials, error)

func (*Service) GetAll

func (service *Service) GetAll() ([]VPNCredentials, error)

func (*Service) GetByFQDN

func (service *Service) GetByFQDN(vpnCredentialName string) (*VPNCredentials, error)

func (*Service) GetByIP

func (service *Service) GetByIP(vpnCredentialIP string) (*VPNCredentials, error)

func (*Service) GetVPNByType

func (service *Service) GetVPNByType(vpnType string) (*VPNCredentials, error)

func (*Service) Update

func (service *Service) Update(vpnCredentialID int, vpnCredentials *VPNCredentials) (*VPNCredentials, *http.Response, error)

type VPNCredentials

type VPNCredentials struct {
	// VPN credential id
	ID int `json:"id"`

	// VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created.
	// Note: Zscaler no longer supports adding a new XAUTH VPN credential, but existing entries can be edited or deleted using the respective endpoints.
	Type string `json:"type,omitempty"`

	// Fully Qualified Domain Name. Applicable only to UFQDN or XAUTH (or HOSTED_MOBILE_USERS) auth type.
	FQDN string `json:"fqdn,omitempty"`

	// Static IP address for VPN that is self-provisioned or provisioned by Zscaler. This is a required field for IP auth type and is not applicable to other auth types.
	// Note: If you want Zscaler to provision static IP addresses for your organization, contact Zscaler Support.
	IPAddress string `json:"ipAddress,omitempty"`

	// Pre-shared key. This is a required field for UFQDN and IP auth type.
	PreSharedKey string `json:"preSharedKey,omitempty"`

	// Additional information about this VPN credential.
	Comments string `json:"comments,omitempty"`

	// Location that is associated to this VPN credential. Non-existence means not associated to any location.
	Location *Location `json:"location,omitempty"`

	// SD-WAN Partner that manages the location. If a partner does not manage the location, this is set to Self.
	ManagedBy *ManagedBy `json:"managedBy,omitempty"`
}