auth

Documentation

Index

• Constants
• type AuthAPI
• type AuthService
  • func New(cfg *config.Config) *AuthService
  • func (s *AuthService) DeleteAdminBasicWebSessionCommand() (resp *http.Response, err error)
  • func (s *AuthService) DeleteAdminTokenProviderCommand() (resp *http.Response, err error)
  • func (s *AuthService) DeleteBasicAuthCommand() (resp *http.Response, err error)
  • func (s *AuthService) DeleteOAuthAuthCommand() (resp *http.Response, err error)
  • func (s *AuthService) DeleteOidcAuthCommand() (resp *http.Response, err error)
  • func (s *AuthService) GetAdminBasicWebSessionCommand() (output *models.AdminBasicWebSessionView, resp *http.Response, err error)
  • func (s *AuthService) GetAdminTokenProviderCommand() (output *models.AdminTokenProviderView, resp *http.Response, err error)
  • func (s *AuthService) GetAdminTokenProviderMetadataCommand() (output *models.OIDCProviderMetadata, resp *http.Response, err error)
  • func (s *AuthService) GetAuthOidcScopesCommand(input *GetAuthOidcScopesCommandInput) (output *models.SupportedScopesView, resp *http.Response, err error)
  • func (s *AuthService) GetBasicAuthCommand() (output *models.BasicConfig, resp *http.Response, err error)
  • func (s *AuthService) GetOAuthAuthCommand() (output *models.OAuthConfigView, resp *http.Response, err error)
  • func (s *AuthService) GetOidcAuthCommand() (output *models.OidcConfigView, resp *http.Response, err error)
  • func (s *AuthService) UpdateAdminBasicWebSessionCommand(input *UpdateAdminBasicWebSessionCommandInput) (output *models.AdminBasicWebSessionView, resp *http.Response, err error)
  • func (s *AuthService) UpdateAdminTokenProviderCommand(input *UpdateAdminTokenProviderCommandInput) (output *models.AdminTokenProviderView, resp *http.Response, err error)
  • func (s *AuthService) UpdateBasicAuthCommand(input *UpdateBasicAuthCommandInput) (output *models.BasicAuthConfigView, resp *http.Response, err error)
  • func (s *AuthService) UpdateOAuthAuthCommand(input *UpdateOAuthAuthCommandInput) (output *models.OAuthConfigView, resp *http.Response, err error)
  • func (s *AuthService) UpdateOidcAuthCommand(input *UpdateOidcAuthCommandInput) (output *models.OidcConfigView, resp *http.Response, err error)
• type GetAuthOidcScopesCommandInput
• type UpdateAdminBasicWebSessionCommandInput
• type UpdateAdminTokenProviderCommandInput
• type UpdateBasicAuthCommandInput
• type UpdateOAuthAuthCommandInput
• type UpdateOidcAuthCommandInput

Constants

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

Types

type AuthAPI

type AuthAPI interface {
	DeleteBasicAuthCommand() (resp *http.Response, err error)
	GetBasicAuthCommand() (output *models.BasicConfig, resp *http.Response, err error)
	UpdateBasicAuthCommand(input *UpdateBasicAuthCommandInput) (output *models.BasicAuthConfigView, resp *http.Response, err error)
	DeleteOAuthAuthCommand() (resp *http.Response, err error)
	GetOAuthAuthCommand() (output *models.OAuthConfigView, resp *http.Response, err error)
	UpdateOAuthAuthCommand(input *UpdateOAuthAuthCommandInput) (output *models.OAuthConfigView, resp *http.Response, err error)
	DeleteOidcAuthCommand() (resp *http.Response, err error)
	GetOidcAuthCommand() (output *models.OidcConfigView, resp *http.Response, err error)
	UpdateOidcAuthCommand(input *UpdateOidcAuthCommandInput) (output *models.OidcConfigView, resp *http.Response, err error)
	GetAuthOidcScopesCommand(input *GetAuthOidcScopesCommandInput) (output *models.SupportedScopesView, resp *http.Response, err error)
	DeleteAdminTokenProviderCommand() (resp *http.Response, err error)
	GetAdminTokenProviderCommand() (output *models.AdminTokenProviderView, resp *http.Response, err error)
	UpdateAdminTokenProviderCommand(input *UpdateAdminTokenProviderCommandInput) (output *models.AdminTokenProviderView, resp *http.Response, err error)
	GetAdminTokenProviderMetadataCommand() (output *models.OIDCProviderMetadata, resp *http.Response, err error)
	DeleteAdminBasicWebSessionCommand() (resp *http.Response, err error)
	GetAdminBasicWebSessionCommand() (output *models.AdminBasicWebSessionView, resp *http.Response, err error)
	UpdateAdminBasicWebSessionCommand(input *UpdateAdminBasicWebSessionCommandInput) (output *models.AdminBasicWebSessionView, resp *http.Response, err error)
}

