authentication

package
v0.26.22 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 22, 2024 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source 
const AuthenticateBadRequestCode int = 400

AuthenticateBadRequestCode is the HTTP code returned for type AuthenticateBadRequest

View Source 
const AuthenticateMfaOKCode int = 200

AuthenticateMfaOKCode is the HTTP code returned for type AuthenticateMfaOK

View Source 
const AuthenticateMfaTooManyRequestsCode int = 429

AuthenticateMfaTooManyRequestsCode is the HTTP code returned for type AuthenticateMfaTooManyRequests

View Source 
const AuthenticateMfaUnauthorizedCode int = 401

AuthenticateMfaUnauthorizedCode is the HTTP code returned for type AuthenticateMfaUnauthorized

View Source 
const AuthenticateOKCode int = 200

AuthenticateOKCode is the HTTP code returned for type AuthenticateOK

View Source 
const AuthenticateTooManyRequestsCode int = 429

AuthenticateTooManyRequestsCode is the HTTP code returned for type AuthenticateTooManyRequests

View Source 
const AuthenticateUnauthorizedCode int = 401

AuthenticateUnauthorizedCode is the HTTP code returned for type AuthenticateUnauthorized

Variables

This section is empty.

Functions

This section is empty.

Types

type Authenticate 

type Authenticate struct {
	Context *middleware.Context
	Handler AuthenticateHandler
}
Authenticate swagger:route POST /authenticate Authentication authenticate

Authenticate via a method supplied via a query string parameter

Allowed authentication methods include "password", "cert", and "ext-jwt"

func NewAuthenticate 

func NewAuthenticate(ctx *middleware.Context, handler AuthenticateHandler) *Authenticate

NewAuthenticate creates a new http.Handler for the authenticate operation

func (*Authenticate) ServeHTTP 

func (o *Authenticate) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type AuthenticateBadRequest 

type AuthenticateBadRequest struct {

	/*
	  In: Body
	*/
	Payload *rest_model.APIErrorEnvelope `json:"body,omitempty"`
}

AuthenticateBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies). The error's code, message, and cause fields can be inspected for further information

swagger:response authenticateBadRequest

func NewAuthenticateBadRequest 

func NewAuthenticateBadRequest() *AuthenticateBadRequest

NewAuthenticateBadRequest creates AuthenticateBadRequest with default headers values

func (*AuthenticateBadRequest) SetPayload 

func (o *AuthenticateBadRequest) SetPayload(payload *rest_model.APIErrorEnvelope)

SetPayload sets the payload to the authenticate bad request response

func (*AuthenticateBadRequest) WithPayload 

func (o *AuthenticateBadRequest) WithPayload(payload *rest_model.APIErrorEnvelope) *AuthenticateBadRequest

WithPayload adds the payload to the authenticate bad request response

func (*AuthenticateBadRequest) WriteResponse 

func (o *AuthenticateBadRequest) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type AuthenticateHandler 

type AuthenticateHandler interface {
	Handle(AuthenticateParams) middleware.Responder
}

AuthenticateHandler interface for that can handle valid authenticate params

type AuthenticateHandlerFunc 

type AuthenticateHandlerFunc func(AuthenticateParams) middleware.Responder

AuthenticateHandlerFunc turns a function with the right signature into a authenticate handler

func (AuthenticateHandlerFunc) Handle 

func (fn AuthenticateHandlerFunc) Handle(params AuthenticateParams) middleware.Responder

Handle executing the request and returning a response

type AuthenticateMfa 

type AuthenticateMfa struct {
	Context *middleware.Context
	Handler AuthenticateMfaHandler
}
AuthenticateMfa swagger:route POST /authenticate/mfa Authentication MFA authenticateMfa

Complete MFA authentication

Completes MFA authentication by submitting a MFA time based one time token or backup code.

func NewAuthenticateMfa 

func NewAuthenticateMfa(ctx *middleware.Context, handler AuthenticateMfaHandler) *AuthenticateMfa

NewAuthenticateMfa creates a new http.Handler for the authenticate mfa operation

func (*AuthenticateMfa) ServeHTTP 

func (o *AuthenticateMfa) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type AuthenticateMfaHandler 

type AuthenticateMfaHandler interface {
	Handle(AuthenticateMfaParams, interface{}) middleware.Responder
}

AuthenticateMfaHandler interface for that can handle valid authenticate mfa params

type AuthenticateMfaHandlerFunc 

type AuthenticateMfaHandlerFunc func(AuthenticateMfaParams, interface{}) middleware.Responder

AuthenticateMfaHandlerFunc turns a function with the right signature into a authenticate mfa handler

func (AuthenticateMfaHandlerFunc) Handle 

func (fn AuthenticateMfaHandlerFunc) Handle(params AuthenticateMfaParams, principal interface{}) middleware.Responder

Handle executing the request and returning a response

type AuthenticateMfaOK 

type AuthenticateMfaOK struct {

	/*
	  In: Body
	*/
	Payload *rest_model.Empty `json:"body,omitempty"`
}

AuthenticateMfaOK Base empty response

swagger:response authenticateMfaOK

func NewAuthenticateMfaOK 

