api_keys

Documentation

Index

• type ProvisioningAPIKeys
  • func Create(service *services.Service, apiKeyValue *ProvisioningAPIKeys, ...) (*ProvisioningAPIKeys, error)
  • func Get(service *services.Service, apiKeyID int) (*ProvisioningAPIKeys, error)
  • func GetAll(service *services.Service) ([]ProvisioningAPIKeys, error)
  • func GetPartnerAPIKey(service *services.Service, 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"`
}

func Create

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

func Get

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

func GetAll

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

func GetPartnerAPIKey

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