siteAuthenticators

Documentation

Index

• Constants
• type AddSiteAuthenticatorCommandInput
• type DeleteSiteAuthenticatorCommandInput
• type GetSiteAuthenticatorCommandInput
• type GetSiteAuthenticatorDescriptorCommandInput
• type GetSiteAuthenticatorsCommandInput
• type SiteAuthenticatorsAPI
• type SiteAuthenticatorsService
  • func New(cfg *config.Config) *SiteAuthenticatorsService
  • func (s *SiteAuthenticatorsService) AddSiteAuthenticatorCommand(input *AddSiteAuthenticatorCommandInput) (output *models.SiteAuthenticatorView, resp *http.Response, err error)
  • func (s *SiteAuthenticatorsService) DeleteSiteAuthenticatorCommand(input *DeleteSiteAuthenticatorCommandInput) (resp *http.Response, err error)
  • func (s *SiteAuthenticatorsService) GetSiteAuthenticatorCommand(input *GetSiteAuthenticatorCommandInput) (output *models.SiteAuthenticatorView, resp *http.Response, err error)
  • func (s *SiteAuthenticatorsService) GetSiteAuthenticatorDescriptorCommand(input *GetSiteAuthenticatorDescriptorCommandInput) (output *models.DescriptorView, resp *http.Response, err error)
  • func (s *SiteAuthenticatorsService) GetSiteAuthenticatorDescriptorsCommand() (output *models.DescriptorsView, resp *http.Response, err error)
  • func (s *SiteAuthenticatorsService) GetSiteAuthenticatorsCommand(input *GetSiteAuthenticatorsCommandInput) (output *models.SiteAuthenticatorsView, resp *http.Response, err error)
  • func (s *SiteAuthenticatorsService) UpdateSiteAuthenticatorCommand(input *UpdateSiteAuthenticatorCommandInput) (output *models.SiteAuthenticatorView, resp *http.Response, err error)
• type UpdateSiteAuthenticatorCommandInput

Constants

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

Types

type AddSiteAuthenticatorCommandInput

type AddSiteAuthenticatorCommandInput struct {
	Body models.SiteAuthenticatorView
}

AddSiteAuthenticatorCommandInput - Inputs for AddSiteAuthenticatorCommand

type DeleteSiteAuthenticatorCommandInput

type DeleteSiteAuthenticatorCommandInput struct {
	Id string
}

DeleteSiteAuthenticatorCommandInput - Inputs for DeleteSiteAuthenticatorCommand

type GetSiteAuthenticatorCommandInput

type GetSiteAuthenticatorCommandInput struct {
	Id string
}

GetSiteAuthenticatorCommandInput - Inputs for GetSiteAuthenticatorCommand

type GetSiteAuthenticatorDescriptorCommandInput

type GetSiteAuthenticatorDescriptorCommandInput struct {
	SiteAuthenticatorType string
}

GetSiteAuthenticatorDescriptorCommandInput - Inputs for GetSiteAuthenticatorDescriptorCommand

type GetSiteAuthenticatorsCommandInput

type GetSiteAuthenticatorsCommandInput struct {
	Page          string
	NumberPerPage string
	Filter        string
	Name          string
	SortKey       string
	Order         string
}

GetSiteAuthenticatorsCommandInput - Inputs for GetSiteAuthenticatorsCommand

type SiteAuthenticatorsAPI

type SiteAuthenticatorsAPI interface {
	GetSiteAuthenticatorsCommand(input *GetSiteAuthenticatorsCommandInput) (output *models.SiteAuthenticatorsView, resp *http.Response, err error)
	AddSiteAuthenticatorCommand(input *AddSiteAuthenticatorCommandInput) (output *models.SiteAuthenticatorView, resp *http.Response, err error)
	GetSiteAuthenticatorDescriptorsCommand() (output *models.DescriptorsView, resp *http.Response, err error)
	GetSiteAuthenticatorDescriptorCommand(input *GetSiteAuthenticatorDescriptorCommandInput) (output *models.DescriptorView, resp *http.Response, err error)
	DeleteSiteAuthenticatorCommand(input *DeleteSiteAuthenticatorCommandInput) (resp *http.Response, err error)
	GetSiteAuthenticatorCommand(input *GetSiteAuthenticatorCommandInput) (output *models.SiteAuthenticatorView, resp *http.Response, err error)
	UpdateSiteAuthenticatorCommand(input *UpdateSiteAuthenticatorCommandInput) (output *models.SiteAuthenticatorView, resp *http.Response, err error)
}