func NewAuthenticateMfaOK() *AuthenticateMfaOK

NewAuthenticateMfaOK creates AuthenticateMfaOK with default headers values

func (*AuthenticateMfaOK) SetPayload 

func (o *AuthenticateMfaOK) SetPayload(payload *rest_model.Empty)

SetPayload sets the payload to the authenticate mfa o k response

func (*AuthenticateMfaOK) WithPayload 

func (o *AuthenticateMfaOK) WithPayload(payload *rest_model.Empty) *AuthenticateMfaOK

WithPayload adds the payload to the authenticate mfa o k response

func (*AuthenticateMfaOK) WriteResponse 

func (o *AuthenticateMfaOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type AuthenticateMfaParams 

type AuthenticateMfaParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request `json:"-"`

	/*An MFA validation request
	  Required: true
	  In: body
	*/
	MfaAuth *rest_model.MfaCode
}

AuthenticateMfaParams contains all the bound params for the authenticate mfa operation typically these are obtained from a http.Request

swagger:parameters authenticateMfa

func NewAuthenticateMfaParams 

func NewAuthenticateMfaParams() AuthenticateMfaParams

NewAuthenticateMfaParams creates a new AuthenticateMfaParams object

There are no default values defined in the spec.

func (*AuthenticateMfaParams) BindRequest 

