Documentation
¶
Index ¶
- Constants
- type Authenticate
- type AuthenticateBadRequest
- type AuthenticateForbidden
- type AuthenticateHandler
- type AuthenticateHandlerFunc
- type AuthenticateOK
- type AuthenticateParams
- type AuthenticateURL
- func (o *AuthenticateURL) Build() (*url.URL, error)
- func (o *AuthenticateURL) BuildFull(scheme, host string) (*url.URL, error)
- func (o *AuthenticateURL) Must(u *url.URL, err error) *url.URL
- func (o *AuthenticateURL) SetBasePath(bp string)
- func (o *AuthenticateURL) String() string
- func (o *AuthenticateURL) StringFull(scheme, host string) string
- func (o *AuthenticateURL) WithBasePath(bp string) *AuthenticateURL
Constants ¶
const AuthenticateBadRequestCode int = 400
AuthenticateBadRequestCode is the HTTP code returned for type AuthenticateBadRequest
const AuthenticateForbiddenCode int = 403
AuthenticateForbiddenCode is the HTTP code returned for type AuthenticateForbidden
const AuthenticateOKCode int = 200
AuthenticateOKCode is the HTTP code returned for type AuthenticateOK
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 ¶
Allows authentication Methods include "password" and "cert"
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 AuthenticateForbidden ¶
type AuthenticateForbidden struct {
/*
In: Body
*/
Payload *rest_model.APIErrorEnvelope `json:"body,omitempty"`
}
AuthenticateForbidden The authentication request could not be processed as the credentials are invalid
swagger:response authenticateForbidden
func NewAuthenticateForbidden ¶
func NewAuthenticateForbidden() *AuthenticateForbidden
NewAuthenticateForbidden creates AuthenticateForbidden with default headers values
func (*AuthenticateForbidden) SetPayload ¶
func (o *AuthenticateForbidden) SetPayload(payload *rest_model.APIErrorEnvelope)
SetPayload sets the payload to the authenticate forbidden response
func (*AuthenticateForbidden) WithPayload ¶
func (o *AuthenticateForbidden) WithPayload(payload *rest_model.APIErrorEnvelope) *AuthenticateForbidden
WithPayload adds the payload to the authenticate forbidden response
func (*AuthenticateForbidden) WriteResponse ¶
func (o *AuthenticateForbidden) 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 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
*/
Body *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 no default values defined in 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 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 ¶
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
Source Files