Documentation
¶
Overview ¶
Package api provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version 2.4.1 DO NOT EDIT.
Package api provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version 2.4.1 DO NOT EDIT.
Index ¶
- Constants
- func GetSwagger() (swagger *openapi3.T, err error)
- func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)
- func RegisterHandlers(router gin.IRouter, si ServerInterface)
- func RegisterHandlersWithOptions(router gin.IRouter, si ServerInterface, options GinServerOptions)
- type AddSecurityKey200JSONResponse
- type AddSecurityKeyRequestObject
- type AddSecurityKeyResponseObject
- type AddSecurityKeydefaultJSONResponse
- type AttestationFormat
- type AuthenticationExtensions
- type AuthenticationExtensionsClientOutputs
- func (a AuthenticationExtensionsClientOutputs) Get(fieldName string) (value interface{}, found bool)
- func (a AuthenticationExtensionsClientOutputs) MarshalJSON() ([]byte, error)
- func (a *AuthenticationExtensionsClientOutputs) Set(fieldName string, value interface{})
- func (a *AuthenticationExtensionsClientOutputs) UnmarshalJSON(b []byte) error
- type AuthenticatorAssertionResponse
- type AuthenticatorAttachment
- type AuthenticatorAttestationResponse
- type AuthenticatorSelection
- type AuthenticatorTransport
- type ChangeUserEmail200JSONResponse
- type ChangeUserEmailJSONRequestBody
- type ChangeUserEmailRequestObject
- type ChangeUserEmailResponseObject
- type ChangeUserEmaildefaultJSONResponse
- type ChangeUserMfa200JSONResponse
- type ChangeUserMfaRequestObject
- type ChangeUserMfaResponseObject
- type ChangeUserMfadefaultJSONResponse
- type ChangeUserPassword200JSONResponse
- type ChangeUserPasswordJSONRequestBody
- type ChangeUserPasswordRequestObject
- type ChangeUserPasswordResponseObject
- type ChangeUserPassworddefaultJSONResponse
- type ConveyancePreference
- type CreatePAT200JSONResponse
- type CreatePATJSONRequestBody
- type CreatePATRequest
- type CreatePATRequestObject
- type CreatePATResponse
- type CreatePATResponseObject
- type CreatePATdefaultJSONResponse
- type CredentialAssertionResponse
- type CredentialCreationResponse
- type CredentialParameter
- type CredentialPropertiesOutput
- type CredentialType
- type DeanonymizeUser200JSONResponse
- type DeanonymizeUserJSONRequestBody
- type DeanonymizeUserRequestObject
- type DeanonymizeUserResponseObject
- type DeanonymizeUserdefaultJSONResponse
- type ElevateWebauthn200JSONResponse
- type ElevateWebauthnRequestObject
- type ElevateWebauthnResponseObject
- type ElevateWebauthndefaultJSONResponse
- type ErrorResponse
- type ErrorResponseError
- type GetJWKs200JSONResponse
- type GetJWKsRequestObject
- type GetJWKsResponseObject
- type GetJWKsdefaultJSONResponse
- type GetUser200JSONResponse
- type GetUserRequestObject
- type GetUserResponseObject
- type GetUserdefaultJSONResponse
- type GetVersion200JSONResponse
- type GetVersionRequestObject
- type GetVersionResponseObject
- type GetVersiondefaultJSONResponse
- type GinServerOptions
- type HealthCheckGet200JSONResponse
- type HealthCheckGetRequestObject
- type HealthCheckGetResponseObject
- type HealthCheckGetdefaultJSONResponse
- type HealthCheckHead200Response
- type HealthCheckHeadRequestObject
- type HealthCheckHeadResponseObject
- type HealthCheckHeaddefaultJSONResponse
- type IdTokenProvider
- type JWK
- type JWKSet
- type LinkIdToken200JSONResponse
- type LinkIdTokenJSONRequestBody
- type LinkIdTokenRequest
- type LinkIdTokenRequestObject
- type LinkIdTokenResponseObject
- type LinkIdTokendefaultJSONResponse
- type MFAChallengePayload
- type MiddlewareFunc
- type OKResponse
- type OptionsRedirectTo
- type PublicKeyCredentialCreationOptions
- type PublicKeyCredentialDescriptor
- type PublicKeyCredentialHints
- type PublicKeyCredentialRequestOptions
- type RedirectToQuery
- type RefreshToken200JSONResponse
- type RefreshTokenJSONRequestBody
- type RefreshTokenRequest
- type RefreshTokenRequestObject
- type RefreshTokenResponseObject
- type RefreshTokendefaultJSONResponse
- type RelyingPartyEntity
- type ResidentKeyRequirement
- type SendPasswordResetEmail200JSONResponse
- type SendPasswordResetEmailJSONRequestBody
- type SendPasswordResetEmailRequestObject
- type SendPasswordResetEmailResponseObject
- type SendPasswordResetEmaildefaultJSONResponse
- type SendVerificationEmail200JSONResponse
- type SendVerificationEmailJSONRequestBody
- type SendVerificationEmailRequestObject
- type SendVerificationEmailResponseObject
- type SendVerificationEmaildefaultJSONResponse
- type ServerInterface
- type ServerInterfaceWrapper
- func (siw *ServerInterfaceWrapper) AddSecurityKey(c *gin.Context)
- func (siw *ServerInterfaceWrapper) ChangeUserEmail(c *gin.Context)
- func (siw *ServerInterfaceWrapper) ChangeUserMfa(c *gin.Context)
- func (siw *ServerInterfaceWrapper) ChangeUserPassword(c *gin.Context)
- func (siw *ServerInterfaceWrapper) CreatePAT(c *gin.Context)
- func (siw *ServerInterfaceWrapper) DeanonymizeUser(c *gin.Context)
- func (siw *ServerInterfaceWrapper) ElevateWebauthn(c *gin.Context)
- func (siw *ServerInterfaceWrapper) GetJWKs(c *gin.Context)
- func (siw *ServerInterfaceWrapper) GetUser(c *gin.Context)
- func (siw *ServerInterfaceWrapper) GetVersion(c *gin.Context)
- func (siw *ServerInterfaceWrapper) HealthCheckGet(c *gin.Context)
- func (siw *ServerInterfaceWrapper) HealthCheckHead(c *gin.Context)
- func (siw *ServerInterfaceWrapper) LinkIdToken(c *gin.Context)
- func (siw *ServerInterfaceWrapper) RefreshToken(c *gin.Context)
- func (siw *ServerInterfaceWrapper) SendPasswordResetEmail(c *gin.Context)
- func (siw *ServerInterfaceWrapper) SendVerificationEmail(c *gin.Context)
- func (siw *ServerInterfaceWrapper) SignInAnonymous(c *gin.Context)
- func (siw *ServerInterfaceWrapper) SignInEmailPassword(c *gin.Context)
- func (siw *ServerInterfaceWrapper) SignInIdToken(c *gin.Context)
- func (siw *ServerInterfaceWrapper) SignInOTPEmail(c *gin.Context)
- func (siw *ServerInterfaceWrapper) SignInPAT(c *gin.Context)
- func (siw *ServerInterfaceWrapper) SignInPasswordlessEmail(c *gin.Context)
- func (siw *ServerInterfaceWrapper) SignInPasswordlessSms(c *gin.Context)
- func (siw *ServerInterfaceWrapper) SignInProvider(c *gin.Context)
- func (siw *ServerInterfaceWrapper) SignInProviderCallbackGet(c *gin.Context)
- func (siw *ServerInterfaceWrapper) SignInProviderCallbackPost(c *gin.Context)
- func (siw *ServerInterfaceWrapper) SignInWebauthn(c *gin.Context)
- func (siw *ServerInterfaceWrapper) SignOut(c *gin.Context)
- func (siw *ServerInterfaceWrapper) SignUpEmailPassword(c *gin.Context)
- func (siw *ServerInterfaceWrapper) SignUpWebauthn(c *gin.Context)
- func (siw *ServerInterfaceWrapper) VerifyAddSecurityKey(c *gin.Context)
- func (siw *ServerInterfaceWrapper) VerifyChangeUserMfa(c *gin.Context)
- func (siw *ServerInterfaceWrapper) VerifyElevateWebauthn(c *gin.Context)
- func (siw *ServerInterfaceWrapper) VerifySignInMfaTotp(c *gin.Context)
- func (siw *ServerInterfaceWrapper) VerifySignInOTPEmail(c *gin.Context)
- func (siw *ServerInterfaceWrapper) VerifySignInPasswordlessSms(c *gin.Context)
- func (siw *ServerInterfaceWrapper) VerifySignInWebauthn(c *gin.Context)
- func (siw *ServerInterfaceWrapper) VerifySignUpWebauthn(c *gin.Context)
- func (siw *ServerInterfaceWrapper) VerifyTicket(c *gin.Context)
- func (siw *ServerInterfaceWrapper) VerifyToken(c *gin.Context)
- type Session
- type SessionPayload
- type SignInAnonymous200JSONResponse
- type SignInAnonymousJSONRequestBody
- type SignInAnonymousRequest
- type SignInAnonymousRequestObject
- type SignInAnonymousResponseObject
- type SignInAnonymousdefaultJSONResponse
- type SignInEmailPassword200JSONResponse
- type SignInEmailPasswordJSONRequestBody
- type SignInEmailPasswordRequest
- type SignInEmailPasswordRequestObject
- type SignInEmailPasswordResponse
- type SignInEmailPasswordResponseObject
- type SignInEmailPassworddefaultJSONResponse
- type SignInIdToken200JSONResponse
- type SignInIdTokenJSONRequestBody
- type SignInIdTokenRequest
- type SignInIdTokenRequestObject
- type SignInIdTokenResponseObject
- type SignInIdTokendefaultJSONResponse
- type SignInMfaTotpRequest
- type SignInOTPEmail200JSONResponse
- type SignInOTPEmailJSONRequestBody
- type SignInOTPEmailRequest
- type SignInOTPEmailRequestObject
- type SignInOTPEmailResponseObject
- type SignInOTPEmailVerifyRequest
- type SignInOTPEmailVerifyResponse
- type SignInOTPEmaildefaultJSONResponse
- type SignInPAT200JSONResponse
- type SignInPATJSONRequestBody
- type SignInPATRequest
- type SignInPATRequestObject
- type SignInPATResponseObject
- type SignInPATdefaultJSONResponse
- type SignInPasswordlessEmail200JSONResponse
- type SignInPasswordlessEmailJSONRequestBody
- type SignInPasswordlessEmailRequest
- type SignInPasswordlessEmailRequestObject
- type SignInPasswordlessEmailResponseObject
- type SignInPasswordlessEmaildefaultJSONResponse
- type SignInPasswordlessSms200JSONResponse
- type SignInPasswordlessSmsJSONRequestBody
- type SignInPasswordlessSmsOtpRequest
- type SignInPasswordlessSmsOtpResponse
- type SignInPasswordlessSmsRequest
- type SignInPasswordlessSmsRequestObject
- type SignInPasswordlessSmsResponseObject
- type SignInPasswordlessSmsdefaultJSONResponse
- type SignInProvider
- type SignInProvider302Response
- type SignInProvider302ResponseHeaders
- type SignInProviderCallbackGet302Response
- type SignInProviderCallbackGet302ResponseHeaders
- type SignInProviderCallbackGetParams
- type SignInProviderCallbackGetParamsProvider
- type SignInProviderCallbackGetRequestObject
- type SignInProviderCallbackGetResponseObject
- type SignInProviderCallbackGetdefaultJSONResponse
- type SignInProviderCallbackPost302Response
- type SignInProviderCallbackPost302ResponseHeaders
- type SignInProviderCallbackPostFormdataBody
- func (a SignInProviderCallbackPostFormdataBody) Get(fieldName string) (value interface{}, found bool)
- func (a SignInProviderCallbackPostFormdataBody) MarshalJSON() ([]byte, error)
- func (a *SignInProviderCallbackPostFormdataBody) Set(fieldName string, value interface{})
- func (a *SignInProviderCallbackPostFormdataBody) UnmarshalJSON(b []byte) error
- type SignInProviderCallbackPostFormdataRequestBody
- type SignInProviderCallbackPostParamsProvider
- type SignInProviderCallbackPostRequestObject
- type SignInProviderCallbackPostResponseObject
- type SignInProviderCallbackPostdefaultJSONResponse
- type SignInProviderParams
- type SignInProviderParamsProvider
- type SignInProviderRequestObject
- type SignInProviderResponseObject
- type SignInProviderdefaultJSONResponse
- type SignInWebauthn200JSONResponse
- type SignInWebauthnJSONRequestBody
- type SignInWebauthnRequest
- type SignInWebauthnRequestObject
- type SignInWebauthnResponseObject
- type SignInWebauthnVerifyRequest
- type SignInWebauthndefaultJSONResponse
- type SignOut200JSONResponse
- type SignOutJSONRequestBody
- type SignOutRequest
- type SignOutRequestObject
- type SignOutResponseObject
- type SignOutdefaultJSONResponse
- type SignUpEmailPassword200JSONResponse
- type SignUpEmailPasswordJSONRequestBody
- type SignUpEmailPasswordRequest
- type SignUpEmailPasswordRequestObject
- type SignUpEmailPasswordResponseObject
- type SignUpEmailPassworddefaultJSONResponse
- type SignUpOptions
- type SignUpWebauthn200JSONResponse
- type SignUpWebauthnJSONRequestBody
- type SignUpWebauthnRequest
- type SignUpWebauthnRequestObject
- type SignUpWebauthnResponseObject
- type SignUpWebauthnVerifyRequest
- type SignUpWebauthndefaultJSONResponse
- type StrictHandlerFunc
- type StrictMiddlewareFunc
- type StrictServerInterface
- type TicketQuery
- type TicketTypeQuery
- type TotpGenerateResponse
- type URLEncodedBase64
- type User
- type UserDeanonymizeRequest
- type UserDeanonymizeRequestSignInMethod
- type UserEmailChangeRequest
- type UserEmailSendVerificationEmailRequest
- type UserEntity
- type UserMfaRequest
- type UserMfaRequestActiveMfaType
- type UserPasswordRequest
- type UserPasswordResetRequest
- type UserVerificationRequirement
- type VerifyAddSecurityKey200JSONResponse
- type VerifyAddSecurityKeyJSONRequestBody
- type VerifyAddSecurityKeyRequest
- type VerifyAddSecurityKeyRequestObject
- type VerifyAddSecurityKeyResponse
- type VerifyAddSecurityKeyResponseObject
- type VerifyAddSecurityKeydefaultJSONResponse
- type VerifyChangeUserMfa200JSONResponse
- type VerifyChangeUserMfaJSONRequestBody
- type VerifyChangeUserMfaRequestObject
- type VerifyChangeUserMfaResponseObject
- type VerifyChangeUserMfadefaultJSONResponse
- type VerifyElevateWebauthn200JSONResponse
- type VerifyElevateWebauthnJSONRequestBody
- type VerifyElevateWebauthnRequestObject
- type VerifyElevateWebauthnResponseObject
- type VerifyElevateWebauthndefaultJSONResponse
- type VerifySignInMfaTotp200JSONResponse
- type VerifySignInMfaTotpJSONRequestBody
- type VerifySignInMfaTotpRequestObject
- type VerifySignInMfaTotpResponseObject
- type VerifySignInMfaTotpdefaultJSONResponse
- type VerifySignInOTPEmail200JSONResponse
- type VerifySignInOTPEmailJSONRequestBody
- type VerifySignInOTPEmailRequestObject
- type VerifySignInOTPEmailResponseObject
- type VerifySignInOTPEmaildefaultJSONResponse
- type VerifySignInPasswordlessSms200JSONResponse
- type VerifySignInPasswordlessSmsJSONRequestBody
- type VerifySignInPasswordlessSmsRequestObject
- type VerifySignInPasswordlessSmsResponseObject
- type VerifySignInPasswordlessSmsdefaultJSONResponse
- type VerifySignInWebauthn200JSONResponse
- type VerifySignInWebauthnJSONRequestBody
- type VerifySignInWebauthnRequestObject
- type VerifySignInWebauthnResponseObject
- type VerifySignInWebauthndefaultJSONResponse
- type VerifySignUpWebauthn200JSONResponse
- type VerifySignUpWebauthnJSONRequestBody
- type VerifySignUpWebauthnRequestObject
- type VerifySignUpWebauthnResponseObject
- type VerifySignUpWebauthndefaultJSONResponse
- type VerifyTicket302Response
- type VerifyTicket302ResponseHeaders
- type VerifyTicketParams
- type VerifyTicketParamsType
- type VerifyTicketRequestObject
- type VerifyTicketResponseObject
- type VerifyTicketdefaultJSONResponse
- type VerifyToken200JSONResponse
- type VerifyTokenJSONRequestBody
- type VerifyTokenRequest
- type VerifyTokenRequestObject
- type VerifyTokenResponseObject
- type VerifyTokendefaultJSONResponse
Constants ¶
const ( BearerAuthScopes = "BearerAuth.Scopes" BearerAuthElevatedScopes = "BearerAuthElevated.Scopes" )
const IdTokenProviderFake = IdTokenProvider("fake") //nolint:revive
Variables ¶
This section is empty.
Functions ¶
func GetSwagger ¶
GetSwagger returns the Swagger specification corresponding to the generated code in this file. The external references of Swagger specification are resolved. The logic of resolving external references is tightly connected to "import-mapping" feature. Externally referenced files must be embedded in the corresponding golang packages. Urls can be supported but this task was out of the scope.
func PathToRawSpec ¶
Constructs a synthetic filesystem for resolving external references when loading openapi specifications.
func RegisterHandlers ¶
func RegisterHandlers(router gin.IRouter, si ServerInterface)
RegisterHandlers creates http.Handler with routing matching OpenAPI spec.
func RegisterHandlersWithOptions ¶
func RegisterHandlersWithOptions(router gin.IRouter, si ServerInterface, options GinServerOptions)
RegisterHandlersWithOptions creates http.Handler with additional options
Types ¶
type AddSecurityKey200JSONResponse ¶ added in v0.40.2
type AddSecurityKey200JSONResponse PublicKeyCredentialCreationOptions
func (AddSecurityKey200JSONResponse) VisitAddSecurityKeyResponse ¶ added in v0.40.2
func (response AddSecurityKey200JSONResponse) VisitAddSecurityKeyResponse(w http.ResponseWriter) error
type AddSecurityKeyRequestObject ¶ added in v0.40.2
type AddSecurityKeyRequestObject struct {
}
type AddSecurityKeyResponseObject ¶ added in v0.40.2
type AddSecurityKeyResponseObject interface {
VisitAddSecurityKeyResponse(w http.ResponseWriter) error
}
type AddSecurityKeydefaultJSONResponse ¶ added in v0.40.2
type AddSecurityKeydefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (AddSecurityKeydefaultJSONResponse) VisitAddSecurityKeyResponse ¶ added in v0.40.2
func (response AddSecurityKeydefaultJSONResponse) VisitAddSecurityKeyResponse(w http.ResponseWriter) error
type AttestationFormat ¶ added in v0.40.2
type AttestationFormat string
AttestationFormat The attestation statement format
const ( AttestationFormatAndroidKey AttestationFormat = "android-key" AttestationFormatAndroidSafetynet AttestationFormat = "android-safetynet" AttestationFormatApple AttestationFormat = "apple" AttestationFormatFidoU2f AttestationFormat = "fido-u2f" AttestationFormatNone AttestationFormat = "none" AttestationFormatPacked AttestationFormat = "packed" AttestationFormatTpm AttestationFormat = "tpm" )
Defines values for AttestationFormat.
type AuthenticationExtensions ¶ added in v0.40.2
type AuthenticationExtensions map[string]interface{}
AuthenticationExtensions Additional parameters requesting additional processing by the client and authenticator
type AuthenticationExtensionsClientOutputs ¶ added in v0.40.2
type AuthenticationExtensionsClientOutputs struct {
// Appid Application identifier extension output
Appid *bool `json:"appid,omitempty"`
// CredProps Credential properties extension output
CredProps *CredentialPropertiesOutput `json:"credProps,omitempty"`
// HmacCreateSecret HMAC secret extension output
HmacCreateSecret *bool `json:"hmacCreateSecret,omitempty"`
AdditionalProperties map[string]interface{} `json:"-"`
}
AuthenticationExtensionsClientOutputs Map of extension outputs from the client
func (AuthenticationExtensionsClientOutputs) Get ¶ added in v0.40.2
func (a AuthenticationExtensionsClientOutputs) Get(fieldName string) (value interface{}, found bool)
Getter for additional properties for AuthenticationExtensionsClientOutputs. Returns the specified element and whether it was found
func (AuthenticationExtensionsClientOutputs) MarshalJSON ¶ added in v0.40.2
func (a AuthenticationExtensionsClientOutputs) MarshalJSON() ([]byte, error)
Override default JSON handling for AuthenticationExtensionsClientOutputs to handle AdditionalProperties
func (*AuthenticationExtensionsClientOutputs) Set ¶ added in v0.40.2
func (a *AuthenticationExtensionsClientOutputs) Set(fieldName string, value interface{})
Setter for additional properties for AuthenticationExtensionsClientOutputs
func (*AuthenticationExtensionsClientOutputs) UnmarshalJSON ¶ added in v0.40.2
func (a *AuthenticationExtensionsClientOutputs) UnmarshalJSON(b []byte) error
Override default JSON handling for AuthenticationExtensionsClientOutputs to handle AdditionalProperties
type AuthenticatorAssertionResponse ¶ added in v0.40.2
type AuthenticatorAssertionResponse struct {
// AuthenticatorData Base64url encoded authenticator data
AuthenticatorData string `json:"authenticatorData"`
// ClientDataJSON Base64url encoded client data JSON
ClientDataJSON string `json:"clientDataJSON"`
// Signature Base64url encoded assertion signature
Signature string `json:"signature"`
// UserHandle Base64url encoded user handle
UserHandle *string `json:"userHandle"`
}
AuthenticatorAssertionResponse defines model for AuthenticatorAssertionResponse.
type AuthenticatorAttachment ¶ added in v0.40.2
type AuthenticatorAttachment string
AuthenticatorAttachment The authenticator attachment modality
const ( CrossPlatform AuthenticatorAttachment = "cross-platform" Platform AuthenticatorAttachment = "platform" )
Defines values for AuthenticatorAttachment.
type AuthenticatorAttestationResponse ¶ added in v0.40.2
type AuthenticatorAttestationResponse struct {
// AttestationObject Base64url-encoded binary data
AttestationObject URLEncodedBase64 `json:"attestationObject"`
// AuthenticatorData Base64url-encoded binary data
AuthenticatorData *URLEncodedBase64 `json:"authenticatorData,omitempty"`
// ClientDataJSON Base64url-encoded binary data
ClientDataJSON URLEncodedBase64 `json:"clientDataJSON"`
// PublicKey Base64url-encoded binary data
PublicKey *URLEncodedBase64 `json:"publicKey,omitempty"`
// PublicKeyAlgorithm The public key algorithm identifier
PublicKeyAlgorithm *int64 `json:"publicKeyAlgorithm,omitempty"`
// Transports The authenticator transports
Transports *[]string `json:"transports,omitempty"`
}
AuthenticatorAttestationResponse defines model for AuthenticatorAttestationResponse.
type AuthenticatorSelection ¶ added in v0.40.2
type AuthenticatorSelection struct {
// AuthenticatorAttachment The authenticator attachment modality
AuthenticatorAttachment *AuthenticatorAttachment `json:"authenticatorAttachment,omitempty"`
// RequireResidentKey Whether the authenticator must create a client-side-resident public key credential source
RequireResidentKey *bool `json:"requireResidentKey,omitempty"`
// ResidentKey The resident key requirement
ResidentKey *ResidentKeyRequirement `json:"residentKey,omitempty"`
// UserVerification A requirement for user verification for the operation
UserVerification *UserVerificationRequirement `json:"userVerification,omitempty"`
}
AuthenticatorSelection defines model for AuthenticatorSelection.
type AuthenticatorTransport ¶ added in v0.40.2
type AuthenticatorTransport string
AuthenticatorTransport The authenticator transports that can be used
const ( AuthenticatorTransportBle AuthenticatorTransport = "ble" AuthenticatorTransportHybrid AuthenticatorTransport = "hybrid" AuthenticatorTransportInternal AuthenticatorTransport = "internal" AuthenticatorTransportNfc AuthenticatorTransport = "nfc" AuthenticatorTransportSmartCard AuthenticatorTransport = "smart-card" AuthenticatorTransportUsb AuthenticatorTransport = "usb" )
Defines values for AuthenticatorTransport.
type ChangeUserEmail200JSONResponse ¶ added in v0.40.2
type ChangeUserEmail200JSONResponse OKResponse
func (ChangeUserEmail200JSONResponse) VisitChangeUserEmailResponse ¶ added in v0.40.2
func (response ChangeUserEmail200JSONResponse) VisitChangeUserEmailResponse(w http.ResponseWriter) error
type ChangeUserEmailJSONRequestBody ¶ added in v0.40.2
type ChangeUserEmailJSONRequestBody = UserEmailChangeRequest
ChangeUserEmailJSONRequestBody defines body for ChangeUserEmail for application/json ContentType.
type ChangeUserEmailRequestObject ¶ added in v0.40.2
type ChangeUserEmailRequestObject struct {
Body *ChangeUserEmailJSONRequestBody
}
type ChangeUserEmailResponseObject ¶ added in v0.40.2
type ChangeUserEmailResponseObject interface {
VisitChangeUserEmailResponse(w http.ResponseWriter) error
}
type ChangeUserEmaildefaultJSONResponse ¶ added in v0.40.2
type ChangeUserEmaildefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (ChangeUserEmaildefaultJSONResponse) VisitChangeUserEmailResponse ¶ added in v0.40.2
func (response ChangeUserEmaildefaultJSONResponse) VisitChangeUserEmailResponse(w http.ResponseWriter) error
type ChangeUserMfa200JSONResponse ¶ added in v0.40.2
type ChangeUserMfa200JSONResponse TotpGenerateResponse
func (ChangeUserMfa200JSONResponse) VisitChangeUserMfaResponse ¶ added in v0.40.2
func (response ChangeUserMfa200JSONResponse) VisitChangeUserMfaResponse(w http.ResponseWriter) error
type ChangeUserMfaRequestObject ¶ added in v0.40.2
type ChangeUserMfaRequestObject struct {
}
type ChangeUserMfaResponseObject ¶ added in v0.40.2
type ChangeUserMfaResponseObject interface {
VisitChangeUserMfaResponse(w http.ResponseWriter) error
}
type ChangeUserMfadefaultJSONResponse ¶ added in v0.40.2
type ChangeUserMfadefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (ChangeUserMfadefaultJSONResponse) VisitChangeUserMfaResponse ¶ added in v0.40.2
func (response ChangeUserMfadefaultJSONResponse) VisitChangeUserMfaResponse(w http.ResponseWriter) error
type ChangeUserPassword200JSONResponse ¶ added in v0.40.2
type ChangeUserPassword200JSONResponse OKResponse
func (ChangeUserPassword200JSONResponse) VisitChangeUserPasswordResponse ¶ added in v0.40.2
func (response ChangeUserPassword200JSONResponse) VisitChangeUserPasswordResponse(w http.ResponseWriter) error
type ChangeUserPasswordJSONRequestBody ¶ added in v0.40.2
type ChangeUserPasswordJSONRequestBody = UserPasswordRequest
ChangeUserPasswordJSONRequestBody defines body for ChangeUserPassword for application/json ContentType.
type ChangeUserPasswordRequestObject ¶ added in v0.40.2
type ChangeUserPasswordRequestObject struct {
Body *ChangeUserPasswordJSONRequestBody
}
type ChangeUserPasswordResponseObject ¶ added in v0.40.2
type ChangeUserPasswordResponseObject interface {
VisitChangeUserPasswordResponse(w http.ResponseWriter) error
}
type ChangeUserPassworddefaultJSONResponse ¶ added in v0.40.2
type ChangeUserPassworddefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (ChangeUserPassworddefaultJSONResponse) VisitChangeUserPasswordResponse ¶ added in v0.40.2
func (response ChangeUserPassworddefaultJSONResponse) VisitChangeUserPasswordResponse(w http.ResponseWriter) error
type ConveyancePreference ¶ added in v0.40.2
type ConveyancePreference string
ConveyancePreference The attestation conveyance preference
const ( ConveyancePreferenceDirect ConveyancePreference = "direct" ConveyancePreferenceEnterprise ConveyancePreference = "enterprise" ConveyancePreferenceIndirect ConveyancePreference = "indirect" ConveyancePreferenceNone ConveyancePreference = "none" )
Defines values for ConveyancePreference.
type CreatePAT200JSONResponse ¶ added in v0.40.2
type CreatePAT200JSONResponse CreatePATResponse
func (CreatePAT200JSONResponse) VisitCreatePATResponse ¶ added in v0.40.2
func (response CreatePAT200JSONResponse) VisitCreatePATResponse(w http.ResponseWriter) error
type CreatePATJSONRequestBody ¶ added in v0.40.2
type CreatePATJSONRequestBody = CreatePATRequest
CreatePATJSONRequestBody defines body for CreatePAT for application/json ContentType.
type CreatePATRequest ¶ added in v0.28.0
type CreatePATRequest struct {
// ExpiresAt Expiration date of the PAT
ExpiresAt time.Time `json:"expiresAt"`
Metadata *map[string]interface{} `json:"metadata,omitempty"`
}
CreatePATRequest defines model for CreatePATRequest.
type CreatePATRequestObject ¶ added in v0.40.2
type CreatePATRequestObject struct {
Body *CreatePATJSONRequestBody
}
type CreatePATResponse ¶ added in v0.28.0
type CreatePATResponse struct {
// Id ID of the PAT
Id string `json:"id"`
// PersonalAccessToken PAT
PersonalAccessToken string `json:"personalAccessToken"`
}
CreatePATResponse defines model for CreatePATResponse.
type CreatePATResponseObject ¶ added in v0.40.2
type CreatePATResponseObject interface {
VisitCreatePATResponse(w http.ResponseWriter) error
}
type CreatePATdefaultJSONResponse ¶ added in v0.40.2
type CreatePATdefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (CreatePATdefaultJSONResponse) VisitCreatePATResponse ¶ added in v0.40.2
func (response CreatePATdefaultJSONResponse) VisitCreatePATResponse(w http.ResponseWriter) error
type CredentialAssertionResponse ¶ added in v0.40.2
type CredentialAssertionResponse = protocol.CredentialAssertionResponse
CredentialAssertionResponse defines model for CredentialAssertionResponse.
type CredentialCreationResponse ¶ added in v0.40.2
type CredentialCreationResponse = protocol.CredentialCreationResponse
CredentialCreationResponse defines model for CredentialCreationResponse.
type CredentialParameter ¶ added in v0.40.2
type CredentialParameter struct {
// Alg The cryptographic algorithm identifier
Alg int `json:"alg"`
// Type The valid credential types
Type CredentialType `json:"type"`
}
CredentialParameter defines model for CredentialParameter.
type CredentialPropertiesOutput ¶ added in v0.40.2
type CredentialPropertiesOutput struct {
// Rk Indicates if the credential is a resident key
Rk *bool `json:"rk,omitempty"`
}
CredentialPropertiesOutput Credential properties extension output
type CredentialType ¶ added in v0.40.2
type CredentialType string
CredentialType The valid credential types
const (
PublicKey CredentialType = "public-key"
)
Defines values for CredentialType.
type DeanonymizeUser200JSONResponse ¶ added in v0.40.2
type DeanonymizeUser200JSONResponse OKResponse
func (DeanonymizeUser200JSONResponse) VisitDeanonymizeUserResponse ¶ added in v0.40.2
func (response DeanonymizeUser200JSONResponse) VisitDeanonymizeUserResponse(w http.ResponseWriter) error
type DeanonymizeUserJSONRequestBody ¶ added in v0.40.2
type DeanonymizeUserJSONRequestBody = UserDeanonymizeRequest
DeanonymizeUserJSONRequestBody defines body for DeanonymizeUser for application/json ContentType.
type DeanonymizeUserRequestObject ¶ added in v0.40.2
type DeanonymizeUserRequestObject struct {
Body *DeanonymizeUserJSONRequestBody
}
type DeanonymizeUserResponseObject ¶ added in v0.40.2
type DeanonymizeUserResponseObject interface {
VisitDeanonymizeUserResponse(w http.ResponseWriter) error
}
type DeanonymizeUserdefaultJSONResponse ¶ added in v0.40.2
type DeanonymizeUserdefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (DeanonymizeUserdefaultJSONResponse) VisitDeanonymizeUserResponse ¶ added in v0.40.2
func (response DeanonymizeUserdefaultJSONResponse) VisitDeanonymizeUserResponse(w http.ResponseWriter) error
type ElevateWebauthn200JSONResponse ¶ added in v0.40.2
type ElevateWebauthn200JSONResponse PublicKeyCredentialRequestOptions
func (ElevateWebauthn200JSONResponse) VisitElevateWebauthnResponse ¶ added in v0.40.2
func (response ElevateWebauthn200JSONResponse) VisitElevateWebauthnResponse(w http.ResponseWriter) error
type ElevateWebauthnRequestObject ¶ added in v0.40.2
type ElevateWebauthnRequestObject struct {
}
type ElevateWebauthnResponseObject ¶ added in v0.40.2
type ElevateWebauthnResponseObject interface {
VisitElevateWebauthnResponse(w http.ResponseWriter) error
}
type ElevateWebauthndefaultJSONResponse ¶ added in v0.40.2
type ElevateWebauthndefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (ElevateWebauthndefaultJSONResponse) VisitElevateWebauthnResponse ¶ added in v0.40.2
func (response ElevateWebauthndefaultJSONResponse) VisitElevateWebauthnResponse(w http.ResponseWriter) error
type ErrorResponse ¶
type ErrorResponse struct {
// Error Error code identifying the specific application error
Error ErrorResponseError `json:"error"`
// Message Human-friendly error message
Message string `json:"message"`
// Status HTTP status error code
Status int `json:"status"`
}
ErrorResponse Standardized error response
type ErrorResponseError ¶
type ErrorResponseError string
ErrorResponseError Error code identifying the specific application error
const ( CannotSendSms ErrorResponseError = "cannot-send-sms" DefaultRoleMustBeInAllowedRoles ErrorResponseError = "default-role-must-be-in-allowed-roles" DisabledEndpoint ErrorResponseError = "disabled-endpoint" DisabledMfaTotp ErrorResponseError = "disabled-mfa-totp" DisabledUser ErrorResponseError = "disabled-user" EmailAlreadyInUse ErrorResponseError = "email-already-in-use" EmailAlreadyVerified ErrorResponseError = "email-already-verified" ForbiddenAnonymous ErrorResponseError = "forbidden-anonymous" InternalServerError ErrorResponseError = "internal-server-error" InvalidEmailPassword ErrorResponseError = "invalid-email-password" InvalidOtp ErrorResponseError = "invalid-otp" InvalidPat ErrorResponseError = "invalid-pat" InvalidRefreshToken ErrorResponseError = "invalid-refresh-token" InvalidRequest ErrorResponseError = "invalid-request" InvalidState ErrorResponseError = "invalid-state" InvalidTicket ErrorResponseError = "invalid-ticket" InvalidTotp ErrorResponseError = "invalid-totp" LocaleNotAllowed ErrorResponseError = "locale-not-allowed" MfaTypeNotFound ErrorResponseError = "mfa-type-not-found" NoTotpSecret ErrorResponseError = "no-totp-secret" OauthProfileFetchFailed ErrorResponseError = "oauth-profile-fetch-failed" OauthProviderError ErrorResponseError = "oauth-provider-error" OauthTokenEchangeFailed ErrorResponseError = "oauth-token-echange-failed" PasswordInHibpDatabase ErrorResponseError = "password-in-hibp-database" PasswordTooShort ErrorResponseError = "password-too-short" RedirectToNotAllowed ErrorResponseError = "redirectTo-not-allowed" RoleNotAllowed ErrorResponseError = "role-not-allowed" SignupDisabled ErrorResponseError = "signup-disabled" TotpAlreadyActive ErrorResponseError = "totp-already-active" UnverifiedUser ErrorResponseError = "unverified-user" UserNotAnonymous ErrorResponseError = "user-not-anonymous" )
Defines values for ErrorResponseError.
type GetJWKs200JSONResponse ¶ added in v0.40.2
type GetJWKs200JSONResponse JWKSet
func (GetJWKs200JSONResponse) VisitGetJWKsResponse ¶ added in v0.40.2
func (response GetJWKs200JSONResponse) VisitGetJWKsResponse(w http.ResponseWriter) error
type GetJWKsRequestObject ¶ added in v0.40.2
type GetJWKsRequestObject struct {
}
type GetJWKsResponseObject ¶ added in v0.40.2
type GetJWKsResponseObject interface {
VisitGetJWKsResponse(w http.ResponseWriter) error
}
type GetJWKsdefaultJSONResponse ¶ added in v0.40.2
type GetJWKsdefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (GetJWKsdefaultJSONResponse) VisitGetJWKsResponse ¶ added in v0.40.2
func (response GetJWKsdefaultJSONResponse) VisitGetJWKsResponse(w http.ResponseWriter) error
type GetUser200JSONResponse ¶ added in v0.40.0
type GetUser200JSONResponse User
func (GetUser200JSONResponse) VisitGetUserResponse ¶ added in v0.40.0
func (response GetUser200JSONResponse) VisitGetUserResponse(w http.ResponseWriter) error
type GetUserRequestObject ¶ added in v0.40.0
type GetUserRequestObject struct {
}
type GetUserResponseObject ¶ added in v0.40.0
type GetUserResponseObject interface {
VisitGetUserResponse(w http.ResponseWriter) error
}
type GetUserdefaultJSONResponse ¶ added in v0.40.2
type GetUserdefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (GetUserdefaultJSONResponse) VisitGetUserResponse ¶ added in v0.40.2
func (response GetUserdefaultJSONResponse) VisitGetUserResponse(w http.ResponseWriter) error
type GetVersion200JSONResponse ¶ added in v0.28.0
type GetVersion200JSONResponse struct {
// Version The version of the authentication service
Version string `json:"version"`
}
func (GetVersion200JSONResponse) VisitGetVersionResponse ¶ added in v0.28.0
func (response GetVersion200JSONResponse) VisitGetVersionResponse(w http.ResponseWriter) error
type GetVersionRequestObject ¶ added in v0.28.0
type GetVersionRequestObject struct {
}
type GetVersionResponseObject ¶ added in v0.28.0
type GetVersionResponseObject interface {
VisitGetVersionResponse(w http.ResponseWriter) error
}
type GetVersiondefaultJSONResponse ¶ added in v0.40.2
type GetVersiondefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (GetVersiondefaultJSONResponse) VisitGetVersionResponse ¶ added in v0.40.2
func (response GetVersiondefaultJSONResponse) VisitGetVersionResponse(w http.ResponseWriter) error
type GinServerOptions ¶
type GinServerOptions struct {
BaseURL string
Middlewares []MiddlewareFunc
ErrorHandler func(*gin.Context, error, int)
}
GinServerOptions provides options for the Gin server.
type HealthCheckGet200JSONResponse ¶ added in v0.40.2
type HealthCheckGet200JSONResponse OKResponse
func (HealthCheckGet200JSONResponse) VisitHealthCheckGetResponse ¶ added in v0.40.2
func (response HealthCheckGet200JSONResponse) VisitHealthCheckGetResponse(w http.ResponseWriter) error
type HealthCheckGetRequestObject ¶ added in v0.40.2
type HealthCheckGetRequestObject struct {
}
type HealthCheckGetResponseObject ¶ added in v0.40.2
type HealthCheckGetResponseObject interface {
VisitHealthCheckGetResponse(w http.ResponseWriter) error
}
type HealthCheckGetdefaultJSONResponse ¶ added in v0.40.2
type HealthCheckGetdefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (HealthCheckGetdefaultJSONResponse) VisitHealthCheckGetResponse ¶ added in v0.40.2
func (response HealthCheckGetdefaultJSONResponse) VisitHealthCheckGetResponse(w http.ResponseWriter) error
type HealthCheckHead200Response ¶ added in v0.40.2
type HealthCheckHead200Response struct {
}
func (HealthCheckHead200Response) VisitHealthCheckHeadResponse ¶ added in v0.40.2
func (response HealthCheckHead200Response) VisitHealthCheckHeadResponse(w http.ResponseWriter) error
type HealthCheckHeadRequestObject ¶ added in v0.40.2
type HealthCheckHeadRequestObject struct {
}
type HealthCheckHeadResponseObject ¶ added in v0.40.2
type HealthCheckHeadResponseObject interface {
VisitHealthCheckHeadResponse(w http.ResponseWriter) error
}
type HealthCheckHeaddefaultJSONResponse ¶ added in v0.40.2
type HealthCheckHeaddefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (HealthCheckHeaddefaultJSONResponse) VisitHealthCheckHeadResponse ¶ added in v0.40.2
func (response HealthCheckHeaddefaultJSONResponse) VisitHealthCheckHeadResponse(w http.ResponseWriter) error
type IdTokenProvider ¶ added in v0.39.0
type IdTokenProvider string
IdTokenProvider defines model for IdTokenProvider.
const ( IdTokenProviderApple IdTokenProvider = "apple" IdTokenProviderGoogle IdTokenProvider = "google" )
Defines values for IdTokenProvider.
type JWK ¶ added in v0.35.0
type JWK struct {
// Alg Algorithm used with this key
Alg string `json:"alg"`
// E RSA public exponent
E string `json:"e"`
// Kid Key ID
Kid string `json:"kid"`
// Kty Key type
Kty string `json:"kty"`
// N RSA modulus
N string `json:"n"`
// Use Key usage
Use string `json:"use"`
}
JWK JSON Web Key for JWT verification
type JWKSet ¶ added in v0.35.0
type JWKSet struct {
// Keys Array of public keys
Keys []JWK `json:"keys"`
}
JWKSet JSON Web Key Set for verifying JWT signatures
type LinkIdToken200JSONResponse ¶ added in v0.40.2
type LinkIdToken200JSONResponse OKResponse
func (LinkIdToken200JSONResponse) VisitLinkIdTokenResponse ¶ added in v0.40.2
func (response LinkIdToken200JSONResponse) VisitLinkIdTokenResponse(w http.ResponseWriter) error
type LinkIdTokenJSONRequestBody ¶ added in v0.40.2
type LinkIdTokenJSONRequestBody = LinkIdTokenRequest
LinkIdTokenJSONRequestBody defines body for LinkIdToken for application/json ContentType.
type LinkIdTokenRequest ¶ added in v0.35.0
type LinkIdTokenRequest struct {
// IdToken Apple ID token
IdToken string `json:"idToken"`
// Nonce Nonce used during sign in process
Nonce *string `json:"nonce,omitempty"`
Provider IdTokenProvider `json:"provider"`
}
LinkIdTokenRequest defines model for LinkIdTokenRequest.
type LinkIdTokenRequestObject ¶ added in v0.40.2
type LinkIdTokenRequestObject struct {
Body *LinkIdTokenJSONRequestBody
}
type LinkIdTokenResponseObject ¶ added in v0.40.2
type LinkIdTokenResponseObject interface {
VisitLinkIdTokenResponse(w http.ResponseWriter) error
}
type LinkIdTokendefaultJSONResponse ¶ added in v0.40.2
type LinkIdTokendefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (LinkIdTokendefaultJSONResponse) VisitLinkIdTokenResponse ¶ added in v0.40.2
func (response LinkIdTokendefaultJSONResponse) VisitLinkIdTokenResponse(w http.ResponseWriter) error
type MFAChallengePayload ¶ added in v0.28.0
type MFAChallengePayload struct {
// Ticket Ticket to use when completing the MFA challenge
Ticket string `json:"ticket"`
}
MFAChallengePayload Challenge payload for multi-factor authentication
type MiddlewareFunc ¶
type OKResponse ¶ added in v0.28.0
type OKResponse string
OKResponse defines model for OKResponse.
const (
OK OKResponse = "OK"
)
Defines values for OKResponse.
type OptionsRedirectTo ¶ added in v0.28.0
type OptionsRedirectTo struct {
RedirectTo *string `json:"redirectTo,omitempty"`
}
OptionsRedirectTo defines model for OptionsRedirectTo.
type PublicKeyCredentialCreationOptions ¶ added in v0.40.2
type PublicKeyCredentialCreationOptions = protocol.PublicKeyCredentialCreationOptions
PublicKeyCredentialCreationOptions defines model for PublicKeyCredentialCreationOptions.
type PublicKeyCredentialDescriptor ¶ added in v0.40.2
type PublicKeyCredentialDescriptor struct {
// Id Base64url-encoded binary data
Id URLEncodedBase64 `json:"id"`
// Transports The authenticator transports that can be used
Transports *[]AuthenticatorTransport `json:"transports,omitempty"`
// Type The valid credential types
Type CredentialType `json:"type"`
}
PublicKeyCredentialDescriptor defines model for PublicKeyCredentialDescriptor.
type PublicKeyCredentialHints ¶ added in v0.40.2
type PublicKeyCredentialHints string
PublicKeyCredentialHints Hints to help guide the user through the experience
const ( PublicKeyCredentialHintsClientDevice PublicKeyCredentialHints = "client-device" PublicKeyCredentialHintsHybrid PublicKeyCredentialHints = "hybrid" PublicKeyCredentialHintsSecurityKey PublicKeyCredentialHints = "security-key" )
Defines values for PublicKeyCredentialHints.
type PublicKeyCredentialRequestOptions ¶ added in v0.40.2
type PublicKeyCredentialRequestOptions = protocol.PublicKeyCredentialRequestOptions
PublicKeyCredentialRequestOptions defines model for PublicKeyCredentialRequestOptions.
type RedirectToQuery ¶ added in v0.35.0
type RedirectToQuery = string
RedirectToQuery Target URL for the redirect
type RefreshToken200JSONResponse ¶ added in v0.40.2
type RefreshToken200JSONResponse Session
func (RefreshToken200JSONResponse) VisitRefreshTokenResponse ¶ added in v0.40.2
func (response RefreshToken200JSONResponse) VisitRefreshTokenResponse(w http.ResponseWriter) error
type RefreshTokenJSONRequestBody ¶ added in v0.40.2
type RefreshTokenJSONRequestBody = RefreshTokenRequest
RefreshTokenJSONRequestBody defines body for RefreshToken for application/json ContentType.
type RefreshTokenRequest ¶ added in v0.29.0
type RefreshTokenRequest struct {
// RefreshToken Refresh token used to generate a new access token
RefreshToken string `json:"refreshToken"`
}
RefreshTokenRequest Request to refresh an access token
type RefreshTokenRequestObject ¶ added in v0.40.2
type RefreshTokenRequestObject struct {
Body *RefreshTokenJSONRequestBody
}
type RefreshTokenResponseObject ¶ added in v0.40.2
type RefreshTokenResponseObject interface {
VisitRefreshTokenResponse(w http.ResponseWriter) error
}
type RefreshTokendefaultJSONResponse ¶ added in v0.40.2
type RefreshTokendefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (RefreshTokendefaultJSONResponse) VisitRefreshTokenResponse ¶ added in v0.40.2
func (response RefreshTokendefaultJSONResponse) VisitRefreshTokenResponse(w http.ResponseWriter) error
type RelyingPartyEntity ¶ added in v0.40.2
type RelyingPartyEntity struct {
// Id A unique identifier for the Relying Party entity, which sets the RP ID
Id string `json:"id"`
// Name A human-palatable name for the entity
Name string `json:"name"`
}
RelyingPartyEntity defines model for RelyingPartyEntity.
type ResidentKeyRequirement ¶ added in v0.40.2
type ResidentKeyRequirement string
ResidentKeyRequirement The resident key requirement
const ( ResidentKeyRequirementDiscouraged ResidentKeyRequirement = "discouraged" ResidentKeyRequirementPreferred ResidentKeyRequirement = "preferred" ResidentKeyRequirementRequired ResidentKeyRequirement = "required" )
Defines values for ResidentKeyRequirement.
type SendPasswordResetEmail200JSONResponse ¶ added in v0.40.2
type SendPasswordResetEmail200JSONResponse OKResponse
func (SendPasswordResetEmail200JSONResponse) VisitSendPasswordResetEmailResponse ¶ added in v0.40.2
func (response SendPasswordResetEmail200JSONResponse) VisitSendPasswordResetEmailResponse(w http.ResponseWriter) error
type SendPasswordResetEmailJSONRequestBody ¶ added in v0.40.2
type SendPasswordResetEmailJSONRequestBody = UserPasswordResetRequest
SendPasswordResetEmailJSONRequestBody defines body for SendPasswordResetEmail for application/json ContentType.
type SendPasswordResetEmailRequestObject ¶ added in v0.40.2
type SendPasswordResetEmailRequestObject struct {
Body *SendPasswordResetEmailJSONRequestBody
}
type SendPasswordResetEmailResponseObject ¶ added in v0.40.2
type SendPasswordResetEmailResponseObject interface {
VisitSendPasswordResetEmailResponse(w http.ResponseWriter) error
}
type SendPasswordResetEmaildefaultJSONResponse ¶ added in v0.40.2
type SendPasswordResetEmaildefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (SendPasswordResetEmaildefaultJSONResponse) VisitSendPasswordResetEmailResponse ¶ added in v0.40.2
func (response SendPasswordResetEmaildefaultJSONResponse) VisitSendPasswordResetEmailResponse(w http.ResponseWriter) error
type SendVerificationEmail200JSONResponse ¶ added in v0.40.2
type SendVerificationEmail200JSONResponse OKResponse
func (SendVerificationEmail200JSONResponse) VisitSendVerificationEmailResponse ¶ added in v0.40.2
func (response SendVerificationEmail200JSONResponse) VisitSendVerificationEmailResponse(w http.ResponseWriter) error
type SendVerificationEmailJSONRequestBody ¶ added in v0.40.2
type SendVerificationEmailJSONRequestBody = UserEmailSendVerificationEmailRequest
SendVerificationEmailJSONRequestBody defines body for SendVerificationEmail for application/json ContentType.
type SendVerificationEmailRequestObject ¶ added in v0.40.2
type SendVerificationEmailRequestObject struct {
Body *SendVerificationEmailJSONRequestBody
}
type SendVerificationEmailResponseObject ¶ added in v0.40.2
type SendVerificationEmailResponseObject interface {
VisitSendVerificationEmailResponse(w http.ResponseWriter) error
}
type SendVerificationEmaildefaultJSONResponse ¶ added in v0.40.2
type SendVerificationEmaildefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (SendVerificationEmaildefaultJSONResponse) VisitSendVerificationEmailResponse ¶ added in v0.40.2
func (response SendVerificationEmaildefaultJSONResponse) VisitSendVerificationEmailResponse(w http.ResponseWriter) error
type ServerInterface ¶
type ServerInterface interface {
// Get public keys for JWT verification in JWK Set format
// (GET /.well-known/jwks.json)
GetJWKs(c *gin.Context)
// Elevate access for an already signed in user using FIDO2 Webauthn
// (POST /elevate/webauthn)
ElevateWebauthn(c *gin.Context)
// Verify FIDO2 Webauthn authentication using public-key cryptography for elevation
// (POST /elevate/webauthn/verify)
VerifyElevateWebauthn(c *gin.Context)
// Health check (GET)
// (GET /healthz)
HealthCheckGet(c *gin.Context)
// Health check (HEAD)
// (HEAD /healthz)
HealthCheckHead(c *gin.Context)
// Link a user account with the provider's account using an id token
// (POST /link/idtoken)
LinkIdToken(c *gin.Context)
// Generate TOTP secret
// (GET /mfa/totp/generate)
ChangeUserMfa(c *gin.Context)
// Create a Personal Access Token (PAT)
// (POST /pat)
CreatePAT(c *gin.Context)
// Sign in anonymously
// (POST /signin/anonymous)
SignInAnonymous(c *gin.Context)
// Sign in with email and password
// (POST /signin/email-password)
SignInEmailPassword(c *gin.Context)
// Sign in with an ID token
// (POST /signin/idtoken)
SignInIdToken(c *gin.Context)
// Verify TOTP for MFA
// (POST /signin/mfa/totp)
VerifySignInMfaTotp(c *gin.Context)
// Sign in with email OTP
// (POST /signin/otp/email)
SignInOTPEmail(c *gin.Context)
// Verify email OTP
// (POST /signin/otp/email/verify)
VerifySignInOTPEmail(c *gin.Context)
// Sign in with magic link email
// (POST /signin/passwordless/email)
SignInPasswordlessEmail(c *gin.Context)
// Sign in with SMS OTP
// (POST /signin/passwordless/sms)
SignInPasswordlessSms(c *gin.Context)
// Verify SMS OTP
// (POST /signin/passwordless/sms/otp)
VerifySignInPasswordlessSms(c *gin.Context)
// Sign in with Personal Access Token (PAT)
// (POST /signin/pat)
SignInPAT(c *gin.Context)
// Sign in with an OAuth2 provider
// (GET /signin/provider/{provider})
SignInProvider(c *gin.Context, provider SignInProviderParamsProvider, params SignInProviderParams)
// OAuth2 provider callback endpoint
// (GET /signin/provider/{provider}/callback)
SignInProviderCallbackGet(c *gin.Context, provider SignInProviderCallbackGetParamsProvider, params SignInProviderCallbackGetParams)
// OAuth2 provider callback endpoint (form_post)
// (POST /signin/provider/{provider}/callback)
SignInProviderCallbackPost(c *gin.Context, provider SignInProviderCallbackPostParamsProvider)
// Sign in with Webauthn
// (POST /signin/webauthn)
SignInWebauthn(c *gin.Context)
// Verify Webauthn sign-in
// (POST /signin/webauthn/verify)
VerifySignInWebauthn(c *gin.Context)
// Sign out
// (POST /signout)
SignOut(c *gin.Context)
// Sign up with email and password
// (POST /signup/email-password)
SignUpEmailPassword(c *gin.Context)
// Sign up with Webauthn
// (POST /signup/webauthn)
SignUpWebauthn(c *gin.Context)
// Verify Webauthn sign-up
// (POST /signup/webauthn/verify)
VerifySignUpWebauthn(c *gin.Context)
// Refresh access token
// (POST /token)
RefreshToken(c *gin.Context)
// Verify JWT token
// (POST /token/verify)
VerifyToken(c *gin.Context)
// Get user information
// (GET /user)
GetUser(c *gin.Context)
// Deanonymize an anonymous user
// (POST /user/deanonymize)
DeanonymizeUser(c *gin.Context)
// Change user email
// (POST /user/email/change)
ChangeUserEmail(c *gin.Context)
// Send verification email
// (POST /user/email/send-verification-email)
SendVerificationEmail(c *gin.Context)
// Manage multi-factor authentication
// (POST /user/mfa)
VerifyChangeUserMfa(c *gin.Context)
// Change user password
// (POST /user/password)
ChangeUserPassword(c *gin.Context)
// Request password reset
// (POST /user/password/reset)
SendPasswordResetEmail(c *gin.Context)
// Initialize adding of a new webauthn security key
// (POST /user/webauthn/add)
AddSecurityKey(c *gin.Context)
// Verify adding of a new webauthn security key
// (POST /user/webauthn/verify)
VerifyAddSecurityKey(c *gin.Context)
// Verify email and authentication tickets
// (GET /verify)
VerifyTicket(c *gin.Context, params VerifyTicketParams)
// Get service version
// (GET /version)
GetVersion(c *gin.Context)
}
ServerInterface represents all server handlers.
func NewStrictHandler ¶
func NewStrictHandler(ssi StrictServerInterface, middlewares []StrictMiddlewareFunc) ServerInterface
type ServerInterfaceWrapper ¶
type ServerInterfaceWrapper struct {
Handler ServerInterface
HandlerMiddlewares []MiddlewareFunc
ErrorHandler func(*gin.Context, error, int)
}
ServerInterfaceWrapper converts contexts to parameters.
func (*ServerInterfaceWrapper) AddSecurityKey ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) AddSecurityKey(c *gin.Context)
AddSecurityKey operation middleware
func (*ServerInterfaceWrapper) ChangeUserEmail ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) ChangeUserEmail(c *gin.Context)
ChangeUserEmail operation middleware
func (*ServerInterfaceWrapper) ChangeUserMfa ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) ChangeUserMfa(c *gin.Context)
ChangeUserMfa operation middleware
func (*ServerInterfaceWrapper) ChangeUserPassword ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) ChangeUserPassword(c *gin.Context)
ChangeUserPassword operation middleware
func (*ServerInterfaceWrapper) CreatePAT ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) CreatePAT(c *gin.Context)
CreatePAT operation middleware
func (*ServerInterfaceWrapper) DeanonymizeUser ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) DeanonymizeUser(c *gin.Context)
DeanonymizeUser operation middleware
func (*ServerInterfaceWrapper) ElevateWebauthn ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) ElevateWebauthn(c *gin.Context)
ElevateWebauthn operation middleware
func (*ServerInterfaceWrapper) GetJWKs ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) GetJWKs(c *gin.Context)
GetJWKs operation middleware
func (*ServerInterfaceWrapper) GetUser ¶ added in v0.40.0
func (siw *ServerInterfaceWrapper) GetUser(c *gin.Context)
GetUser operation middleware
func (*ServerInterfaceWrapper) GetVersion ¶ added in v0.28.0
func (siw *ServerInterfaceWrapper) GetVersion(c *gin.Context)
GetVersion operation middleware
func (*ServerInterfaceWrapper) HealthCheckGet ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) HealthCheckGet(c *gin.Context)
HealthCheckGet operation middleware
func (*ServerInterfaceWrapper) HealthCheckHead ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) HealthCheckHead(c *gin.Context)
HealthCheckHead operation middleware
func (*ServerInterfaceWrapper) LinkIdToken ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) LinkIdToken(c *gin.Context)
LinkIdToken operation middleware
func (*ServerInterfaceWrapper) RefreshToken ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) RefreshToken(c *gin.Context)
RefreshToken operation middleware
func (*ServerInterfaceWrapper) SendPasswordResetEmail ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) SendPasswordResetEmail(c *gin.Context)
SendPasswordResetEmail operation middleware
func (*ServerInterfaceWrapper) SendVerificationEmail ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) SendVerificationEmail(c *gin.Context)
SendVerificationEmail operation middleware
func (*ServerInterfaceWrapper) SignInAnonymous ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) SignInAnonymous(c *gin.Context)
SignInAnonymous operation middleware
func (*ServerInterfaceWrapper) SignInEmailPassword ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) SignInEmailPassword(c *gin.Context)
SignInEmailPassword operation middleware
func (*ServerInterfaceWrapper) SignInIdToken ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) SignInIdToken(c *gin.Context)
SignInIdToken operation middleware
func (*ServerInterfaceWrapper) SignInOTPEmail ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) SignInOTPEmail(c *gin.Context)
SignInOTPEmail operation middleware
func (*ServerInterfaceWrapper) SignInPAT ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) SignInPAT(c *gin.Context)
SignInPAT operation middleware
func (*ServerInterfaceWrapper) SignInPasswordlessEmail ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) SignInPasswordlessEmail(c *gin.Context)
SignInPasswordlessEmail operation middleware
func (*ServerInterfaceWrapper) SignInPasswordlessSms ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) SignInPasswordlessSms(c *gin.Context)
SignInPasswordlessSms operation middleware
func (*ServerInterfaceWrapper) SignInProvider ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) SignInProvider(c *gin.Context)
SignInProvider operation middleware
func (*ServerInterfaceWrapper) SignInProviderCallbackGet ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) SignInProviderCallbackGet(c *gin.Context)
SignInProviderCallbackGet operation middleware
func (*ServerInterfaceWrapper) SignInProviderCallbackPost ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) SignInProviderCallbackPost(c *gin.Context)
SignInProviderCallbackPost operation middleware
func (*ServerInterfaceWrapper) SignInWebauthn ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) SignInWebauthn(c *gin.Context)
SignInWebauthn operation middleware
func (*ServerInterfaceWrapper) SignOut ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) SignOut(c *gin.Context)
SignOut operation middleware
func (*ServerInterfaceWrapper) SignUpEmailPassword ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) SignUpEmailPassword(c *gin.Context)
SignUpEmailPassword operation middleware
func (*ServerInterfaceWrapper) SignUpWebauthn ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) SignUpWebauthn(c *gin.Context)
SignUpWebauthn operation middleware
func (*ServerInterfaceWrapper) VerifyAddSecurityKey ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) VerifyAddSecurityKey(c *gin.Context)
VerifyAddSecurityKey operation middleware
func (*ServerInterfaceWrapper) VerifyChangeUserMfa ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) VerifyChangeUserMfa(c *gin.Context)
VerifyChangeUserMfa operation middleware
func (*ServerInterfaceWrapper) VerifyElevateWebauthn ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) VerifyElevateWebauthn(c *gin.Context)
VerifyElevateWebauthn operation middleware
func (*ServerInterfaceWrapper) VerifySignInMfaTotp ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) VerifySignInMfaTotp(c *gin.Context)
VerifySignInMfaTotp operation middleware
func (*ServerInterfaceWrapper) VerifySignInOTPEmail ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) VerifySignInOTPEmail(c *gin.Context)
VerifySignInOTPEmail operation middleware
func (*ServerInterfaceWrapper) VerifySignInPasswordlessSms ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) VerifySignInPasswordlessSms(c *gin.Context)
VerifySignInPasswordlessSms operation middleware
func (*ServerInterfaceWrapper) VerifySignInWebauthn ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) VerifySignInWebauthn(c *gin.Context)
VerifySignInWebauthn operation middleware
func (*ServerInterfaceWrapper) VerifySignUpWebauthn ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) VerifySignUpWebauthn(c *gin.Context)
VerifySignUpWebauthn operation middleware
func (*ServerInterfaceWrapper) VerifyTicket ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) VerifyTicket(c *gin.Context)
VerifyTicket operation middleware
func (*ServerInterfaceWrapper) VerifyToken ¶ added in v0.40.2
func (siw *ServerInterfaceWrapper) VerifyToken(c *gin.Context)
VerifyToken operation middleware
type Session ¶
type Session struct {
// AccessToken JWT token for authenticating API requests
AccessToken string `json:"accessToken"`
// AccessTokenExpiresIn Expiration time of the access token in seconds
AccessTokenExpiresIn int64 `json:"accessTokenExpiresIn"`
// RefreshToken Token used to refresh the access token
RefreshToken string `json:"refreshToken"`
// RefreshTokenId Identifier for the refresh token
RefreshTokenId string `json:"refreshTokenId"`
// User User profile and account information
User *User `json:"user,omitempty"`
}
Session User authentication session containing tokens and user information
type SessionPayload ¶
type SessionPayload struct {
// Session User authentication session containing tokens and user information
Session *Session `json:"session,omitempty"`
}
SessionPayload Container for session information
type SignInAnonymous200JSONResponse ¶ added in v0.40.2
type SignInAnonymous200JSONResponse SessionPayload
func (SignInAnonymous200JSONResponse) VisitSignInAnonymousResponse ¶ added in v0.40.2
func (response SignInAnonymous200JSONResponse) VisitSignInAnonymousResponse(w http.ResponseWriter) error
type SignInAnonymousJSONRequestBody ¶ added in v0.40.2
type SignInAnonymousJSONRequestBody = SignInAnonymousRequest
SignInAnonymousJSONRequestBody defines body for SignInAnonymous for application/json ContentType.
type SignInAnonymousRequest ¶ added in v0.40.2
type SignInAnonymousRequest struct {
DisplayName *string `json:"displayName,omitempty"`
// Locale A two-characters locale
Locale *string `json:"locale,omitempty"`
Metadata *map[string]interface{} `json:"metadata,omitempty"`
}
SignInAnonymousRequest defines model for SignInAnonymousRequest.
type SignInAnonymousRequestObject ¶ added in v0.40.2
type SignInAnonymousRequestObject struct {
Body *SignInAnonymousJSONRequestBody
}
type SignInAnonymousResponseObject ¶ added in v0.40.2
type SignInAnonymousResponseObject interface {
VisitSignInAnonymousResponse(w http.ResponseWriter) error
}
type SignInAnonymousdefaultJSONResponse ¶ added in v0.40.2
type SignInAnonymousdefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (SignInAnonymousdefaultJSONResponse) VisitSignInAnonymousResponse ¶ added in v0.40.2
func (response SignInAnonymousdefaultJSONResponse) VisitSignInAnonymousResponse(w http.ResponseWriter) error
type SignInEmailPassword200JSONResponse ¶ added in v0.40.2
type SignInEmailPassword200JSONResponse SignInEmailPasswordResponse
func (SignInEmailPassword200JSONResponse) VisitSignInEmailPasswordResponse ¶ added in v0.40.2
func (response SignInEmailPassword200JSONResponse) VisitSignInEmailPasswordResponse(w http.ResponseWriter) error
type SignInEmailPasswordJSONRequestBody ¶ added in v0.40.2
type SignInEmailPasswordJSONRequestBody = SignInEmailPasswordRequest
SignInEmailPasswordJSONRequestBody defines body for SignInEmailPassword for application/json ContentType.
type SignInEmailPasswordRequest ¶ added in v0.28.0
type SignInEmailPasswordRequest struct {
// Email User's email address
Email openapi_types.Email `json:"email"`
// Password User's password
Password string `json:"password"`
}
SignInEmailPasswordRequest Request to authenticate using email and password
type SignInEmailPasswordRequestObject ¶ added in v0.40.2
type SignInEmailPasswordRequestObject struct {
Body *SignInEmailPasswordJSONRequestBody
}
type SignInEmailPasswordResponse ¶ added in v0.28.0
type SignInEmailPasswordResponse struct {
// Mfa Challenge payload for multi-factor authentication
Mfa *MFAChallengePayload `json:"mfa,omitempty"`
// Session User authentication session containing tokens and user information
Session *Session `json:"session,omitempty"`
}
SignInEmailPasswordResponse Response for email-password authentication that may include a session or MFA challenge
type SignInEmailPasswordResponseObject ¶ added in v0.40.2
type SignInEmailPasswordResponseObject interface {
VisitSignInEmailPasswordResponse(w http.ResponseWriter) error
}
type SignInEmailPassworddefaultJSONResponse ¶ added in v0.40.2
type SignInEmailPassworddefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (SignInEmailPassworddefaultJSONResponse) VisitSignInEmailPasswordResponse ¶ added in v0.40.2
func (response SignInEmailPassworddefaultJSONResponse) VisitSignInEmailPasswordResponse(w http.ResponseWriter) error
type SignInIdToken200JSONResponse ¶ added in v0.40.2
type SignInIdToken200JSONResponse SessionPayload
func (SignInIdToken200JSONResponse) VisitSignInIdTokenResponse ¶ added in v0.40.2
func (response SignInIdToken200JSONResponse) VisitSignInIdTokenResponse(w http.ResponseWriter) error
type SignInIdTokenJSONRequestBody ¶ added in v0.40.2
type SignInIdTokenJSONRequestBody = SignInIdTokenRequest
SignInIdTokenJSONRequestBody defines body for SignInIdToken for application/json ContentType.
type SignInIdTokenRequest ¶ added in v0.35.0
type SignInIdTokenRequest struct {
// IdToken Apple ID token
IdToken string `json:"idToken"`
// Nonce Nonce used during sign in process
Nonce *string `json:"nonce,omitempty"`
Options *SignUpOptions `json:"options,omitempty"`
Provider IdTokenProvider `json:"provider"`
}
SignInIdTokenRequest defines model for SignInIdTokenRequest.
type SignInIdTokenRequestObject ¶ added in v0.40.2
type SignInIdTokenRequestObject struct {
Body *SignInIdTokenJSONRequestBody
}
type SignInIdTokenResponseObject ¶ added in v0.40.2
type SignInIdTokenResponseObject interface {
VisitSignInIdTokenResponse(w http.ResponseWriter) error
}
type SignInIdTokendefaultJSONResponse ¶ added in v0.40.2
type SignInIdTokendefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (SignInIdTokendefaultJSONResponse) VisitSignInIdTokenResponse ¶ added in v0.40.2
func (response SignInIdTokendefaultJSONResponse) VisitSignInIdTokenResponse(w http.ResponseWriter) error
type SignInMfaTotpRequest ¶ added in v0.38.1
type SignInMfaTotpRequest struct {
// Otp One time password
Otp string `json:"otp"`
// Ticket Ticket
Ticket string `json:"ticket"`
}
SignInMfaTotpRequest defines model for SignInMfaTotpRequest.
type SignInOTPEmail200JSONResponse ¶ added in v0.40.2
type SignInOTPEmail200JSONResponse OKResponse
func (SignInOTPEmail200JSONResponse) VisitSignInOTPEmailResponse ¶ added in v0.40.2
func (response SignInOTPEmail200JSONResponse) VisitSignInOTPEmailResponse(w http.ResponseWriter) error
type SignInOTPEmailJSONRequestBody ¶ added in v0.40.2
type SignInOTPEmailJSONRequestBody = SignInOTPEmailRequest
SignInOTPEmailJSONRequestBody defines body for SignInOTPEmail for application/json ContentType.
type SignInOTPEmailRequest ¶ added in v0.35.0
type SignInOTPEmailRequest struct {
// Email A valid email
Email openapi_types.Email `json:"email"`
Options *SignUpOptions `json:"options,omitempty"`
}
SignInOTPEmailRequest defines model for SignInOTPEmailRequest.
type SignInOTPEmailRequestObject ¶ added in v0.40.2
type SignInOTPEmailRequestObject struct {
Body *SignInOTPEmailJSONRequestBody
}
type SignInOTPEmailResponseObject ¶ added in v0.40.2
type SignInOTPEmailResponseObject interface {
VisitSignInOTPEmailResponse(w http.ResponseWriter) error
}
type SignInOTPEmailVerifyRequest ¶ added in v0.35.0
type SignInOTPEmailVerifyRequest struct {
// Email A valid email
Email openapi_types.Email `json:"email"`
// Otp One time password
Otp string `json:"otp"`
}
SignInOTPEmailVerifyRequest defines model for SignInOTPEmailVerifyRequest.
type SignInOTPEmailVerifyResponse ¶ added in v0.35.0
type SignInOTPEmailVerifyResponse struct {
// Session User authentication session containing tokens and user information
Session *Session `json:"session,omitempty"`
}
SignInOTPEmailVerifyResponse defines model for SignInOTPEmailVerifyResponse.
type SignInOTPEmaildefaultJSONResponse ¶ added in v0.40.2
type SignInOTPEmaildefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (SignInOTPEmaildefaultJSONResponse) VisitSignInOTPEmailResponse ¶ added in v0.40.2
func (response SignInOTPEmaildefaultJSONResponse) VisitSignInOTPEmailResponse(w http.ResponseWriter) error
type SignInPAT200JSONResponse ¶ added in v0.40.2
type SignInPAT200JSONResponse SessionPayload
func (SignInPAT200JSONResponse) VisitSignInPATResponse ¶ added in v0.40.2
func (response SignInPAT200JSONResponse) VisitSignInPATResponse(w http.ResponseWriter) error
type SignInPATJSONRequestBody ¶ added in v0.40.2
type SignInPATJSONRequestBody = SignInPATRequest
SignInPATJSONRequestBody defines body for SignInPAT for application/json ContentType.
type SignInPATRequest ¶ added in v0.28.0
type SignInPATRequest struct {
// PersonalAccessToken PAT
PersonalAccessToken string `json:"personalAccessToken"`
}
SignInPATRequest defines model for SignInPATRequest.
type SignInPATRequestObject ¶ added in v0.40.2
type SignInPATRequestObject struct {
Body *SignInPATJSONRequestBody
}
type SignInPATResponseObject ¶ added in v0.40.2
type SignInPATResponseObject interface {
VisitSignInPATResponse(w http.ResponseWriter) error
}
type SignInPATdefaultJSONResponse ¶ added in v0.40.2
type SignInPATdefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (SignInPATdefaultJSONResponse) VisitSignInPATResponse ¶ added in v0.40.2
func (response SignInPATdefaultJSONResponse) VisitSignInPATResponse(w http.ResponseWriter) error
type SignInPasswordlessEmail200JSONResponse ¶ added in v0.40.2
type SignInPasswordlessEmail200JSONResponse OKResponse
func (SignInPasswordlessEmail200JSONResponse) VisitSignInPasswordlessEmailResponse ¶ added in v0.40.2
func (response SignInPasswordlessEmail200JSONResponse) VisitSignInPasswordlessEmailResponse(w http.ResponseWriter) error
type SignInPasswordlessEmailJSONRequestBody ¶ added in v0.40.2
type SignInPasswordlessEmailJSONRequestBody = SignInPasswordlessEmailRequest
SignInPasswordlessEmailJSONRequestBody defines body for SignInPasswordlessEmail for application/json ContentType.
type SignInPasswordlessEmailRequest ¶ added in v0.28.0
type SignInPasswordlessEmailRequest struct {
// Email A valid email
Email openapi_types.Email `json:"email"`
Options *SignUpOptions `json:"options,omitempty"`
}
SignInPasswordlessEmailRequest defines model for SignInPasswordlessEmailRequest.
type SignInPasswordlessEmailRequestObject ¶ added in v0.40.2
type SignInPasswordlessEmailRequestObject struct {
Body *SignInPasswordlessEmailJSONRequestBody
}
type SignInPasswordlessEmailResponseObject ¶ added in v0.40.2
type SignInPasswordlessEmailResponseObject interface {
VisitSignInPasswordlessEmailResponse(w http.ResponseWriter) error
}
type SignInPasswordlessEmaildefaultJSONResponse ¶ added in v0.40.2
type SignInPasswordlessEmaildefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (SignInPasswordlessEmaildefaultJSONResponse) VisitSignInPasswordlessEmailResponse ¶ added in v0.40.2
func (response SignInPasswordlessEmaildefaultJSONResponse) VisitSignInPasswordlessEmailResponse(w http.ResponseWriter) error
type SignInPasswordlessSms200JSONResponse ¶ added in v0.40.2
type SignInPasswordlessSms200JSONResponse OKResponse
func (SignInPasswordlessSms200JSONResponse) VisitSignInPasswordlessSmsResponse ¶ added in v0.40.2
func (response SignInPasswordlessSms200JSONResponse) VisitSignInPasswordlessSmsResponse(w http.ResponseWriter) error
type SignInPasswordlessSmsJSONRequestBody ¶ added in v0.40.2
type SignInPasswordlessSmsJSONRequestBody = SignInPasswordlessSmsRequest
SignInPasswordlessSmsJSONRequestBody defines body for SignInPasswordlessSms for application/json ContentType.
type SignInPasswordlessSmsOtpRequest ¶ added in v0.39.1
type SignInPasswordlessSmsOtpRequest struct {
// Otp One-time password received by SMS
Otp string `json:"otp"`
// PhoneNumber Phone number of the user
PhoneNumber string `json:"phoneNumber"`
}
SignInPasswordlessSmsOtpRequest defines model for SignInPasswordlessSmsOtpRequest.
type SignInPasswordlessSmsOtpResponse ¶ added in v0.39.1
type SignInPasswordlessSmsOtpResponse struct {
// Mfa Challenge payload for multi-factor authentication
Mfa *MFAChallengePayload `json:"mfa,omitempty"`
// Session User authentication session containing tokens and user information
Session *Session `json:"session,omitempty"`
}
SignInPasswordlessSmsOtpResponse defines model for SignInPasswordlessSmsOtpResponse.
type SignInPasswordlessSmsRequest ¶ added in v0.39.1
type SignInPasswordlessSmsRequest struct {
Options *SignUpOptions `json:"options,omitempty"`
// PhoneNumber Phone number of the user
PhoneNumber string `json:"phoneNumber"`
}
SignInPasswordlessSmsRequest defines model for SignInPasswordlessSmsRequest.
type SignInPasswordlessSmsRequestObject ¶ added in v0.40.2
type SignInPasswordlessSmsRequestObject struct {
Body *SignInPasswordlessSmsJSONRequestBody
}
type SignInPasswordlessSmsResponseObject ¶ added in v0.40.2
type SignInPasswordlessSmsResponseObject interface {
VisitSignInPasswordlessSmsResponse(w http.ResponseWriter) error
}
type SignInPasswordlessSmsdefaultJSONResponse ¶ added in v0.40.2
type SignInPasswordlessSmsdefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (SignInPasswordlessSmsdefaultJSONResponse) VisitSignInPasswordlessSmsResponse ¶ added in v0.40.2
func (response SignInPasswordlessSmsdefaultJSONResponse) VisitSignInPasswordlessSmsResponse(w http.ResponseWriter) error
type SignInProvider ¶ added in v0.40.2
type SignInProvider string
SignInProvider defines model for SignInProvider.
const ( SignInProviderApple SignInProvider = "apple" SignInProviderAzuread SignInProvider = "azuread" SignInProviderBitbucket SignInProvider = "bitbucket" SignInProviderDiscord SignInProvider = "discord" SignInProviderEntraid SignInProvider = "entraid" SignInProviderFacebook SignInProvider = "facebook" SignInProviderGithub SignInProvider = "github" SignInProviderGitlab SignInProvider = "gitlab" SignInProviderGoogle SignInProvider = "google" SignInProviderLinkedin SignInProvider = "linkedin" SignInProviderSpotify SignInProvider = "spotify" SignInProviderStrava SignInProvider = "strava" SignInProviderTwitch SignInProvider = "twitch" SignInProviderTwitter SignInProvider = "twitter" SignInProviderWindowslive SignInProvider = "windowslive" SignInProviderWorkos SignInProvider = "workos" )
Defines values for SignInProvider.
type SignInProvider302Response ¶ added in v0.40.2
type SignInProvider302Response struct {
Headers SignInProvider302ResponseHeaders
}
func (SignInProvider302Response) VisitSignInProviderResponse ¶ added in v0.40.2
func (response SignInProvider302Response) VisitSignInProviderResponse(w http.ResponseWriter) error
type SignInProvider302ResponseHeaders ¶ added in v0.40.2
type SignInProvider302ResponseHeaders struct {
Location string
}
type SignInProviderCallbackGet302Response ¶ added in v0.40.2
type SignInProviderCallbackGet302Response struct {
Headers SignInProviderCallbackGet302ResponseHeaders
}
func (SignInProviderCallbackGet302Response) VisitSignInProviderCallbackGetResponse ¶ added in v0.40.2
func (response SignInProviderCallbackGet302Response) VisitSignInProviderCallbackGetResponse(w http.ResponseWriter) error
type SignInProviderCallbackGet302ResponseHeaders ¶ added in v0.40.2
type SignInProviderCallbackGet302ResponseHeaders struct {
Location string
}
type SignInProviderCallbackGetParams ¶ added in v0.40.2
type SignInProviderCallbackGetParams struct {
// Code Authorization code provided by the authentication provider
Code *string `form:"code,omitempty" json:"code,omitempty"`
// IdToken ID token provided by the authentication provider
IdToken *string `form:"id_token,omitempty" json:"id_token,omitempty"`
// State State parameter to avoid CSRF attacks
State string `form:"state" json:"state"`
// OauthToken OAuth token for the provider (e.g., X)
OauthToken *string `form:"oauth_token,omitempty" json:"oauth_token,omitempty"`
// OauthVerifier OAuth verifier for the provider (e.g., X)
OauthVerifier *string `form:"oauth_verifier,omitempty" json:"oauth_verifier,omitempty"`
// Error Error message if authentication failed
Error *string `form:"error,omitempty" json:"error,omitempty"`
// ErrorDescription Detailed error description if authentication failed
ErrorDescription *string `form:"error_description,omitempty" json:"error_description,omitempty"`
// ErrorUri URI with more information about the error
ErrorUri *string `form:"error_uri,omitempty" json:"error_uri,omitempty"`
}
SignInProviderCallbackGetParams defines parameters for SignInProviderCallbackGet.
type SignInProviderCallbackGetParamsProvider ¶ added in v0.40.2
type SignInProviderCallbackGetParamsProvider string
SignInProviderCallbackGetParamsProvider defines parameters for SignInProviderCallbackGet.
const ( SignInProviderCallbackGetParamsProviderApple SignInProviderCallbackGetParamsProvider = "apple" SignInProviderCallbackGetParamsProviderAzuread SignInProviderCallbackGetParamsProvider = "azuread" SignInProviderCallbackGetParamsProviderBitbucket SignInProviderCallbackGetParamsProvider = "bitbucket" SignInProviderCallbackGetParamsProviderDiscord SignInProviderCallbackGetParamsProvider = "discord" SignInProviderCallbackGetParamsProviderEntraid SignInProviderCallbackGetParamsProvider = "entraid" SignInProviderCallbackGetParamsProviderFacebook SignInProviderCallbackGetParamsProvider = "facebook" SignInProviderCallbackGetParamsProviderGithub SignInProviderCallbackGetParamsProvider = "github" SignInProviderCallbackGetParamsProviderGitlab SignInProviderCallbackGetParamsProvider = "gitlab" SignInProviderCallbackGetParamsProviderGoogle SignInProviderCallbackGetParamsProvider = "google" SignInProviderCallbackGetParamsProviderLinkedin SignInProviderCallbackGetParamsProvider = "linkedin" SignInProviderCallbackGetParamsProviderSpotify SignInProviderCallbackGetParamsProvider = "spotify" SignInProviderCallbackGetParamsProviderStrava SignInProviderCallbackGetParamsProvider = "strava" SignInProviderCallbackGetParamsProviderTwitch SignInProviderCallbackGetParamsProvider = "twitch" SignInProviderCallbackGetParamsProviderTwitter SignInProviderCallbackGetParamsProvider = "twitter" SignInProviderCallbackGetParamsProviderWindowslive SignInProviderCallbackGetParamsProvider = "windowslive" SignInProviderCallbackGetParamsProviderWorkos SignInProviderCallbackGetParamsProvider = "workos" )
Defines values for SignInProviderCallbackGetParamsProvider.
type SignInProviderCallbackGetRequestObject ¶ added in v0.40.2
type SignInProviderCallbackGetRequestObject struct {
Provider SignInProviderCallbackGetParamsProvider `json:"provider"`
Params SignInProviderCallbackGetParams
}
type SignInProviderCallbackGetResponseObject ¶ added in v0.40.2
type SignInProviderCallbackGetResponseObject interface {
VisitSignInProviderCallbackGetResponse(w http.ResponseWriter) error
}
type SignInProviderCallbackGetdefaultJSONResponse ¶ added in v0.40.2
type SignInProviderCallbackGetdefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (SignInProviderCallbackGetdefaultJSONResponse) VisitSignInProviderCallbackGetResponse ¶ added in v0.40.2
func (response SignInProviderCallbackGetdefaultJSONResponse) VisitSignInProviderCallbackGetResponse(w http.ResponseWriter) error
type SignInProviderCallbackPost302Response ¶ added in v0.40.2
type SignInProviderCallbackPost302Response struct {
Headers SignInProviderCallbackPost302ResponseHeaders
}
func (SignInProviderCallbackPost302Response) VisitSignInProviderCallbackPostResponse ¶ added in v0.40.2
func (response SignInProviderCallbackPost302Response) VisitSignInProviderCallbackPostResponse(w http.ResponseWriter) error
type SignInProviderCallbackPost302ResponseHeaders ¶ added in v0.40.2
type SignInProviderCallbackPost302ResponseHeaders struct {
Location string
}
type SignInProviderCallbackPostFormdataBody ¶ added in v0.40.2
type SignInProviderCallbackPostFormdataBody struct {
// Code Authorization code provided by the authentication provider
Code *string `form:"code" json:"code"`
// Error Error message if authentication failed
Error *string `form:"error" json:"error"`
// ErrorDescription Detailed error description if authentication failed
ErrorDescription *string `form:"error_description" json:"error_description"`
// ErrorUri URI with more information about the error
ErrorUri *string `form:"error_uri" json:"error_uri"`
// IdToken ID token provided by the authentication provider
IdToken *string `form:"id_token" json:"id_token"`
// State State parameter to avoid CSRF attacks
State string `form:"state" json:"state"`
// User JSON string containing user information (only provided on first authentication with Apple)
User *string `form:"user" json:"user"`
AdditionalProperties map[string]interface{} `json:"-"`
}
SignInProviderCallbackPostFormdataBody defines parameters for SignInProviderCallbackPost.
func (SignInProviderCallbackPostFormdataBody) Get ¶ added in v0.40.2
func (a SignInProviderCallbackPostFormdataBody) Get(fieldName string) (value interface{}, found bool)
Getter for additional properties for SignInProviderCallbackPostFormdataBody. Returns the specified element and whether it was found
func (SignInProviderCallbackPostFormdataBody) MarshalJSON ¶ added in v0.40.2
func (a SignInProviderCallbackPostFormdataBody) MarshalJSON() ([]byte, error)
Override default JSON handling for SignInProviderCallbackPostFormdataBody to handle AdditionalProperties
func (*SignInProviderCallbackPostFormdataBody) Set ¶ added in v0.40.2
func (a *SignInProviderCallbackPostFormdataBody) Set(fieldName string, value interface{})
Setter for additional properties for SignInProviderCallbackPostFormdataBody
func (*SignInProviderCallbackPostFormdataBody) UnmarshalJSON ¶ added in v0.40.2
func (a *SignInProviderCallbackPostFormdataBody) UnmarshalJSON(b []byte) error
Override default JSON handling for SignInProviderCallbackPostFormdataBody to handle AdditionalProperties
type SignInProviderCallbackPostFormdataRequestBody ¶ added in v0.40.2
type SignInProviderCallbackPostFormdataRequestBody SignInProviderCallbackPostFormdataBody
SignInProviderCallbackPostFormdataRequestBody defines body for SignInProviderCallbackPost for application/x-www-form-urlencoded ContentType.
type SignInProviderCallbackPostParamsProvider ¶ added in v0.40.2
type SignInProviderCallbackPostParamsProvider string
SignInProviderCallbackPostParamsProvider defines parameters for SignInProviderCallbackPost.
const ( Apple SignInProviderCallbackPostParamsProvider = "apple" Azuread SignInProviderCallbackPostParamsProvider = "azuread" Bitbucket SignInProviderCallbackPostParamsProvider = "bitbucket" Discord SignInProviderCallbackPostParamsProvider = "discord" Entraid SignInProviderCallbackPostParamsProvider = "entraid" Facebook SignInProviderCallbackPostParamsProvider = "facebook" Github SignInProviderCallbackPostParamsProvider = "github" Gitlab SignInProviderCallbackPostParamsProvider = "gitlab" Google SignInProviderCallbackPostParamsProvider = "google" Linkedin SignInProviderCallbackPostParamsProvider = "linkedin" Spotify SignInProviderCallbackPostParamsProvider = "spotify" Strava SignInProviderCallbackPostParamsProvider = "strava" Twitch SignInProviderCallbackPostParamsProvider = "twitch" Twitter SignInProviderCallbackPostParamsProvider = "twitter" Windowslive SignInProviderCallbackPostParamsProvider = "windowslive" Workos SignInProviderCallbackPostParamsProvider = "workos" )
Defines values for SignInProviderCallbackPostParamsProvider.
type SignInProviderCallbackPostRequestObject ¶ added in v0.40.2
type SignInProviderCallbackPostRequestObject struct {
Provider SignInProviderCallbackPostParamsProvider `json:"provider"`
Body *SignInProviderCallbackPostFormdataRequestBody
}
type SignInProviderCallbackPostResponseObject ¶ added in v0.40.2
type SignInProviderCallbackPostResponseObject interface {
VisitSignInProviderCallbackPostResponse(w http.ResponseWriter) error
}
type SignInProviderCallbackPostdefaultJSONResponse ¶ added in v0.40.2
type SignInProviderCallbackPostdefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (SignInProviderCallbackPostdefaultJSONResponse) VisitSignInProviderCallbackPostResponse ¶ added in v0.40.2
func (response SignInProviderCallbackPostdefaultJSONResponse) VisitSignInProviderCallbackPostResponse(w http.ResponseWriter) error
type SignInProviderParams ¶ added in v0.40.2
type SignInProviderParams struct {
// AllowedRoles Array of allowed roles for the user
AllowedRoles *[]string `form:"allowedRoles,omitempty" json:"allowedRoles,omitempty"`
// DefaultRole Default role for the user
DefaultRole *string `form:"defaultRole,omitempty" json:"defaultRole,omitempty"`
// DisplayName Display name for the user
DisplayName *string `form:"displayName,omitempty" json:"displayName,omitempty"`
// Locale A two-characters locale
Locale *string `form:"locale,omitempty" json:"locale,omitempty"`
// Metadata Additional metadata for the user (JSON encoded string)
Metadata *map[string]interface{} `form:"metadata,omitempty" json:"metadata,omitempty"`
// RedirectTo URI to redirect to
RedirectTo *string `form:"redirectTo,omitempty" json:"redirectTo,omitempty"`
// Connect If set, this means that the user is already authenticated and wants to link their account. This needs to be a valid JWT access token.
Connect *string `form:"connect,omitempty" json:"connect,omitempty"`
}
SignInProviderParams defines parameters for SignInProvider.
type SignInProviderParamsProvider ¶ added in v0.40.2
type SignInProviderParamsProvider string
SignInProviderParamsProvider defines parameters for SignInProvider.
const ( SignInProviderParamsProviderApple SignInProviderParamsProvider = "apple" SignInProviderParamsProviderAzuread SignInProviderParamsProvider = "azuread" SignInProviderParamsProviderBitbucket SignInProviderParamsProvider = "bitbucket" SignInProviderParamsProviderDiscord SignInProviderParamsProvider = "discord" SignInProviderParamsProviderEntraid SignInProviderParamsProvider = "entraid" SignInProviderParamsProviderFacebook SignInProviderParamsProvider = "facebook" SignInProviderParamsProviderGithub SignInProviderParamsProvider = "github" SignInProviderParamsProviderGitlab SignInProviderParamsProvider = "gitlab" SignInProviderParamsProviderGoogle SignInProviderParamsProvider = "google" SignInProviderParamsProviderLinkedin SignInProviderParamsProvider = "linkedin" SignInProviderParamsProviderSpotify SignInProviderParamsProvider = "spotify" SignInProviderParamsProviderStrava SignInProviderParamsProvider = "strava" SignInProviderParamsProviderTwitch SignInProviderParamsProvider = "twitch" SignInProviderParamsProviderTwitter SignInProviderParamsProvider = "twitter" SignInProviderParamsProviderWindowslive SignInProviderParamsProvider = "windowslive" SignInProviderParamsProviderWorkos SignInProviderParamsProvider = "workos" )
Defines values for SignInProviderParamsProvider.
type SignInProviderRequestObject ¶ added in v0.40.2
type SignInProviderRequestObject struct {
Provider SignInProviderParamsProvider `json:"provider"`
Params SignInProviderParams
}
type SignInProviderResponseObject ¶ added in v0.40.2
type SignInProviderResponseObject interface {
VisitSignInProviderResponse(w http.ResponseWriter) error
}
type SignInProviderdefaultJSONResponse ¶ added in v0.40.2
type SignInProviderdefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (SignInProviderdefaultJSONResponse) VisitSignInProviderResponse ¶ added in v0.40.2
func (response SignInProviderdefaultJSONResponse) VisitSignInProviderResponse(w http.ResponseWriter) error
type SignInWebauthn200JSONResponse ¶ added in v0.40.2
type SignInWebauthn200JSONResponse PublicKeyCredentialRequestOptions
func (SignInWebauthn200JSONResponse) VisitSignInWebauthnResponse ¶ added in v0.40.2
func (response SignInWebauthn200JSONResponse) VisitSignInWebauthnResponse(w http.ResponseWriter) error
type SignInWebauthnJSONRequestBody ¶ added in v0.40.2
type SignInWebauthnJSONRequestBody = SignInWebauthnRequest
SignInWebauthnJSONRequestBody defines body for SignInWebauthn for application/json ContentType.
type SignInWebauthnRequest ¶ added in v0.36.0
type SignInWebauthnRequest struct {
// Email A valid email
Email *openapi_types.Email `json:"email,omitempty"`
}
SignInWebauthnRequest defines model for SignInWebauthnRequest.
type SignInWebauthnRequestObject ¶ added in v0.40.2
type SignInWebauthnRequestObject struct {
Body *SignInWebauthnJSONRequestBody
}
type SignInWebauthnResponseObject ¶ added in v0.40.2
type SignInWebauthnResponseObject interface {
VisitSignInWebauthnResponse(w http.ResponseWriter) error
}
type SignInWebauthnVerifyRequest ¶ added in v0.36.0
type SignInWebauthnVerifyRequest struct {
Credential CredentialAssertionResponse `json:"credential"`
// Email A valid email. Deprecated, no longer used
// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
Email *openapi_types.Email `json:"email,omitempty"`
}
SignInWebauthnVerifyRequest defines model for SignInWebauthnVerifyRequest.
type SignInWebauthndefaultJSONResponse ¶ added in v0.40.2
type SignInWebauthndefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (SignInWebauthndefaultJSONResponse) VisitSignInWebauthnResponse ¶ added in v0.40.2
func (response SignInWebauthndefaultJSONResponse) VisitSignInWebauthnResponse(w http.ResponseWriter) error
type SignOut200JSONResponse ¶ added in v0.40.2
type SignOut200JSONResponse OKResponse
func (SignOut200JSONResponse) VisitSignOutResponse ¶ added in v0.40.2
func (response SignOut200JSONResponse) VisitSignOutResponse(w http.ResponseWriter) error
type SignOutJSONRequestBody ¶ added in v0.40.2
type SignOutJSONRequestBody = SignOutRequest
SignOutJSONRequestBody defines body for SignOut for application/json ContentType.
type SignOutRequest ¶ added in v0.40.0
type SignOutRequest struct {
// All Sign out from all connected devices
All *bool `json:"all,omitempty"`
// RefreshToken Refresh token for the current session
RefreshToken *string `json:"refreshToken,omitempty"`
}
SignOutRequest defines model for SignOutRequest.
type SignOutRequestObject ¶ added in v0.40.2
type SignOutRequestObject struct {
Body *SignOutJSONRequestBody
}
type SignOutResponseObject ¶ added in v0.40.2
type SignOutResponseObject interface {
VisitSignOutResponse(w http.ResponseWriter) error
}
type SignOutdefaultJSONResponse ¶ added in v0.40.2
type SignOutdefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (SignOutdefaultJSONResponse) VisitSignOutResponse ¶ added in v0.40.2
func (response SignOutdefaultJSONResponse) VisitSignOutResponse(w http.ResponseWriter) error
type SignUpEmailPassword200JSONResponse ¶ added in v0.40.2
type SignUpEmailPassword200JSONResponse SessionPayload
func (SignUpEmailPassword200JSONResponse) VisitSignUpEmailPasswordResponse ¶ added in v0.40.2
func (response SignUpEmailPassword200JSONResponse) VisitSignUpEmailPasswordResponse(w http.ResponseWriter) error
type SignUpEmailPasswordJSONRequestBody ¶ added in v0.40.2
type SignUpEmailPasswordJSONRequestBody = SignUpEmailPasswordRequest
SignUpEmailPasswordJSONRequestBody defines body for SignUpEmailPassword for application/json ContentType.
type SignUpEmailPasswordRequest ¶ added in v0.28.0
type SignUpEmailPasswordRequest struct {
// Email Email address for the new user account
Email openapi_types.Email `json:"email"`
Options *SignUpOptions `json:"options,omitempty"`
// Password Password for the new user account
Password string `json:"password"`
}
SignUpEmailPasswordRequest Request to register a new user with email and password
type SignUpEmailPasswordRequestObject ¶ added in v0.40.2
type SignUpEmailPasswordRequestObject struct {
Body *SignUpEmailPasswordJSONRequestBody
}
type SignUpEmailPasswordResponseObject ¶ added in v0.40.2
type SignUpEmailPasswordResponseObject interface {
VisitSignUpEmailPasswordResponse(w http.ResponseWriter) error
}
type SignUpEmailPassworddefaultJSONResponse ¶ added in v0.40.2
type SignUpEmailPassworddefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (SignUpEmailPassworddefaultJSONResponse) VisitSignUpEmailPasswordResponse ¶ added in v0.40.2
func (response SignUpEmailPassworddefaultJSONResponse) VisitSignUpEmailPasswordResponse(w http.ResponseWriter) error
type SignUpOptions ¶
type SignUpOptions struct {
AllowedRoles *[]string `json:"allowedRoles,omitempty"`
DefaultRole *string `json:"defaultRole,omitempty"`
DisplayName *string `json:"displayName,omitempty"`
// Locale A two-characters locale
Locale *string `json:"locale,omitempty"`
Metadata *map[string]interface{} `json:"metadata,omitempty"`
RedirectTo *string `json:"redirectTo,omitempty"`
}
SignUpOptions defines model for SignUpOptions.
type SignUpWebauthn200JSONResponse ¶ added in v0.40.2
type SignUpWebauthn200JSONResponse PublicKeyCredentialCreationOptions
func (SignUpWebauthn200JSONResponse) VisitSignUpWebauthnResponse ¶ added in v0.40.2
func (response SignUpWebauthn200JSONResponse) VisitSignUpWebauthnResponse(w http.ResponseWriter) error
type SignUpWebauthnJSONRequestBody ¶ added in v0.40.2
type SignUpWebauthnJSONRequestBody = SignUpWebauthnRequest
SignUpWebauthnJSONRequestBody defines body for SignUpWebauthn for application/json ContentType.
type SignUpWebauthnRequest ¶ added in v0.28.0
type SignUpWebauthnRequest struct {
// Email A valid email
Email openapi_types.Email `json:"email"`
Options *SignUpOptions `json:"options,omitempty"`
}
SignUpWebauthnRequest defines model for SignUpWebauthnRequest.
type SignUpWebauthnRequestObject ¶ added in v0.40.2
type SignUpWebauthnRequestObject struct {
Body *SignUpWebauthnJSONRequestBody
}
type SignUpWebauthnResponseObject ¶ added in v0.40.2
type SignUpWebauthnResponseObject interface {
VisitSignUpWebauthnResponse(w http.ResponseWriter) error
}
type SignUpWebauthnVerifyRequest ¶ added in v0.28.0
type SignUpWebauthnVerifyRequest struct {
Credential CredentialCreationResponse `json:"credential"`
// Nickname Nickname for the security key
Nickname *string `json:"nickname,omitempty"`
Options *SignUpOptions `json:"options,omitempty"`
}
SignUpWebauthnVerifyRequest defines model for SignUpWebauthnVerifyRequest.
type SignUpWebauthndefaultJSONResponse ¶ added in v0.40.2
type SignUpWebauthndefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (SignUpWebauthndefaultJSONResponse) VisitSignUpWebauthnResponse ¶ added in v0.40.2
func (response SignUpWebauthndefaultJSONResponse) VisitSignUpWebauthnResponse(w http.ResponseWriter) error
type StrictHandlerFunc ¶
type StrictHandlerFunc = strictgin.StrictGinHandlerFunc
type StrictMiddlewareFunc ¶
type StrictMiddlewareFunc = strictgin.StrictGinMiddlewareFunc
type StrictServerInterface ¶
type StrictServerInterface interface {
// Get public keys for JWT verification in JWK Set format
// (GET /.well-known/jwks.json)
GetJWKs(ctx context.Context, request GetJWKsRequestObject) (GetJWKsResponseObject, error)
// Elevate access for an already signed in user using FIDO2 Webauthn
// (POST /elevate/webauthn)
ElevateWebauthn(ctx context.Context, request ElevateWebauthnRequestObject) (ElevateWebauthnResponseObject, error)
// Verify FIDO2 Webauthn authentication using public-key cryptography for elevation
// (POST /elevate/webauthn/verify)
VerifyElevateWebauthn(ctx context.Context, request VerifyElevateWebauthnRequestObject) (VerifyElevateWebauthnResponseObject, error)
// Health check (GET)
// (GET /healthz)
HealthCheckGet(ctx context.Context, request HealthCheckGetRequestObject) (HealthCheckGetResponseObject, error)
// Health check (HEAD)
// (HEAD /healthz)
HealthCheckHead(ctx context.Context, request HealthCheckHeadRequestObject) (HealthCheckHeadResponseObject, error)
// Link a user account with the provider's account using an id token
// (POST /link/idtoken)
LinkIdToken(ctx context.Context, request LinkIdTokenRequestObject) (LinkIdTokenResponseObject, error)
// Generate TOTP secret
// (GET /mfa/totp/generate)
ChangeUserMfa(ctx context.Context, request ChangeUserMfaRequestObject) (ChangeUserMfaResponseObject, error)
// Create a Personal Access Token (PAT)
// (POST /pat)
CreatePAT(ctx context.Context, request CreatePATRequestObject) (CreatePATResponseObject, error)
// Sign in anonymously
// (POST /signin/anonymous)
SignInAnonymous(ctx context.Context, request SignInAnonymousRequestObject) (SignInAnonymousResponseObject, error)
// Sign in with email and password
// (POST /signin/email-password)
SignInEmailPassword(ctx context.Context, request SignInEmailPasswordRequestObject) (SignInEmailPasswordResponseObject, error)
// Sign in with an ID token
// (POST /signin/idtoken)
SignInIdToken(ctx context.Context, request SignInIdTokenRequestObject) (SignInIdTokenResponseObject, error)
// Verify TOTP for MFA
// (POST /signin/mfa/totp)
VerifySignInMfaTotp(ctx context.Context, request VerifySignInMfaTotpRequestObject) (VerifySignInMfaTotpResponseObject, error)
// Sign in with email OTP
// (POST /signin/otp/email)
SignInOTPEmail(ctx context.Context, request SignInOTPEmailRequestObject) (SignInOTPEmailResponseObject, error)
// Verify email OTP
// (POST /signin/otp/email/verify)
VerifySignInOTPEmail(ctx context.Context, request VerifySignInOTPEmailRequestObject) (VerifySignInOTPEmailResponseObject, error)
// Sign in with magic link email
// (POST /signin/passwordless/email)
SignInPasswordlessEmail(ctx context.Context, request SignInPasswordlessEmailRequestObject) (SignInPasswordlessEmailResponseObject, error)
// Sign in with SMS OTP
// (POST /signin/passwordless/sms)
SignInPasswordlessSms(ctx context.Context, request SignInPasswordlessSmsRequestObject) (SignInPasswordlessSmsResponseObject, error)
// Verify SMS OTP
// (POST /signin/passwordless/sms/otp)
VerifySignInPasswordlessSms(ctx context.Context, request VerifySignInPasswordlessSmsRequestObject) (VerifySignInPasswordlessSmsResponseObject, error)
// Sign in with Personal Access Token (PAT)
// (POST /signin/pat)
SignInPAT(ctx context.Context, request SignInPATRequestObject) (SignInPATResponseObject, error)
// Sign in with an OAuth2 provider
// (GET /signin/provider/{provider})
SignInProvider(ctx context.Context, request SignInProviderRequestObject) (SignInProviderResponseObject, error)
// OAuth2 provider callback endpoint
// (GET /signin/provider/{provider}/callback)
SignInProviderCallbackGet(ctx context.Context, request SignInProviderCallbackGetRequestObject) (SignInProviderCallbackGetResponseObject, error)
// OAuth2 provider callback endpoint (form_post)
// (POST /signin/provider/{provider}/callback)
SignInProviderCallbackPost(ctx context.Context, request SignInProviderCallbackPostRequestObject) (SignInProviderCallbackPostResponseObject, error)
// Sign in with Webauthn
// (POST /signin/webauthn)
SignInWebauthn(ctx context.Context, request SignInWebauthnRequestObject) (SignInWebauthnResponseObject, error)
// Verify Webauthn sign-in
// (POST /signin/webauthn/verify)
VerifySignInWebauthn(ctx context.Context, request VerifySignInWebauthnRequestObject) (VerifySignInWebauthnResponseObject, error)
// Sign out
// (POST /signout)
SignOut(ctx context.Context, request SignOutRequestObject) (SignOutResponseObject, error)
// Sign up with email and password
// (POST /signup/email-password)
SignUpEmailPassword(ctx context.Context, request SignUpEmailPasswordRequestObject) (SignUpEmailPasswordResponseObject, error)
// Sign up with Webauthn
// (POST /signup/webauthn)
SignUpWebauthn(ctx context.Context, request SignUpWebauthnRequestObject) (SignUpWebauthnResponseObject, error)
// Verify Webauthn sign-up
// (POST /signup/webauthn/verify)
VerifySignUpWebauthn(ctx context.Context, request VerifySignUpWebauthnRequestObject) (VerifySignUpWebauthnResponseObject, error)
// Refresh access token
// (POST /token)
RefreshToken(ctx context.Context, request RefreshTokenRequestObject) (RefreshTokenResponseObject, error)
// Verify JWT token
// (POST /token/verify)
VerifyToken(ctx context.Context, request VerifyTokenRequestObject) (VerifyTokenResponseObject, error)
// Get user information
// (GET /user)
GetUser(ctx context.Context, request GetUserRequestObject) (GetUserResponseObject, error)
// Deanonymize an anonymous user
// (POST /user/deanonymize)
DeanonymizeUser(ctx context.Context, request DeanonymizeUserRequestObject) (DeanonymizeUserResponseObject, error)
// Change user email
// (POST /user/email/change)
ChangeUserEmail(ctx context.Context, request ChangeUserEmailRequestObject) (ChangeUserEmailResponseObject, error)
// Send verification email
// (POST /user/email/send-verification-email)
SendVerificationEmail(ctx context.Context, request SendVerificationEmailRequestObject) (SendVerificationEmailResponseObject, error)
// Manage multi-factor authentication
// (POST /user/mfa)
VerifyChangeUserMfa(ctx context.Context, request VerifyChangeUserMfaRequestObject) (VerifyChangeUserMfaResponseObject, error)
// Change user password
// (POST /user/password)
ChangeUserPassword(ctx context.Context, request ChangeUserPasswordRequestObject) (ChangeUserPasswordResponseObject, error)
// Request password reset
// (POST /user/password/reset)
SendPasswordResetEmail(ctx context.Context, request SendPasswordResetEmailRequestObject) (SendPasswordResetEmailResponseObject, error)
// Initialize adding of a new webauthn security key
// (POST /user/webauthn/add)
AddSecurityKey(ctx context.Context, request AddSecurityKeyRequestObject) (AddSecurityKeyResponseObject, error)
// Verify adding of a new webauthn security key
// (POST /user/webauthn/verify)
VerifyAddSecurityKey(ctx context.Context, request VerifyAddSecurityKeyRequestObject) (VerifyAddSecurityKeyResponseObject, error)
// Verify email and authentication tickets
// (GET /verify)
VerifyTicket(ctx context.Context, request VerifyTicketRequestObject) (VerifyTicketResponseObject, error)
// Get service version
// (GET /version)
GetVersion(ctx context.Context, request GetVersionRequestObject) (GetVersionResponseObject, error)
}
StrictServerInterface represents all server handlers.
type TicketTypeQuery ¶ added in v0.35.0
type TicketTypeQuery string
TicketTypeQuery Type of the ticket
const ( TicketTypeQueryEmailConfirmChange TicketTypeQuery = "emailConfirmChange" TicketTypeQueryEmailVerify TicketTypeQuery = "emailVerify" TicketTypeQueryPasswordReset TicketTypeQuery = "passwordReset" TicketTypeQuerySigninPasswordless TicketTypeQuery = "signinPasswordless" )
Defines values for TicketTypeQuery.
type TotpGenerateResponse ¶ added in v0.38.1
type TotpGenerateResponse struct {
// ImageUrl URL to QR code image for scanning with an authenticator app
ImageUrl string `json:"imageUrl"`
// TotpSecret TOTP secret key for manual setup with an authenticator app
TotpSecret string `json:"totpSecret"`
}
TotpGenerateResponse Response containing TOTP setup information for MFA
type URLEncodedBase64 ¶ added in v0.40.2
type URLEncodedBase64 = []byte
URLEncodedBase64 Base64url-encoded binary data
type User ¶
type User struct {
// ActiveMfaType Active MFA type for the user
ActiveMfaType *string `json:"activeMfaType"`
// AvatarUrl URL to the user's profile picture
AvatarUrl string `json:"avatarUrl"`
// CreatedAt Timestamp when the user account was created
CreatedAt time.Time `json:"createdAt"`
// DefaultRole Default authorization role for the user
DefaultRole string `json:"defaultRole"`
// DisplayName User's display name
DisplayName string `json:"displayName"`
// Email User's email address
Email *openapi_types.Email `json:"email,omitempty"`
// EmailVerified Whether the user's email has been verified
EmailVerified bool `json:"emailVerified"`
// Id Unique identifier for the user
Id string `json:"id"`
// IsAnonymous Whether this is an anonymous user account
IsAnonymous bool `json:"isAnonymous"`
// Locale User's preferred locale (language code)
Locale string `json:"locale"`
// Metadata Custom metadata associated with the user
Metadata map[string]interface{} `json:"metadata"`
// PhoneNumber User's phone number
PhoneNumber *string `json:"phoneNumber,omitempty"`
// PhoneNumberVerified Whether the user's phone number has been verified
PhoneNumberVerified bool `json:"phoneNumberVerified"`
// Roles List of roles assigned to the user
Roles []string `json:"roles"`
}
User User profile and account information
type UserDeanonymizeRequest ¶ added in v0.28.0
type UserDeanonymizeRequest struct {
// Connection Deprecated, will be ignored
// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
Connection *string `json:"connection,omitempty"`
// Email A valid email
Email openapi_types.Email `json:"email"`
Options *SignUpOptions `json:"options,omitempty"`
// Password A password of minimum 3 characters
Password *string `json:"password,omitempty"`
// SignInMethod Which sign-in method to use
SignInMethod UserDeanonymizeRequestSignInMethod `json:"signInMethod"`
}
UserDeanonymizeRequest defines model for UserDeanonymizeRequest.
type UserDeanonymizeRequestSignInMethod ¶ added in v0.28.0
type UserDeanonymizeRequestSignInMethod string
UserDeanonymizeRequestSignInMethod Which sign-in method to use
const ( EmailPassword UserDeanonymizeRequestSignInMethod = "email-password" Passwordless UserDeanonymizeRequestSignInMethod = "passwordless" )
Defines values for UserDeanonymizeRequestSignInMethod.
type UserEmailChangeRequest ¶ added in v0.28.0
type UserEmailChangeRequest struct {
// NewEmail A valid email
NewEmail openapi_types.Email `json:"newEmail"`
Options *OptionsRedirectTo `json:"options,omitempty"`
}
UserEmailChangeRequest defines model for UserEmailChangeRequest.
type UserEmailSendVerificationEmailRequest ¶ added in v0.28.0
type UserEmailSendVerificationEmailRequest struct {
// Email A valid email
Email openapi_types.Email `json:"email"`
Options *OptionsRedirectTo `json:"options,omitempty"`
}
UserEmailSendVerificationEmailRequest defines model for UserEmailSendVerificationEmailRequest.
type UserEntity ¶ added in v0.40.2
type UserEntity struct {
// DisplayName A human-palatable name for the user account, intended only for display
DisplayName string `json:"displayName"`
// Id The user handle of the user account entity
Id string `json:"id"`
// Name A human-palatable name for the entity
Name string `json:"name"`
}
UserEntity defines model for UserEntity.
type UserMfaRequest ¶ added in v0.38.1
type UserMfaRequest struct {
// ActiveMfaType Type of MFA to activate. Use empty string to disable MFA.
ActiveMfaType *UserMfaRequestActiveMfaType `json:"activeMfaType,omitempty"`
// Code Verification code from the authenticator app when activating MFA
Code string `json:"code"`
}
UserMfaRequest Request to activate or deactivate multi-factor authentication
type UserMfaRequestActiveMfaType ¶ added in v0.38.1
type UserMfaRequestActiveMfaType string
UserMfaRequestActiveMfaType Type of MFA to activate. Use empty string to disable MFA.
const ( Empty UserMfaRequestActiveMfaType = "" Totp UserMfaRequestActiveMfaType = "totp" )
Defines values for UserMfaRequestActiveMfaType.
type UserPasswordRequest ¶ added in v0.34.0
type UserPasswordRequest struct {
// NewPassword A password of minimum 3 characters
NewPassword string `json:"newPassword"`
// Ticket Ticket to reset the password, required if the user is not authenticated
Ticket *string `json:"ticket,omitempty"`
}
UserPasswordRequest defines model for UserPasswordRequest.
type UserPasswordResetRequest ¶ added in v0.28.0
type UserPasswordResetRequest struct {
// Email A valid email
Email openapi_types.Email `json:"email"`
Options *OptionsRedirectTo `json:"options,omitempty"`
}
UserPasswordResetRequest defines model for UserPasswordResetRequest.
type UserVerificationRequirement ¶ added in v0.40.2
type UserVerificationRequirement string
UserVerificationRequirement A requirement for user verification for the operation
const ( UserVerificationRequirementDiscouraged UserVerificationRequirement = "discouraged" UserVerificationRequirementPreferred UserVerificationRequirement = "preferred" UserVerificationRequirementRequired UserVerificationRequirement = "required" )
Defines values for UserVerificationRequirement.
type VerifyAddSecurityKey200JSONResponse ¶ added in v0.40.2
type VerifyAddSecurityKey200JSONResponse VerifyAddSecurityKeyResponse
func (VerifyAddSecurityKey200JSONResponse) VisitVerifyAddSecurityKeyResponse ¶ added in v0.40.2
func (response VerifyAddSecurityKey200JSONResponse) VisitVerifyAddSecurityKeyResponse(w http.ResponseWriter) error
type VerifyAddSecurityKeyJSONRequestBody ¶ added in v0.40.2
type VerifyAddSecurityKeyJSONRequestBody = VerifyAddSecurityKeyRequest
VerifyAddSecurityKeyJSONRequestBody defines body for VerifyAddSecurityKey for application/json ContentType.
type VerifyAddSecurityKeyRequest ¶ added in v0.40.2
type VerifyAddSecurityKeyRequest struct {
Credential CredentialCreationResponse `json:"credential"`
// Nickname Optional nickname for the security key
Nickname *string `json:"nickname,omitempty"`
}
VerifyAddSecurityKeyRequest defines model for VerifyAddSecurityKeyRequest.
type VerifyAddSecurityKeyRequestObject ¶ added in v0.40.2
type VerifyAddSecurityKeyRequestObject struct {
Body *VerifyAddSecurityKeyJSONRequestBody
}
type VerifyAddSecurityKeyResponse ¶ added in v0.40.2
type VerifyAddSecurityKeyResponse struct {
// Id The ID of the newly added security key
Id string `json:"id"`
// Nickname The nickname of the security key if provided
Nickname *string `json:"nickname,omitempty"`
}
VerifyAddSecurityKeyResponse defines model for VerifyAddSecurityKeyResponse.
type VerifyAddSecurityKeyResponseObject ¶ added in v0.40.2
type VerifyAddSecurityKeyResponseObject interface {
VisitVerifyAddSecurityKeyResponse(w http.ResponseWriter) error
}
type VerifyAddSecurityKeydefaultJSONResponse ¶ added in v0.40.2
type VerifyAddSecurityKeydefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (VerifyAddSecurityKeydefaultJSONResponse) VisitVerifyAddSecurityKeyResponse ¶ added in v0.40.2
func (response VerifyAddSecurityKeydefaultJSONResponse) VisitVerifyAddSecurityKeyResponse(w http.ResponseWriter) error
type VerifyChangeUserMfa200JSONResponse ¶ added in v0.40.2
type VerifyChangeUserMfa200JSONResponse OKResponse
func (VerifyChangeUserMfa200JSONResponse) VisitVerifyChangeUserMfaResponse ¶ added in v0.40.2
func (response VerifyChangeUserMfa200JSONResponse) VisitVerifyChangeUserMfaResponse(w http.ResponseWriter) error
type VerifyChangeUserMfaJSONRequestBody ¶ added in v0.40.2
type VerifyChangeUserMfaJSONRequestBody = UserMfaRequest
VerifyChangeUserMfaJSONRequestBody defines body for VerifyChangeUserMfa for application/json ContentType.
type VerifyChangeUserMfaRequestObject ¶ added in v0.40.2
type VerifyChangeUserMfaRequestObject struct {
Body *VerifyChangeUserMfaJSONRequestBody
}
type VerifyChangeUserMfaResponseObject ¶ added in v0.40.2
type VerifyChangeUserMfaResponseObject interface {
VisitVerifyChangeUserMfaResponse(w http.ResponseWriter) error
}
type VerifyChangeUserMfadefaultJSONResponse ¶ added in v0.40.2
type VerifyChangeUserMfadefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (VerifyChangeUserMfadefaultJSONResponse) VisitVerifyChangeUserMfaResponse ¶ added in v0.40.2
func (response VerifyChangeUserMfadefaultJSONResponse) VisitVerifyChangeUserMfaResponse(w http.ResponseWriter) error
type VerifyElevateWebauthn200JSONResponse ¶ added in v0.40.2
type VerifyElevateWebauthn200JSONResponse SessionPayload
func (VerifyElevateWebauthn200JSONResponse) VisitVerifyElevateWebauthnResponse ¶ added in v0.40.2
func (response VerifyElevateWebauthn200JSONResponse) VisitVerifyElevateWebauthnResponse(w http.ResponseWriter) error
type VerifyElevateWebauthnJSONRequestBody ¶ added in v0.40.2
type VerifyElevateWebauthnJSONRequestBody = SignInWebauthnVerifyRequest
VerifyElevateWebauthnJSONRequestBody defines body for VerifyElevateWebauthn for application/json ContentType.
type VerifyElevateWebauthnRequestObject ¶ added in v0.40.2
type VerifyElevateWebauthnRequestObject struct {
Body *VerifyElevateWebauthnJSONRequestBody
}
type VerifyElevateWebauthnResponseObject ¶ added in v0.40.2
type VerifyElevateWebauthnResponseObject interface {
VisitVerifyElevateWebauthnResponse(w http.ResponseWriter) error
}
type VerifyElevateWebauthndefaultJSONResponse ¶ added in v0.40.2
type VerifyElevateWebauthndefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (VerifyElevateWebauthndefaultJSONResponse) VisitVerifyElevateWebauthnResponse ¶ added in v0.40.2
func (response VerifyElevateWebauthndefaultJSONResponse) VisitVerifyElevateWebauthnResponse(w http.ResponseWriter) error
type VerifySignInMfaTotp200JSONResponse ¶ added in v0.40.2
type VerifySignInMfaTotp200JSONResponse SessionPayload
func (VerifySignInMfaTotp200JSONResponse) VisitVerifySignInMfaTotpResponse ¶ added in v0.40.2
func (response VerifySignInMfaTotp200JSONResponse) VisitVerifySignInMfaTotpResponse(w http.ResponseWriter) error
type VerifySignInMfaTotpJSONRequestBody ¶ added in v0.40.2
type VerifySignInMfaTotpJSONRequestBody = SignInMfaTotpRequest
VerifySignInMfaTotpJSONRequestBody defines body for VerifySignInMfaTotp for application/json ContentType.
type VerifySignInMfaTotpRequestObject ¶ added in v0.40.2
type VerifySignInMfaTotpRequestObject struct {
Body *VerifySignInMfaTotpJSONRequestBody
}
type VerifySignInMfaTotpResponseObject ¶ added in v0.40.2
type VerifySignInMfaTotpResponseObject interface {
VisitVerifySignInMfaTotpResponse(w http.ResponseWriter) error
}
type VerifySignInMfaTotpdefaultJSONResponse ¶ added in v0.40.2
type VerifySignInMfaTotpdefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (VerifySignInMfaTotpdefaultJSONResponse) VisitVerifySignInMfaTotpResponse ¶ added in v0.40.2
func (response VerifySignInMfaTotpdefaultJSONResponse) VisitVerifySignInMfaTotpResponse(w http.ResponseWriter) error
type VerifySignInOTPEmail200JSONResponse ¶ added in v0.40.2
type VerifySignInOTPEmail200JSONResponse SignInOTPEmailVerifyResponse
func (VerifySignInOTPEmail200JSONResponse) VisitVerifySignInOTPEmailResponse ¶ added in v0.40.2
func (response VerifySignInOTPEmail200JSONResponse) VisitVerifySignInOTPEmailResponse(w http.ResponseWriter) error
type VerifySignInOTPEmailJSONRequestBody ¶ added in v0.40.2
type VerifySignInOTPEmailJSONRequestBody = SignInOTPEmailVerifyRequest
VerifySignInOTPEmailJSONRequestBody defines body for VerifySignInOTPEmail for application/json ContentType.
type VerifySignInOTPEmailRequestObject ¶ added in v0.40.2
type VerifySignInOTPEmailRequestObject struct {
Body *VerifySignInOTPEmailJSONRequestBody
}
type VerifySignInOTPEmailResponseObject ¶ added in v0.40.2
type VerifySignInOTPEmailResponseObject interface {
VisitVerifySignInOTPEmailResponse(w http.ResponseWriter) error
}
type VerifySignInOTPEmaildefaultJSONResponse ¶ added in v0.40.2
type VerifySignInOTPEmaildefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (VerifySignInOTPEmaildefaultJSONResponse) VisitVerifySignInOTPEmailResponse ¶ added in v0.40.2
func (response VerifySignInOTPEmaildefaultJSONResponse) VisitVerifySignInOTPEmailResponse(w http.ResponseWriter) error
type VerifySignInPasswordlessSms200JSONResponse ¶ added in v0.40.2
type VerifySignInPasswordlessSms200JSONResponse SignInPasswordlessSmsOtpResponse
func (VerifySignInPasswordlessSms200JSONResponse) VisitVerifySignInPasswordlessSmsResponse ¶ added in v0.40.2
func (response VerifySignInPasswordlessSms200JSONResponse) VisitVerifySignInPasswordlessSmsResponse(w http.ResponseWriter) error
type VerifySignInPasswordlessSmsJSONRequestBody ¶ added in v0.40.2
type VerifySignInPasswordlessSmsJSONRequestBody = SignInPasswordlessSmsOtpRequest
VerifySignInPasswordlessSmsJSONRequestBody defines body for VerifySignInPasswordlessSms for application/json ContentType.
type VerifySignInPasswordlessSmsRequestObject ¶ added in v0.40.2
type VerifySignInPasswordlessSmsRequestObject struct {
Body *VerifySignInPasswordlessSmsJSONRequestBody
}
type VerifySignInPasswordlessSmsResponseObject ¶ added in v0.40.2
type VerifySignInPasswordlessSmsResponseObject interface {
VisitVerifySignInPasswordlessSmsResponse(w http.ResponseWriter) error
}
type VerifySignInPasswordlessSmsdefaultJSONResponse ¶ added in v0.40.2
type VerifySignInPasswordlessSmsdefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (VerifySignInPasswordlessSmsdefaultJSONResponse) VisitVerifySignInPasswordlessSmsResponse ¶ added in v0.40.2
func (response VerifySignInPasswordlessSmsdefaultJSONResponse) VisitVerifySignInPasswordlessSmsResponse(w http.ResponseWriter) error
type VerifySignInWebauthn200JSONResponse ¶ added in v0.40.2
type VerifySignInWebauthn200JSONResponse SessionPayload
func (VerifySignInWebauthn200JSONResponse) VisitVerifySignInWebauthnResponse ¶ added in v0.40.2
func (response VerifySignInWebauthn200JSONResponse) VisitVerifySignInWebauthnResponse(w http.ResponseWriter) error
type VerifySignInWebauthnJSONRequestBody ¶ added in v0.40.2
type VerifySignInWebauthnJSONRequestBody = SignInWebauthnVerifyRequest
VerifySignInWebauthnJSONRequestBody defines body for VerifySignInWebauthn for application/json ContentType.
type VerifySignInWebauthnRequestObject ¶ added in v0.40.2
type VerifySignInWebauthnRequestObject struct {
Body *VerifySignInWebauthnJSONRequestBody
}
type VerifySignInWebauthnResponseObject ¶ added in v0.40.2
type VerifySignInWebauthnResponseObject interface {
VisitVerifySignInWebauthnResponse(w http.ResponseWriter) error
}
type VerifySignInWebauthndefaultJSONResponse ¶ added in v0.40.2
type VerifySignInWebauthndefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (VerifySignInWebauthndefaultJSONResponse) VisitVerifySignInWebauthnResponse ¶ added in v0.40.2
func (response VerifySignInWebauthndefaultJSONResponse) VisitVerifySignInWebauthnResponse(w http.ResponseWriter) error
type VerifySignUpWebauthn200JSONResponse ¶ added in v0.40.2
type VerifySignUpWebauthn200JSONResponse SessionPayload
func (VerifySignUpWebauthn200JSONResponse) VisitVerifySignUpWebauthnResponse ¶ added in v0.40.2
func (response VerifySignUpWebauthn200JSONResponse) VisitVerifySignUpWebauthnResponse(w http.ResponseWriter) error
type VerifySignUpWebauthnJSONRequestBody ¶ added in v0.40.2
type VerifySignUpWebauthnJSONRequestBody = SignUpWebauthnVerifyRequest
VerifySignUpWebauthnJSONRequestBody defines body for VerifySignUpWebauthn for application/json ContentType.
type VerifySignUpWebauthnRequestObject ¶ added in v0.40.2
type VerifySignUpWebauthnRequestObject struct {
Body *VerifySignUpWebauthnJSONRequestBody
}
type VerifySignUpWebauthnResponseObject ¶ added in v0.40.2
type VerifySignUpWebauthnResponseObject interface {
VisitVerifySignUpWebauthnResponse(w http.ResponseWriter) error
}
type VerifySignUpWebauthndefaultJSONResponse ¶ added in v0.40.2
type VerifySignUpWebauthndefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (VerifySignUpWebauthndefaultJSONResponse) VisitVerifySignUpWebauthnResponse ¶ added in v0.40.2
func (response VerifySignUpWebauthndefaultJSONResponse) VisitVerifySignUpWebauthnResponse(w http.ResponseWriter) error
type VerifyTicket302Response ¶ added in v0.40.2
type VerifyTicket302Response struct {
Headers VerifyTicket302ResponseHeaders
}
func (VerifyTicket302Response) VisitVerifyTicketResponse ¶ added in v0.40.2
func (response VerifyTicket302Response) VisitVerifyTicketResponse(w http.ResponseWriter) error
type VerifyTicket302ResponseHeaders ¶ added in v0.40.2
type VerifyTicket302ResponseHeaders struct {
Location string
}
type VerifyTicketParams ¶ added in v0.40.2
type VerifyTicketParams struct {
// Ticket Ticket
Ticket TicketQuery `form:"ticket" json:"ticket"`
// Type Type of the ticket. Deprecated, no longer used
Type *VerifyTicketParamsType `form:"type,omitempty" json:"type,omitempty"`
// RedirectTo Target URL for the redirect
RedirectTo RedirectToQuery `form:"redirectTo" json:"redirectTo"`
}
VerifyTicketParams defines parameters for VerifyTicket.
type VerifyTicketParamsType ¶ added in v0.40.2
type VerifyTicketParamsType string
VerifyTicketParamsType defines parameters for VerifyTicket.
const ( VerifyTicketParamsTypeEmailConfirmChange VerifyTicketParamsType = "emailConfirmChange" VerifyTicketParamsTypeEmailVerify VerifyTicketParamsType = "emailVerify" VerifyTicketParamsTypePasswordReset VerifyTicketParamsType = "passwordReset" VerifyTicketParamsTypeSigninPasswordless VerifyTicketParamsType = "signinPasswordless" )
Defines values for VerifyTicketParamsType.
type VerifyTicketRequestObject ¶ added in v0.40.2
type VerifyTicketRequestObject struct {
Params VerifyTicketParams
}
type VerifyTicketResponseObject ¶ added in v0.40.2
type VerifyTicketResponseObject interface {
VisitVerifyTicketResponse(w http.ResponseWriter) error
}
type VerifyTicketdefaultJSONResponse ¶ added in v0.40.2
type VerifyTicketdefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (VerifyTicketdefaultJSONResponse) VisitVerifyTicketResponse ¶ added in v0.40.2
func (response VerifyTicketdefaultJSONResponse) VisitVerifyTicketResponse(w http.ResponseWriter) error
type VerifyToken200JSONResponse ¶ added in v0.40.2
type VerifyToken200JSONResponse string
func (VerifyToken200JSONResponse) VisitVerifyTokenResponse ¶ added in v0.40.2
func (response VerifyToken200JSONResponse) VisitVerifyTokenResponse(w http.ResponseWriter) error
type VerifyTokenJSONRequestBody ¶ added in v0.40.2
type VerifyTokenJSONRequestBody = VerifyTokenRequest
VerifyTokenJSONRequestBody defines body for VerifyToken for application/json ContentType.
type VerifyTokenRequest ¶ added in v0.40.0
type VerifyTokenRequest struct {
// Token JWT token to verify
Token *string `json:"token,omitempty"`
}
VerifyTokenRequest defines model for VerifyTokenRequest.
type VerifyTokenRequestObject ¶ added in v0.40.2
type VerifyTokenRequestObject struct {
Body *VerifyTokenJSONRequestBody
}
type VerifyTokenResponseObject ¶ added in v0.40.2
type VerifyTokenResponseObject interface {
VisitVerifyTokenResponse(w http.ResponseWriter) error
}
type VerifyTokendefaultJSONResponse ¶ added in v0.40.2
type VerifyTokendefaultJSONResponse struct {
Body ErrorResponse
StatusCode int
}
func (VerifyTokendefaultJSONResponse) VisitVerifyTokenResponse ¶ added in v0.40.2
func (response VerifyTokendefaultJSONResponse) VisitVerifyTokenResponse(w http.ResponseWriter) error