type AuthService

type AuthService struct {
	*client.Client
}

AuthService provides the API operations for making requests to Auth endpoint.

func New

func New(cfg *config.Config) *AuthService

New createa a new instance of the AuthService client.

Example:

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

//Create a AuthService from the configuration
svc := auth.New(cfg)

func (*AuthService) DeleteAdminBasicWebSessionCommand

func (s *AuthService) DeleteAdminBasicWebSessionCommand() (resp *http.Response, err error)

DeleteAdminBasicWebSessionCommand - Resets the Admin Web Session configuration to default values RequestType: DELETE Input:

func (*AuthService) DeleteAdminTokenProviderCommand

func (s *AuthService) DeleteAdminTokenProviderCommand() (resp *http.Response, err error)

DeleteAdminTokenProviderCommand - Resets the Admin Token Provider configuration to default values RequestType: DELETE Input:

func (*AuthService) DeleteBasicAuthCommand

func (s *AuthService) DeleteBasicAuthCommand() (resp *http.Response, err error)

DeleteBasicAuthCommand - Resets the HTTP Basic Authentication configuration to default values RequestType: DELETE Input:

func (*AuthService) DeleteOAuthAuthCommand

func (s *AuthService) DeleteOAuthAuthCommand() (resp *http.Response, err error)

DeleteOAuthAuthCommand - Resets the OAuth Authentication configuration to default values RequestType: DELETE Input:

func (*AuthService) DeleteOidcAuthCommand

func (s *AuthService) DeleteOidcAuthCommand() (resp *http.Response, err error)

DeleteOidcAuthCommand - Resets the OIDC Authentication configuration to default values RequestType: DELETE Input:

func (*AuthService) GetAdminBasicWebSessionCommand

func (s *AuthService) GetAdminBasicWebSessionCommand() (output *models.AdminBasicWebSessionView, resp *http.Response, err error)

GetAdminBasicWebSessionCommand - Get the admin web session configuration RequestType: GET Input:

func (*AuthService) GetAdminTokenProviderCommand

func (s *AuthService) GetAdminTokenProviderCommand() (output *models.AdminTokenProviderView, resp *http.Response, err error)

GetAdminTokenProviderCommand - Get the Admin Token Provider configuration RequestType: GET Input:

func (*AuthService) GetAdminTokenProviderMetadataCommand

func (s *AuthService) GetAdminTokenProviderMetadataCommand() (output *models.OIDCProviderMetadata, resp *http.Response, err error)

GetAdminTokenProviderMetadataCommand - Get the Admin Token Provider metadata RequestType: GET Input:

func (*AuthService) GetAuthOidcScopesCommand

func (s *AuthService) GetAuthOidcScopesCommand(input *GetAuthOidcScopesCommandInput) (output *models.SupportedScopesView, resp *http.Response, err error)

GetAuthOidcScopesCommand - Get the scopes supported by the current Admin OIDC Provider RequestType: GET Input: input *GetAuthOidcScopesCommandInput

func (*AuthService) GetBasicAuthCommand

func (s *AuthService) GetBasicAuthCommand() (output *models.BasicConfig, resp *http.Response, err error)

