Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuthorizeParams ¶
type AuthorizeParams struct {
// HTTP Request Object
HTTPRequest *http.Request `json:"-"`
/*The URL to which the authentication server redirects the browser for action
In: query
*/
AppURI *string
/*
Required: true
In: query
*/
Audience string
/*The client id
Required: true
In: query
*/
ClientID string
/*The generated challenge from the code_verifier.
Required: true
In: query
*/
CodeChallenge string
/*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
/*The URL to which the authentication server redirects the browser after authorization has been granted by the user
In: query
*/
RedirectURI *string
/*The authorization code response type
Required: true
In: query
*/
ResponseType string
/*The requested scopes, if empty will request all the user permissions.
In: query
Collection Format: ssv
*/
Scope []string
/*Opaque state returned the redirect uri
In: query
*/
State *string
}
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 ¶
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 NewAuthorizeParams() beforehand.
type LoginParams ¶
type LoginParams struct {
// HTTP Request Object
HTTPRequest *http.Request `json:"-"`
/*The PKCE code verifier
Required: true
In: formData
*/
CodeVerifier string
/*The user login
Required: true
In: formData
*/
Login string
/*The user password
Required: true
In: formData
*/
Password string
/*"The authorization request token"
Required: true
In: formData
*/
RequestToken string
}
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 ¶
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 NewLoginParams() beforehand.
type LogoutParams ¶
type LogoutParams struct {
// HTTP Request Object
HTTPRequest *http.Request `json:"-"`
/*The client id
Required: true
In: query
*/
ClientID string
/*The uri to redirect to after logout
In: query
*/
RedirectURI *string
/*Logout state
In: query
*/
State *string
}
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 ¶
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 NewLogoutParams() beforehand.
type SignupParams ¶
type SignupParams struct {
// HTTP Request Object
HTTPRequest *http.Request `json:"-"`
/*The PKCE code verifier
Required: true
In: formData
*/
CodeVerifier string
/*The user's email address
Required: true
In: formData
*/
Email strfmt.Email
/*Inivitation codes allow for users to sign up when public sign up is disabled.
In: formData
*/
InviteCode *string
/*The user's login
Required: true
In: formData
*/
Login string
/*The user's full name
In: formData
*/
Name *string
/*The user's password
Required: true
In: formData
*/
Password string
/*"The authorization request token"
Required: true
In: formData
*/
RequestToken string
}
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 ¶
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 NewSignupParams() beforehand.
type TokenParams ¶
type TokenParams struct {
// HTTP Request Object
HTTPRequest *http.Request `json:"-"`
/*The reqest audience for client_credentials flows
In: formData
*/
Audience *string
/*The client id
Required: true
In: formData
*/
ClientID string
/*The client secret
In: formData
*/
ClientSecret *string
/*The authorization code
In: formData
*/
Code *string
/*The PKCE code verifier
In: formData
*/
CodeVerifier *string
/*The authorization grant type
Required: true
In: formData
*/
GrantType string
/*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
/*The refresh token
In: formData
*/
RefreshToken *string
/*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
/*The scopes
In: formData
Collection Format: ssv
*/
Scope []string
}
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 ¶
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 NewTokenParams() beforehand.
Source Files