Documentation ¶
Index ¶
- Constants
- type GetAuthLogin
- type GetAuthLoginHandler
- type GetAuthLoginHandlerFunc
- type GetAuthLoginOK
- type GetAuthLoginParams
- type GetAuthLoginURL
- func (o *GetAuthLoginURL) Build() (*url.URL, error)
- func (o *GetAuthLoginURL) BuildFull(scheme, host string) (*url.URL, error)
- func (o *GetAuthLoginURL) Must(u *url.URL, err error) *url.URL
- func (o *GetAuthLoginURL) SetBasePath(bp string)
- func (o *GetAuthLoginURL) String() string
- func (o *GetAuthLoginURL) StringFull(scheme, host string) string
- func (o *GetAuthLoginURL) WithBasePath(bp string) *GetAuthLoginURL
- type PostAuthOauthToken
- type PostAuthOauthTokenHandler
- type PostAuthOauthTokenHandlerFunc
- type PostAuthOauthTokenOK
- type PostAuthOauthTokenParams
- type PostAuthOauthTokenURL
- func (o *PostAuthOauthTokenURL) Build() (*url.URL, error)
- func (o *PostAuthOauthTokenURL) BuildFull(scheme, host string) (*url.URL, error)
- func (o *PostAuthOauthTokenURL) Must(u *url.URL, err error) *url.URL
- func (o *PostAuthOauthTokenURL) SetBasePath(bp string)
- func (o *PostAuthOauthTokenURL) String() string
- func (o *PostAuthOauthTokenURL) StringFull(scheme, host string) string
- func (o *PostAuthOauthTokenURL) WithBasePath(bp string) *PostAuthOauthTokenURL
- type PostOauthToken
- type PostOauthTokenHandler
- type PostOauthTokenHandlerFunc
- type PostOauthTokenOK
- type PostOauthTokenParams
- type PostOauthTokenURL
- func (o *PostOauthTokenURL) Build() (*url.URL, error)
- func (o *PostOauthTokenURL) BuildFull(scheme, host string) (*url.URL, error)
- func (o *PostOauthTokenURL) Must(u *url.URL, err error) *url.URL
- func (o *PostOauthTokenURL) SetBasePath(bp string)
- func (o *PostOauthTokenURL) String() string
- func (o *PostOauthTokenURL) StringFull(scheme, host string) string
- func (o *PostOauthTokenURL) WithBasePath(bp string) *PostOauthTokenURL
Constants ¶
const GetAuthLoginOKCode int = 200
GetAuthLoginOKCode is the HTTP code returned for type GetAuthLoginOK
const PostAuthOauthTokenOKCode int = 200
PostAuthOauthTokenOKCode is the HTTP code returned for type PostAuthOauthTokenOK
const PostOauthTokenOKCode int = 200
PostOauthTokenOKCode is the HTTP code returned for type PostOauthTokenOK
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GetAuthLogin ¶
type GetAuthLogin struct { Context *middleware.Context Handler GetAuthLoginHandler }
GetAuthLogin swagger:route GET /auth/login auth getAuthLogin
Supports both JSON and HTML output. The HTML output is intended for browser user agents to display a login page.
func NewGetAuthLogin ¶
func NewGetAuthLogin(ctx *middleware.Context, handler GetAuthLoginHandler) *GetAuthLogin
NewGetAuthLogin creates a new http.Handler for the get auth login operation
func (*GetAuthLogin) ServeHTTP ¶
func (o *GetAuthLogin) ServeHTTP(rw http.ResponseWriter, r *http.Request)
type GetAuthLoginHandler ¶
type GetAuthLoginHandler interface {
Handle(GetAuthLoginParams) middleware.Responder
}
GetAuthLoginHandler interface for that can handle valid get auth login params
type GetAuthLoginHandlerFunc ¶
type GetAuthLoginHandlerFunc func(GetAuthLoginParams) middleware.Responder
GetAuthLoginHandlerFunc turns a function with the right signature into a get auth login handler
func (GetAuthLoginHandlerFunc) Handle ¶
func (fn GetAuthLoginHandlerFunc) Handle(params GetAuthLoginParams) middleware.Responder
Handle executing the request and returning a response
type GetAuthLoginOK ¶
type GetAuthLoginOK struct { /* In: Body */ Payload *models.RetrieveAuthLogin `json:"body,omitempty"` }
GetAuthLoginOK successful response
swagger:response getAuthLoginOK
func NewGetAuthLoginOK ¶
func NewGetAuthLoginOK() *GetAuthLoginOK
NewGetAuthLoginOK creates GetAuthLoginOK with default headers values
func (*GetAuthLoginOK) SetPayload ¶
func (o *GetAuthLoginOK) SetPayload(payload *models.RetrieveAuthLogin)
SetPayload sets the payload to the get auth login o k response
func (*GetAuthLoginOK) WithPayload ¶
func (o *GetAuthLoginOK) WithPayload(payload *models.RetrieveAuthLogin) *GetAuthLoginOK
WithPayload adds the payload to the get auth login o k response
func (*GetAuthLoginOK) WriteResponse ¶
func (o *GetAuthLoginOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type GetAuthLoginParams ¶
type GetAuthLoginParams struct { // HTTP Request Object HTTPRequest *http.Request `json:"-"` /*Use the configured prompts of the OpenID Connect Provider with the given origin key in the response. Fallback to zone values if no prompts are configured or origin is invalid. In: query */ Origin *string }
GetAuthLoginParams contains all the bound params for the get auth login operation typically these are obtained from a http.Request
swagger:parameters GetAuthLogin
func NewGetAuthLoginParams ¶
func NewGetAuthLoginParams() GetAuthLoginParams
NewGetAuthLoginParams creates a new GetAuthLoginParams object no default values defined in spec.
func (*GetAuthLoginParams) BindRequest ¶
func (o *GetAuthLoginParams) 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 NewGetAuthLoginParams() beforehand.
type GetAuthLoginURL ¶
type GetAuthLoginURL struct { Origin *string // contains filtered or unexported fields }
GetAuthLoginURL generates an URL for the get auth login operation
func (*GetAuthLoginURL) Build ¶
func (o *GetAuthLoginURL) Build() (*url.URL, error)
Build a url path and query string
func (*GetAuthLoginURL) BuildFull ¶
func (o *GetAuthLoginURL) BuildFull(scheme, host string) (*url.URL, error)
BuildFull builds a full url with scheme, host, path and query string
func (*GetAuthLoginURL) Must ¶
Must is a helper function to panic when the url builder returns an error
func (*GetAuthLoginURL) SetBasePath ¶
func (o *GetAuthLoginURL) 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 (*GetAuthLoginURL) String ¶
func (o *GetAuthLoginURL) String() string
String returns the string representation of the path with query string
func (*GetAuthLoginURL) StringFull ¶
func (o *GetAuthLoginURL) StringFull(scheme, host string) string
StringFull returns the string representation of a complete url
func (*GetAuthLoginURL) WithBasePath ¶
func (o *GetAuthLoginURL) WithBasePath(bp string) *GetAuthLoginURL
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 PostAuthOauthToken ¶
type PostAuthOauthToken struct { Context *middleware.Context Handler PostAuthOauthTokenHandler }
PostAuthOauthToken swagger:route POST /auth/oauth/token auth postAuthOauthToken
The /oauth/token endpoint requires client authentication to be accessed. Client Authentication can be passed as as part of the request authorization header, using basic authentication, or as part of the request parameters, using the client_id and client_secret parameter names.
func NewPostAuthOauthToken ¶
func NewPostAuthOauthToken(ctx *middleware.Context, handler PostAuthOauthTokenHandler) *PostAuthOauthToken
NewPostAuthOauthToken creates a new http.Handler for the post auth oauth token operation
func (*PostAuthOauthToken) ServeHTTP ¶
func (o *PostAuthOauthToken) ServeHTTP(rw http.ResponseWriter, r *http.Request)
type PostAuthOauthTokenHandler ¶
type PostAuthOauthTokenHandler interface {
Handle(PostAuthOauthTokenParams) middleware.Responder
}
PostAuthOauthTokenHandler interface for that can handle valid post auth oauth token params
type PostAuthOauthTokenHandlerFunc ¶
type PostAuthOauthTokenHandlerFunc func(PostAuthOauthTokenParams) middleware.Responder
PostAuthOauthTokenHandlerFunc turns a function with the right signature into a post auth oauth token handler
func (PostAuthOauthTokenHandlerFunc) Handle ¶
func (fn PostAuthOauthTokenHandlerFunc) Handle(params PostAuthOauthTokenParams) middleware.Responder
Handle executing the request and returning a response
type PostAuthOauthTokenOK ¶
type PostAuthOauthTokenOK struct { /* In: Body */ Payload *models.CreatesOAuthTokenResponse `json:"body,omitempty"` }
PostAuthOauthTokenOK successful response
swagger:response postAuthOauthTokenOK
func NewPostAuthOauthTokenOK ¶
func NewPostAuthOauthTokenOK() *PostAuthOauthTokenOK
NewPostAuthOauthTokenOK creates PostAuthOauthTokenOK with default headers values
func (*PostAuthOauthTokenOK) SetPayload ¶
func (o *PostAuthOauthTokenOK) SetPayload(payload *models.CreatesOAuthTokenResponse)
SetPayload sets the payload to the post auth oauth token o k response
func (*PostAuthOauthTokenOK) WithPayload ¶
func (o *PostAuthOauthTokenOK) WithPayload(payload *models.CreatesOAuthTokenResponse) *PostAuthOauthTokenOK
WithPayload adds the payload to the post auth oauth token o k response
func (*PostAuthOauthTokenOK) WriteResponse ¶
func (o *PostAuthOauthTokenOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type PostAuthOauthTokenParams ¶
type PostAuthOauthTokenParams struct { // HTTP Request Object HTTPRequest *http.Request `json:"-"` /*Client ID and secret may be passed as a basic authorization header, per RFC 6749 or as request parameters. In: header */ Authorization *string /*A unique string representing the registration information provided by the client, the recipient of the token. Optional if it is passed as part of the Basic Authorization header. In: formData */ ClientID *string /*The secret passphrase configured for the OAuth client. Optional if it is passed as part of the Basic Authorization header. In: formData */ ClientSecret *string /*The authorization code, obtained from /oauth/authorize, issued for the user In: formData */ Code *string /*The type of authentication being used to obtain the token, in this case authorization_code Required: true In: formData */ GrantType string /*Redirection URI to which the authorization server will send the user-agent back once access is granted (or denied) In: formData */ RedirectURI *string /*Can be set to opaque to retrieve an opaque and revocable token or to jwt to retrieve a JWT token. If not set the zone setting config.tokenPolicy.jwtRevocable is used. In: formData */ TokenFormat *string }
PostAuthOauthTokenParams contains all the bound params for the post auth oauth token operation typically these are obtained from a http.Request
swagger:parameters PostAuthOauthToken
func NewPostAuthOauthTokenParams ¶
func NewPostAuthOauthTokenParams() PostAuthOauthTokenParams
NewPostAuthOauthTokenParams creates a new PostAuthOauthTokenParams object no default values defined in spec.
func (*PostAuthOauthTokenParams) BindRequest ¶
func (o *PostAuthOauthTokenParams) 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 NewPostAuthOauthTokenParams() beforehand.
type PostAuthOauthTokenURL ¶
type PostAuthOauthTokenURL struct {
// contains filtered or unexported fields
}
PostAuthOauthTokenURL generates an URL for the post auth oauth token operation
func (*PostAuthOauthTokenURL) Build ¶
func (o *PostAuthOauthTokenURL) Build() (*url.URL, error)
Build a url path and query string
func (*PostAuthOauthTokenURL) BuildFull ¶
func (o *PostAuthOauthTokenURL) BuildFull(scheme, host string) (*url.URL, error)
BuildFull builds a full url with scheme, host, path and query string
func (*PostAuthOauthTokenURL) Must ¶
Must is a helper function to panic when the url builder returns an error
func (*PostAuthOauthTokenURL) SetBasePath ¶
func (o *PostAuthOauthTokenURL) 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 (*PostAuthOauthTokenURL) String ¶
func (o *PostAuthOauthTokenURL) String() string
String returns the string representation of the path with query string
func (*PostAuthOauthTokenURL) StringFull ¶
func (o *PostAuthOauthTokenURL) StringFull(scheme, host string) string
StringFull returns the string representation of a complete url
func (*PostAuthOauthTokenURL) WithBasePath ¶
func (o *PostAuthOauthTokenURL) WithBasePath(bp string) *PostAuthOauthTokenURL
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 PostOauthToken ¶
type PostOauthToken struct { Context *middleware.Context Handler PostOauthTokenHandler }
PostOauthToken swagger:route POST /oauth/token auth postOauthToken
The /oauth/token endpoint requires client authentication to be accessed. Client Authentication can be passed as as part of the request authorization header, using basic authentication, or as part of the request parameters, using the client_id and client_secret parameter names.
func NewPostOauthToken ¶
func NewPostOauthToken(ctx *middleware.Context, handler PostOauthTokenHandler) *PostOauthToken
NewPostOauthToken creates a new http.Handler for the post oauth token operation
func (*PostOauthToken) ServeHTTP ¶
func (o *PostOauthToken) ServeHTTP(rw http.ResponseWriter, r *http.Request)
type PostOauthTokenHandler ¶
type PostOauthTokenHandler interface {
Handle(PostOauthTokenParams) middleware.Responder
}
PostOauthTokenHandler interface for that can handle valid post oauth token params
type PostOauthTokenHandlerFunc ¶
type PostOauthTokenHandlerFunc func(PostOauthTokenParams) middleware.Responder
PostOauthTokenHandlerFunc turns a function with the right signature into a post oauth token handler
func (PostOauthTokenHandlerFunc) Handle ¶
func (fn PostOauthTokenHandlerFunc) Handle(params PostOauthTokenParams) middleware.Responder
Handle executing the request and returning a response
type PostOauthTokenOK ¶
type PostOauthTokenOK struct { /* In: Body */ Payload *models.CreatesOAuthTokenResponse `json:"body,omitempty"` }
PostOauthTokenOK successful response
swagger:response postOauthTokenOK
func NewPostOauthTokenOK ¶
func NewPostOauthTokenOK() *PostOauthTokenOK
NewPostOauthTokenOK creates PostOauthTokenOK with default headers values
func (*PostOauthTokenOK) SetPayload ¶
func (o *PostOauthTokenOK) SetPayload(payload *models.CreatesOAuthTokenResponse)
SetPayload sets the payload to the post oauth token o k response
func (*PostOauthTokenOK) WithPayload ¶
func (o *PostOauthTokenOK) WithPayload(payload *models.CreatesOAuthTokenResponse) *PostOauthTokenOK
WithPayload adds the payload to the post oauth token o k response
func (*PostOauthTokenOK) WriteResponse ¶
func (o *PostOauthTokenOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type PostOauthTokenParams ¶
type PostOauthTokenParams struct { // HTTP Request Object HTTPRequest *http.Request `json:"-"` /*Client ID and secret may be passed as a basic authorization header, per RFC 6749 or as request parameters. In: header */ Authorization *string /*A unique string representing the registration information provided by the client, the recipient of the token. Optional if it is passed as part of the Basic Authorization header. In: query */ ClientID *string /*The secret passphrase configured for the OAuth client. Optional if it is passed as part of the Basic Authorization header. In: query */ ClientSecret *string /*The authorization code, obtained from /oauth/authorize, issued for the user Required: true In: query */ Code string /*The type of authentication being used to obtain the token, in this case authorization_code Required: true In: query */ GrantType string /*Redirection URI to which the authorization server will send the user-agent back once access is granted (or denied) In: query */ RedirectURI *string /*Can be set to opaque to retrieve an opaque and revocable token or to jwt to retrieve a JWT token. If not set the zone setting config.tokenPolicy.jwtRevocable is used. In: query */ TokenFormat *string }
PostOauthTokenParams contains all the bound params for the post oauth token operation typically these are obtained from a http.Request
swagger:parameters PostOauthToken
func NewPostOauthTokenParams ¶
func NewPostOauthTokenParams() PostOauthTokenParams
NewPostOauthTokenParams creates a new PostOauthTokenParams object no default values defined in spec.
func (*PostOauthTokenParams) BindRequest ¶
func (o *PostOauthTokenParams) 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 NewPostOauthTokenParams() beforehand.
type PostOauthTokenURL ¶
type PostOauthTokenURL struct { ClientID *string ClientSecret *string Code string GrantType string RedirectURI *string TokenFormat *string // contains filtered or unexported fields }
PostOauthTokenURL generates an URL for the post oauth token operation
func (*PostOauthTokenURL) Build ¶
func (o *PostOauthTokenURL) Build() (*url.URL, error)
Build a url path and query string
func (*PostOauthTokenURL) BuildFull ¶
func (o *PostOauthTokenURL) BuildFull(scheme, host string) (*url.URL, error)
BuildFull builds a full url with scheme, host, path and query string
func (*PostOauthTokenURL) Must ¶
Must is a helper function to panic when the url builder returns an error
func (*PostOauthTokenURL) SetBasePath ¶
func (o *PostOauthTokenURL) 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 (*PostOauthTokenURL) String ¶
func (o *PostOauthTokenURL) String() string
String returns the string representation of the path with query string
func (*PostOauthTokenURL) StringFull ¶
func (o *PostOauthTokenURL) StringFull(scheme, host string) string
StringFull returns the string representation of a complete url
func (*PostOauthTokenURL) WithBasePath ¶
func (o *PostOauthTokenURL) WithBasePath(bp string) *PostOauthTokenURL
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 ¶
- get_auth_login.go
- get_auth_login_parameters.go
- get_auth_login_responses.go
- get_auth_login_urlbuilder.go
- post_auth_oauth_token.go
- post_auth_oauth_token_parameters.go
- post_auth_oauth_token_responses.go
- post_auth_oauth_token_urlbuilder.go
- post_oauth_token.go
- post_oauth_token_parameters.go
- post_oauth_token_responses.go
- post_oauth_token_urlbuilder.go