func (o *AuthenticateMfaParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error

BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls.

To ensure default values, the struct must have been initialized with NewAuthenticateMfaParams() beforehand.

type AuthenticateMfaTooManyRequests added in v0.26.7 

type AuthenticateMfaTooManyRequests struct {

	/*
	  In: Body
	*/
	Payload *rest_model.APIErrorEnvelope `json:"body,omitempty"`
}

AuthenticateMfaTooManyRequests The resource requested is rate limited and the rate limit has been exceeded

swagger:response authenticateMfaTooManyRequests

func NewAuthenticateMfaTooManyRequests added in v0.26.7 

func NewAuthenticateMfaTooManyRequests() *AuthenticateMfaTooManyRequests

NewAuthenticateMfaTooManyRequests creates AuthenticateMfaTooManyRequests with default headers values

func (*AuthenticateMfaTooManyRequests) SetPayload added in v0.26.7 

func (o *AuthenticateMfaTooManyRequests) SetPayload(payload *rest_model.APIErrorEnvelope)

SetPayload sets the payload to the authenticate mfa too many requests response

func (*AuthenticateMfaTooManyRequests) WithPayload added in v0.26.7 

func (o *AuthenticateMfaTooManyRequests) WithPayload(payload *rest_model.APIErrorEnvelope) *AuthenticateMfaTooManyRequests

WithPayload adds the payload to the authenticate mfa too many requests response

func (*AuthenticateMfaTooManyRequests) WriteResponse added in v0.26.7 

func (o *AuthenticateMfaTooManyRequests) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type AuthenticateMfaURL 

type AuthenticateMfaURL struct {
	// contains filtered or unexported fields
}

AuthenticateMfaURL generates an URL for the authenticate mfa operation

func (*AuthenticateMfaURL) Build 

func (o *AuthenticateMfaURL) Build() (*url.URL, error)

Build a url path and query string

func (*AuthenticateMfaURL) BuildFull 

func (o *AuthenticateMfaURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*AuthenticateMfaURL) Must 

func (o *AuthenticateMfaURL) Must(u *url.URL, err error) *url.URL

Must is a helper function to panic when the url builder returns an error

func (*AuthenticateMfaURL) SetBasePath 

func (o *AuthenticateMfaURL) SetBasePath(bp string)

SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

func (*AuthenticateMfaURL) String 

func (o *AuthenticateMfaURL) String() string

String returns the string representation of the path with query string

func (*AuthenticateMfaURL) StringFull 

func (o *AuthenticateMfaURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*AuthenticateMfaURL) WithBasePath 

func (o *AuthenticateMfaURL) WithBasePath(bp string) *AuthenticateMfaURL

WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

type AuthenticateMfaUnauthorized 

type AuthenticateMfaUnauthorized struct {

	/*
	  In: Body
	*/
	Payload *rest_model.Empty `json:"body,omitempty"`
}

AuthenticateMfaUnauthorized Base empty response

swagger:response authenticateMfaUnauthorized

func NewAuthenticateMfaUnauthorized 

func NewAuthenticateMfaUnauthorized() *AuthenticateMfaUnauthorized

NewAuthenticateMfaUnauthorized creates AuthenticateMfaUnauthorized with default headers values

func (*AuthenticateMfaUnauthorized) SetPayload 

func (o *AuthenticateMfaUnauthorized) SetPayload(payload *rest_model.Empty)

SetPayload sets the payload to the authenticate mfa unauthorized response

func (*AuthenticateMfaUnauthorized) WithPayload 

func (o *AuthenticateMfaUnauthorized) WithPayload(payload *rest_model.Empty) *AuthenticateMfaUnauthorized

WithPayload adds the payload to the authenticate mfa unauthorized response

func (*AuthenticateMfaUnauthorized) WriteResponse 

func (o *AuthenticateMfaUnauthorized) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type AuthenticateOK 

type AuthenticateOK struct {

	/*
	  In: Body
	*/
	Payload *rest_model.CurrentAPISessionDetailEnvelope `json:"body,omitempty"`
}

AuthenticateOK The API session associated with the session used to issue the request

swagger:response authenticateOK

func NewAuthenticateOK 

func NewAuthenticateOK() *AuthenticateOK

NewAuthenticateOK creates AuthenticateOK with default headers values

func (*AuthenticateOK) SetPayload 

func (o *AuthenticateOK) SetPayload(payload *rest_model.CurrentAPISessionDetailEnvelope)

SetPayload sets the payload to the authenticate o k response

func (*AuthenticateOK) WithPayload 

func (o *AuthenticateOK) WithPayload(payload *rest_model.CurrentAPISessionDetailEnvelope) *AuthenticateOK

WithPayload adds the payload to the authenticate o k response

func (*AuthenticateOK) WriteResponse 

func (o *AuthenticateOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type AuthenticateParams 

type AuthenticateParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request `json:"-"`

	/*
	  In: body
	*/
	Auth *rest_model.Authenticate
	/*
	  Required: true
	  In: query
	*/
	Method string
}

AuthenticateParams contains all the bound params for the authenticate operation typically these are obtained from a http.Request

swagger:parameters authenticate

func NewAuthenticateParams 

func NewAuthenticateParams() AuthenticateParams

NewAuthenticateParams creates a new AuthenticateParams object

There are no default values defined in the spec.

func (*AuthenticateParams) BindRequest 

func (o *AuthenticateParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error

BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls.

To ensure default values, the struct must have been initialized with NewAuthenticateParams() beforehand.

type AuthenticateTooManyRequests added in v0.26.7 

type AuthenticateTooManyRequests struct {

	/*
	  In: Body
	*/
	Payload *rest_model.APIErrorEnvelope `json:"body,omitempty"`
}

AuthenticateTooManyRequests The resource requested is rate limited and the rate limit has been exceeded

swagger:response authenticateTooManyRequests

func NewAuthenticateTooManyRequests added in v0.26.7 

func NewAuthenticateTooManyRequests() *AuthenticateTooManyRequests

NewAuthenticateTooManyRequests creates AuthenticateTooManyRequests with default headers values

func (*AuthenticateTooManyRequests) SetPayload added in v0.26.7 

func (o *AuthenticateTooManyRequests) SetPayload(payload *rest_model.APIErrorEnvelope)

SetPayload sets the payload to the authenticate too many requests response

func (*AuthenticateTooManyRequests) WithPayload added in v0.26.7 

func (o *AuthenticateTooManyRequests) WithPayload(payload *rest_model.APIErrorEnvelope) *AuthenticateTooManyRequests

WithPayload adds the payload to the authenticate too many requests response

func (*AuthenticateTooManyRequests) WriteResponse added in v0.26.7 

func (o *AuthenticateTooManyRequests) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type AuthenticateURL 

type AuthenticateURL struct {
	Method string
	// contains filtered or unexported fields
}

AuthenticateURL generates an URL for the authenticate operation

func (*AuthenticateURL) Build 

func (o *AuthenticateURL) Build() (*url.URL, error)

Build a url path and query string

func (*AuthenticateURL) BuildFull 

func (o *AuthenticateURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*AuthenticateURL) Must 

func (o *AuthenticateURL) Must(u *url.URL, err error) *url.URL

Must is a helper function to panic when the url builder returns an error

func (*AuthenticateURL) SetBasePath 

func (o *AuthenticateURL) SetBasePath(bp string)

SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

func (*AuthenticateURL) String 

func (o *AuthenticateURL) String() string

String returns the string representation of the path with query string

func (*AuthenticateURL) StringFull 

func (o *AuthenticateURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*AuthenticateURL) WithBasePath 

func (o *AuthenticateURL) WithBasePath(bp string) *AuthenticateURL

WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

type AuthenticateUnauthorized added in v0.25.15 

type AuthenticateUnauthorized struct {

	/*
	  In: Body
	*/
	Payload *rest_model.APIErrorEnvelope `json:"body,omitempty"`
}

AuthenticateUnauthorized The authentication request could not be processed as the credentials are invalid

swagger:response authenticateUnauthorized

func NewAuthenticateUnauthorized added in v0.25.15 

func NewAuthenticateUnauthorized() *AuthenticateUnauthorized

NewAuthenticateUnauthorized creates AuthenticateUnauthorized with default headers values

func (*AuthenticateUnauthorized) SetPayload added in v0.25.15 

func (o *AuthenticateUnauthorized) SetPayload(payload *rest_model.APIErrorEnvelope)

SetPayload sets the payload to the authenticate unauthorized response

func (*AuthenticateUnauthorized) WithPayload added in v0.25.15 

func (o *AuthenticateUnauthorized) WithPayload(payload *rest_model.APIErrorEnvelope) *AuthenticateUnauthorized

WithPayload adds the payload to the authenticate unauthorized response

func (*AuthenticateUnauthorized) WriteResponse added in v0.25.15 

func (o *AuthenticateUnauthorized) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.