oidc

Documentation

Index

• Constants
• type GetOIDCProviderPluginDescriptorCommandInput
• type OidcAPI
• type OidcService
  • func New(cfg *config.Config) *OidcService
  • func (s *OidcService) DeleteOIDCProviderCommand() (resp *http.Response, err error)
  • func (s *OidcService) GetOIDCProviderCommand() (output *models.OIDCProviderView, resp *http.Response, err error)
  • func (s *OidcService) GetOIDCProviderMetadataCommand() (output *models.OIDCProviderMetadata, resp *http.Response, err error)
  • func (s *OidcService) GetOIDCProviderPluginDescriptorCommand(input *GetOIDCProviderPluginDescriptorCommandInput) (output *models.DescriptorView, resp *http.Response, err error)
  • func (s *OidcService) GetOIDCProviderPluginDescriptorsCommand() (output *models.DescriptorsView, resp *http.Response, err error)
  • func (s *OidcService) UpdateOIDCProviderCommand(input *UpdateOIDCProviderCommandInput) (output *models.OIDCProviderView, resp *http.Response, err error)
• type UpdateOIDCProviderCommandInput

Constants

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

Types

type GetOIDCProviderPluginDescriptorCommandInput

type GetOIDCProviderPluginDescriptorCommandInput struct {
	PluginType string
}

GetOIDCProviderPluginDescriptorCommandInput - Inputs for GetOIDCProviderPluginDescriptorCommand

type OidcAPI

type OidcAPI interface {
	DeleteOIDCProviderCommand() (resp *http.Response, err error)
	GetOIDCProviderCommand() (output *models.OIDCProviderView, resp *http.Response, err error)
	UpdateOIDCProviderCommand(input *UpdateOIDCProviderCommandInput) (output *models.OIDCProviderView, resp *http.Response, err error)
	GetOIDCProviderPluginDescriptorsCommand() (output *models.DescriptorsView, resp *http.Response, err error)
	GetOIDCProviderPluginDescriptorCommand(input *GetOIDCProviderPluginDescriptorCommandInput) (output *models.DescriptorView, resp *http.Response, err error)
	GetOIDCProviderMetadataCommand() (output *models.OIDCProviderMetadata, resp *http.Response, err error)
}

type OidcService

type OidcService struct {
	*client.Client
}

OidcService provides the API operations for making requests to Oidc endpoint.

func New

func New(cfg *config.Config) *OidcService

New createa a new instance of the OidcService client.

Example:

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

//Create a OidcService from the configuration
svc := oidc.New(cfg)

func (*OidcService) DeleteOIDCProviderCommand

func (s *OidcService) DeleteOIDCProviderCommand() (resp *http.Response, err error)

DeleteOIDCProviderCommand - Resets the OpenID Connect Provider configuration to default values RequestType: DELETE Input:

func (*OidcService) GetOIDCProviderCommand

func (s *OidcService) GetOIDCProviderCommand() (output *models.OIDCProviderView, resp *http.Response, err error)

GetOIDCProviderCommand - Get the OpenID Connect Provider configuration RequestType: GET Input:

func (*OidcService) GetOIDCProviderMetadataCommand

func (s *OidcService) GetOIDCProviderMetadataCommand() (output *models.OIDCProviderMetadata, resp *http.Response, err error)

GetOIDCProviderMetadataCommand - Get the OpenID Connect Provider's metadata RequestType: GET Input:

func (*OidcService) GetOIDCProviderPluginDescriptorCommand

func (s *OidcService) GetOIDCProviderPluginDescriptorCommand(input *GetOIDCProviderPluginDescriptorCommandInput) (output *models.DescriptorView, resp *http.Response, err error)

GetOIDCProviderPluginDescriptorCommand - Get a descriptor for a OIDC Provider plugin RequestType: GET Input: input *GetOIDCProviderPluginDescriptorCommandInput

func (*OidcService) GetOIDCProviderPluginDescriptorsCommand

func (s *OidcService) GetOIDCProviderPluginDescriptorsCommand() (output *models.DescriptorsView, resp *http.Response, err error)

GetOIDCProviderPluginDescriptorsCommand - Get descriptors for all OIDC Provider plugins RequestType: GET Input:

func (*OidcService) UpdateOIDCProviderCommand

func (s *OidcService) UpdateOIDCProviderCommand(input *UpdateOIDCProviderCommandInput) (output *models.OIDCProviderView, resp *http.Response, err error)

UpdateOIDCProviderCommand - Update the OpenID Connect Provider configuration RequestType: PUT Input: input *UpdateOIDCProviderCommandInput

type UpdateOIDCProviderCommandInput

type UpdateOIDCProviderCommandInput struct {
	Body models.OIDCProviderView
}

UpdateOIDCProviderCommandInput - Inputs for UpdateOIDCProviderCommand