Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuthorizeParams ¶
type AuthorizeParams struct { /*The URL to which the authentication server redirects the browser for action In: query */ AppURI *string `json:"app_uri"` /* Required: true In: query */ Audience string `json:"audience"` /*The client id Required: true In: query */ ClientID string `json:"client_id"` /*The generated challenge from the code_verifier. Required: true In: query */ CodeChallenge string `json:"code_challenge"` /*The method used to generate the challenge. The PKCE RFC defines two methods, S256 and plain; however, the authentication serivce supports only S256. In: query Default: "S256" */ CodeChallengeMethod *string `json:"code_challenge_method"` /*The URL to which the authentication server redirects the browser after authorization has been granted by the user In: query */ RedirectURI *string `json:"redirect_uri"` /*The authorization code response type Required: true In: query */ ResponseType string `json:"response_type"` /*The requested scopes, if empty will request all the user permissions. In: query Collection Format: ssv */ Scope []string `json:"scope"` /*Opaque state returned the redirect uri In: query */ State *string `json:"state"` /*The user pool to authorize against In: query */ UserPool *string `json:"user_pool"` // contains filtered or unexported fields }
AuthorizeParams contains all the bound params for the authorize operation typically these are obtained from a http.Request
swagger:parameters Authorize
func NewAuthorizeParams ¶
func NewAuthorizeParams() AuthorizeParams
NewAuthorizeParams creates a new AuthorizeParams object with the default values initialized.
func (*AuthorizeParams) BindRequest ¶
func (o *AuthorizeParams) BindRequest(w http.ResponseWriter, r *http.Request, c ...runtime.Consumer) 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.
func (*AuthorizeParams) Context ¶
func (o *AuthorizeParams) Context() context.Context
Context returns the request context
func (*AuthorizeParams) UnbindRequest ¶
func (o *AuthorizeParams) UnbindRequest() (http.ResponseWriter, *http.Request)
UnbindRequest returns the response and request associated with the parameters
type LoginParams ¶
type LoginParams struct { /*The user login Required: true In: formData */ Login string `json:"login"` /*The user password Required: true In: formData */ Password string `json:"password"` /*"The authorization request token" Required: true In: formData */ RequestToken string `json:"request_token"` // contains filtered or unexported fields }
LoginParams contains all the bound params for the login operation typically these are obtained from a http.Request
swagger:parameters Login
func NewLoginParams ¶
func NewLoginParams() LoginParams
NewLoginParams creates a new LoginParams object no default values defined in spec.
func (*LoginParams) BindRequest ¶
func (o *LoginParams) BindRequest(w http.ResponseWriter, r *http.Request, c ...runtime.Consumer) 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.
func (*LoginParams) Context ¶
func (o *LoginParams) Context() context.Context
Context returns the request context
func (*LoginParams) UnbindRequest ¶
func (o *LoginParams) UnbindRequest() (http.ResponseWriter, *http.Request)
UnbindRequest returns the response and request associated with the parameters
type LogoutParams ¶
type LogoutParams struct { /* Required: true In: query */ Audience string `json:"audience"` /*The client id Required: true In: query */ ClientID string `json:"client_id"` /*The uri to redirect to after logout In: query */ RedirectURI *string `json:"redirect_uri"` /*Logout state In: query */ State *string `json:"state"` // contains filtered or unexported fields }
LogoutParams contains all the bound params for the logout operation typically these are obtained from a http.Request
swagger:parameters Logout
func NewLogoutParams ¶
func NewLogoutParams() LogoutParams
NewLogoutParams creates a new LogoutParams object no default values defined in spec.
func (*LogoutParams) BindRequest ¶
func (o *LogoutParams) BindRequest(w http.ResponseWriter, r *http.Request, c ...runtime.Consumer) 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.
func (*LogoutParams) Context ¶
func (o *LogoutParams) Context() context.Context
Context returns the request context
func (*LogoutParams) UnbindRequest ¶
func (o *LogoutParams) UnbindRequest() (http.ResponseWriter, *http.Request)
UnbindRequest returns the response and request associated with the parameters
type PasswordResetParams ¶
type PasswordResetParams struct { /*The PKCE code verifier Required: true In: formData */ CodeVerifier string `json:"code_verifier"` /*The user's login Required: true In: formData */ Login string `json:"login"` /*The uri to redirect to after password reset request In: formData */ RedirectURI *strfmt.URI `json:"redirect_uri"` /*"The authorization request token" Required: true In: formData */ RequestToken string `json:"request_token"` // contains filtered or unexported fields }
PasswordResetParams contains all the bound params for the password reset operation typically these are obtained from a http.Request
swagger:parameters PasswordReset
func NewPasswordResetParams ¶
func NewPasswordResetParams() PasswordResetParams
NewPasswordResetParams creates a new PasswordResetParams object no default values defined in spec.
func (*PasswordResetParams) BindRequest ¶
func (o *PasswordResetParams) BindRequest(w http.ResponseWriter, r *http.Request, c ...runtime.Consumer) 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.
func (*PasswordResetParams) Context ¶
func (o *PasswordResetParams) Context() context.Context
Context returns the request context
func (*PasswordResetParams) UnbindRequest ¶
func (o *PasswordResetParams) UnbindRequest() (http.ResponseWriter, *http.Request)
UnbindRequest returns the response and request associated with the parameters
type PasswordSetParams ¶
type PasswordSetParams struct { /*The PKCE code verifier Required: true In: formData */ CodeVerifier string `json:"code_verifier"` /*The user's login Required: true In: formData */ Login string `json:"login"` /*The new password Required: true In: formData */ Password string `json:"password"` /*The uri to redirect to after password reset In: formData */ RedirectURI *strfmt.URI `json:"redirect_uri"` /*The reset verification code Required: true In: formData */ ResetCode string `json:"reset_code"` // contains filtered or unexported fields }
PasswordSetParams contains all the bound params for the password set operation typically these are obtained from a http.Request
swagger:parameters PasswordSet
func NewPasswordSetParams ¶
func NewPasswordSetParams() PasswordSetParams
NewPasswordSetParams creates a new PasswordSetParams object no default values defined in spec.
func (*PasswordSetParams) BindRequest ¶
func (o *PasswordSetParams) BindRequest(w http.ResponseWriter, r *http.Request, c ...runtime.Consumer) 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.
func (*PasswordSetParams) Context ¶
func (o *PasswordSetParams) Context() context.Context
Context returns the request context
func (*PasswordSetParams) UnbindRequest ¶
func (o *PasswordSetParams) UnbindRequest() (http.ResponseWriter, *http.Request)
UnbindRequest returns the response and request associated with the parameters
type PublicKeyGetParams ¶
type PublicKeyGetParams struct { /*The audience for the request In: query */ Audience *string `json:"audience"` // contains filtered or unexported fields }
PublicKeyGetParams contains all the bound params for the public key get operation typically these are obtained from a http.Request
swagger:parameters PublicKeyGet
func NewPublicKeyGetParams ¶
func NewPublicKeyGetParams() PublicKeyGetParams
NewPublicKeyGetParams creates a new PublicKeyGetParams object no default values defined in spec.
func (*PublicKeyGetParams) BindRequest ¶
func (o *PublicKeyGetParams) BindRequest(w http.ResponseWriter, r *http.Request, c ...runtime.Consumer) 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.
func (*PublicKeyGetParams) Context ¶
func (o *PublicKeyGetParams) Context() context.Context
Context returns the request context
func (*PublicKeyGetParams) UnbindRequest ¶
func (o *PublicKeyGetParams) UnbindRequest() (http.ResponseWriter, *http.Request)
UnbindRequest returns the response and request associated with the parameters
type SignupParams ¶
type SignupParams struct { /*The user's email address Required: true In: formData */ Email strfmt.Email `json:"email"` /*Inivitation codes allow for users to sign up when public sign up is disabled. In: formData */ InviteCode *string `json:"invite_code"` /*The user's login Required: true In: formData */ Login string `json:"login"` /*The user's full name In: formData */ Name *string `json:"name"` /*The user's password Required: true In: formData */ Password string `json:"password"` /*"The authorization request token" Required: true In: formData */ RequestToken string `json:"request_token"` // contains filtered or unexported fields }
SignupParams contains all the bound params for the signup operation typically these are obtained from a http.Request
swagger:parameters Signup
func NewSignupParams ¶
func NewSignupParams() SignupParams
NewSignupParams creates a new SignupParams object no default values defined in spec.
func (*SignupParams) BindRequest ¶
func (o *SignupParams) BindRequest(w http.ResponseWriter, r *http.Request, c ...runtime.Consumer) 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.
func (*SignupParams) Context ¶
func (o *SignupParams) Context() context.Context
Context returns the request context
func (*SignupParams) UnbindRequest ¶
func (o *SignupParams) UnbindRequest() (http.ResponseWriter, *http.Request)
UnbindRequest returns the response and request associated with the parameters
type TokenParams ¶
type TokenParams struct { /*The reqest audience for client_credentials flows Required: true In: formData */ Audience string `json:"audience"` /*The client id Required: true In: formData */ ClientID string `json:"client_id"` /*The client secret In: formData */ ClientSecret *string `json:"client_secret"` /*The authorization code In: formData */ Code *string `json:"code"` /*The PKCE code verifier In: formData */ CodeVerifier *string `json:"code_verifier"` /*The authorization grant type Required: true In: formData */ GrantType string `json:"grant_type"` /*The password for password grants In: formData */ Password *string `json:"password"` /*The new refresh token nonce is the S256 of a client generated value as defined in the PKCE standard, similar to that used in the authorization flow. When requesting `offline_access` the client will generate a nonce value and pass the base64 raw url encoded value of the S256 of this nonce. Each subsequent `offline_access` request in the `refresh_token` flow requires a new verifier. In: formData */ RefreshNonce *string `json:"refresh_nonce"` /*The refresh token In: formData */ RefreshToken *string `json:"refresh_token"` /*Verifier nonce used to validate a refresh token request. This is the base64 raw url encoded value of the original nonce generated by the client. In: formData */ RefreshVerifier *string `json:"refresh_verifier"` /*The scopes In: formData Collection Format: ssv */ Scope []string `json:"scope"` /*The username for password grants In: formData */ Username *string `json:"username"` // contains filtered or unexported fields }
TokenParams contains all the bound params for the token operation typically these are obtained from a http.Request
swagger:parameters Token
func NewTokenParams ¶
func NewTokenParams() TokenParams
NewTokenParams creates a new TokenParams object no default values defined in spec.
func (*TokenParams) BindRequest ¶
func (o *TokenParams) BindRequest(w http.ResponseWriter, r *http.Request, c ...runtime.Consumer) 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.
func (*TokenParams) Context ¶
func (o *TokenParams) Context() context.Context
Context returns the request context
func (*TokenParams) UnbindRequest ¶
func (o *TokenParams) UnbindRequest() (http.ResponseWriter, *http.Request)
UnbindRequest returns the response and request associated with the parameters
type VerifyParams ¶
type VerifyParams struct { /*The verification code Required: true In: query */ Code string `json:"code"` /*The redirect uri Required: true In: query */ RedirectURI string `json:"redirect_uri"` /*The user's subject identifier Required: true In: query */ Sub string `json:"sub"` // contains filtered or unexported fields }
VerifyParams contains all the bound params for the verify operation typically these are obtained from a http.Request
swagger:parameters Verify
func NewVerifyParams ¶
func NewVerifyParams() VerifyParams
NewVerifyParams creates a new VerifyParams object no default values defined in spec.
func (*VerifyParams) BindRequest ¶
func (o *VerifyParams) BindRequest(w http.ResponseWriter, r *http.Request, c ...runtime.Consumer) 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.
func (*VerifyParams) Context ¶
func (o *VerifyParams) Context() context.Context
Context returns the request context
func (*VerifyParams) UnbindRequest ¶
func (o *VerifyParams) UnbindRequest() (http.ResponseWriter, *http.Request)
UnbindRequest returns the response and request associated with the parameters
Source Files ¶
- authorize.go
- authorize_parameters.go
- login.go
- login_parameters.go
- logout.go
- logout_parameters.go
- password_reset.go
- password_reset_parameters.go
- password_set.go
- password_set_parameters.go
- public_key_get.go
- public_key_get_parameters.go
- signup.go
- signup_parameters.go
- token.go
- token_parameters.go
- verify.go
- verify_parameters.go