sharedSecrets

Documentation

Index

• Constants
• type AddSharedSecretCommandInput
• type DeleteSharedSecretCommandInput
• type GetSharedSecretCommandInput
• type GetSharedSecretsCommandInput
• type SharedSecretsAPI
• type SharedSecretsService
  • func New(cfg *config.Config) *SharedSecretsService
  • func (s *SharedSecretsService) AddSharedSecretCommand(input *AddSharedSecretCommandInput) (output *models.SharedSecretView, resp *http.Response, err error)
  • func (s *SharedSecretsService) DeleteSharedSecretCommand(input *DeleteSharedSecretCommandInput) (resp *http.Response, err error)
  • func (s *SharedSecretsService) GetSharedSecretCommand(input *GetSharedSecretCommandInput) (output *models.SharedSecretView, resp *http.Response, err error)
  • func (s *SharedSecretsService) GetSharedSecretsCommand(input *GetSharedSecretsCommandInput) (output *models.SharedSecretsView, resp *http.Response, err error)

Constants

const (
	// ServiceName - The name of service.
	ServiceName = "SharedSecrets"
)

Types

type AddSharedSecretCommandInput

type AddSharedSecretCommandInput struct {
	Body models.SharedSecretView
}

AddSharedSecretCommandInput - Inputs for AddSharedSecretCommand

type DeleteSharedSecretCommandInput

type DeleteSharedSecretCommandInput struct {
	Id string
}

DeleteSharedSecretCommandInput - Inputs for DeleteSharedSecretCommand

type GetSharedSecretCommandInput

type GetSharedSecretCommandInput struct {
	Id string
}

GetSharedSecretCommandInput - Inputs for GetSharedSecretCommand

type GetSharedSecretsCommandInput

type GetSharedSecretsCommandInput struct {
	SortKey string
	Order   string
}

GetSharedSecretsCommandInput - Inputs for GetSharedSecretsCommand

type SharedSecretsAPI

type SharedSecretsAPI interface {
	GetSharedSecretsCommand(input *GetSharedSecretsCommandInput) (output *models.SharedSecretsView, resp *http.Response, err error)
	AddSharedSecretCommand(input *AddSharedSecretCommandInput) (output *models.SharedSecretView, resp *http.Response, err error)
	DeleteSharedSecretCommand(input *DeleteSharedSecretCommandInput) (resp *http.Response, err error)
	GetSharedSecretCommand(input *GetSharedSecretCommandInput) (output *models.SharedSecretView, resp *http.Response, err error)
}

type SharedSecretsService

type SharedSecretsService struct {
	*client.Client
}

SharedSecretsService provides the API operations for making requests to SharedSecrets endpoint.

func New

func New(cfg *config.Config) *SharedSecretsService

New createa a new instance of the SharedSecretsService client.

Example:

cfg := config.NewConfig().WithUsername("Administrator").WithPassword("2Access").WithEndpoint(paURL)

//Create a SharedSecretsService from the configuration
svc := sharedSecrets.New(cfg)

func (*SharedSecretsService) AddSharedSecretCommand

func (s *SharedSecretsService) AddSharedSecretCommand(input *AddSharedSecretCommandInput) (output *models.SharedSecretView, resp *http.Response, err error)

AddSharedSecretCommand - Create a Shared Secret RequestType: POST Input: input *AddSharedSecretCommandInput

func (*SharedSecretsService) DeleteSharedSecretCommand

func (s *SharedSecretsService) DeleteSharedSecretCommand(input *DeleteSharedSecretCommandInput) (resp *http.Response, err error)

DeleteSharedSecretCommand - Delete a Shared Secret RequestType: DELETE Input: input *DeleteSharedSecretCommandInput

func (*SharedSecretsService) GetSharedSecretCommand

func (s *SharedSecretsService) GetSharedSecretCommand(input *GetSharedSecretCommandInput) (output *models.SharedSecretView, resp *http.Response, err error)

GetSharedSecretCommand - Get a Shared Secret RequestType: GET Input: input *GetSharedSecretCommandInput

func (*SharedSecretsService) GetSharedSecretsCommand

func (s *SharedSecretsService) GetSharedSecretsCommand(input *GetSharedSecretsCommandInput) (output *models.SharedSecretsView, resp *http.Response, err error)

GetSharedSecretsCommand - Get all Shared Secrets RequestType: GET Input: input *GetSharedSecretsCommandInput