GetBasicAuthCommand - Get the HTTP Basic Authentication configuration RequestType: GET Input:

func (*AuthService) GetOAuthAuthCommand

func (s *AuthService) GetOAuthAuthCommand() (output *models.OAuthConfigView, resp *http.Response, err error)

GetOAuthAuthCommand - Get the OAuth Authentication configuration RequestType: GET Input:

func (*AuthService) GetOidcAuthCommand

func (s *AuthService) GetOidcAuthCommand() (output *models.OidcConfigView, resp *http.Response, err error)

GetOidcAuthCommand - Get the OIDC Authentication configuration RequestType: GET Input:

func (*AuthService) UpdateAdminBasicWebSessionCommand

func (s *AuthService) UpdateAdminBasicWebSessionCommand(input *UpdateAdminBasicWebSessionCommandInput) (output *models.AdminBasicWebSessionView, resp *http.Response, err error)

UpdateAdminBasicWebSessionCommand - Update the admin web session configuration RequestType: PUT Input: input *UpdateAdminBasicWebSessionCommandInput

func (*AuthService) UpdateAdminTokenProviderCommand

func (s *AuthService) UpdateAdminTokenProviderCommand(input *UpdateAdminTokenProviderCommandInput) (output *models.AdminTokenProviderView, resp *http.Response, err error)

UpdateAdminTokenProviderCommand - Update the Admin Token Provider configuration RequestType: PUT Input: input *UpdateAdminTokenProviderCommandInput

func (*AuthService) UpdateBasicAuthCommand

func (s *AuthService) UpdateBasicAuthCommand(input *UpdateBasicAuthCommandInput) (output *models.BasicAuthConfigView, resp *http.Response, err error)

UpdateBasicAuthCommand - Update the Basic Authentication configuration RequestType: PUT Input: input *UpdateBasicAuthCommandInput

func (*AuthService) UpdateOAuthAuthCommand

func (s *AuthService) UpdateOAuthAuthCommand(input *UpdateOAuthAuthCommandInput) (output *models.OAuthConfigView, resp *http.Response, err error)

UpdateOAuthAuthCommand - Update the OAuth Authentication configuration RequestType: PUT Input: input *UpdateOAuthAuthCommandInput

func (*AuthService) UpdateOidcAuthCommand

func (s *AuthService) UpdateOidcAuthCommand(input *UpdateOidcAuthCommandInput) (output *models.OidcConfigView, resp *http.Response, err error)

UpdateOidcAuthCommand - Update the OIDC Authentication configuration RequestType: PUT Input: input *UpdateOidcAuthCommandInput

type GetAuthOidcScopesCommandInput

type GetAuthOidcScopesCommandInput struct {
	ClientId string
}

GetAuthOidcScopesCommandInput - Inputs for GetAuthOidcScopesCommand

type UpdateAdminBasicWebSessionCommandInput

type UpdateAdminBasicWebSessionCommandInput struct {
	Body models.AdminBasicWebSessionView
}

UpdateAdminBasicWebSessionCommandInput - Inputs for UpdateAdminBasicWebSessionCommand

type UpdateAdminTokenProviderCommandInput

type UpdateAdminTokenProviderCommandInput struct {
	Body models.AdminTokenProviderView
}

UpdateAdminTokenProviderCommandInput - Inputs for UpdateAdminTokenProviderCommand

type UpdateBasicAuthCommandInput

type UpdateBasicAuthCommandInput struct {
	Body models.BasicAuthConfigView
}

UpdateBasicAuthCommandInput - Inputs for UpdateBasicAuthCommand

type UpdateOAuthAuthCommandInput

type UpdateOAuthAuthCommandInput struct {
	Body models.OAuthConfigView
}

UpdateOAuthAuthCommandInput - Inputs for UpdateOAuthAuthCommand

type UpdateOidcAuthCommandInput

type UpdateOidcAuthCommandInput struct {
	Body models.OidcConfigView
}

UpdateOidcAuthCommandInput - Inputs for UpdateOidcAuthCommand