vpncredentials

Documentation

Index

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

Functions

func BulkDelete

func BulkDelete(service *services.Service, ids []int) (*http.Response, error)

BulkDeleteVPNCredentials sends a bulk delete request for VPN credentials.

func Delete

func Delete(service *services.Service, vpnCredentialID int) error

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 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"`
}

func Create

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

func Get

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

func GetAll

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

func GetByFQDN

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

func GetByIP

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

func GetVPNByType

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

func Update

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