type SiteAuthenticatorsService

type SiteAuthenticatorsService struct {
	*client.Client
}

SiteAuthenticatorsService provides the API operations for making requests to SiteAuthenticators endpoint.

func New

func New(cfg *config.Config) *SiteAuthenticatorsService

New createa a new instance of the SiteAuthenticatorsService client.

Example:

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

//Create a SiteAuthenticatorsService from the configuration
svc := siteAuthenticators.New(cfg)

func (*SiteAuthenticatorsService) AddSiteAuthenticatorCommand

func (s *SiteAuthenticatorsService) AddSiteAuthenticatorCommand(input *AddSiteAuthenticatorCommandInput) (output *models.SiteAuthenticatorView, resp *http.Response, err error)

AddSiteAuthenticatorCommand - Create a Site Authenticator RequestType: POST Input: input *AddSiteAuthenticatorCommandInput

func (*SiteAuthenticatorsService) DeleteSiteAuthenticatorCommand

func (s *SiteAuthenticatorsService) DeleteSiteAuthenticatorCommand(input *DeleteSiteAuthenticatorCommandInput) (resp *http.Response, err error)

DeleteSiteAuthenticatorCommand - Delete a Site Authenticator RequestType: DELETE Input: input *DeleteSiteAuthenticatorCommandInput

func (*SiteAuthenticatorsService) GetSiteAuthenticatorCommand

func (s *SiteAuthenticatorsService) GetSiteAuthenticatorCommand(input *GetSiteAuthenticatorCommandInput) (output *models.SiteAuthenticatorView, resp *http.Response, err error)

GetSiteAuthenticatorCommand - Get a Site Authenticator RequestType: GET Input: input *GetSiteAuthenticatorCommandInput

func (*SiteAuthenticatorsService) GetSiteAuthenticatorDescriptorCommand

func (s *SiteAuthenticatorsService) GetSiteAuthenticatorDescriptorCommand(input *GetSiteAuthenticatorDescriptorCommandInput) (output *models.DescriptorView, resp *http.Response, err error)

GetSiteAuthenticatorDescriptorCommand - Get descriptor for a Site Authenticator type RequestType: GET Input: input *GetSiteAuthenticatorDescriptorCommandInput

func (*SiteAuthenticatorsService) GetSiteAuthenticatorDescriptorsCommand

func (s *SiteAuthenticatorsService) GetSiteAuthenticatorDescriptorsCommand() (output *models.DescriptorsView, resp *http.Response, err error)

GetSiteAuthenticatorDescriptorsCommand - Get descriptors for all supported Site Authenticator types RequestType: GET Input:

func (*SiteAuthenticatorsService) GetSiteAuthenticatorsCommand

func (s *SiteAuthenticatorsService) GetSiteAuthenticatorsCommand(input *GetSiteAuthenticatorsCommandInput) (output *models.SiteAuthenticatorsView, resp *http.Response, err error)

GetSiteAuthenticatorsCommand - Get all Site Authenticators RequestType: GET Input: input *GetSiteAuthenticatorsCommandInput

func (*SiteAuthenticatorsService) UpdateSiteAuthenticatorCommand

func (s *SiteAuthenticatorsService) UpdateSiteAuthenticatorCommand(input *UpdateSiteAuthenticatorCommandInput) (output *models.SiteAuthenticatorView, resp *http.Response, err error)

UpdateSiteAuthenticatorCommand - Update a Site Authenticator RequestType: PUT Input: input *UpdateSiteAuthenticatorCommandInput

type UpdateSiteAuthenticatorCommandInput

type UpdateSiteAuthenticatorCommandInput struct {
	Body models.SiteAuthenticatorView
	Id   string
}

UpdateSiteAuthenticatorCommandInput - Inputs for UpdateSiteAuthenticatorCommand