Documentation ¶
Index ¶
- Constants
- type AuthenticationExtensions
- type AuthenticationExtensionsClientOutputs
- type AuthenticationMechanisms
- type Authenticator
- type AuthenticatorAttachment
- type AuthenticatorAttestationResponse
- func (m *AuthenticatorAttestationResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *AuthenticatorAttestationResponse) MarshalBinary() ([]byte, error)
- func (m *AuthenticatorAttestationResponse) UnmarshalBinary(b []byte) error
- func (m *AuthenticatorAttestationResponse) Validate(formats strfmt.Registry) error
- type AuthenticatorTransport
- type ChangePassword
- type ChangeTotpSecret
- type CompleteAddressVerification
- func (m *CompleteAddressVerification) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *CompleteAddressVerification) MarshalBinary() ([]byte, error)
- func (m *CompleteAddressVerification) UnmarshalBinary(b []byte) error
- func (m *CompleteAddressVerification) Validate(formats strfmt.Registry) error
- type Credential
- type CredentialAssertion
- type CredentialAttestation
- type CredentialCreationResponse
- func (m *CredentialCreationResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *CredentialCreationResponse) MarshalBinary() ([]byte, error)
- func (m *CredentialCreationResponse) UnmarshalBinary(b []byte) error
- func (m *CredentialCreationResponse) Validate(formats strfmt.Registry) error
- type CredentialDescriptor
- type CredentialFlags
- type CredentialType
- type Error
- type FederatedAccount
- type ListUserMFASessions
- type NameWebAuthnKey
- type PublicKeyCredentialHints
- type PublicKeyCredentialRequestOptions
- func (m *PublicKeyCredentialRequestOptions) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *PublicKeyCredentialRequestOptions) MarshalBinary() ([]byte, error)
- func (m *PublicKeyCredentialRequestOptions) UnmarshalBinary(b []byte) error
- func (m *PublicKeyCredentialRequestOptions) Validate(formats strfmt.Registry) error
- type ResetPasswordConfirm
- type SelfUserCredentials
- type SelfUserIdentifier
- type SelfUserUpdate
- type SelfUserVerifiableAddress
- func (m *SelfUserVerifiableAddress) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *SelfUserVerifiableAddress) MarshalBinary() ([]byte, error)
- func (m *SelfUserVerifiableAddress) UnmarshalBinary(b []byte) error
- func (m *SelfUserVerifiableAddress) Validate(formats strfmt.Registry) error
- type SelfUserWithData
- type SelfUserWithDataV2
- type SetPassword
- type SetTotpSecret
- type SetWebAuthn
- type SupportedJSONSchema
- type URLEncodedBase64
- type UserMFASession
- type UserVerificationRequirement
- type WebAuthnCredentials
Constants ¶
const ( // SelfUserCredentialsStateValid captures enum value "valid" SelfUserCredentialsStateValid string = "valid" // SelfUserCredentialsStateMustBeReset captures enum value "must_be_reset" SelfUserCredentialsStateMustBeReset string = "must_be_reset" // SelfUserCredentialsStateMustBeChanged captures enum value "must_be_changed" SelfUserCredentialsStateMustBeChanged string = "must_be_changed" )
const ( // SelfUserCredentialsTypePassword captures enum value "password" SelfUserCredentialsTypePassword string = "password" // SelfUserCredentialsTypeWebauthn captures enum value "webauthn" SelfUserCredentialsTypeWebauthn string = "webauthn" // SelfUserCredentialsTypeTotp captures enum value "totp" SelfUserCredentialsTypeTotp string = "totp" )
const ( // SelfUserIdentifierTypeEmail captures enum value "email" SelfUserIdentifierTypeEmail string = "email" // SelfUserIdentifierTypeMobile captures enum value "mobile" SelfUserIdentifierTypeMobile string = "mobile" // SelfUserIdentifierTypeUID captures enum value "uid" SelfUserIdentifierTypeUID string = "uid" // SelfUserIdentifierTypeExternal captures enum value "external" SelfUserIdentifierTypeExternal string = "external" // SelfUserIdentifierTypeFederated captures enum value "federated" SelfUserIdentifierTypeFederated string = "federated" )
const ( // SelfUserVerifiableAddressPreferredContactMethodSms captures enum value "sms" SelfUserVerifiableAddressPreferredContactMethodSms string = "sms" // SelfUserVerifiableAddressPreferredContactMethodVoice captures enum value "voice" SelfUserVerifiableAddressPreferredContactMethodVoice string = "voice" )
const ( // SelfUserVerifiableAddressStatusActive captures enum value "active" SelfUserVerifiableAddressStatusActive string = "active" // SelfUserVerifiableAddressStatusInactive captures enum value "inactive" SelfUserVerifiableAddressStatusInactive string = "inactive" )
const ( // SelfUserVerifiableAddressTypeEmail captures enum value "email" SelfUserVerifiableAddressTypeEmail string = "email" // SelfUserVerifiableAddressTypeMobile captures enum value "mobile" SelfUserVerifiableAddressTypeMobile string = "mobile" )
const ( // SelfUserWithDataV2PreferredAuthenticationMechanismTotp captures enum value "totp" SelfUserWithDataV2PreferredAuthenticationMechanismTotp string = "totp" // SelfUserWithDataV2PreferredAuthenticationMechanismPassword captures enum value "password" SelfUserWithDataV2PreferredAuthenticationMechanismPassword string = "password" // SelfUserWithDataV2PreferredAuthenticationMechanismOtp captures enum value "otp" SelfUserWithDataV2PreferredAuthenticationMechanismOtp string = "otp" // SelfUserWithDataV2PreferredAuthenticationMechanismWebauthn captures enum value "webauthn" SelfUserWithDataV2PreferredAuthenticationMechanismWebauthn string = "webauthn" )
const ( // SelfUserWithDataV2SecondFactorPreferredAuthenticationMechanismTotp captures enum value "totp" SelfUserWithDataV2SecondFactorPreferredAuthenticationMechanismTotp string = "totp" // SelfUserWithDataV2SecondFactorPreferredAuthenticationMechanismPassword captures enum value "password" SelfUserWithDataV2SecondFactorPreferredAuthenticationMechanismPassword string = "password" // SelfUserWithDataV2SecondFactorPreferredAuthenticationMechanismOtp captures enum value "otp" SelfUserWithDataV2SecondFactorPreferredAuthenticationMechanismOtp string = "otp" // SelfUserWithDataV2SecondFactorPreferredAuthenticationMechanismWebauthn captures enum value "webauthn" SelfUserWithDataV2SecondFactorPreferredAuthenticationMechanismWebauthn string = "webauthn" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuthenticationExtensions ¶
type AuthenticationExtensions map[string]interface{}
AuthenticationExtensions AuthenticationExtensions represents the AuthenticationExtensionsClientInputs IDL. This member contains additional parameters requesting additional processing by the client and authenticator.
Specification: §5.7.1. Authentication Extensions Client Inputs (https://www.w3.org/TR/webauthn/#iface-authentication-extensions-client-inputs)
swagger:model AuthenticationExtensions
func (AuthenticationExtensions) ContextValidate ¶
func (m AuthenticationExtensions) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this authentication extensions based on context it is used
type AuthenticationExtensionsClientOutputs ¶
type AuthenticationExtensionsClientOutputs map[string]interface{}
AuthenticationExtensionsClientOutputs authentication extensions client outputs
swagger:model AuthenticationExtensionsClientOutputs
func (AuthenticationExtensionsClientOutputs) ContextValidate ¶
func (m AuthenticationExtensionsClientOutputs) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this authentication extensions client outputs based on context it is used
type AuthenticationMechanisms ¶
type AuthenticationMechanisms []string
AuthenticationMechanisms authentication mechanisms
swagger:model AuthenticationMechanisms
func (AuthenticationMechanisms) ContextValidate ¶
func (m AuthenticationMechanisms) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this authentication mechanisms based on context it is used
type Authenticator ¶
type Authenticator struct { // The AAGUID of the authenticator. An AAGUID is defined as an array containing the globally unique // identifier of the authenticator model being sought. AAGUID []uint8 `json:"AAGUID" yaml:"AAGUID"` // attachment Attachment AuthenticatorAttachment `json:"attachment,omitempty" yaml:"attachment,omitempty"` // CloneWarning - This is a signal that the authenticator may be cloned, i.e. at least two copies of the // credential private key may exist and are being used in parallel. Relying Parties should incorporate // this information into their risk scoring. Whether the Relying Party updates the stored signature // counter value in this case, or not, or fails the authentication ceremony or not, is Relying Party-specific. CloneWarning bool `json:"cloneWarning,omitempty" yaml:"cloneWarning,omitempty"` // SignCount -Upon a new login operation, the Relying Party compares the stored signature counter value // with the new signCount value returned in the assertion’s authenticator data. If this new // signCount value is less than or equal to the stored value, a cloned authenticator may // exist, or the authenticator may be malfunctioning. SignCount uint32 `json:"signCount,omitempty" yaml:"signCount,omitempty"` }
Authenticator authenticator
swagger:model Authenticator
func (*Authenticator) ContextValidate ¶
ContextValidate validate this authenticator based on the context it is used
func (*Authenticator) MarshalBinary ¶
func (m *Authenticator) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Authenticator) UnmarshalBinary ¶
func (m *Authenticator) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AuthenticatorAttachment ¶
type AuthenticatorAttachment string
AuthenticatorAttachment AuthenticatorAttachment represents the IDL enum of the same name, and is used as part of the Authenticator Selection Criteria.
This enumeration’s values describe authenticators' attachment modalities. Relying Parties use this to express a preferred authenticator attachment modality when calling navigator.credentials.create() to create a credential.
If this member is present, eligible authenticators are filtered to only authenticators attached with the specified §5.4.5 Authenticator Attachment Enumeration (enum AuthenticatorAttachment). The value SHOULD be a member of AuthenticatorAttachment but client platforms MUST ignore unknown values, treating an unknown value as if the member does not exist.
Specification: §5.4.4. Authenticator Selection Criteria (https://www.w3.org/TR/webauthn/#dom-authenticatorselectioncriteria-authenticatorattachment)
Specification: §5.4.5. Authenticator Attachment Enumeration (https://www.w3.org/TR/webauthn/#enum-attachment)
swagger:model AuthenticatorAttachment
func (AuthenticatorAttachment) ContextValidate ¶
func (m AuthenticatorAttachment) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this authenticator attachment based on context it is used
type AuthenticatorAttestationResponse ¶
type AuthenticatorAttestationResponse struct { // attestation object AttestationObject URLEncodedBase64 `json:"attestationObject,omitempty" yaml:"attestationObject,omitempty"` // authenticator data AuthenticatorData URLEncodedBase64 `json:"authenticatorData,omitempty" yaml:"authenticatorData,omitempty"` // client data JSON ClientDataJSON URLEncodedBase64 `json:"clientDataJSON,omitempty" yaml:"clientDataJSON,omitempty"` // public key PublicKey URLEncodedBase64 `json:"publicKey,omitempty" yaml:"publicKey,omitempty"` // public key algorithm PublicKeyAlgorithm int64 `json:"publicKeyAlgorithm,omitempty" yaml:"publicKeyAlgorithm,omitempty"` // transports Transports []string `json:"transports" yaml:"transports"` }
AuthenticatorAttestationResponse AuthenticatorAttestationResponse is the initial unpacked 'response' object received by the relying party. This contains the clientDataJSON object, which will be marshalled into CollectedClientData, and the 'attestationObject', which contains information about the authenticator, and the newly minted public key credential. The information in both objects are used to verify the authenticity of the ceremony and new credential.
See: https://www.w3.org/TR/webauthn/#typedefdef-publickeycredentialjson
swagger:model AuthenticatorAttestationResponse
func (*AuthenticatorAttestationResponse) ContextValidate ¶
func (m *AuthenticatorAttestationResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this authenticator attestation response based on the context it is used
func (*AuthenticatorAttestationResponse) MarshalBinary ¶
func (m *AuthenticatorAttestationResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AuthenticatorAttestationResponse) UnmarshalBinary ¶
func (m *AuthenticatorAttestationResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AuthenticatorTransport ¶
type AuthenticatorTransport string
AuthenticatorTransport AuthenticatorTransport represents the IDL enum with the same name.
Authenticators may implement various transports for communicating with clients. This enumeration defines hints as to how clients might communicate with a particular authenticator in order to obtain an assertion for a specific credential. Note that these hints represent the WebAuthn Relying Party's best belief as to how an authenticator may be reached. A Relying Party will typically learn of the supported transports for a public key credential via getTransports().
Specification: §5.8.4. Authenticator Transport Enumeration (https://www.w3.org/TR/webauthn/#enumdef-authenticatortransport)
swagger:model AuthenticatorTransport
func (AuthenticatorTransport) ContextValidate ¶
ContextValidate validates this authenticator transport based on context it is used
type ChangePassword ¶
type ChangePassword struct { // new password // Required: true NewPassword string `json:"new_password" yaml:"new_password"` // old password // Required: true OldPassword string `json:"old_password" yaml:"old_password"` }
ChangePassword change password
swagger:model ChangePassword
func (*ChangePassword) ContextValidate ¶
ContextValidate validates this change password based on context it is used
func (*ChangePassword) MarshalBinary ¶
func (m *ChangePassword) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ChangePassword) UnmarshalBinary ¶
func (m *ChangePassword) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ChangeTotpSecret ¶
type ChangeTotpSecret struct { // new totp secret // Required: true NewTotpSecret string `json:"new_totp_secret" yaml:"new_totp_secret"` // totp // Required: true Totp string `json:"totp" yaml:"totp"` }
ChangeTotpSecret change totp secret
swagger:model ChangeTotpSecret
func (*ChangeTotpSecret) ContextValidate ¶
ContextValidate validates this change totp secret based on context it is used
func (*ChangeTotpSecret) MarshalBinary ¶
func (m *ChangeTotpSecret) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ChangeTotpSecret) UnmarshalBinary ¶
func (m *ChangeTotpSecret) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CompleteAddressVerification ¶
type CompleteAddressVerification struct { // address // Example: sample@email.com/+48123456789 // Required: true Address string `json:"address" yaml:"address"` // code // Required: true Code string `json:"code" yaml:"code"` }
CompleteAddressVerification complete address verification
swagger:model CompleteAddressVerification
func (*CompleteAddressVerification) ContextValidate ¶
func (m *CompleteAddressVerification) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this complete address verification based on context it is used
func (*CompleteAddressVerification) MarshalBinary ¶
func (m *CompleteAddressVerification) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CompleteAddressVerification) UnmarshalBinary ¶
func (m *CompleteAddressVerification) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Credential ¶
type Credential struct { // attestation Attestation *CredentialAttestation `json:"attestation,omitempty" yaml:"attestation,omitempty"` // The attestation format used (if any) by the authenticator when creating the credential. AttestationType string `json:"attestationType,omitempty" yaml:"attestationType,omitempty"` // authenticator Authenticator *Authenticator `json:"authenticator,omitempty" yaml:"authenticator,omitempty"` // flags Flags *CredentialFlags `json:"flags,omitempty" yaml:"flags,omitempty"` // The Credential ID of the public key credential source. Described by the Credential Record 'id' field. ID []uint8 `json:"id" yaml:"id"` // The credential public key of the public key credential source. Described by the Credential Record 'publicKey field. PublicKey []uint8 `json:"publicKey" yaml:"publicKey"` // The transport types the authenticator supports. Transport []AuthenticatorTransport `json:"transport" yaml:"transport"` }
Credential Credential contains all needed information about a WebAuthn credential for storage. This struct is effectively the Credential Record as described in the specification.
See: §4. Terminology: Credential Record (https://www.w3.org/TR/webauthn-3/#credential-record)
swagger:model Credential
func (*Credential) ContextValidate ¶
ContextValidate validate this credential based on the context it is used
func (*Credential) MarshalBinary ¶
func (m *Credential) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Credential) UnmarshalBinary ¶
func (m *Credential) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CredentialAssertion ¶
type CredentialAssertion struct { // public key PublicKey *PublicKeyCredentialRequestOptions `json:"publicKey,omitempty" yaml:"publicKey,omitempty"` }
CredentialAssertion credential assertion
swagger:model CredentialAssertion
func (*CredentialAssertion) ContextValidate ¶
ContextValidate validate this credential assertion based on the context it is used
func (*CredentialAssertion) MarshalBinary ¶
func (m *CredentialAssertion) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CredentialAssertion) UnmarshalBinary ¶
func (m *CredentialAssertion) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CredentialAttestation ¶
type CredentialAttestation struct { // authenticator data AuthenticatorData []uint8 `json:"authenticatorData" yaml:"authenticatorData"` // client data hash ClientDataHash []uint8 `json:"clientDataHash" yaml:"clientDataHash"` // client data JSON ClientDataJSON []uint8 `json:"clientDataJSON" yaml:"clientDataJSON"` // object Object []uint8 `json:"object" yaml:"object"` // public key algorithm PublicKeyAlgorithm int64 `json:"publicKeyAlgorithm,omitempty" yaml:"publicKeyAlgorithm,omitempty"` }
CredentialAttestation credential attestation
swagger:model CredentialAttestation
func (*CredentialAttestation) ContextValidate ¶
ContextValidate validates this credential attestation based on context it is used
func (*CredentialAttestation) MarshalBinary ¶
func (m *CredentialAttestation) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CredentialAttestation) UnmarshalBinary ¶
func (m *CredentialAttestation) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CredentialCreationResponse ¶
type CredentialCreationResponse struct { // authenticator attachment AuthenticatorAttachment string `json:"authenticatorAttachment,omitempty" yaml:"authenticatorAttachment,omitempty"` // client extension results ClientExtensionResults AuthenticationExtensionsClientOutputs `json:"clientExtensionResults,omitempty" yaml:"clientExtensionResults,omitempty"` // ID is The credential’s identifier. The requirements for the // identifier are distinct for each type of credential. It might // represent a username for username/password tuples, for example. ID string `json:"id,omitempty" yaml:"id,omitempty"` // raw Id RawID URLEncodedBase64 `json:"rawId,omitempty" yaml:"rawId,omitempty"` // response Response *AuthenticatorAttestationResponse `json:"response,omitempty" yaml:"response,omitempty"` // Type is the value of the object’s interface object's [[type]] slot, // which specifies the credential type represented by this object. // This should be type "public-key" for Webauthn credentials. Type string `json:"type,omitempty" yaml:"type,omitempty"` }
CredentialCreationResponse credential creation response
swagger:model CredentialCreationResponse
func (*CredentialCreationResponse) ContextValidate ¶
func (m *CredentialCreationResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this credential creation response based on the context it is used
func (*CredentialCreationResponse) MarshalBinary ¶
func (m *CredentialCreationResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CredentialCreationResponse) UnmarshalBinary ¶
func (m *CredentialCreationResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CredentialDescriptor ¶
type CredentialDescriptor struct { // id ID URLEncodedBase64 `json:"id,omitempty" yaml:"id,omitempty"` // The authenticator transports that can be used. Transports []AuthenticatorTransport `json:"transports" yaml:"transports"` // type Type CredentialType `json:"type,omitempty" yaml:"type,omitempty"` }
CredentialDescriptor CredentialDescriptor represents the PublicKeyCredentialDescriptor IDL.
This dictionary contains the attributes that are specified by a caller when referring to a public key credential as an input parameter to the create() or get() methods. It mirrors the fields of the PublicKeyCredential object returned by the latter methods.
Specification: §5.10.3. Credential Descriptor (https://www.w3.org/TR/webauthn/#credential-dictionary)
swagger:model CredentialDescriptor
func (*CredentialDescriptor) ContextValidate ¶
ContextValidate validate this credential descriptor based on the context it is used
func (*CredentialDescriptor) MarshalBinary ¶
func (m *CredentialDescriptor) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CredentialDescriptor) UnmarshalBinary ¶
func (m *CredentialDescriptor) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CredentialFlags ¶
type CredentialFlags struct { // Flag BE indicates the credential is able to be backed up and/or sync'd between devices. This should NEVER change. BackupEligible bool `json:"backupEligible,omitempty" yaml:"backupEligible,omitempty"` // Flag BS indicates the credential has been backed up and/or sync'd. This value can change but it's recommended // that RP's keep track of this value. BackupState bool `json:"backupState,omitempty" yaml:"backupState,omitempty"` // Flag UP indicates the users presence. UserPresent bool `json:"userPresent,omitempty" yaml:"userPresent,omitempty"` // Flag UV indicates the user performed verification. UserVerified bool `json:"userVerified,omitempty" yaml:"userVerified,omitempty"` }
CredentialFlags credential flags
swagger:model CredentialFlags
func (*CredentialFlags) ContextValidate ¶
ContextValidate validates this credential flags based on context it is used
func (*CredentialFlags) MarshalBinary ¶
func (m *CredentialFlags) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CredentialFlags) UnmarshalBinary ¶
func (m *CredentialFlags) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CredentialType ¶
type CredentialType string
CredentialType CredentialType represents the PublicKeyCredentialType IDL and is used with the CredentialDescriptor IDL.
This enumeration defines the valid credential types. It is an extension point; values can be added to it in the future, as more credential types are defined. The values of this enumeration are used for versioning the Authentication Assertion and attestation structures according to the type of the authenticator.
Currently one credential type is defined, namely "public-key".
Specification: §5.8.2. Credential Type Enumeration (https://www.w3.org/TR/webauthn/#enumdef-publickeycredentialtype)
Specification: §5.8.3. Credential Descriptor (https://www.w3.org/TR/webauthn/#dictionary-credential-descriptor)
swagger:model CredentialType
func (CredentialType) ContextValidate ¶
ContextValidate validates this credential type based on context it is used
type Error ¶
type Error struct { // details Details interface{} `json:"details,omitempty" yaml:"details,omitempty"` // error Error string `json:"error,omitempty" yaml:"error,omitempty"` // error code ErrorCode string `json:"error_code,omitempty" yaml:"error_code,omitempty"` // status code StatusCode int64 `json:"status_code,omitempty" yaml:"status_code,omitempty"` }
Error HTTP error response
swagger:model Error
func (*Error) ContextValidate ¶
ContextValidate validates this error based on context it is used
func (*Error) MarshalBinary ¶
MarshalBinary interface implementation
func (*Error) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type FederatedAccount ¶
type FederatedAccount struct { // federated idp id FederatedIdpID string `json:"federated_idp_id,omitempty" yaml:"federated_idp_id,omitempty"` // federated idp method FederatedIdpMethod string `json:"federated_idp_method,omitempty" yaml:"federated_idp_method,omitempty"` // federated idp name FederatedIdpName string `json:"federated_idp_name,omitempty" yaml:"federated_idp_name,omitempty"` // federated sub FederatedSub string `json:"federated_sub,omitempty" yaml:"federated_sub,omitempty"` // identifier id IdentifierID string `json:"identifier_id,omitempty" yaml:"identifier_id,omitempty"` // workspace id WorkspaceID string `json:"workspace_id,omitempty" yaml:"workspace_id,omitempty"` }
FederatedAccount federated account
swagger:model FederatedAccount
func (*FederatedAccount) ContextValidate ¶
ContextValidate validates this federated account based on context it is used
func (*FederatedAccount) MarshalBinary ¶
func (m *FederatedAccount) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*FederatedAccount) UnmarshalBinary ¶
func (m *FederatedAccount) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ListUserMFASessions ¶
type ListUserMFASessions struct { // sessions Sessions []*UserMFASession `json:"sessions" yaml:"sessions"` }
ListUserMFASessions list user m f a sessions
swagger:model ListUserMFASessions
func (*ListUserMFASessions) ContextValidate ¶
ContextValidate validate this list user m f a sessions based on the context it is used
func (*ListUserMFASessions) MarshalBinary ¶
func (m *ListUserMFASessions) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ListUserMFASessions) UnmarshalBinary ¶
func (m *ListUserMFASessions) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type NameWebAuthnKey ¶
type NameWebAuthnKey struct { // name // Required: true Name string `json:"name" yaml:"name"` }
NameWebAuthnKey name web authn key
swagger:model NameWebAuthnKey
func (*NameWebAuthnKey) ContextValidate ¶
ContextValidate validates this name web authn key based on context it is used
func (*NameWebAuthnKey) MarshalBinary ¶
func (m *NameWebAuthnKey) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NameWebAuthnKey) UnmarshalBinary ¶
func (m *NameWebAuthnKey) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PublicKeyCredentialHints ¶
type PublicKeyCredentialHints string
PublicKeyCredentialHints public key credential hints
swagger:model PublicKeyCredentialHints
func (PublicKeyCredentialHints) ContextValidate ¶
func (m PublicKeyCredentialHints) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this public key credential hints based on context it is used
type PublicKeyCredentialRequestOptions ¶
type PublicKeyCredentialRequestOptions struct { // allow credentials AllowCredentials []*CredentialDescriptor `json:"allowCredentials" yaml:"allowCredentials"` // challenge Challenge URLEncodedBase64 `json:"challenge,omitempty" yaml:"challenge,omitempty"` // extensions Extensions AuthenticationExtensions `json:"extensions,omitempty" yaml:"extensions,omitempty"` // hints Hints []PublicKeyCredentialHints `json:"hints" yaml:"hints"` // rp Id RpID string `json:"rpId,omitempty" yaml:"rpId,omitempty"` // timeout Timeout int64 `json:"timeout,omitempty" yaml:"timeout,omitempty"` // user verification UserVerification UserVerificationRequirement `json:"userVerification,omitempty" yaml:"userVerification,omitempty"` }
PublicKeyCredentialRequestOptions The PublicKeyCredentialRequestOptions dictionary supplies get() with the data it needs to generate an assertion. Its challenge member MUST be present, while its other members are OPTIONAL.
WebAuthn Level 3: hints.
Specification: §5.5. Options for Assertion Generation (https://www.w3.org/TR/webauthn/#dictionary-assertion-options)
swagger:model PublicKeyCredentialRequestOptions
func (*PublicKeyCredentialRequestOptions) ContextValidate ¶
func (m *PublicKeyCredentialRequestOptions) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this public key credential request options based on the context it is used
func (*PublicKeyCredentialRequestOptions) MarshalBinary ¶
func (m *PublicKeyCredentialRequestOptions) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PublicKeyCredentialRequestOptions) UnmarshalBinary ¶
func (m *PublicKeyCredentialRequestOptions) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ResetPasswordConfirm ¶
type ResetPasswordConfirm struct { // code // Required: true Code string `json:"code" yaml:"code"` // identifier Identifier string `json:"identifier,omitempty" yaml:"identifier,omitempty"` // new password // Required: true NewPassword string `json:"new_password" yaml:"new_password"` }
ResetPasswordConfirm reset password confirm
swagger:model ResetPasswordConfirm
func (*ResetPasswordConfirm) ContextValidate ¶
ContextValidate validates this reset password confirm based on context it is used
func (*ResetPasswordConfirm) MarshalBinary ¶
func (m *ResetPasswordConfirm) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ResetPasswordConfirm) UnmarshalBinary ¶
func (m *ResetPasswordConfirm) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SelfUserCredentials ¶
type SelfUserCredentials struct { // expires after // Format: duration ExpiresAfter strfmt.Duration `json:"expires_after,omitempty" yaml:"expires_after,omitempty"` // expires at // Format: date-time ExpiresAt strfmt.DateTime `json:"expires_at,omitempty" yaml:"expires_at,omitempty"` // id ID string `json:"id,omitempty" yaml:"id,omitempty"` // some credentials might have name - like passkeys Name string `json:"name,omitempty" yaml:"name,omitempty"` // state // Enum: ["valid","must_be_reset","must_be_changed"] State string `json:"state,omitempty" yaml:"state,omitempty"` // type // Example: password // Required: true // Enum: ["password","webauthn","totp"] Type string `json:"type" yaml:"type"` // updated at // Required: true // Format: date-time UpdatedAt strfmt.DateTime `json:"updated_at" yaml:"updated_at"` }
SelfUserCredentials self user credentials
swagger:model SelfUserCredentials
func (*SelfUserCredentials) ContextValidate ¶
ContextValidate validates this self user credentials based on context it is used
func (*SelfUserCredentials) MarshalBinary ¶
func (m *SelfUserCredentials) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SelfUserCredentials) UnmarshalBinary ¶
func (m *SelfUserCredentials) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SelfUserIdentifier ¶
type SelfUserIdentifier struct { // created at // Required: true // Format: date-time CreatedAt strfmt.DateTime `json:"created_at" yaml:"created_at"` // identifier // Required: true Identifier string `json:"identifier" yaml:"identifier"` // type // Example: email // Required: true // Enum: ["email","mobile","uid","external","federated"] Type string `json:"type" yaml:"type"` }
SelfUserIdentifier self user identifier
swagger:model SelfUserIdentifier
func (*SelfUserIdentifier) ContextValidate ¶
ContextValidate validates this self user identifier based on context it is used
func (*SelfUserIdentifier) MarshalBinary ¶
func (m *SelfUserIdentifier) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SelfUserIdentifier) UnmarshalBinary ¶
func (m *SelfUserIdentifier) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SelfUserUpdate ¶
type SelfUserUpdate struct { // payload Payload map[string]interface{} `json:"payload,omitempty" yaml:"payload,omitempty"` }
SelfUserUpdate self user update
swagger:model SelfUserUpdate
func (*SelfUserUpdate) ContextValidate ¶
ContextValidate validates this self user update based on context it is used
func (*SelfUserUpdate) MarshalBinary ¶
func (m *SelfUserUpdate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SelfUserUpdate) UnmarshalBinary ¶
func (m *SelfUserUpdate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SelfUserVerifiableAddress ¶
type SelfUserVerifiableAddress struct { // address // Required: true Address string `json:"address" yaml:"address"` // created at // Required: true // Format: date-time CreatedAt strfmt.DateTime `json:"created_at" yaml:"created_at"` // preferred contact method // Example: sms // Enum: ["sms","voice"] PreferredContactMethod string `json:"preferred_contact_method,omitempty" yaml:"preferred_contact_method,omitempty"` // status // Example: active // Required: true // Enum: ["active","inactive"] Status string `json:"status" yaml:"status"` // type // Example: mobile // Required: true // Enum: ["email","mobile"] Type string `json:"type" yaml:"type"` // updated at // Required: true // Format: date-time UpdatedAt strfmt.DateTime `json:"updated_at" yaml:"updated_at"` // verified // Required: true Verified bool `json:"verified" yaml:"verified"` // verified at // Format: date-time VerifiedAt strfmt.DateTime `json:"verified_at,omitempty" yaml:"verified_at,omitempty"` }
SelfUserVerifiableAddress self user verifiable address
swagger:model SelfUserVerifiableAddress
func (*SelfUserVerifiableAddress) ContextValidate ¶
func (m *SelfUserVerifiableAddress) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this self user verifiable address based on context it is used
func (*SelfUserVerifiableAddress) MarshalBinary ¶
func (m *SelfUserVerifiableAddress) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SelfUserVerifiableAddress) UnmarshalBinary ¶
func (m *SelfUserVerifiableAddress) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SelfUserWithData ¶
type SelfUserWithData struct { // business metadata BusinessMetadata map[string]interface{} `json:"business_metadata,omitempty" yaml:"business_metadata,omitempty"` // id ID string `json:"id,omitempty" yaml:"id,omitempty"` // identifiers Identifiers []*SelfUserIdentifier `json:"identifiers" yaml:"identifiers"` // metadata Metadata map[string]interface{} `json:"metadata,omitempty" yaml:"metadata,omitempty"` // payload Payload map[string]interface{} `json:"payload,omitempty" yaml:"payload,omitempty"` // verifiable addresses VerifiableAddresses []*SelfUserVerifiableAddress `json:"verifiable_addresses" yaml:"verifiable_addresses"` }
SelfUserWithData self user with data
swagger:model SelfUserWithData
func (*SelfUserWithData) ContextValidate ¶
ContextValidate validate this self user with data based on the context it is used
func (*SelfUserWithData) MarshalBinary ¶
func (m *SelfUserWithData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SelfUserWithData) UnmarshalBinary ¶
func (m *SelfUserWithData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SelfUserWithDataV2 ¶
type SelfUserWithDataV2 struct { // allowed authentication mechanisms that user can use AllowedAuthenticationMechanisms []string `json:"allowed_authentication_mechanisms" yaml:"allowed_authentication_mechanisms"` // authentication mechanisms AuthenticationMechanisms AuthenticationMechanisms `json:"authentication_mechanisms,omitempty" yaml:"authentication_mechanisms,omitempty"` // business metadata BusinessMetadata map[string]interface{} `json:"business_metadata,omitempty" yaml:"business_metadata,omitempty"` // credentials Credentials []*SelfUserCredentials `json:"credentials" yaml:"credentials"` // federated accounts FederatedAccounts []*FederatedAccount `json:"federated_accounts" yaml:"federated_accounts"` // id ID string `json:"id,omitempty" yaml:"id,omitempty"` // identifiers Identifiers []*SelfUserIdentifier `json:"identifiers" yaml:"identifiers"` // metadata Metadata map[string]interface{} `json:"metadata,omitempty" yaml:"metadata,omitempty"` // payload Payload map[string]interface{} `json:"payload,omitempty" yaml:"payload,omitempty"` // payload schema PayloadSchema *SupportedJSONSchema `json:"payload_schema,omitempty" yaml:"payload_schema,omitempty"` // preferred authentication mechanism // Example: password // Enum: ["totp","password","otp","webauthn"] PreferredAuthenticationMechanism string `json:"preferred_authentication_mechanism,omitempty" yaml:"preferred_authentication_mechanism,omitempty"` // second factor authentication mechanisms SecondFactorAuthenticationMechanisms AuthenticationMechanisms `json:"second_factor_authentication_mechanisms,omitempty" yaml:"second_factor_authentication_mechanisms,omitempty"` // second factor preferred authentication mechanism // Example: password // Enum: ["totp","password","otp","webauthn"] SecondFactorPreferredAuthenticationMechanism string `` /* 131-byte string literal not displayed */ // verifiable addresses VerifiableAddresses []*SelfUserVerifiableAddress `json:"verifiable_addresses" yaml:"verifiable_addresses"` }
SelfUserWithDataV2 self user with data v2
swagger:model SelfUserWithDataV2
func (*SelfUserWithDataV2) ContextValidate ¶
ContextValidate validate this self user with data v2 based on the context it is used
func (*SelfUserWithDataV2) MarshalBinary ¶
func (m *SelfUserWithDataV2) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SelfUserWithDataV2) UnmarshalBinary ¶
func (m *SelfUserWithDataV2) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SetPassword ¶
type SetPassword struct { // new password // Required: true NewPassword string `json:"new_password" yaml:"new_password"` }
SetPassword set password
swagger:model SetPassword
func (*SetPassword) ContextValidate ¶
ContextValidate validates this set password based on context it is used
func (*SetPassword) MarshalBinary ¶
func (m *SetPassword) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SetPassword) UnmarshalBinary ¶
func (m *SetPassword) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SetTotpSecret ¶
type SetTotpSecret struct { // new totp secret // Required: true NewTotpSecret string `json:"new_totp_secret" yaml:"new_totp_secret"` }
SetTotpSecret set totp secret
swagger:model SetTotpSecret
func (*SetTotpSecret) ContextValidate ¶
ContextValidate validates this set totp secret based on context it is used
func (*SetTotpSecret) MarshalBinary ¶
func (m *SetTotpSecret) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SetTotpSecret) UnmarshalBinary ¶
func (m *SetTotpSecret) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SetWebAuthn ¶
type SetWebAuthn struct { // new webauthn // Required: true NewWebauthn *Credential `json:"new_webauthn" yaml:"new_webauthn"` }
SetWebAuthn set web authn
swagger:model SetWebAuthn
func (*SetWebAuthn) ContextValidate ¶
ContextValidate validate this set web authn based on the context it is used
func (*SetWebAuthn) MarshalBinary ¶
func (m *SetWebAuthn) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SetWebAuthn) UnmarshalBinary ¶
func (m *SetWebAuthn) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SupportedJSONSchema ¶
type SupportedJSONSchema struct { // additional properties AdditionalProperties bool `json:"additionalProperties,omitempty" yaml:"additionalProperties,omitempty"` // all of AllOf []*SupportedJSONSchema `json:"allOf" yaml:"allOf"` // any of AnyOf []*SupportedJSONSchema `json:"anyOf" yaml:"anyOf"` // const Const string `json:"const,omitempty" yaml:"const,omitempty"` // contains Contains *SupportedJSONSchema `json:"contains,omitempty" yaml:"contains,omitempty"` // dependent required DependentRequired map[string][]string `json:"dependentRequired,omitempty" yaml:"dependentRequired,omitempty"` // dependent schemas DependentSchemas map[string]SupportedJSONSchema `json:"dependentSchemas,omitempty" yaml:"dependentSchemas,omitempty"` // description Description string `json:"description,omitempty" yaml:"description,omitempty"` // else Else *SupportedJSONSchema `json:"else,omitempty" yaml:"else,omitempty"` // enum Enum []string `json:"enum" yaml:"enum"` // exclusive maximum ExclusiveMaximum int64 `json:"exclusiveMaximum,omitempty" yaml:"exclusiveMaximum,omitempty"` // exclusive minimum ExclusiveMinimum int64 `json:"exclusiveMinimum,omitempty" yaml:"exclusiveMinimum,omitempty"` // hidden Hidden bool `json:"hidden,omitempty" yaml:"hidden,omitempty"` // if If *SupportedJSONSchema `json:"if,omitempty" yaml:"if,omitempty"` // items Items *SupportedJSONSchema `json:"items,omitempty" yaml:"items,omitempty"` // max contains MaxContains int64 `json:"maxContains,omitempty" yaml:"maxContains,omitempty"` // arrays MaxItems int64 `json:"maxItems,omitempty" yaml:"maxItems,omitempty"` // strings MaxLength int64 `json:"maxLength,omitempty" yaml:"maxLength,omitempty"` // objects MaxProperties int64 `json:"maxProperties,omitempty" yaml:"maxProperties,omitempty"` // maximum Maximum int64 `json:"maximum,omitempty" yaml:"maximum,omitempty"` // min contains MinContains int64 `json:"minContains,omitempty" yaml:"minContains,omitempty"` // min items MinItems int64 `json:"minItems,omitempty" yaml:"minItems,omitempty"` // min length MinLength int64 `json:"minLength,omitempty" yaml:"minLength,omitempty"` // min properties MinProperties int64 `json:"minProperties,omitempty" yaml:"minProperties,omitempty"` // minimum Minimum int64 `json:"minimum,omitempty" yaml:"minimum,omitempty"` // numeric MultipleOf int64 `json:"multipleOf,omitempty" yaml:"multipleOf,omitempty"` // not Not *SupportedJSONSchema `json:"not,omitempty" yaml:"not,omitempty"` // one of OneOf []*SupportedJSONSchema `json:"oneOf" yaml:"oneOf"` // pattern Pattern string `json:"pattern,omitempty" yaml:"pattern,omitempty"` // pattern properties PatternProperties map[string]SupportedJSONSchema `json:"patternProperties,omitempty" yaml:"patternProperties,omitempty"` // properties Properties map[string]SupportedJSONSchema `json:"properties,omitempty" yaml:"properties,omitempty"` // property names PropertyNames *SupportedJSONSchema `json:"propertyNames,omitempty" yaml:"propertyNames,omitempty"` // required Required []string `json:"required" yaml:"required"` // then Then *SupportedJSONSchema `json:"then,omitempty" yaml:"then,omitempty"` // title Title string `json:"title,omitempty" yaml:"title,omitempty"` // any Type string `json:"type,omitempty" yaml:"type,omitempty"` // unique items UniqueItems bool `json:"uniqueItems,omitempty" yaml:"uniqueItems,omitempty"` }
SupportedJSONSchema supported JSON schema
swagger:model SupportedJSONSchema
func (*SupportedJSONSchema) ContextValidate ¶
ContextValidate validate this supported JSON schema based on the context it is used
func (*SupportedJSONSchema) MarshalBinary ¶
func (m *SupportedJSONSchema) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SupportedJSONSchema) UnmarshalBinary ¶
func (m *SupportedJSONSchema) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type URLEncodedBase64 ¶
type URLEncodedBase64 []uint8
URLEncodedBase64 URLEncodedBase64 represents a byte slice holding URL-encoded base64 data.
When fields of this type are unmarshalled from JSON, the data is base64 decoded into a byte slice.
swagger:model URLEncodedBase64
func (URLEncodedBase64) ContextValidate ¶
ContextValidate validates this URL encoded base64 based on context it is used
type UserMFASession ¶
type UserMFASession struct { // Session id ID string `json:"id,omitempty" yaml:"id,omitempty"` // IP address of the user who created the session IPAddress string `json:"ip_address,omitempty" yaml:"ip_address,omitempty"` // Time when the session was issued // Format: date-time IssueTime strfmt.DateTime `json:"issue_time,omitempty" yaml:"issue_time,omitempty"` // User agent of the user who created the session UserAgent string `json:"user_agent,omitempty" yaml:"user_agent,omitempty"` }
UserMFASession user m f a session
swagger:model UserMFASession
func (*UserMFASession) ContextValidate ¶
ContextValidate validates this user m f a session based on context it is used
func (*UserMFASession) MarshalBinary ¶
func (m *UserMFASession) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UserMFASession) UnmarshalBinary ¶
func (m *UserMFASession) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UserVerificationRequirement ¶
type UserVerificationRequirement string
UserVerificationRequirement UserVerificationRequirement is a representation of the UserVerificationRequirement IDL enum.
A WebAuthn Relying Party may require user verification for some of its operations but not for others, and may use this type to express its needs.
Specification: §5.8.6. User Verification Requirement Enumeration (https://www.w3.org/TR/webauthn/#enum-userVerificationRequirement)
swagger:model UserVerificationRequirement
func (UserVerificationRequirement) ContextValidate ¶
func (m UserVerificationRequirement) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this user verification requirement based on context it is used
type WebAuthnCredentials ¶
type WebAuthnCredentials struct { // credentials Credentials []*Credential `json:"credentials" yaml:"credentials"` }
WebAuthnCredentials web authn credentials
swagger:model WebAuthnCredentials
func (*WebAuthnCredentials) ContextValidate ¶
ContextValidate validate this web authn credentials based on the context it is used
func (*WebAuthnCredentials) MarshalBinary ¶
func (m *WebAuthnCredentials) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*WebAuthnCredentials) UnmarshalBinary ¶
func (m *WebAuthnCredentials) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
Source Files ¶
- authentication_extensions.go
- authentication_extensions_client_outputs.go
- authentication_mechanisms.go
- authenticator.go
- authenticator_attachment.go
- authenticator_attestation_response.go
- authenticator_transport.go
- change_password.go
- change_totp_secret.go
- complete_address_verification.go
- credential.go
- credential_assertion.go
- credential_attestation.go
- credential_creation_response.go
- credential_descriptor.go
- credential_flags.go
- credential_type.go
- error.go
- federated_account.go
- list_user_m_f_a_sessions.go
- name_web_authn_key.go
- public_key_credential_hints.go
- public_key_credential_request_options.go
- reset_password_confirm.go
- self_user_credentials.go
- self_user_identifier.go
- self_user_update.go
- self_user_verifiable_address.go
- self_user_with_data.go
- self_user_with_data_v2.go
- set_password.go
- set_totp_secret.go
- set_web_authn.go
- supported_json_schema.go
- url_encoded_base64.go
- user_m_f_a_session.go
- user_verification_requirement.go
- web_authn_credentials.go