provisioning

Documentation

Index

• type ProvisioningAPIKeys
• type Service
  • func New(c *zcon.Client) *Service
  • func (service *Service) Create(apiKeyValue *ProvisioningAPIKeys, includePartnerKey bool, keyId *int) (*ProvisioningAPIKeys, error)
  • func (service *Service) Get(apiKeyID int) (*ProvisioningAPIKeys, error)
  • func (service *Service) GetAll() ([]ProvisioningAPIKeys, error)
  • func (service *Service) GetPartnerAPIKey(apiKeyValue string, includePartnerKey bool) (*ProvisioningAPIKeys, error)

Types

type ProvisioningAPIKeys

type ProvisioningAPIKeys struct {
	// ID of the API key. This is used to regenerate the API key
	ID int `json:"id,omitempty"`

	// API key value (12 alphanumeric characters in length)
	KeyValue string `json:"keyValue,omitempty"`

	// List of functional areas to which this API key applies. This attribute is subject to change
	Permissions []string `json:"permissions,omitempty"`

	// Indicates whether API key is enabled
	Enabled bool `json:"enabled,omitempty"`

	// Last time API key was modified
	LastModifiedTime int `json:"lastModifiedTime,omitempty"`

	// Last user to modify API key
	LastModifiedBy *common.IDNameExtensions `json:"lastModifiedBy,omitempty"`

	// Not applicable to Cloud & Branch Connector
	PartnerUrl string `json:"partnerUrl,omitempty"`
}

type Service

type Service struct {
	Client *zcon.Client
}

func New

func New(c *zcon.Client) *Service

func (*Service) Create

func (service *Service) Create(apiKeyValue *ProvisioningAPIKeys, includePartnerKey bool, keyId *int) (*ProvisioningAPIKeys, error)

func (*Service) Get

func (service *Service) Get(apiKeyID int) (*ProvisioningAPIKeys, error)

func (*Service) GetAll

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

func (*Service) GetPartnerAPIKey

func (service *Service) GetPartnerAPIKey(apiKeyValue string, includePartnerKey bool) (*ProvisioningAPIKeys, error)