oauth

Documentation

Index

• Constants
• type OauthAPI
• type OauthService
  • func New(cfg *config.Config) *OauthService
  • func (s *OauthService) DeleteAuthorizationServerCommand() (resp *http.Response, err error)
  • func (s *OauthService) GetAuthorizationServerCommand() (output *models.AuthorizationServerView, resp *http.Response, err error)
  • func (s *OauthService) UpdateAuthorizationServerCommand(input *UpdateAuthorizationServerCommandInput) (output *models.AuthorizationServerView, resp *http.Response, err error)
• type UpdateAuthorizationServerCommandInput

Constants

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

Types

type OauthAPI

type OauthAPI interface {
	DeleteAuthorizationServerCommand() (resp *http.Response, err error)
	GetAuthorizationServerCommand() (output *models.AuthorizationServerView, resp *http.Response, err error)
	UpdateAuthorizationServerCommand(input *UpdateAuthorizationServerCommandInput) (output *models.AuthorizationServerView, resp *http.Response, err error)
}

type OauthService

type OauthService struct {
	*client.Client
}

OauthService provides the API operations for making requests to Oauth endpoint.

func New

func New(cfg *config.Config) *OauthService

New createa a new instance of the OauthService client.

Example:

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

//Create a OauthService from the configuration
svc := oauth.New(cfg)

func (*OauthService) DeleteAuthorizationServerCommand

func (s *OauthService) DeleteAuthorizationServerCommand() (resp *http.Response, err error)

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

func (*OauthService) GetAuthorizationServerCommand

func (s *OauthService) GetAuthorizationServerCommand() (output *models.AuthorizationServerView, resp *http.Response, err error)

GetAuthorizationServerCommand - Get Authorization Server configuration RequestType: GET Input:

func (*OauthService) UpdateAuthorizationServerCommand

func (s *OauthService) UpdateAuthorizationServerCommand(input *UpdateAuthorizationServerCommandInput) (output *models.AuthorizationServerView, resp *http.Response, err error)

UpdateAuthorizationServerCommand - Update OAuth 2.0 Authorization Server configuration RequestType: PUT Input: input *UpdateAuthorizationServerCommandInput

type UpdateAuthorizationServerCommandInput

type UpdateAuthorizationServerCommandInput struct {
	Body models.AuthorizationServerView
}

UpdateAuthorizationServerCommandInput - Inputs for UpdateAuthorizationServerCommand