Documentation
¶
Index ¶
- Constants
- type ActivateSelfRegisteredUser
- func (m *ActivateSelfRegisteredUser) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ActivateSelfRegisteredUser) MarshalBinary() ([]byte, error)
- func (m *ActivateSelfRegisteredUser) UnmarshalBinary(b []byte) error
- func (m *ActivateSelfRegisteredUser) Validate(formats strfmt.Registry) error
- type ActivationSettings
- type AddUserIdentifier
- type AddUserVerifiableAddress
- func (m *AddUserVerifiableAddress) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *AddUserVerifiableAddress) MarshalBinary() ([]byte, error)
- func (m *AddUserVerifiableAddress) UnmarshalBinary(b []byte) error
- func (m *AddUserVerifiableAddress) Validate(formats strfmt.Registry) error
- type Address
- type Argon2Config
- type AttestationFormat
- type Attribute
- type AuthenticationExtensions
- func (m *AuthenticationExtensions) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *AuthenticationExtensions) MarshalBinary() ([]byte, error)
- func (m *AuthenticationExtensions) UnmarshalBinary(b []byte) error
- func (m *AuthenticationExtensions) Validate(formats strfmt.Registry) error
- type AuthenticationExtensionsClientOutputs
- func (m *AuthenticationExtensionsClientOutputs) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *AuthenticationExtensionsClientOutputs) MarshalBinary() ([]byte, error)
- func (m *AuthenticationExtensionsClientOutputs) UnmarshalBinary(b []byte) error
- func (m *AuthenticationExtensionsClientOutputs) Validate(formats strfmt.Registry) error
- type AuthenticationMechanisms
- type AuthenticationScheme
- type Authenticator
- type AuthenticatorAssertionResponse
- func (m *AuthenticatorAssertionResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *AuthenticatorAssertionResponse) MarshalBinary() ([]byte, error)
- func (m *AuthenticatorAssertionResponse) UnmarshalBinary(b []byte) error
- func (m *AuthenticatorAssertionResponse) Validate(formats strfmt.Registry) error
- 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 AuthenticatorSelection
- func (m *AuthenticatorSelection) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *AuthenticatorSelection) MarshalBinary() ([]byte, error)
- func (m *AuthenticatorSelection) UnmarshalBinary(b []byte) error
- func (m *AuthenticatorSelection) Validate(formats strfmt.Registry) error
- type AuthenticatorTransport
- type BaseGroup
- type BaseVerifyOTP
- type BcryptConfig
- type BeginVerifyWebAuthnRequest
- func (m *BeginVerifyWebAuthnRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *BeginVerifyWebAuthnRequest) MarshalBinary() ([]byte, error)
- func (m *BeginVerifyWebAuthnRequest) UnmarshalBinary(b []byte) error
- func (m *BeginVerifyWebAuthnRequest) Validate(formats strfmt.Registry) error
- type BulkSupport
- type COSEAlgorithmIdentifier
- type ChangePassword
- type ChangeTotpSecret
- type Code
- type CodeID
- type CodeValue
- type Codes
- type CompleteAddWebAuthn
- 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 CompleteResetPassword
- type CompleteResetTotp
- type CompleteVerifyWebAuthnRequest
- func (m *CompleteVerifyWebAuthnRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *CompleteVerifyWebAuthnRequest) MarshalBinary() ([]byte, error)
- func (m *CompleteVerifyWebAuthnRequest) UnmarshalBinary(b []byte) error
- func (m *CompleteVerifyWebAuthnRequest) Validate(formats strfmt.Registry) error
- type ConfirmResetPassword
- type ConveyancePreference
- type Credential
- type CredentialAssertionResponse
- func (m *CredentialAssertionResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *CredentialAssertionResponse) MarshalBinary() ([]byte, error)
- func (m *CredentialAssertionResponse) UnmarshalBinary(b []byte) error
- func (m *CredentialAssertionResponse) Validate(formats strfmt.Registry) error
- type CredentialAttestation
- type CredentialCreation
- 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 CredentialExtensions
- type CredentialFlags
- type CredentialMediationRequirement
- type CredentialParameter
- type CredentialPropertiesOutput
- func (m *CredentialPropertiesOutput) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *CredentialPropertiesOutput) MarshalBinary() ([]byte, error)
- func (m *CredentialPropertiesOutput) UnmarshalBinary(b []byte) error
- func (m *CredentialPropertiesOutput) Validate(formats strfmt.Registry) error
- type CredentialProtectionPolicy
- type CredentialType
- type Cursor
- type DeleteUserIdentifier
- type DeleteUserVerifiableAddress
- func (m *DeleteUserVerifiableAddress) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *DeleteUserVerifiableAddress) MarshalBinary() ([]byte, error)
- func (m *DeleteUserVerifiableAddress) UnmarshalBinary(b []byte) error
- func (m *DeleteUserVerifiableAddress) Validate(formats strfmt.Registry) error
- type DeviceToSet
- type DevicesToSet
- type Error
- type ExtendedUser
- type ExtensionSchemaData
- type FieldMapping
- type FilterSupport
- type GetUserByKey
- type Group
- type GroupGetResponse
- type GroupMember
- type GroupMembershipType
- type GroupUpsertRequest
- type Groups
- type HMACGetSecretInputs
- type HMACGetSecretOutputs
- type Hash
- type HashConfig
- type IdentifierDetails
- type IdentifiersToSet
- type InspectOTP
- type InspectOTPUserOperationalData
- func (m *InspectOTPUserOperationalData) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *InspectOTPUserOperationalData) MarshalBinary() ([]byte, error)
- func (m *InspectOTPUserOperationalData) UnmarshalBinary(b []byte) error
- func (m *InspectOTPUserOperationalData) Validate(formats strfmt.Registry) error
- type InternalGroup
- type LargeBlobInputs
- type LargeBlobOutputs
- type LargeBlobSupport
- type ListGroupsResponse
- type ListUsersResponse
- type MD5Config
- type MFAPreferences
- type Member
- type MemberType
- type NameWebAuthnKey
- type NewUser
- type NewUserCredential
- type NewUserIdentifier
- type NewUserVerifiableAddress
- func (m *NewUserVerifiableAddress) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *NewUserVerifiableAddress) MarshalBinary() ([]byte, error)
- func (m *NewUserVerifiableAddress) UnmarshalBinary(b []byte) error
- func (m *NewUserVerifiableAddress) Validate(formats strfmt.Registry) error
- type OtpConfig
- type OtpSettings
- type PBKDF2Config
- type PRFInputs
- type PRFOutputs
- type PRFValues
- type PasswordPolicy
- type PasswordSettings
- type Pool
- type PoolLimits
- type PoolResponse
- type Pools
- type PublicKeyCredentialCreationOptions
- func (m *PublicKeyCredentialCreationOptions) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *PublicKeyCredentialCreationOptions) MarshalBinary() ([]byte, error)
- func (m *PublicKeyCredentialCreationOptions) UnmarshalBinary(b []byte) error
- func (m *PublicKeyCredentialCreationOptions) Validate(formats strfmt.Registry) error
- 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 RedactionPolicy
- type RelyingPartyEntity
- type RequestActivation
- type RequestAddOrResetCredential
- func (m *RequestAddOrResetCredential) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *RequestAddOrResetCredential) MarshalBinary() ([]byte, error)
- func (m *RequestAddOrResetCredential) UnmarshalBinary(b []byte) error
- func (m *RequestAddOrResetCredential) Validate(formats strfmt.Registry) error
- type RequestAddWebAuthn
- type RequestCode
- type RequestCodeForUser
- type RequestOTPCode
- type RequestOTPForAddress
- type ResetCredentialsSettings
- func (m *ResetCredentialsSettings) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ResetCredentialsSettings) MarshalBinary() ([]byte, error)
- func (m *ResetCredentialsSettings) UnmarshalBinary(b []byte) error
- func (m *ResetCredentialsSettings) Validate(formats strfmt.Registry) error
- type ResidentKeyRequirement
- type ResourceType
- type ResourceTypes
- type Rfc6902PatchOperation
- type Rfc6902PatchOperations
- type SCIMSettings
- type SCIMv2AttributeType
- type SCIMv2Email
- type SCIMv2ErrorResponse
- type SCIMv2ExtensionEmail
- type SCIMv2ExtensionPhoneNumber
- func (m *SCIMv2ExtensionPhoneNumber) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *SCIMv2ExtensionPhoneNumber) MarshalBinary() ([]byte, error)
- func (m *SCIMv2ExtensionPhoneNumber) UnmarshalBinary(b []byte) error
- func (m *SCIMv2ExtensionPhoneNumber) Validate(formats strfmt.Registry) error
- type SCIMv2Identifier
- type SCIMv2IdentifierType
- type SCIMv2Meta
- type SCIMv2Patch
- type SCIMv2PhoneNumber
- type SCIMv2Schema
- type SCIMv2Schemas
- type SCIMv2UserGroup
- type SHAConfig
- type Schema
- type SchemaExtension
- type Schemas
- type SelfRegisterUser
- type ServiceProviderConfig
- type SetPasswordStateRequest
- func (m *SetPasswordStateRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *SetPasswordStateRequest) MarshalBinary() ([]byte, error)
- func (m *SetPasswordStateRequest) UnmarshalBinary(b []byte) error
- func (m *SetPasswordStateRequest) Validate(formats strfmt.Registry) error
- type SupportedFeature
- type SupportedJSONSchema
- type TenantDump
- type TotpSettings
- type URLEncodedBase64
- type UpdateUser
- type UpdateUserVerifiableAddress
- func (m *UpdateUserVerifiableAddress) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *UpdateUserVerifiableAddress) MarshalBinary() ([]byte, error)
- func (m *UpdateUserVerifiableAddress) UnmarshalBinary(b []byte) error
- func (m *UpdateUserVerifiableAddress) Validate(formats strfmt.Registry) error
- type User
- type UserCredential
- type UserEntity
- type UserGetResponse
- type UserID
- type UserIdentifier
- type UserPools
- type UserPreferences
- type UserUpsertRequest
- type UserVerifiableAddress
- type UserVerificationRequirement
- type UserWithData
- type Users
- type VerifiableAddressesToSet
- func (m *VerifiableAddressesToSet) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *VerifiableAddressesToSet) MarshalBinary() ([]byte, error)
- func (m *VerifiableAddressesToSet) UnmarshalBinary(b []byte) error
- func (m *VerifiableAddressesToSet) Validate(formats strfmt.Registry) error
- type VerifyCodeResult
- type VerifyOTP
- type VerifyPassword
- type VerifyPasswordResponseData
- func (m *VerifyPasswordResponseData) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *VerifyPasswordResponseData) MarshalBinary() ([]byte, error)
- func (m *VerifyPasswordResponseData) UnmarshalBinary(b []byte) error
- func (m *VerifyPasswordResponseData) Validate(formats strfmt.Registry) error
- type VerifyPasswordResponseDataV2
- func (m *VerifyPasswordResponseDataV2) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *VerifyPasswordResponseDataV2) MarshalBinary() ([]byte, error)
- func (m *VerifyPasswordResponseDataV2) UnmarshalBinary(b []byte) error
- func (m *VerifyPasswordResponseDataV2) Validate(formats strfmt.Registry) error
- type VerifyWebAuthnResponseData
- func (m *VerifyWebAuthnResponseData) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *VerifyWebAuthnResponseData) MarshalBinary() ([]byte, error)
- func (m *VerifyWebAuthnResponseData) UnmarshalBinary(b []byte) error
- func (m *VerifyWebAuthnResponseData) Validate(formats strfmt.Registry) error
- type WebAuthnCredential
- type WebAuthnLoginBeginData
- func (m *WebAuthnLoginBeginData) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *WebAuthnLoginBeginData) MarshalBinary() ([]byte, error)
- func (m *WebAuthnLoginBeginData) UnmarshalBinary(b []byte) error
- func (m *WebAuthnLoginBeginData) Validate(formats strfmt.Registry) error
- type WebAuthnSettings
Constants ¶
const ( // ActivateSelfRegisteredUserWebauthnTypeRegular captures enum value "regular" ActivateSelfRegisteredUserWebauthnTypeRegular string = "regular" // ActivateSelfRegisteredUserWebauthnTypeDiscoverable captures enum value "discoverable" ActivateSelfRegisteredUserWebauthnTypeDiscoverable string = "discoverable" )
const ( // AddUserIdentifierTypeEmail captures enum value "email" AddUserIdentifierTypeEmail string = "email" // AddUserIdentifierTypeMobile captures enum value "mobile" AddUserIdentifierTypeMobile string = "mobile" // AddUserIdentifierTypeUID captures enum value "uid" AddUserIdentifierTypeUID string = "uid" // AddUserIdentifierTypeExternal captures enum value "external" AddUserIdentifierTypeExternal string = "external" // AddUserIdentifierTypeFederated captures enum value "federated" AddUserIdentifierTypeFederated string = "federated" )
const ( // AddUserVerifiableAddressPreferredContactMethodSms captures enum value "sms" AddUserVerifiableAddressPreferredContactMethodSms string = "sms" // AddUserVerifiableAddressPreferredContactMethodVoice captures enum value "voice" AddUserVerifiableAddressPreferredContactMethodVoice string = "voice" )
const ( // AddUserVerifiableAddressStatusActive captures enum value "active" AddUserVerifiableAddressStatusActive string = "active" // AddUserVerifiableAddressStatusInactive captures enum value "inactive" AddUserVerifiableAddressStatusInactive string = "inactive" )
const ( // AddUserVerifiableAddressTypeEmail captures enum value "email" AddUserVerifiableAddressTypeEmail string = "email" // AddUserVerifiableAddressTypeMobile captures enum value "mobile" AddUserVerifiableAddressTypeMobile string = "mobile" )
const ( // CodeTypeActivation captures enum value "activation" CodeTypeActivation string = "activation" // CodeTypeResetPassword captures enum value "reset_password" CodeTypeResetPassword string = "reset_password" // CodeTypeResetTotp captures enum value "reset_totp" CodeTypeResetTotp string = "reset_totp" // CodeTypeEnrollWebauthn captures enum value "enroll_webauthn" CodeTypeEnrollWebauthn string = "enroll_webauthn" // CodeTypeChallenge captures enum value "challenge" CodeTypeChallenge string = "challenge" // CodeTypeVerifyAddress captures enum value "verify_address" CodeTypeVerifyAddress string = "verify_address" // CodeTypeAuthentication captures enum value "authentication" CodeTypeAuthentication string = "authentication" // CodeTypePairDevice captures enum value "pair_device" CodeTypePairDevice string = "pair_device" )
const ( // CompleteAddWebAuthnWebauthnTypeRegular captures enum value "regular" CompleteAddWebAuthnWebauthnTypeRegular string = "regular" // CompleteAddWebAuthnWebauthnTypeDiscoverable captures enum value "discoverable" CompleteAddWebAuthnWebauthnTypeDiscoverable string = "discoverable" )
const ( // ExtendedUserStatusActive captures enum value "active" ExtendedUserStatusActive string = "active" // ExtendedUserStatusInactive captures enum value "inactive" ExtendedUserStatusInactive string = "inactive" // ExtendedUserStatusDeleted captures enum value "deleted" ExtendedUserStatusDeleted string = "deleted" // ExtendedUserStatusNew captures enum value "new" ExtendedUserStatusNew string = "new" )
const ( // ExtendedUserUserTypeJit captures enum value "jit" ExtendedUserUserTypeJit string = "jit" // ExtendedUserUserTypeStandard captures enum value "standard" ExtendedUserUserTypeStandard string = "standard" // ExtendedUserUserTypeScim captures enum value "scim" ExtendedUserUserTypeScim string = "scim" )
const ( // HashConfigMethodBcrypt captures enum value "bcrypt" HashConfigMethodBcrypt string = "bcrypt" // HashConfigMethodPbkdf2 captures enum value "pbkdf2" HashConfigMethodPbkdf2 string = "pbkdf2" // HashConfigMethodArgon2 captures enum value "argon2" HashConfigMethodArgon2 string = "argon2" // HashConfigMethodSha captures enum value "sha" HashConfigMethodSha string = "sha" // HashConfigMethodMd5 captures enum value "md5" HashConfigMethodMd5 string = "md5" )
const ( // IdentifierDetailsTypeEmail captures enum value "email" IdentifierDetailsTypeEmail string = "email" // IdentifierDetailsTypeMobile captures enum value "mobile" IdentifierDetailsTypeMobile string = "mobile" // IdentifierDetailsTypeUID captures enum value "uid" IdentifierDetailsTypeUID string = "uid" // IdentifierDetailsTypeExternal captures enum value "external" IdentifierDetailsTypeExternal string = "external" // IdentifierDetailsTypeFederated captures enum value "federated" IdentifierDetailsTypeFederated string = "federated" )
const ( // InspectOTPUserOperationalDataCodeTypeActivation captures enum value "activation" InspectOTPUserOperationalDataCodeTypeActivation string = "activation" // InspectOTPUserOperationalDataCodeTypeResetPassword captures enum value "reset_password" InspectOTPUserOperationalDataCodeTypeResetPassword string = "reset_password" // InspectOTPUserOperationalDataCodeTypeResetTotp captures enum value "reset_totp" InspectOTPUserOperationalDataCodeTypeResetTotp string = "reset_totp" // InspectOTPUserOperationalDataCodeTypeEnrollWebauthn captures enum value "enroll_webauthn" InspectOTPUserOperationalDataCodeTypeEnrollWebauthn string = "enroll_webauthn" // InspectOTPUserOperationalDataCodeTypeChallenge captures enum value "challenge" InspectOTPUserOperationalDataCodeTypeChallenge string = "challenge" // InspectOTPUserOperationalDataCodeTypeVerifyAddress captures enum value "verify_address" InspectOTPUserOperationalDataCodeTypeVerifyAddress string = "verify_address" // InspectOTPUserOperationalDataCodeTypeAuthentication captures enum value "authentication" InspectOTPUserOperationalDataCodeTypeAuthentication string = "authentication" // InspectOTPUserOperationalDataCodeTypePairDevice captures enum value "pair_device" InspectOTPUserOperationalDataCodeTypePairDevice string = "pair_device" )
const ( // MFAPreferencesPreferred2faTotp captures enum value "totp" MFAPreferencesPreferred2faTotp string = "totp" // MFAPreferencesPreferred2faPassword captures enum value "password" MFAPreferencesPreferred2faPassword string = "password" // MFAPreferencesPreferred2faOtp captures enum value "otp" MFAPreferencesPreferred2faOtp string = "otp" // MFAPreferencesPreferred2faEmailOtp captures enum value "email_otp" MFAPreferencesPreferred2faEmailOtp string = "email_otp" // MFAPreferencesPreferred2faSmsOtp captures enum value "sms_otp" MFAPreferencesPreferred2faSmsOtp string = "sms_otp" // MFAPreferencesPreferred2faVoiceOtp captures enum value "voice_otp" MFAPreferencesPreferred2faVoiceOtp string = "voice_otp" // MFAPreferencesPreferred2faWebauthn captures enum value "webauthn" MFAPreferencesPreferred2faWebauthn string = "webauthn" // MFAPreferencesPreferred2faUsernamelessWebauthn captures enum value "usernameless_webauthn" MFAPreferencesPreferred2faUsernamelessWebauthn string = "usernameless_webauthn" // MFAPreferencesPreferred2faPush captures enum value "push" MFAPreferencesPreferred2faPush string = "push" // MFAPreferencesPreferred2faSymbol captures enum value "symbol" MFAPreferencesPreferred2faSymbol string = "symbol" // MFAPreferencesPreferred2faQrCode captures enum value "qr_code" MFAPreferencesPreferred2faQrCode string = "qr_code" )
const ( // NewUserStatusActive captures enum value "active" NewUserStatusActive string = "active" // NewUserStatusInactive captures enum value "inactive" NewUserStatusInactive string = "inactive" // NewUserStatusDeleted captures enum value "deleted" NewUserStatusDeleted string = "deleted" // NewUserStatusNew captures enum value "new" NewUserStatusNew string = "new" )
const ( // NewUserUserTypeJit captures enum value "jit" NewUserUserTypeJit string = "jit" // NewUserUserTypeStandard captures enum value "standard" NewUserUserTypeStandard string = "standard" // NewUserUserTypeScim captures enum value "scim" NewUserUserTypeScim string = "scim" )
const ( // NewUserCredentialTypePassword captures enum value "password" NewUserCredentialTypePassword string = "password" // NewUserCredentialTypeWebauthn captures enum value "webauthn" NewUserCredentialTypeWebauthn string = "webauthn" // NewUserCredentialTypeTotp captures enum value "totp" NewUserCredentialTypeTotp string = "totp" // NewUserCredentialTypeDevice captures enum value "device" NewUserCredentialTypeDevice string = "device" )
const ( // NewUserCredentialWebauthnTypeRegular captures enum value "regular" NewUserCredentialWebauthnTypeRegular string = "regular" // NewUserCredentialWebauthnTypeDiscoverable captures enum value "discoverable" NewUserCredentialWebauthnTypeDiscoverable string = "discoverable" )
const ( // NewUserIdentifierTypeEmail captures enum value "email" NewUserIdentifierTypeEmail string = "email" // NewUserIdentifierTypeMobile captures enum value "mobile" NewUserIdentifierTypeMobile string = "mobile" // NewUserIdentifierTypeUID captures enum value "uid" NewUserIdentifierTypeUID string = "uid" // NewUserIdentifierTypeExternal captures enum value "external" NewUserIdentifierTypeExternal string = "external" // NewUserIdentifierTypeFederated captures enum value "federated" NewUserIdentifierTypeFederated string = "federated" )
const ( // NewUserVerifiableAddressPreferredContactMethodSms captures enum value "sms" NewUserVerifiableAddressPreferredContactMethodSms string = "sms" // NewUserVerifiableAddressPreferredContactMethodVoice captures enum value "voice" NewUserVerifiableAddressPreferredContactMethodVoice string = "voice" )
const ( // NewUserVerifiableAddressStatusActive captures enum value "active" NewUserVerifiableAddressStatusActive string = "active" // NewUserVerifiableAddressStatusInactive captures enum value "inactive" NewUserVerifiableAddressStatusInactive string = "inactive" )
const ( // NewUserVerifiableAddressTypeEmail captures enum value "email" NewUserVerifiableAddressTypeEmail string = "email" // NewUserVerifiableAddressTypeMobile captures enum value "mobile" NewUserVerifiableAddressTypeMobile string = "mobile" )
const ( // PasswordPolicyStrengthAny captures enum value "any" PasswordPolicyStrengthAny string = "any" // PasswordPolicyStrengthWeak captures enum value "weak" PasswordPolicyStrengthWeak string = "weak" // PasswordPolicyStrengthFair captures enum value "fair" PasswordPolicyStrengthFair string = "fair" // PasswordPolicyStrengthStrong captures enum value "strong" PasswordPolicyStrengthStrong string = "strong" // PasswordPolicyStrengthVeryStrong captures enum value "very_strong" PasswordPolicyStrengthVeryStrong string = "very_strong" )
const ( // PasswordSettingsHashingMethodBcrypt captures enum value "bcrypt" PasswordSettingsHashingMethodBcrypt string = "bcrypt" // PasswordSettingsHashingMethodPbkdf2 captures enum value "pbkdf2" PasswordSettingsHashingMethodPbkdf2 string = "pbkdf2" // PasswordSettingsHashingMethodArgon2 captures enum value "argon2" PasswordSettingsHashingMethodArgon2 string = "argon2" // PasswordSettingsHashingMethodSha captures enum value "sha" PasswordSettingsHashingMethodSha string = "sha" )
const ( // PoolPreferredAuthenticationMechanismTotp captures enum value "totp" PoolPreferredAuthenticationMechanismTotp string = "totp" // PoolPreferredAuthenticationMechanismPassword captures enum value "password" PoolPreferredAuthenticationMechanismPassword string = "password" // PoolPreferredAuthenticationMechanismOtp captures enum value "otp" PoolPreferredAuthenticationMechanismOtp string = "otp" // PoolPreferredAuthenticationMechanismEmailOtp captures enum value "email_otp" PoolPreferredAuthenticationMechanismEmailOtp string = "email_otp" // PoolPreferredAuthenticationMechanismSmsOtp captures enum value "sms_otp" PoolPreferredAuthenticationMechanismSmsOtp string = "sms_otp" // PoolPreferredAuthenticationMechanismVoiceOtp captures enum value "voice_otp" PoolPreferredAuthenticationMechanismVoiceOtp string = "voice_otp" // PoolPreferredAuthenticationMechanismWebauthn captures enum value "webauthn" PoolPreferredAuthenticationMechanismWebauthn string = "webauthn" // PoolPreferredAuthenticationMechanismUsernamelessWebauthn captures enum value "usernameless_webauthn" PoolPreferredAuthenticationMechanismUsernamelessWebauthn string = "usernameless_webauthn" // PoolPreferredAuthenticationMechanismPush captures enum value "push" PoolPreferredAuthenticationMechanismPush string = "push" // PoolPreferredAuthenticationMechanismSymbol captures enum value "symbol" PoolPreferredAuthenticationMechanismSymbol string = "symbol" // PoolPreferredAuthenticationMechanismQrCode captures enum value "qr_code" PoolPreferredAuthenticationMechanismQrCode string = "qr_code" )
const ( // PoolSecondFactorPreferredAuthenticationMechanismTotp captures enum value "totp" PoolSecondFactorPreferredAuthenticationMechanismTotp string = "totp" // PoolSecondFactorPreferredAuthenticationMechanismPassword captures enum value "password" PoolSecondFactorPreferredAuthenticationMechanismPassword string = "password" // PoolSecondFactorPreferredAuthenticationMechanismOtp captures enum value "otp" PoolSecondFactorPreferredAuthenticationMechanismOtp string = "otp" // PoolSecondFactorPreferredAuthenticationMechanismEmailOtp captures enum value "email_otp" PoolSecondFactorPreferredAuthenticationMechanismEmailOtp string = "email_otp" // PoolSecondFactorPreferredAuthenticationMechanismSmsOtp captures enum value "sms_otp" PoolSecondFactorPreferredAuthenticationMechanismSmsOtp string = "sms_otp" // PoolSecondFactorPreferredAuthenticationMechanismVoiceOtp captures enum value "voice_otp" PoolSecondFactorPreferredAuthenticationMechanismVoiceOtp string = "voice_otp" // PoolSecondFactorPreferredAuthenticationMechanismWebauthn captures enum value "webauthn" PoolSecondFactorPreferredAuthenticationMechanismWebauthn string = "webauthn" // PoolSecondFactorPreferredAuthenticationMechanismUsernamelessWebauthn captures enum value "usernameless_webauthn" PoolSecondFactorPreferredAuthenticationMechanismUsernamelessWebauthn string = "usernameless_webauthn" // PoolSecondFactorPreferredAuthenticationMechanismPush captures enum value "push" PoolSecondFactorPreferredAuthenticationMechanismPush string = "push" // PoolSecondFactorPreferredAuthenticationMechanismSymbol captures enum value "symbol" PoolSecondFactorPreferredAuthenticationMechanismSymbol string = "symbol" // PoolSecondFactorPreferredAuthenticationMechanismQrCode captures enum value "qr_code" PoolSecondFactorPreferredAuthenticationMechanismQrCode string = "qr_code" )
const ( // PoolResponsePreferredAuthenticationMechanismTotp captures enum value "totp" PoolResponsePreferredAuthenticationMechanismTotp string = "totp" // PoolResponsePreferredAuthenticationMechanismPassword captures enum value "password" PoolResponsePreferredAuthenticationMechanismPassword string = "password" // PoolResponsePreferredAuthenticationMechanismOtp captures enum value "otp" PoolResponsePreferredAuthenticationMechanismOtp string = "otp" // PoolResponsePreferredAuthenticationMechanismEmailOtp captures enum value "email_otp" PoolResponsePreferredAuthenticationMechanismEmailOtp string = "email_otp" // PoolResponsePreferredAuthenticationMechanismSmsOtp captures enum value "sms_otp" PoolResponsePreferredAuthenticationMechanismSmsOtp string = "sms_otp" // PoolResponsePreferredAuthenticationMechanismVoiceOtp captures enum value "voice_otp" PoolResponsePreferredAuthenticationMechanismVoiceOtp string = "voice_otp" // PoolResponsePreferredAuthenticationMechanismWebauthn captures enum value "webauthn" PoolResponsePreferredAuthenticationMechanismWebauthn string = "webauthn" // PoolResponsePreferredAuthenticationMechanismUsernamelessWebauthn captures enum value "usernameless_webauthn" PoolResponsePreferredAuthenticationMechanismUsernamelessWebauthn string = "usernameless_webauthn" // PoolResponsePreferredAuthenticationMechanismPush captures enum value "push" PoolResponsePreferredAuthenticationMechanismPush string = "push" // PoolResponsePreferredAuthenticationMechanismSymbol captures enum value "symbol" PoolResponsePreferredAuthenticationMechanismSymbol string = "symbol" // PoolResponsePreferredAuthenticationMechanismQrCode captures enum value "qr_code" PoolResponsePreferredAuthenticationMechanismQrCode string = "qr_code" )
const ( // PoolResponseSecondFactorPreferredAuthenticationMechanismTotp captures enum value "totp" PoolResponseSecondFactorPreferredAuthenticationMechanismTotp string = "totp" // PoolResponseSecondFactorPreferredAuthenticationMechanismPassword captures enum value "password" PoolResponseSecondFactorPreferredAuthenticationMechanismPassword string = "password" // PoolResponseSecondFactorPreferredAuthenticationMechanismOtp captures enum value "otp" PoolResponseSecondFactorPreferredAuthenticationMechanismOtp string = "otp" // PoolResponseSecondFactorPreferredAuthenticationMechanismEmailOtp captures enum value "email_otp" PoolResponseSecondFactorPreferredAuthenticationMechanismEmailOtp string = "email_otp" // PoolResponseSecondFactorPreferredAuthenticationMechanismSmsOtp captures enum value "sms_otp" PoolResponseSecondFactorPreferredAuthenticationMechanismSmsOtp string = "sms_otp" // PoolResponseSecondFactorPreferredAuthenticationMechanismVoiceOtp captures enum value "voice_otp" PoolResponseSecondFactorPreferredAuthenticationMechanismVoiceOtp string = "voice_otp" // PoolResponseSecondFactorPreferredAuthenticationMechanismWebauthn captures enum value "webauthn" PoolResponseSecondFactorPreferredAuthenticationMechanismWebauthn string = "webauthn" // PoolResponseSecondFactorPreferredAuthenticationMechanismUsernamelessWebauthn captures enum value "usernameless_webauthn" PoolResponseSecondFactorPreferredAuthenticationMechanismUsernamelessWebauthn string = "usernameless_webauthn" // PoolResponseSecondFactorPreferredAuthenticationMechanismPush captures enum value "push" PoolResponseSecondFactorPreferredAuthenticationMechanismPush string = "push" // PoolResponseSecondFactorPreferredAuthenticationMechanismSymbol captures enum value "symbol" PoolResponseSecondFactorPreferredAuthenticationMechanismSymbol string = "symbol" // PoolResponseSecondFactorPreferredAuthenticationMechanismQrCode captures enum value "qr_code" PoolResponseSecondFactorPreferredAuthenticationMechanismQrCode string = "qr_code" )
const ( // RequestAddWebAuthnWebauthnTypeRegular captures enum value "regular" RequestAddWebAuthnWebauthnTypeRegular string = "regular" // RequestAddWebAuthnWebauthnTypeDiscoverable captures enum value "discoverable" RequestAddWebAuthnWebauthnTypeDiscoverable string = "discoverable" )
const ( // RequestCodeTypeActivation captures enum value "activation" RequestCodeTypeActivation string = "activation" // RequestCodeTypeResetPassword captures enum value "reset_password" RequestCodeTypeResetPassword string = "reset_password" // RequestCodeTypeResetTotp captures enum value "reset_totp" RequestCodeTypeResetTotp string = "reset_totp" // RequestCodeTypeEnrollWebauthn captures enum value "enroll_webauthn" RequestCodeTypeEnrollWebauthn string = "enroll_webauthn" // RequestCodeTypeChallenge captures enum value "challenge" RequestCodeTypeChallenge string = "challenge" // RequestCodeTypeVerifyAddress captures enum value "verify_address" RequestCodeTypeVerifyAddress string = "verify_address" // RequestCodeTypeAuthentication captures enum value "authentication" RequestCodeTypeAuthentication string = "authentication" // RequestCodeTypePairDevice captures enum value "pair_device" RequestCodeTypePairDevice string = "pair_device" )
const ( // RequestCodeForUserTypeActivation captures enum value "activation" RequestCodeForUserTypeActivation string = "activation" // RequestCodeForUserTypeResetPassword captures enum value "reset_password" RequestCodeForUserTypeResetPassword string = "reset_password" // RequestCodeForUserTypeResetTotp captures enum value "reset_totp" RequestCodeForUserTypeResetTotp string = "reset_totp" // RequestCodeForUserTypeEnrollWebauthn captures enum value "enroll_webauthn" RequestCodeForUserTypeEnrollWebauthn string = "enroll_webauthn" // RequestCodeForUserTypeChallenge captures enum value "challenge" RequestCodeForUserTypeChallenge string = "challenge" // RequestCodeForUserTypeVerifyAddress captures enum value "verify_address" RequestCodeForUserTypeVerifyAddress string = "verify_address" // RequestCodeForUserTypeAuthentication captures enum value "authentication" RequestCodeForUserTypeAuthentication string = "authentication" // RequestCodeForUserTypePairDevice captures enum value "pair_device" RequestCodeForUserTypePairDevice string = "pair_device" )
const ( // Rfc6902PatchOperationOpAdd captures enum value "add" Rfc6902PatchOperationOpAdd string = "add" // Rfc6902PatchOperationOpRemove captures enum value "remove" Rfc6902PatchOperationOpRemove string = "remove" // Rfc6902PatchOperationOpReplace captures enum value "replace" Rfc6902PatchOperationOpReplace string = "replace" // Rfc6902PatchOperationOpMove captures enum value "move" Rfc6902PatchOperationOpMove string = "move" // Rfc6902PatchOperationOpCopy captures enum value "copy" Rfc6902PatchOperationOpCopy string = "copy" // Rfc6902PatchOperationOpTest captures enum value "test" Rfc6902PatchOperationOpTest string = "test" )
const ( // SelfRegisterUserWebauthnTypeRegular captures enum value "regular" SelfRegisterUserWebauthnTypeRegular string = "regular" // SelfRegisterUserWebauthnTypeDiscoverable captures enum value "discoverable" SelfRegisterUserWebauthnTypeDiscoverable string = "discoverable" )
const ( // SetPasswordStateRequestStateValid captures enum value "valid" SetPasswordStateRequestStateValid string = "valid" // SetPasswordStateRequestStateMustBeReset captures enum value "must_be_reset" SetPasswordStateRequestStateMustBeReset string = "must_be_reset" // SetPasswordStateRequestStateMustBeChanged captures enum value "must_be_changed" SetPasswordStateRequestStateMustBeChanged string = "must_be_changed" )
const ( // UpdateUserStatusActive captures enum value "active" UpdateUserStatusActive string = "active" // UpdateUserStatusInactive captures enum value "inactive" UpdateUserStatusInactive string = "inactive" // UpdateUserStatusDeleted captures enum value "deleted" UpdateUserStatusDeleted string = "deleted" // UpdateUserStatusNew captures enum value "new" UpdateUserStatusNew string = "new" )
const ( // UpdateUserVerifiableAddressPreferredContactMethodSms captures enum value "sms" UpdateUserVerifiableAddressPreferredContactMethodSms string = "sms" // UpdateUserVerifiableAddressPreferredContactMethodVoice captures enum value "voice" UpdateUserVerifiableAddressPreferredContactMethodVoice string = "voice" )
const ( // UpdateUserVerifiableAddressStatusActive captures enum value "active" UpdateUserVerifiableAddressStatusActive string = "active" // UpdateUserVerifiableAddressStatusInactive captures enum value "inactive" UpdateUserVerifiableAddressStatusInactive string = "inactive" )
const ( // UserStatusActive captures enum value "active" UserStatusActive string = "active" // UserStatusInactive captures enum value "inactive" UserStatusInactive string = "inactive" // UserStatusDeleted captures enum value "deleted" UserStatusDeleted string = "deleted" // UserStatusNew captures enum value "new" UserStatusNew string = "new" )
const ( // UserUserTypeJit captures enum value "jit" UserUserTypeJit string = "jit" // UserUserTypeStandard captures enum value "standard" UserUserTypeStandard string = "standard" // UserUserTypeScim captures enum value "scim" UserUserTypeScim string = "scim" )
const ( // UserCredentialStateValid captures enum value "valid" UserCredentialStateValid string = "valid" // UserCredentialStateMustBeReset captures enum value "must_be_reset" UserCredentialStateMustBeReset string = "must_be_reset" // UserCredentialStateMustBeChanged captures enum value "must_be_changed" UserCredentialStateMustBeChanged string = "must_be_changed" )
const ( // UserCredentialTypePassword captures enum value "password" UserCredentialTypePassword string = "password" // UserCredentialTypeWebauthn captures enum value "webauthn" UserCredentialTypeWebauthn string = "webauthn" // UserCredentialTypeTotp captures enum value "totp" UserCredentialTypeTotp string = "totp" // UserCredentialTypeDevice captures enum value "device" UserCredentialTypeDevice string = "device" )
const ( // UserIdentifierTypeEmail captures enum value "email" UserIdentifierTypeEmail string = "email" // UserIdentifierTypeMobile captures enum value "mobile" UserIdentifierTypeMobile string = "mobile" // UserIdentifierTypeUID captures enum value "uid" UserIdentifierTypeUID string = "uid" // UserIdentifierTypeExternal captures enum value "external" UserIdentifierTypeExternal string = "external" // UserIdentifierTypeFederated captures enum value "federated" UserIdentifierTypeFederated string = "federated" )
const ( // UserVerifiableAddressPreferredContactMethodSms captures enum value "sms" UserVerifiableAddressPreferredContactMethodSms string = "sms" // UserVerifiableAddressPreferredContactMethodVoice captures enum value "voice" UserVerifiableAddressPreferredContactMethodVoice string = "voice" )
const ( // UserVerifiableAddressStatusActive captures enum value "active" UserVerifiableAddressStatusActive string = "active" // UserVerifiableAddressStatusInactive captures enum value "inactive" UserVerifiableAddressStatusInactive string = "inactive" )
const ( // UserVerifiableAddressTypeEmail captures enum value "email" UserVerifiableAddressTypeEmail string = "email" // UserVerifiableAddressTypeMobile captures enum value "mobile" UserVerifiableAddressTypeMobile string = "mobile" )
const ( // UserWithDataStatusActive captures enum value "active" UserWithDataStatusActive string = "active" // UserWithDataStatusInactive captures enum value "inactive" UserWithDataStatusInactive string = "inactive" // UserWithDataStatusDeleted captures enum value "deleted" UserWithDataStatusDeleted string = "deleted" // UserWithDataStatusNew captures enum value "new" UserWithDataStatusNew string = "new" )
const ( // UserWithDataUserTypeJit captures enum value "jit" UserWithDataUserTypeJit string = "jit" // UserWithDataUserTypeStandard captures enum value "standard" UserWithDataUserTypeStandard string = "standard" // UserWithDataUserTypeScim captures enum value "scim" UserWithDataUserTypeScim string = "scim" )
const ( // VerifyPasswordResponseDataStateValid captures enum value "valid" VerifyPasswordResponseDataStateValid string = "valid" // VerifyPasswordResponseDataStateMustBeReset captures enum value "must_be_reset" VerifyPasswordResponseDataStateMustBeReset string = "must_be_reset" // VerifyPasswordResponseDataStateMustBeChanged captures enum value "must_be_changed" VerifyPasswordResponseDataStateMustBeChanged string = "must_be_changed" )
const ( // VerifyPasswordResponseDataV2ResultPasswordCorrect captures enum value "password_correct" VerifyPasswordResponseDataV2ResultPasswordCorrect string = "password_correct" // VerifyPasswordResponseDataV2ResultPasswordIncorrect captures enum value "password_incorrect" VerifyPasswordResponseDataV2ResultPasswordIncorrect string = "password_incorrect" // VerifyPasswordResponseDataV2ResultPasswordExpired captures enum value "password_expired" VerifyPasswordResponseDataV2ResultPasswordExpired string = "password_expired" // VerifyPasswordResponseDataV2ResultNoPassword captures enum value "no_password" VerifyPasswordResponseDataV2ResultNoPassword string = "no_password" // VerifyPasswordResponseDataV2ResultUserNotFound captures enum value "user_not_found" VerifyPasswordResponseDataV2ResultUserNotFound string = "user_not_found" )
const ( // VerifyPasswordResponseDataV2StateValid captures enum value "valid" VerifyPasswordResponseDataV2StateValid string = "valid" // VerifyPasswordResponseDataV2StateMustBeReset captures enum value "must_be_reset" VerifyPasswordResponseDataV2StateMustBeReset string = "must_be_reset" // VerifyPasswordResponseDataV2StateMustBeChanged captures enum value "must_be_changed" VerifyPasswordResponseDataV2StateMustBeChanged string = "must_be_changed" )
const ( // VerifyWebAuthnResponseDataResultWebauthnCorrect captures enum value "webauthn_correct" VerifyWebAuthnResponseDataResultWebauthnCorrect string = "webauthn_correct" // VerifyWebAuthnResponseDataResultWebauthnIncorrect captures enum value "webauthn_incorrect" VerifyWebAuthnResponseDataResultWebauthnIncorrect string = "webauthn_incorrect" // VerifyWebAuthnResponseDataResultUserNotFound captures enum value "user_not_found" VerifyWebAuthnResponseDataResultUserNotFound string = "user_not_found" // VerifyWebAuthnResponseDataResultNoWebauthn captures enum value "no_webauthn" VerifyWebAuthnResponseDataResultNoWebauthn string = "no_webauthn" )
const ( // VerifyWebAuthnResponseDataStateValid captures enum value "valid" VerifyWebAuthnResponseDataStateValid string = "valid" // VerifyWebAuthnResponseDataStateMustBeReset captures enum value "must_be_reset" VerifyWebAuthnResponseDataStateMustBeReset string = "must_be_reset" // VerifyWebAuthnResponseDataStateMustBeChanged captures enum value "must_be_changed" VerifyWebAuthnResponseDataStateMustBeChanged string = "must_be_changed" )
const ( // WebAuthnLoginBeginDataResultWebauthnCorrect captures enum value "webauthn_correct" WebAuthnLoginBeginDataResultWebauthnCorrect string = "webauthn_correct" // WebAuthnLoginBeginDataResultWebauthnIncorrect captures enum value "webauthn_incorrect" WebAuthnLoginBeginDataResultWebauthnIncorrect string = "webauthn_incorrect" // WebAuthnLoginBeginDataResultUserNotFound captures enum value "user_not_found" WebAuthnLoginBeginDataResultUserNotFound string = "user_not_found" // WebAuthnLoginBeginDataResultNoWebauthn captures enum value "no_webauthn" WebAuthnLoginBeginDataResultNoWebauthn string = "no_webauthn" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ActivateSelfRegisteredUser ¶
type ActivateSelfRegisteredUser struct {
// code
// Required: true
Code string `json:"code" yaml:"code"`
// otp address
OtpAddress string `json:"otp_address,omitempty" yaml:"otp_address,omitempty"`
// password
Password string `json:"password,omitempty" yaml:"password,omitempty"`
// totp secret
TotpSecret string `json:"totp_secret,omitempty" yaml:"totp_secret,omitempty"`
// webauthn
Webauthn []*WebAuthnCredential `json:"webauthn" yaml:"webauthn"`
// webauthn type
// Enum: ["regular","discoverable"]
WebauthnType string `json:"webauthn_type,omitempty" yaml:"webauthn_type,omitempty"`
}
ActivateSelfRegisteredUser activate self registered user
swagger:model ActivateSelfRegisteredUser
func (*ActivateSelfRegisteredUser) ContextValidate ¶
func (m *ActivateSelfRegisteredUser) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this activate self registered user based on the context it is used
func (*ActivateSelfRegisteredUser) MarshalBinary ¶
func (m *ActivateSelfRegisteredUser) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ActivateSelfRegisteredUser) UnmarshalBinary ¶
func (m *ActivateSelfRegisteredUser) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ActivationSettings ¶
type ActivationSettings struct {
// always allow preferred method setup
AlwaysAllowPreferredMethodSetup bool `json:"always_allow_preferred_method_setup,omitempty" yaml:"always_allow_preferred_method_setup,omitempty"`
}
ActivationSettings activation settings
swagger:model ActivationSettings
func (*ActivationSettings) ContextValidate ¶
ContextValidate validates this activation settings based on context it is used
func (*ActivationSettings) MarshalBinary ¶
func (m *ActivationSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ActivationSettings) UnmarshalBinary ¶
func (m *ActivationSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AddUserIdentifier ¶
type AddUserIdentifier struct {
// identifier
// Required: true
Identifier string `json:"identifier" yaml:"identifier"`
// identifier metadata
Metadata map[string]interface{} `json:"metadata,omitempty" yaml:"metadata,omitempty"`
// type
// Example: email
// Required: true
// Enum: ["email","mobile","uid","external","federated"]
Type string `json:"type" yaml:"type"`
}
AddUserIdentifier add user identifier
swagger:model AddUserIdentifier
func (*AddUserIdentifier) ContextValidate ¶
ContextValidate validates this add user identifier based on context it is used
func (*AddUserIdentifier) MarshalBinary ¶
func (m *AddUserIdentifier) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AddUserIdentifier) UnmarshalBinary ¶
func (m *AddUserIdentifier) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AddUserVerifiableAddress ¶
type AddUserVerifiableAddress struct {
// address
// Required: true
Address string `json:"address" yaml:"address"`
// is allowed for 2FA
AllowedFor2fa bool `json:"allowed_for_2fa,omitempty" yaml:"allowed_for_2fa,omitempty"`
// message redaction
MessageRedaction *RedactionPolicy `json:"message_redaction,omitempty" yaml:"message_redaction,omitempty"`
// general purpose metadata
Metadata map[string]interface{} `json:"metadata,omitempty" yaml:"metadata,omitempty"`
// preferred contact method
// Example: sms
// Enum: ["sms","voice"]
PreferredContactMethod string `json:"preferred_contact_method,omitempty" yaml:"preferred_contact_method,omitempty"`
// status
// Example: active
// Enum: ["active","inactive"]
Status string `json:"status,omitempty" yaml:"status,omitempty"`
// type
// Example: mobile
// Required: true
// Enum: ["email","mobile"]
Type string `json:"type" yaml:"type"`
// verified
// Required: true
Verified bool `json:"verified" yaml:"verified"`
}
AddUserVerifiableAddress add user verifiable address
swagger:model AddUserVerifiableAddress
func (*AddUserVerifiableAddress) ContextValidate ¶
func (m *AddUserVerifiableAddress) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this add user verifiable address based on the context it is used
func (*AddUserVerifiableAddress) MarshalBinary ¶
func (m *AddUserVerifiableAddress) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AddUserVerifiableAddress) UnmarshalBinary ¶
func (m *AddUserVerifiableAddress) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Address ¶
type Address struct {
// address
Address string `json:"address,omitempty" yaml:"address,omitempty"`
// verified
Verified bool `json:"verified,omitempty" yaml:"verified,omitempty"`
}
Address address
swagger:model Address
func (*Address) ContextValidate ¶
ContextValidate validates this address based on context it is used
func (*Address) MarshalBinary ¶
MarshalBinary interface implementation
func (*Address) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Argon2Config ¶
type Argon2Config struct {
// iterations
Iterations int64 `json:"iterations,omitempty" yaml:"iterations,omitempty"`
// key length
KeyLength int64 `json:"key_length,omitempty" yaml:"key_length,omitempty"`
// memory in kb
MemoryInKb int64 `json:"memory_in_kb,omitempty" yaml:"memory_in_kb,omitempty"`
// parallelism
Parallelism int64 `json:"parallelism,omitempty" yaml:"parallelism,omitempty"`
// salt
Salt string `json:"salt,omitempty" yaml:"salt,omitempty"`
// salt length
SaltLength int64 `json:"salt_length,omitempty" yaml:"salt_length,omitempty"`
}
Argon2Config argon2 config
swagger:model Argon2Config
func (*Argon2Config) ContextValidate ¶
ContextValidate validates this argon2 config based on context it is used
func (*Argon2Config) MarshalBinary ¶
func (m *Argon2Config) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Argon2Config) UnmarshalBinary ¶
func (m *Argon2Config) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AttestationFormat ¶
type AttestationFormat string
AttestationFormat AttestationFormat is an internal representation of the relevant inputs for registration.
Specification: §5.4 Options for Credential Creation (https://w3c.github.io/webauthn/#dom-publickeycredentialcreationoptions-attestationformats) Registry: https://www.iana.org/assignments/webauthn/webauthn.xhtml
swagger:model AttestationFormat
func (AttestationFormat) ContextValidate ¶
ContextValidate validates this attestation format based on context it is used
type Attribute ¶
type Attribute struct {
// canonical values
CanonicalValues []string `json:"canonicalValues" yaml:"canonicalValues"`
// case exact
CaseExact bool `json:"caseExact,omitempty" yaml:"caseExact,omitempty"`
// description
Description string `json:"description,omitempty" yaml:"description,omitempty"`
// multi valued
MultiValued bool `json:"multiValued,omitempty" yaml:"multiValued,omitempty"`
// mutability
Mutability string `json:"mutability,omitempty" yaml:"mutability,omitempty"`
// name
Name string `json:"name,omitempty" yaml:"name,omitempty"`
// reference types
ReferenceTypes []string `json:"referenceTypes" yaml:"referenceTypes"`
// required
Required bool `json:"required,omitempty" yaml:"required,omitempty"`
// returned
Returned string `json:"returned,omitempty" yaml:"returned,omitempty"`
// sub attributes
SubAttributes []*Attribute `json:"subAttributes" yaml:"subAttributes"`
// type
Type SCIMv2AttributeType `json:"type,omitempty" yaml:"type,omitempty"`
// uniqueness
Uniqueness string `json:"uniqueness,omitempty" yaml:"uniqueness,omitempty"`
}
Attribute attribute
swagger:model Attribute
func (*Attribute) ContextValidate ¶
ContextValidate validate this attribute based on the context it is used
func (*Attribute) MarshalBinary ¶
MarshalBinary interface implementation
func (*Attribute) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type AuthenticationExtensions ¶
type AuthenticationExtensions struct {
// AppID is the FIDO AppID Extension input. Authentication only.
Appid string `json:"appid,omitempty" yaml:"appid,omitempty"`
// AppIDExclude is the FIDO AppID Exclusion Extension input. Registration only.
AppidExclude string `json:"appidExclude,omitempty" yaml:"appidExclude,omitempty"`
// cred blob
CredBlob URLEncodedBase64 `json:"credBlob,omitempty" yaml:"credBlob,omitempty"`
// CredProps requests the Credential Properties Extension. Registration only.
CredProps bool `json:"credProps,omitempty" yaml:"credProps,omitempty"`
// credential protection policy
CredentialProtectionPolicy CredentialProtectionPolicy `json:"credentialProtectionPolicy,omitempty" yaml:"credentialProtectionPolicy,omitempty"`
// EnforceCredentialProtectionPolicy requires the credProtect policy is honoured. Registration only.
EnforceCredentialProtectionPolicy bool `json:"enforceCredentialProtectionPolicy,omitempty" yaml:"enforceCredentialProtectionPolicy,omitempty"`
// GetCredBlob requests the blob stored with the credential. Authentication only.
GetCredBlob bool `json:"getCredBlob,omitempty" yaml:"getCredBlob,omitempty"`
// HMACCreateSecret requests provisioning of the CTAP hmac-secret. Registration only.
HmacCreateSecret bool `json:"hmacCreateSecret,omitempty" yaml:"hmacCreateSecret,omitempty"`
// hmac get secret
HmacGetSecret *HMACGetSecretInputs `json:"hmacGetSecret,omitempty" yaml:"hmacGetSecret,omitempty"`
// large blob
LargeBlob *LargeBlobInputs `json:"largeBlob,omitempty" yaml:"largeBlob,omitempty"`
// MinPinLength requests the authenticator minimum PIN length. Registration only.
MinPinLength bool `json:"minPinLength,omitempty" yaml:"minPinLength,omitempty"`
// prf
Prf *PRFInputs `json:"prf,omitempty" yaml:"prf,omitempty"`
// RemoteClientDataJSON is the Remote Client Data JSON Extension input. This member is set by a remote desktop
// web client and a Relying Party should not normally set it. See [ExtensionRemoteClientDataJSON], which records
// that this extension is not yet ratified.
RemoteClientDataJSON string `json:"remoteClientDataJSON,omitempty" yaml:"remoteClientDataJSON,omitempty"`
// UVM requests the user verification methods used for the operation.
Uvm bool `json:"uvm,omitempty" yaml:"uvm,omitempty"`
}
AuthenticationExtensions AuthenticationExtensions represents the AuthenticationExtensionsClientInputs IDL. It contains additional parameters requesting additional processing by the client and authenticator.
Members are marshalled in the AuthenticationExtensionsClientInputsJSON form, i.e. buffer sources are base64url encoded strings, which is the form consumed by PublicKeyCredential.parseCreationOptionsFromJSON().
A JSON member whose key matches a modelled name only by case (e.g. "CredProps" for "credProps") is bound to that modelled field, not collected into [AuthenticationExtensions.Extra]: encoding/json resolves the case-insensitive match during the first decoding pass, before UnmarshalJSON ever sees the untyped member map. If such a member's value has the wrong type for the modelled field, unmarshalling fails outright rather than falling back to Extra. encoding/json (v1, the only version this module may use) offers no way to defer that binding.
Specification: §5.7.1. Authentication Extensions Client Inputs (https://www.w3.org/TR/webauthn-3/#iface-authentication-extensions-client-inputs)
Specification: §10.1. Client Extensions (https://www.w3.org/TR/webauthn-3/#sctn-defined-client-extensions)
swagger:model AuthenticationExtensions
func (*AuthenticationExtensions) ContextValidate ¶
func (m *AuthenticationExtensions) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this authentication extensions based on the context it is used
func (*AuthenticationExtensions) MarshalBinary ¶
func (m *AuthenticationExtensions) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AuthenticationExtensions) UnmarshalBinary ¶
func (m *AuthenticationExtensions) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AuthenticationExtensionsClientOutputs ¶
type AuthenticationExtensionsClientOutputs struct {
// AppID indicates the FIDO AppID Extension was acted upon.
Appid bool `json:"appid,omitempty" yaml:"appid,omitempty"`
// AppIDExclude indicates the FIDO AppID Exclusion Extension was acted upon.
AppidExclude bool `json:"appidExclude,omitempty" yaml:"appidExclude,omitempty"`
// cred props
CredProps *CredentialPropertiesOutput `json:"credProps,omitempty" yaml:"credProps,omitempty"`
// HMACCreateSecret indicates the CTAP hmac-secret was provisioned at registration.
HmacCreateSecret bool `json:"hmacCreateSecret,omitempty" yaml:"hmacCreateSecret,omitempty"`
// hmac get secret
HmacGetSecret *HMACGetSecretOutputs `json:"hmacGetSecret,omitempty" yaml:"hmacGetSecret,omitempty"`
// large blob
LargeBlob *LargeBlobOutputs `json:"largeBlob,omitempty" yaml:"largeBlob,omitempty"`
// prf
Prf *PRFOutputs `json:"prf,omitempty" yaml:"prf,omitempty"`
// RemoteClientDataJSON indicates the Remote Client Data JSON Extension was acted upon, which means the local
// client delegated every Relying Party ID and origin check to a remote host. See
// [ExtensionRemoteClientDataJSON], which records that this extension is not yet ratified.
RemoteClientDataJSON bool `json:"remoteClientDataJSON,omitempty" yaml:"remoteClientDataJSON,omitempty"`
}
AuthenticationExtensionsClientOutputs AuthenticationExtensionsClientOutputs represents the AuthenticationExtensionsClientOutputs IDL, returned by the client after a create() or get() call.
Every modelled member is a pointer so an absent value is distinguishable from a false or empty one; the unsolicited output check performed by [AuthenticationExtensionsClientOutputs.Verify] depends on that distinction.
A JSON member whose key matches a modelled name only by case (e.g. "AppID" for "appid") is bound to that modelled field, not collected into [AuthenticationExtensionsClientOutputs.Extra]: encoding/json resolves the case-insensitive match during the first decoding pass, before UnmarshalJSON ever sees the untyped member map. If such a member's value has the wrong type for the modelled field, unmarshalling fails outright rather than falling back to Extra. encoding/json (v1, the only version this module may use) offers no way to defer that binding.
Specification: §5.9. Authentication Extensions Client Outputs (https://www.w3.org/TR/webauthn-3/#iface-authentication-extensions-client-outputs)
swagger:model AuthenticationExtensionsClientOutputs
func (*AuthenticationExtensionsClientOutputs) ContextValidate ¶
func (m *AuthenticationExtensionsClientOutputs) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this authentication extensions client outputs based on the context it is used
func (*AuthenticationExtensionsClientOutputs) MarshalBinary ¶
func (m *AuthenticationExtensionsClientOutputs) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AuthenticationExtensionsClientOutputs) UnmarshalBinary ¶
func (m *AuthenticationExtensionsClientOutputs) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
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 AuthenticationScheme ¶
type AuthenticationScheme struct {
// description
Description string `json:"description,omitempty" yaml:"description,omitempty"`
// documentation Uri
DocumentationURI string `json:"documentationUri,omitempty" yaml:"documentationUri,omitempty"`
// name
Name string `json:"name,omitempty" yaml:"name,omitempty"`
// primary
Primary bool `json:"primary,omitempty" yaml:"primary,omitempty"`
// spec Uri
SpecURI string `json:"specUri,omitempty" yaml:"specUri,omitempty"`
// type
Type string `json:"type,omitempty" yaml:"type,omitempty"`
}
AuthenticationScheme authentication scheme
swagger:model AuthenticationScheme
func (*AuthenticationScheme) ContextValidate ¶
ContextValidate validates this authentication scheme based on context it is used
func (*AuthenticationScheme) MarshalBinary ¶
func (m *AuthenticationScheme) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AuthenticationScheme) UnmarshalBinary ¶
func (m *AuthenticationScheme) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
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 string `json:"AAGUID,omitempty" yaml:"AAGUID,omitempty"`
// attachment
Attachment AuthenticatorAttachment `json:"attachment,omitempty" yaml:"attachment,omitempty"`
// CloneWarning 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 is a representation of the number of times the Authenticator or Credential have been used to login.
// 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 represents a specific authenticator in the context of a Credential.
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 AuthenticatorAssertionResponse ¶
type AuthenticatorAssertionResponse struct {
// authenticator data
AuthenticatorData URLEncodedBase64 `json:"authenticatorData,omitempty" yaml:"authenticatorData,omitempty"`
// client data JSON
ClientDataJSON URLEncodedBase64 `json:"clientDataJSON,omitempty" yaml:"clientDataJSON,omitempty"`
// signature
Signature URLEncodedBase64 `json:"signature,omitempty" yaml:"signature,omitempty"`
// user handle
UserHandle URLEncodedBase64 `json:"userHandle,omitempty" yaml:"userHandle,omitempty"`
}
AuthenticatorAssertionResponse The AuthenticatorAssertionResponse contains the raw authenticator assertion data and is parsed into [ParsedAssertionResponse].
swagger:model AuthenticatorAssertionResponse
func (*AuthenticatorAssertionResponse) ContextValidate ¶
func (m *AuthenticatorAssertionResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this authenticator assertion response based on the context it is used
func (*AuthenticatorAssertionResponse) MarshalBinary ¶
func (m *AuthenticatorAssertionResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AuthenticatorAssertionResponse) UnmarshalBinary ¶
func (m *AuthenticatorAssertionResponse) 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 AuthenticatorSelection ¶
type AuthenticatorSelection struct {
// authenticator attachment
AuthenticatorAttachment AuthenticatorAttachment `json:"authenticatorAttachment,omitempty" yaml:"authenticatorAttachment,omitempty"`
// RequireResidentKey this member describes the Relying Party's requirements regarding resident
// credentials. If the parameter is set to true, the authenticator MUST create a client-side-resident
// public key credential source when creating a public key credential.
RequireResidentKey bool `json:"requireResidentKey,omitempty" yaml:"requireResidentKey,omitempty"`
// resident key
ResidentKey ResidentKeyRequirement `json:"residentKey,omitempty" yaml:"residentKey,omitempty"`
// user verification
UserVerification UserVerificationRequirement `json:"userVerification,omitempty" yaml:"userVerification,omitempty"`
}
AuthenticatorSelection AuthenticatorSelection represents the AuthenticatorSelectionCriteria IDL.
WebAuthn Relying Parties may use the AuthenticatorSelectionCriteria dictionary to specify their requirements regarding authenticator attributes.
Specification: §5.4.4. Authenticator Selection Criteria (https://www.w3.org/TR/webauthn/#dictionary-authenticatorSelection)
swagger:model AuthenticatorSelection
func (*AuthenticatorSelection) ContextValidate ¶
func (m *AuthenticatorSelection) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this authenticator selection based on the context it is used
func (*AuthenticatorSelection) MarshalBinary ¶
func (m *AuthenticatorSelection) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AuthenticatorSelection) UnmarshalBinary ¶
func (m *AuthenticatorSelection) 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 BaseGroup ¶
type BaseGroup struct {
// description
Description string `json:"description,omitempty" yaml:"description,omitempty"`
// id
ID string `json:"id,omitempty" yaml:"id,omitempty"`
// name
Name string `json:"name,omitempty" yaml:"name,omitempty"`
// parent id
ParentID string `json:"parent_id,omitempty" yaml:"parent_id,omitempty"`
// tenant id
TenantID string `json:"tenant_id,omitempty" yaml:"tenant_id,omitempty"`
// user pool id
// Example: default
// Required: true
UserPoolID string `json:"user_pool_id" yaml:"user_pool_id"`
}
BaseGroup base group
swagger:model BaseGroup
func (*BaseGroup) ContextValidate ¶
ContextValidate validates this base group based on context it is used
func (*BaseGroup) MarshalBinary ¶
MarshalBinary interface implementation
func (*BaseGroup) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type BaseVerifyOTP ¶
type BaseVerifyOTP struct {
// code
// Required: true
Code string `json:"code" yaml:"code"`
// identifier
// Example: sample@email.com/+48123456789
Identifier string `json:"identifier,omitempty" yaml:"identifier,omitempty"`
// user ID
UserID string `json:"userID,omitempty" yaml:"userID,omitempty"`
}
BaseVerifyOTP base verify o t p
swagger:model BaseVerifyOTP
func (*BaseVerifyOTP) ContextValidate ¶
ContextValidate validates this base verify o t p based on context it is used
func (*BaseVerifyOTP) MarshalBinary ¶
func (m *BaseVerifyOTP) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BaseVerifyOTP) UnmarshalBinary ¶
func (m *BaseVerifyOTP) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BcryptConfig ¶
type BcryptConfig struct {
// cost
Cost int64 `json:"cost,omitempty" yaml:"cost,omitempty"`
}
BcryptConfig bcrypt config
swagger:model BcryptConfig
func (*BcryptConfig) ContextValidate ¶
ContextValidate validates this bcrypt config based on context it is used
func (*BcryptConfig) MarshalBinary ¶
func (m *BcryptConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BcryptConfig) UnmarshalBinary ¶
func (m *BcryptConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BeginVerifyWebAuthnRequest ¶
type BeginVerifyWebAuthnRequest struct {
// identifier
Identifier string `json:"identifier,omitempty" yaml:"identifier,omitempty"`
// user ID
UserID string `json:"userID,omitempty" yaml:"userID,omitempty"`
}
BeginVerifyWebAuthnRequest BeginVerifyWebAuthnRequest starts a WebAuthn assertion ceremony.
Either userID or identifier must be provided.
swagger:model BeginVerifyWebAuthnRequest
func (*BeginVerifyWebAuthnRequest) ContextValidate ¶
func (m *BeginVerifyWebAuthnRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this begin verify web authn request based on context it is used
func (*BeginVerifyWebAuthnRequest) MarshalBinary ¶
func (m *BeginVerifyWebAuthnRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BeginVerifyWebAuthnRequest) UnmarshalBinary ¶
func (m *BeginVerifyWebAuthnRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BulkSupport ¶
type BulkSupport struct {
// max operations
MaxOperations int64 `json:"maxOperations,omitempty" yaml:"maxOperations,omitempty"`
// max payload size
MaxPayloadSize int64 `json:"maxPayloadSize,omitempty" yaml:"maxPayloadSize,omitempty"`
// supported
Supported bool `json:"supported,omitempty" yaml:"supported,omitempty"`
}
BulkSupport bulk support
swagger:model BulkSupport
func (*BulkSupport) ContextValidate ¶
ContextValidate validates this bulk support based on context it is used
func (*BulkSupport) MarshalBinary ¶
func (m *BulkSupport) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BulkSupport) UnmarshalBinary ¶
func (m *BulkSupport) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type COSEAlgorithmIdentifier ¶
type COSEAlgorithmIdentifier int64
COSEAlgorithmIdentifier COSEAlgorithmIdentifier is a number identifying a cryptographic algorithm. The algorithm identifiers SHOULD be values registered in the IANA COSE Algorithms registry [https://www.w3.org/TR/webauthn/#biblio-iana-cose-algs-reg], for instance, -7 for "ES256" and -257 for "RS256".
Specification: §5.8.5. Cryptographic Algorithm Identifier (https://www.w3.org/TR/webauthn/#sctn-alg-identifier)
swagger:model COSEAlgorithmIdentifier
func (COSEAlgorithmIdentifier) ContextValidate ¶
func (m COSEAlgorithmIdentifier) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this c o s e algorithm identifier 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 Code ¶
type Code struct {
// code
// Required: true
Code *CodeValue `json:"code" yaml:"code"`
// created at
// Format: date-time
CreatedAt strfmt.DateTime `json:"created_at,omitempty" yaml:"created_at,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"`
// issued at
// Format: date-time
IssuedAt strfmt.DateTime `json:"issued_at,omitempty" yaml:"issued_at,omitempty"`
// general purpose metadata
Metadata map[string]interface{} `json:"metadata,omitempty" yaml:"metadata,omitempty"`
// tenant id
// Example: default
// Required: true
TenantID string `json:"tenant_id" yaml:"tenant_id"`
// type
// Example: active
// Required: true
// Enum: ["activation","reset_password","reset_totp","enroll_webauthn","challenge","verify_address","authentication","pair_device"]
Type string `json:"type" yaml:"type"`
// user id
// Required: true
UserID string `json:"user_id" yaml:"user_id"`
// user pool id
// Example: default
// Required: true
UserPoolID string `json:"user_pool_id" yaml:"user_pool_id"`
// verifiable address id
VerifiableAddressID string `json:"verifiable_address_id,omitempty" yaml:"verifiable_address_id,omitempty"`
}
Code code
swagger:model Code
func (*Code) ContextValidate ¶
ContextValidate validate this code based on the context it is used
func (*Code) MarshalBinary ¶
MarshalBinary interface implementation
func (*Code) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type CodeID ¶
type CodeID struct {
// code id
// Required: true
CodeID string `json:"code_id" yaml:"code_id"`
}
CodeID code ID
swagger:model CodeID
func (*CodeID) ContextValidate ¶
ContextValidate validates this code ID based on context it is used
func (*CodeID) MarshalBinary ¶
MarshalBinary interface implementation
func (*CodeID) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type CodeValue ¶
type CodeValue struct {
// hashed code
HashedCode *Hash `json:"hashed_code,omitempty" yaml:"hashed_code,omitempty"`
}
CodeValue code value
swagger:model CodeValue
func (*CodeValue) ContextValidate ¶
ContextValidate validate this code value based on the context it is used
func (*CodeValue) MarshalBinary ¶
MarshalBinary interface implementation
func (*CodeValue) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Codes ¶
type Codes struct {
// code
// Required: true
Code string `json:"code" yaml:"code"`
// extended code
// Required: true
ExtendedCode string `json:"extended_code" yaml:"extended_code"`
}
Codes codes
swagger:model Codes
func (*Codes) ContextValidate ¶
ContextValidate validates this codes based on context it is used
func (*Codes) MarshalBinary ¶
MarshalBinary interface implementation
func (*Codes) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type CompleteAddWebAuthn ¶
type CompleteAddWebAuthn struct {
// address
Address string `json:"address,omitempty" yaml:"address,omitempty"`
// code
// Required: true
Code string `json:"code" yaml:"code"`
// identifier
Identifier string `json:"identifier,omitempty" yaml:"identifier,omitempty"`
// new web authn
// Required: true
NewWebAuthn *WebAuthnCredential `json:"new_web_authn" yaml:"new_web_authn"`
// user ID
UserID string `json:"userID,omitempty" yaml:"userID,omitempty"`
// Webauthn credential type. When omitted, defaults to regular.
// Enum: ["regular","discoverable"]
WebauthnType string `json:"webauthn_type,omitempty" yaml:"webauthn_type,omitempty"`
}
CompleteAddWebAuthn complete add web authn
swagger:model CompleteAddWebAuthn
func (*CompleteAddWebAuthn) ContextValidate ¶
ContextValidate validate this complete add web authn based on the context it is used
func (*CompleteAddWebAuthn) MarshalBinary ¶
func (m *CompleteAddWebAuthn) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CompleteAddWebAuthn) UnmarshalBinary ¶
func (m *CompleteAddWebAuthn) 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 CompleteResetPassword ¶
type CompleteResetPassword struct {
// address
Address string `json:"address,omitempty" yaml:"address,omitempty"`
// 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"`
// user ID
UserID string `json:"userID,omitempty" yaml:"userID,omitempty"`
}
CompleteResetPassword complete reset password
swagger:model CompleteResetPassword
func (*CompleteResetPassword) ContextValidate ¶
ContextValidate validates this complete reset password based on context it is used
func (*CompleteResetPassword) MarshalBinary ¶
func (m *CompleteResetPassword) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CompleteResetPassword) UnmarshalBinary ¶
func (m *CompleteResetPassword) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CompleteResetTotp ¶
type CompleteResetTotp struct {
// address
Address string `json:"address,omitempty" yaml:"address,omitempty"`
// code
// Required: true
Code string `json:"code" yaml:"code"`
// identifier
Identifier string `json:"identifier,omitempty" yaml:"identifier,omitempty"`
// new totp secret
// Required: true
NewTotpSecret string `json:"new_totp_secret" yaml:"new_totp_secret"`
// user ID
UserID string `json:"userID,omitempty" yaml:"userID,omitempty"`
}
CompleteResetTotp complete reset totp
swagger:model CompleteResetTotp
func (*CompleteResetTotp) ContextValidate ¶
ContextValidate validates this complete reset totp based on context it is used
func (*CompleteResetTotp) MarshalBinary ¶
func (m *CompleteResetTotp) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CompleteResetTotp) UnmarshalBinary ¶
func (m *CompleteResetTotp) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CompleteVerifyWebAuthnRequest ¶
type CompleteVerifyWebAuthnRequest struct {
// assertion
// Required: true
Assertion *CredentialAssertionResponse `json:"assertion" yaml:"assertion"`
// session id
// Required: true
SessionID string `json:"session_id" yaml:"session_id"`
}
CompleteVerifyWebAuthnRequest CompleteVerifyWebAuthnRequest is the body for both /webauthn/login/complete and usernameless-webauthn/login/complete — the variants only differ in the begin flow that produced session_id. The user identity is already bound to session_id at begin time, so it is not repeated here.
swagger:model CompleteVerifyWebAuthnRequest
func (*CompleteVerifyWebAuthnRequest) ContextValidate ¶
func (m *CompleteVerifyWebAuthnRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this complete verify web authn request based on the context it is used
func (*CompleteVerifyWebAuthnRequest) MarshalBinary ¶
func (m *CompleteVerifyWebAuthnRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CompleteVerifyWebAuthnRequest) UnmarshalBinary ¶
func (m *CompleteVerifyWebAuthnRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ConfirmResetPassword ¶
type ConfirmResetPassword 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"`
// user ID
UserID string `json:"userID,omitempty" yaml:"userID,omitempty"`
}
ConfirmResetPassword confirm reset password
swagger:model ConfirmResetPassword
func (*ConfirmResetPassword) ContextValidate ¶
ContextValidate validates this confirm reset password based on context it is used
func (*ConfirmResetPassword) MarshalBinary ¶
func (m *ConfirmResetPassword) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ConfirmResetPassword) UnmarshalBinary ¶
func (m *ConfirmResetPassword) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ConveyancePreference ¶
type ConveyancePreference string
ConveyancePreference ConveyancePreference is the type representing the AttestationConveyancePreference IDL.
WebAuthn Relying Parties may use AttestationConveyancePreference to specify their preference regarding attestation conveyance during credential generation.
Specification: §5.4.7. Attestation Conveyance Preference Enumeration (https://www.w3.org/TR/webauthn/#enum-attestation-convey)
swagger:model ConveyancePreference
func (ConveyancePreference) ContextValidate ¶
ContextValidate validates this conveyance preference based on context it is used
type Credential ¶
type Credential struct {
// attestation
Attestation *CredentialAttestation `json:"attestation,omitempty" yaml:"attestation,omitempty"`
// AttestationFormat is the attestation statement format identifier ("packed", "tpm", "android-key",
// "android-safetynet", "fido-u2f", "apple", "compound", "none"); see §8 of the WebAuthn specification and
// the AttestationFormat constants in the protocol package.
AttestationFormat string `json:"attestationFormat,omitempty" yaml:"attestationFormat,omitempty"`
// AttestationType is the attestation type as conveyed by the authenticator during the registration ceremonyl
// one of the values defined by [metadata.AuthenticatorAttestationType] ("basic_full", "basic_surrogate",
// "attca", "anonca", "ecdaa", "none"). Prior releases incorrectly stored the attestation FORMAT here; see the
// custom [Credential.UnmarshalJSON] for the backward-compatibility migration applied when decoding such
// records.
AttestationType string `json:"attestationType,omitempty" yaml:"attestationType,omitempty"`
// authenticator
Authenticator *Authenticator `json:"authenticator,omitempty" yaml:"authenticator,omitempty"`
// extensions
Extensions *CredentialExtensions `json:"extensions,omitempty" yaml:"extensions,omitempty"`
// flags
Flags *CredentialFlags `json:"flags,omitempty" yaml:"flags,omitempty"`
// The ID is the ID of the public key credential source. Described by the Credential Record 'id' field.
ID string `json:"id,omitempty" yaml:"id,omitempty"`
// The credential public key of the public key credential source. Described by the Credential Record 'publicKey'
// field.
PublicKey string `json:"publicKey,omitempty" yaml:"publicKey,omitempty"`
// Transport types the authenticator supports. Described by the Credential Record 'transports' field.
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.
Provided this data structure is preserved properly, a Credential can be verified against the FIDO Metadata Service at a later date using the [Credential.Verify] method with a [metadata.Provider].
It is strongly recommended for the best security that a Credential is encrypted at rest with the exception of the ID and the value you use to lookup the user. This prevents a person with access to the database being able to compromise privacy by being able to view this data, as well as prevents them being able to compromise security by adding or modifying a Credential without them also having access to the encryption key.
For consolidated persistence guidance; recommended schema shape, required lookup columns, and which fields must be written back on every successful FinishLogin / ValidateLogin; see the Storage section of the github.com/go-webauthn/webauthn/webauthn package documentation.
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 CredentialAssertionResponse ¶
type CredentialAssertionResponse 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.
// Required: true
ID string `json:"id" yaml:"id"`
// raw Id
// Required: true
RawID *URLEncodedBase64 `json:"rawId" yaml:"rawId"`
// response
// Required: true
Response *AuthenticatorAssertionResponse `json:"response" yaml:"response"`
// 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.
// Required: true
Type string `json:"type" yaml:"type"`
}
CredentialAssertionResponse The CredentialAssertionResponse is the raw response returned to the Relying Party from an authenticator when we request a credential for login/assertion.
swagger:model CredentialAssertionResponse
func (*CredentialAssertionResponse) ContextValidate ¶
func (m *CredentialAssertionResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this credential assertion response based on the context it is used
func (*CredentialAssertionResponse) MarshalBinary ¶
func (m *CredentialAssertionResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CredentialAssertionResponse) UnmarshalBinary ¶
func (m *CredentialAssertionResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CredentialAttestation ¶
type CredentialAttestation struct {
// AuthenticatorData is the raw authenticator data from the registration response as provided in the
// RegistrationResponseJSON. This is the unparsed byte representation that can be re-parsed for future validation.
AuthenticatorData string `json:"authenticatorData,omitempty" yaml:"authenticatorData,omitempty"`
// ClientDataHash is the SHA-256 hash of ClientDataJSON computed during registration verification. If empty,
// [Credential.Verify] will recompute it from ClientDataJSON.
ClientDataHash string `json:"clientDataHash,omitempty" yaml:"clientDataHash,omitempty"`
// ClientDataJSON is the raw JSON-encoded client data from the registration response. This is the verbatim value
// provided by the client and is used to recompute the client data hash during later verification.
ClientDataJSON string `json:"clientDataJSON,omitempty" yaml:"clientDataJSON,omitempty"`
// Object is the raw CBOR-encoded attestation object from the registration response. This contains the attestation
// statement, format, and authenticator data needed by [Credential.Verify] to re-perform attestation verification.
Object string `json:"object,omitempty" yaml:"object,omitempty"`
// PublicKeyAlgorithm is the COSE algorithm identifier for the credential's public key.
PublicKeyAlgorithm int64 `json:"publicKeyAlgorithm,omitempty" yaml:"publicKeyAlgorithm,omitempty"`
}
CredentialAttestation CredentialAttestation holds the raw attestation data from a registration ceremony. These values are intentionally stored in their original unparsed form rather than as parsed structures. This is critical because:
It enables the Credential to be verified against the FIDO Metadata Service at a later date using [Credential.Verify], even long after the registration ceremony has completed. The WebAuthn specification evolves over time, introducing new validation procedures. Preserving the raw data ensures that credentials created today can be re-validated against future rules without requiring re-registration. Raw data serves as an auditable record of exactly what the authenticator and client provided during registration, independent of how the library parsed it at that point in time.
Implementers MUST persist all fields of this struct.
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 CredentialCreation ¶
type CredentialCreation struct {
// mediation
Mediation CredentialMediationRequirement `json:"mediation,omitempty" yaml:"mediation,omitempty"`
// public key
PublicKey *PublicKeyCredentialCreationOptions `json:"publicKey,omitempty" yaml:"publicKey,omitempty"`
}
CredentialCreation CredentialCreation is the top-level request object for credential registration. It wraps PublicKeyCredentialCreationOptions and an optional mediation requirement. This is the object that should be serialized and sent to the client to initiate the navigator.credentials.create() call.
Specification: §5.4. Options for Credential Creation (https://www.w3.org/TR/webauthn/#dictionary-makecredentialoptions)
swagger:model CredentialCreation
func (*CredentialCreation) ContextValidate ¶
ContextValidate validate this credential creation based on the context it is used
func (*CredentialCreation) MarshalBinary ¶
func (m *CredentialCreation) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CredentialCreation) UnmarshalBinary ¶
func (m *CredentialCreation) 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.
// Required: true
ID string `json:"id" yaml:"id"`
// raw Id
// Required: true
RawID *URLEncodedBase64 `json:"rawId" yaml:"rawId"`
// response
// Required: true
Response *AuthenticatorAttestationResponse `json:"response" yaml:"response"`
// 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.
// Required: true
Type string `json:"type" yaml:"type"`
}
CredentialCreationResponse CredentialCreationResponse is the raw response returned to the Relying Party from the client for a credential registration ceremony. It contains the AuthenticatorAttestationResponse which holds the attestation object and client data.
Specification: §5.4. Options for Credential Creation (https://www.w3.org/TR/webauthn/#sctn-credentialcreationoptions-extension)
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 CredentialExtensions ¶
type CredentialExtensions struct {
// CredBlobSet reports whether the blob submitted with [WithExtensionCredBlob] at registration was stored by
// the authenticator, which is what determines whether requesting [WithExtensionGetCredBlob] at authentication
// can return anything.
CredBlobSet bool `json:"credBlobSet,omitempty" yaml:"credBlobSet,omitempty"`
// cred protect
CredProtect CredentialProtectionPolicy `json:"credProtect,omitempty" yaml:"credProtect,omitempty"`
// HMACSecret reports whether the authenticator provisioned a CTAP hmac-secret for this credential, which is
// what determines whether requesting [WithExtensionHMACGetSecret] at authentication can succeed.
//
// The value is taken from the authenticator extension outputs where present, because those are covered by the
// attestation signature, and from the client's 'hmacCreateSecret' output otherwise. The two are the signed and
// client-reported views of one capability rather than two separate properties, so they share a field.
//
// This is a sibling of PRFEnabled rather than a duplicate of it: the pseudo-random function extension is the
// WebAuthn level abstraction over the same authenticator capability, and a client may report either, both, or
// neither depending on which extension the Relying Party requested.
HmacSecret bool `json:"hmacSecret,omitempty" yaml:"hmacSecret,omitempty"`
// LargeBlobSupported reports whether the credential supports large blob storage.
LargeBlobSupported bool `json:"largeBlobSupported,omitempty" yaml:"largeBlobSupported,omitempty"`
// MinPinLength is the authenticator's minimum PIN length at the time of registration.
MinPinLength uint64 `json:"minPinLength,omitempty" yaml:"minPinLength,omitempty"`
// PRFEnabled reports whether the pseudo-random function is available for this credential. It is populated when
// the registration requested the extension, typically with [WithExtensionPRFSupport].
PrfEnabled bool `json:"prfEnabled,omitempty" yaml:"prfEnabled,omitempty"`
// RK reports whether the credential is client-side discoverable, from the credProps extension. A false value
// is meaningful and distinct from the client not reporting the property.
Rk bool `json:"rk,omitempty" yaml:"rk,omitempty"`
}
CredentialExtensions CredentialExtensions holds the extension results recorded at registration which remain meaningful for the life of the credential.
swagger:model CredentialExtensions
func (*CredentialExtensions) ContextValidate ¶
ContextValidate validate this credential extensions based on the context it is used
func (*CredentialExtensions) MarshalBinary ¶
func (m *CredentialExtensions) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CredentialExtensions) UnmarshalBinary ¶
func (m *CredentialExtensions) 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. On a credential record this is the uvInitialized value
// of the specification, which is latched: once an assertion has verified the user it stays true, because
// [CredentialFlags.Update] only advances it. Read the UV flag of a ceremony's own authenticator data to
// determine whether that ceremony verified the user.
UserVerified bool `json:"userVerified,omitempty" yaml:"userVerified,omitempty"`
}
CredentialFlags CredentialFlags contains the boolean flags derived from the authenticator data during registration or login.
These flags indicate the state of user presence, user verification, and backup eligibility/state at the time the credential was used.
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 CredentialMediationRequirement ¶
type CredentialMediationRequirement string
CredentialMediationRequirement CredentialMediationRequirement represents mediation requirements for clients. When making a request via get(options) or create(options), developers can set a case-by-case requirement for user mediation by choosing the appropriate CredentialMediationRequirement enum value.
See https://www.w3.org/TR/credential-management-1/#mediation-requirements
swagger:model CredentialMediationRequirement
func (CredentialMediationRequirement) ContextValidate ¶
func (m CredentialMediationRequirement) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this credential mediation requirement based on context it is used
type CredentialParameter ¶
type CredentialParameter struct {
// alg
Alg COSEAlgorithmIdentifier `json:"alg,omitempty" yaml:"alg,omitempty"`
// type
Type CredentialType `json:"type,omitempty" yaml:"type,omitempty"`
}
CredentialParameter CredentialParameter is the credential type and algorithm that the relying party wants the authenticator to create.
swagger:model CredentialParameter
func (*CredentialParameter) ContextValidate ¶
ContextValidate validate this credential parameter based on the context it is used
func (*CredentialParameter) MarshalBinary ¶
func (m *CredentialParameter) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CredentialParameter) UnmarshalBinary ¶
func (m *CredentialParameter) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CredentialPropertiesOutput ¶
type CredentialPropertiesOutput struct {
// RK reports whether the created credential is a client-side discoverable credential. A false value is
// meaningful and distinct from the client not reporting the property at all.
Rk bool `json:"rk,omitempty" yaml:"rk,omitempty"`
}
CredentialPropertiesOutput CredentialPropertiesOutput represents the CredentialPropertiesOutput IDL. The editor's draft defines no member other than rk.
Specification: §10.1.3. Credential Properties Extension (https://www.w3.org/TR/webauthn-3/#sctn-authenticator-credential-properties-extension)
swagger:model CredentialPropertiesOutput
func (*CredentialPropertiesOutput) ContextValidate ¶
func (m *CredentialPropertiesOutput) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this credential properties output based on context it is used
func (*CredentialPropertiesOutput) MarshalBinary ¶
func (m *CredentialPropertiesOutput) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CredentialPropertiesOutput) UnmarshalBinary ¶
func (m *CredentialPropertiesOutput) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CredentialProtectionPolicy ¶
type CredentialProtectionPolicy string
CredentialProtectionPolicy CredentialProtectionPolicy represents the credential protection policy values of the CTAP credProtect extension.
Registry: https://www.iana.org/assignments/webauthn/webauthn.xhtml
swagger:model CredentialProtectionPolicy
func (CredentialProtectionPolicy) ContextValidate ¶
func (m CredentialProtectionPolicy) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this credential protection policy based on context it is used
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 Cursor ¶
type Cursor string
Cursor cursor
swagger:model Cursor
func (Cursor) ContextValidate ¶
ContextValidate validates this cursor based on context it is used
type DeleteUserIdentifier ¶
type DeleteUserIdentifier struct {
// identifier
// Required: true
Identifier string `json:"identifier" yaml:"identifier"`
}
DeleteUserIdentifier delete user identifier
swagger:model DeleteUserIdentifier
func (*DeleteUserIdentifier) ContextValidate ¶
ContextValidate validates this delete user identifier based on context it is used
func (*DeleteUserIdentifier) MarshalBinary ¶
func (m *DeleteUserIdentifier) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeleteUserIdentifier) UnmarshalBinary ¶
func (m *DeleteUserIdentifier) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeleteUserVerifiableAddress ¶
type DeleteUserVerifiableAddress struct {
// address
// Required: true
Address string `json:"address" yaml:"address"`
}
DeleteUserVerifiableAddress delete user verifiable address
swagger:model DeleteUserVerifiableAddress
func (*DeleteUserVerifiableAddress) ContextValidate ¶
func (m *DeleteUserVerifiableAddress) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this delete user verifiable address based on context it is used
func (*DeleteUserVerifiableAddress) MarshalBinary ¶
func (m *DeleteUserVerifiableAddress) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeleteUserVerifiableAddress) UnmarshalBinary ¶
func (m *DeleteUserVerifiableAddress) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceToSet ¶
type DeviceToSet struct {
// external id
ExternalID string `json:"external_id,omitempty" yaml:"external_id,omitempty"`
}
DeviceToSet device to set
swagger:model DeviceToSet
func (*DeviceToSet) ContextValidate ¶
ContextValidate validates this device to set based on context it is used
func (*DeviceToSet) MarshalBinary ¶
func (m *DeviceToSet) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceToSet) UnmarshalBinary ¶
func (m *DeviceToSet) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DevicesToSet ¶
type DevicesToSet struct {
// devices
Devices []*DeviceToSet `json:"devices" yaml:"devices"`
}
DevicesToSet devices to set
swagger:model DevicesToSet
func (*DevicesToSet) ContextValidate ¶
ContextValidate validate this devices to set based on the context it is used
func (*DevicesToSet) MarshalBinary ¶
func (m *DevicesToSet) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DevicesToSet) UnmarshalBinary ¶
func (m *DevicesToSet) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
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 ExtendedUser ¶
type ExtendedUser struct {
// addresses
Addresses []*Address `json:"addresses" yaml:"addresses"`
// business metadata
BusinessMetadata map[string]interface{} `json:"business_metadata,omitempty" yaml:"business_metadata,omitempty"`
// business metadata schema id
BusinessMetadataSchemaID string `json:"business_metadata_schema_id,omitempty" yaml:"business_metadata_schema_id,omitempty"`
// created at
// Format: date-time
CreatedAt strfmt.DateTime `json:"created_at,omitempty" yaml:"created_at,omitempty"`
// id
ID string `json:"id,omitempty" yaml:"id,omitempty"`
// identifiers
Identifiers []string `json:"identifiers" yaml:"identifiers"`
// identifiers with details
IdentifiersWithDetails []*IdentifierDetails `json:"identifiers_with_details" yaml:"identifiers_with_details"`
// metadata
Metadata map[string]interface{} `json:"metadata,omitempty" yaml:"metadata,omitempty"`
// metadata schema id
MetadataSchemaID string `json:"metadata_schema_id,omitempty" yaml:"metadata_schema_id,omitempty"`
// payload
Payload map[string]interface{} `json:"payload,omitempty" yaml:"payload,omitempty"`
// payload schema id
PayloadSchemaID string `json:"payload_schema_id,omitempty" yaml:"payload_schema_id,omitempty"`
// preferences
Preferences *UserPreferences `json:"preferences,omitempty" yaml:"preferences,omitempty"`
// status
// Example: active
// Required: true
// Enum: ["active","inactive","deleted","new"]
Status string `json:"status" yaml:"status"`
// status updated at
// Format: date-time
StatusUpdatedAt strfmt.DateTime `json:"status_updated_at,omitempty" yaml:"status_updated_at,omitempty"`
// tenant id
// Example: default
// Required: true
TenantID string `json:"tenant_id" yaml:"tenant_id"`
// updated at
// Format: date-time
UpdatedAt strfmt.DateTime `json:"updated_at,omitempty" yaml:"updated_at,omitempty"`
// user pool id
// Example: default
// Required: true
UserPoolID string `json:"user_pool_id" yaml:"user_pool_id"`
// user type
// Enum: ["jit","standard","scim"]
UserType string `json:"user_type,omitempty" yaml:"user_type,omitempty"`
// verified addresses
VerifiedAddresses []string `json:"verified addresses" yaml:"verified addresses"`
}
ExtendedUser extended user
swagger:model ExtendedUser
func (*ExtendedUser) ContextValidate ¶
ContextValidate validate this extended user based on the context it is used
func (*ExtendedUser) MarshalBinary ¶
func (m *ExtendedUser) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ExtendedUser) UnmarshalBinary ¶
func (m *ExtendedUser) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ExtensionSchemaData ¶
type ExtensionSchemaData struct {
// additional identifiers
AdditionalIdentifiers []*SCIMv2Identifier `json:"additionalIdentifiers" yaml:"additionalIdentifiers"`
// business metadata
BusinessMetadata map[string]interface{} `json:"businessMetadata,omitempty" yaml:"businessMetadata,omitempty"`
// emails
Emails []*SCIMv2ExtensionEmail `json:"emails" yaml:"emails"`
// metadata
Metadata map[string]interface{} `json:"metadata,omitempty" yaml:"metadata,omitempty"`
// payload
Payload map[string]interface{} `json:"payload,omitempty" yaml:"payload,omitempty"`
// phone numbers
PhoneNumbers []*SCIMv2ExtensionPhoneNumber `json:"phoneNumbers" yaml:"phoneNumbers"`
}
ExtensionSchemaData extension schema data
swagger:model ExtensionSchemaData
func (*ExtensionSchemaData) ContextValidate ¶
ContextValidate validate this extension schema data based on the context it is used
func (*ExtensionSchemaData) MarshalBinary ¶
func (m *ExtensionSchemaData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ExtensionSchemaData) UnmarshalBinary ¶
func (m *ExtensionSchemaData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type FieldMapping ¶
type FieldMapping struct {
// internal
Internal string `json:"internal,omitempty" yaml:"internal,omitempty"`
// scim
Scim string `json:"scim,omitempty" yaml:"scim,omitempty"`
}
FieldMapping field mapping
swagger:model FieldMapping
func (*FieldMapping) ContextValidate ¶
ContextValidate validates this field mapping based on context it is used
func (*FieldMapping) MarshalBinary ¶
func (m *FieldMapping) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*FieldMapping) UnmarshalBinary ¶
func (m *FieldMapping) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type FilterSupport ¶
type FilterSupport struct {
// max results
MaxResults int64 `json:"maxResults,omitempty" yaml:"maxResults,omitempty"`
// supported
Supported bool `json:"supported,omitempty" yaml:"supported,omitempty"`
}
FilterSupport filter support
swagger:model FilterSupport
func (*FilterSupport) ContextValidate ¶
ContextValidate validates this filter support based on context it is used
func (*FilterSupport) MarshalBinary ¶
func (m *FilterSupport) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*FilterSupport) UnmarshalBinary ¶
func (m *FilterSupport) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GetUserByKey ¶
type GetUserByKey struct {
// address
Address string `json:"address,omitempty" yaml:"address,omitempty"`
// identifier
Identifier string `json:"identifier,omitempty" yaml:"identifier,omitempty"`
}
GetUserByKey get user by key
swagger:model GetUserByKey
func (*GetUserByKey) ContextValidate ¶
ContextValidate validates this get user by key based on context it is used
func (*GetUserByKey) MarshalBinary ¶
func (m *GetUserByKey) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GetUserByKey) UnmarshalBinary ¶
func (m *GetUserByKey) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Group ¶
type Group struct {
// created at
// Format: date-time
CreatedAt strfmt.DateTime `json:"created_at,omitempty" yaml:"created_at,omitempty"`
// description
Description string `json:"description,omitempty" yaml:"description,omitempty"`
// id
ID string `json:"id,omitempty" yaml:"id,omitempty"`
// name
Name string `json:"name,omitempty" yaml:"name,omitempty"`
// parent id
ParentID string `json:"parent_id,omitempty" yaml:"parent_id,omitempty"`
// tenant id
TenantID string `json:"tenant_id,omitempty" yaml:"tenant_id,omitempty"`
// updated at
// Format: date-time
UpdatedAt strfmt.DateTime `json:"updated_at,omitempty" yaml:"updated_at,omitempty"`
// user pool id
// Example: default
// Required: true
UserPoolID string `json:"user_pool_id" yaml:"user_pool_id"`
}
Group group
swagger:model Group
func (*Group) ContextValidate ¶
ContextValidate validates this group based on context it is used
func (*Group) MarshalBinary ¶
MarshalBinary interface implementation
func (*Group) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type GroupGetResponse ¶
type GroupGetResponse struct {
// display name
// Example: Some Group Name
DisplayName string `json:"displayName,omitempty" yaml:"displayName,omitempty"`
// external Id
// Example: some-external-id
ExternalID string `json:"externalId,omitempty" yaml:"externalId,omitempty"`
// id
ID string `json:"id,omitempty" yaml:"id,omitempty"`
// members
Members []*Member `json:"members" yaml:"members"`
// meta
Meta *SCIMv2Meta `json:"meta,omitempty" yaml:"meta,omitempty"`
// schemas
// Example: ["urn:ietf:params:scim:schemas:core:2.0:Group"]
Schemas []string `json:"schemas" yaml:"schemas"`
}
GroupGetResponse GroupGetResponse
swagger:model GroupGetResponse
func (*GroupGetResponse) ContextValidate ¶
ContextValidate validate this group get response based on the context it is used
func (*GroupGetResponse) MarshalBinary ¶
func (m *GroupGetResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GroupGetResponse) UnmarshalBinary ¶
func (m *GroupGetResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GroupMember ¶
type GroupMember struct {
// group id
GroupID string `json:"group_id,omitempty" yaml:"group_id,omitempty"`
// tenant id
TenantID string `json:"tenant_id,omitempty" yaml:"tenant_id,omitempty"`
// user id
UserID string `json:"user_id,omitempty" yaml:"user_id,omitempty"`
// user pool id
UserPoolID string `json:"user_pool_id,omitempty" yaml:"user_pool_id,omitempty"`
}
GroupMember group member
swagger:model GroupMember
func (*GroupMember) ContextValidate ¶
ContextValidate validates this group member based on context it is used
func (*GroupMember) MarshalBinary ¶
func (m *GroupMember) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GroupMember) UnmarshalBinary ¶
func (m *GroupMember) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GroupMembershipType ¶
type GroupMembershipType string
GroupMembershipType group membership type
swagger:model GroupMembershipType
func (GroupMembershipType) ContextValidate ¶
ContextValidate validates this group membership type based on context it is used
type GroupUpsertRequest ¶
type GroupUpsertRequest struct {
// display name
// Example: Some Group Name
DisplayName string `json:"displayName,omitempty" yaml:"displayName,omitempty"`
// external Id
// Example: some-external-id
ExternalID string `json:"externalId,omitempty" yaml:"externalId,omitempty"`
// members
Members []*Member `json:"members" yaml:"members"`
// schemas
// Example: ["urn:ietf:params:scim:schemas:core:2.0:Group"]
Schemas []string `json:"schemas" yaml:"schemas"`
}
GroupUpsertRequest GroupUpsertRequest
swagger:model GroupUpsertRequest
func (*GroupUpsertRequest) ContextValidate ¶
ContextValidate validate this group upsert request based on the context it is used
func (*GroupUpsertRequest) MarshalBinary ¶
func (m *GroupUpsertRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GroupUpsertRequest) UnmarshalBinary ¶
func (m *GroupUpsertRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Groups ¶
type Groups []*Group
Groups groups
swagger:model Groups
func (Groups) ContextValidate ¶
ContextValidate validate this groups based on the context it is used
type HMACGetSecretInputs ¶
type HMACGetSecretInputs struct {
// salt1
Salt1 URLEncodedBase64 `json:"salt1,omitempty" yaml:"salt1,omitempty"`
// salt2
Salt2 URLEncodedBase64 `json:"salt2,omitempty" yaml:"salt2,omitempty"`
}
HMACGetSecretInputs HMACGetSecretInputs represents the inputs of the CTAP hmac-secret extension during authentication.
Registry: https://www.iana.org/assignments/webauthn/webauthn.xhtml
swagger:model HMACGetSecretInputs
func (*HMACGetSecretInputs) ContextValidate ¶
ContextValidate validate this h m a c get secret inputs based on the context it is used
func (*HMACGetSecretInputs) MarshalBinary ¶
func (m *HMACGetSecretInputs) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HMACGetSecretInputs) UnmarshalBinary ¶
func (m *HMACGetSecretInputs) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HMACGetSecretOutputs ¶
type HMACGetSecretOutputs struct {
// output1
Output1 URLEncodedBase64 `json:"output1,omitempty" yaml:"output1,omitempty"`
// output2
Output2 URLEncodedBase64 `json:"output2,omitempty" yaml:"output2,omitempty"`
}
HMACGetSecretOutputs HMACGetSecretOutputs represents the outputs of the CTAP hmac-secret extension during authentication.
Registry: https://www.iana.org/assignments/webauthn/webauthn.xhtml
swagger:model HMACGetSecretOutputs
func (*HMACGetSecretOutputs) ContextValidate ¶
ContextValidate validate this h m a c get secret outputs based on the context it is used
func (*HMACGetSecretOutputs) MarshalBinary ¶
func (m *HMACGetSecretOutputs) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HMACGetSecretOutputs) UnmarshalBinary ¶
func (m *HMACGetSecretOutputs) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Hash ¶
type Hash struct {
// config
Config *HashConfig `json:"config,omitempty" yaml:"config,omitempty"`
// value
Value string `json:"value,omitempty" yaml:"value,omitempty"`
}
Hash hash
swagger:model Hash
func (*Hash) ContextValidate ¶
ContextValidate validate this hash based on the context it is used
func (*Hash) MarshalBinary ¶
MarshalBinary interface implementation
func (*Hash) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type HashConfig ¶
type HashConfig struct {
// argon2
Argon2 *Argon2Config `json:"argon2,omitempty" yaml:"argon2,omitempty"`
// bcrypt
Bcrypt *BcryptConfig `json:"bcrypt,omitempty" yaml:"bcrypt,omitempty"`
// md5
Md5 *MD5Config `json:"md5,omitempty" yaml:"md5,omitempty"`
// method
// Enum: ["bcrypt","pbkdf2","argon2","sha","md5"]
Method string `json:"method,omitempty" yaml:"method,omitempty"`
// pbkdf2
Pbkdf2 *PBKDF2Config `json:"pbkdf2,omitempty" yaml:"pbkdf2,omitempty"`
// sha
Sha *SHAConfig `json:"sha,omitempty" yaml:"sha,omitempty"`
}
HashConfig hash config
swagger:model HashConfig
func (*HashConfig) ContextValidate ¶
ContextValidate validate this hash config based on the context it is used
func (*HashConfig) MarshalBinary ¶
func (m *HashConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HashConfig) UnmarshalBinary ¶
func (m *HashConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type IdentifierDetails ¶
type IdentifierDetails struct {
// type
// Enum: ["email","mobile","uid","external","federated"]
Type string `json:"type,omitempty" yaml:"type,omitempty"`
// value
Value string `json:"value,omitempty" yaml:"value,omitempty"`
}
IdentifierDetails identifier details
swagger:model IdentifierDetails
func (*IdentifierDetails) ContextValidate ¶
ContextValidate validates this identifier details based on context it is used
func (*IdentifierDetails) MarshalBinary ¶
func (m *IdentifierDetails) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*IdentifierDetails) UnmarshalBinary ¶
func (m *IdentifierDetails) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type IdentifiersToSet ¶
type IdentifiersToSet struct {
// identifiers
Identifiers []*NewUserIdentifier `json:"identifiers" yaml:"identifiers"`
}
IdentifiersToSet identifiers to set
swagger:model IdentifiersToSet
func (*IdentifiersToSet) ContextValidate ¶
ContextValidate validate this identifiers to set based on the context it is used
func (*IdentifiersToSet) MarshalBinary ¶
func (m *IdentifiersToSet) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*IdentifiersToSet) UnmarshalBinary ¶
func (m *IdentifiersToSet) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type InspectOTP ¶
type InspectOTP struct {
// code
// Required: true
Code string `json:"code" yaml:"code"`
}
InspectOTP inspect o t p
swagger:model InspectOTP
func (*InspectOTP) ContextValidate ¶
ContextValidate validates this inspect o t p based on context it is used
func (*InspectOTP) MarshalBinary ¶
func (m *InspectOTP) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*InspectOTP) UnmarshalBinary ¶
func (m *InspectOTP) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type InspectOTPUserOperationalData ¶
type InspectOTPUserOperationalData struct {
// code type
// Required: true
// Enum: ["activation","reset_password","reset_totp","enroll_webauthn","challenge","verify_address","authentication","pair_device"]
CodeType string `json:"code_type" yaml:"code_type"`
// metadata associated with the code when it was generated
Metadata map[string]interface{} `json:"metadata,omitempty" yaml:"metadata,omitempty"`
// password set
// Required: true
PasswordSet bool `json:"password_set" yaml:"password_set"`
// user id
// Required: true
UserID string `json:"user_id" yaml:"user_id"`
}
InspectOTPUserOperationalData inspect o t p user operational data
swagger:model InspectOTPUserOperationalData
func (*InspectOTPUserOperationalData) ContextValidate ¶
func (m *InspectOTPUserOperationalData) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this inspect o t p user operational data based on context it is used
func (*InspectOTPUserOperationalData) MarshalBinary ¶
func (m *InspectOTPUserOperationalData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*InspectOTPUserOperationalData) UnmarshalBinary ¶
func (m *InspectOTPUserOperationalData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type InternalGroup ¶
type InternalGroup struct {
// created at
// Format: date-time
CreatedAt strfmt.DateTime `json:"created_at,omitempty" yaml:"created_at,omitempty"`
// description
Description string `json:"description,omitempty" yaml:"description,omitempty"`
// external id
ExternalID string `json:"external_id,omitempty" yaml:"external_id,omitempty"`
// id
ID string `json:"id,omitempty" yaml:"id,omitempty"`
// name
Name string `json:"name,omitempty" yaml:"name,omitempty"`
// path
Path string `json:"path,omitempty" yaml:"path,omitempty"`
// tenant id
TenantID string `json:"tenant_id,omitempty" yaml:"tenant_id,omitempty"`
// updated at
// Format: date-time
UpdatedAt strfmt.DateTime `json:"updated_at,omitempty" yaml:"updated_at,omitempty"`
// user pool id
// Example: default
// Required: true
UserPoolID string `json:"user_pool_id" yaml:"user_pool_id"`
}
InternalGroup internal group
swagger:model InternalGroup
func (*InternalGroup) ContextValidate ¶
ContextValidate validates this internal group based on context it is used
func (*InternalGroup) MarshalBinary ¶
func (m *InternalGroup) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*InternalGroup) UnmarshalBinary ¶
func (m *InternalGroup) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LargeBlobInputs ¶
type LargeBlobInputs struct {
// read
Read bool `json:"read,omitempty" yaml:"read,omitempty"`
// support
Support LargeBlobSupport `json:"support,omitempty" yaml:"support,omitempty"`
// write
Write URLEncodedBase64 `json:"write,omitempty" yaml:"write,omitempty"`
}
LargeBlobInputs LargeBlobInputs represents the AuthenticationExtensionsLargeBlobInputsJSON IDL. Support is only valid during registration; Read and Write are only valid during authentication and are mutually exclusive.
Specification: §10.1.5. Large blob storage extension (https://www.w3.org/TR/webauthn-3/#sctn-large-blob-extension)
swagger:model LargeBlobInputs
func (*LargeBlobInputs) ContextValidate ¶
ContextValidate validate this large blob inputs based on the context it is used
func (*LargeBlobInputs) MarshalBinary ¶
func (m *LargeBlobInputs) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LargeBlobInputs) UnmarshalBinary ¶
func (m *LargeBlobInputs) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LargeBlobOutputs ¶
type LargeBlobOutputs struct {
// blob
Blob URLEncodedBase64 `json:"blob,omitempty" yaml:"blob,omitempty"`
// Supported reports whether the created credential supports large blob storage. It is only present at
// registration, in answer to the 'support' input. A false value is meaningful and distinct from the client
// not reporting support at all; [AuthenticationExtensionsClientOutputs.Verify] rejects both when support was
// requested as required.
Supported bool `json:"supported,omitempty" yaml:"supported,omitempty"`
// Written reports whether the blob supplied by a 'write' input was stored. A false value is meaningful and
// distinct from the client not reporting the outcome at all.
Written bool `json:"written,omitempty" yaml:"written,omitempty"`
}
LargeBlobOutputs LargeBlobOutputs represents the AuthenticationExtensionsLargeBlobOutputsJSON IDL.
Specification: §10.1.5. Large blob storage extension (https://www.w3.org/TR/webauthn-3/#sctn-large-blob-extension)
swagger:model LargeBlobOutputs
func (*LargeBlobOutputs) ContextValidate ¶
ContextValidate validate this large blob outputs based on the context it is used
func (*LargeBlobOutputs) MarshalBinary ¶
func (m *LargeBlobOutputs) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LargeBlobOutputs) UnmarshalBinary ¶
func (m *LargeBlobOutputs) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LargeBlobSupport ¶
type LargeBlobSupport string
LargeBlobSupport LargeBlobSupport represents the LargeBlobSupport IDL enumeration used by the large blob storage extension during registration.
Specification: §10.1.5. Large blob storage extension (https://www.w3.org/TR/webauthn-3/#sctn-large-blob-extension)
swagger:model LargeBlobSupport
func (LargeBlobSupport) ContextValidate ¶
ContextValidate validates this large blob support based on context it is used
type ListGroupsResponse ¶
type ListGroupsResponse struct {
// resources
Resources []*GroupGetResponse `json:"Resources" yaml:"Resources"`
// items per page
ItemsPerPage int64 `json:"itemsPerPage,omitempty" yaml:"itemsPerPage,omitempty"`
// schemas
Schemas []string `json:"schemas" yaml:"schemas"`
// start index
StartIndex int64 `json:"startIndex,omitempty" yaml:"startIndex,omitempty"`
// total results
TotalResults int64 `json:"totalResults,omitempty" yaml:"totalResults,omitempty"`
}
ListGroupsResponse list groups response
swagger:model ListGroupsResponse
func (*ListGroupsResponse) ContextValidate ¶
ContextValidate validate this list groups response based on the context it is used
func (*ListGroupsResponse) MarshalBinary ¶
func (m *ListGroupsResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ListGroupsResponse) UnmarshalBinary ¶
func (m *ListGroupsResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ListUsersResponse ¶
type ListUsersResponse struct {
// resources
Resources []*UserGetResponse `json:"Resources" yaml:"Resources"`
// items per page
ItemsPerPage int64 `json:"itemsPerPage,omitempty" yaml:"itemsPerPage,omitempty"`
// schemas
Schemas []string `json:"schemas" yaml:"schemas"`
// start index
StartIndex int64 `json:"startIndex,omitempty" yaml:"startIndex,omitempty"`
// total results
TotalResults int64 `json:"totalResults,omitempty" yaml:"totalResults,omitempty"`
}
ListUsersResponse list users response
swagger:model ListUsersResponse
func (*ListUsersResponse) ContextValidate ¶
ContextValidate validate this list users response based on the context it is used
func (*ListUsersResponse) MarshalBinary ¶
func (m *ListUsersResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ListUsersResponse) UnmarshalBinary ¶
func (m *ListUsersResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type MD5Config ¶
type MD5Config struct {
// salt
Salt string `json:"salt,omitempty" yaml:"salt,omitempty"`
// salt after digest in hash
SaltAfterDigestInHash bool `json:"salt_after_digest_in_hash,omitempty" yaml:"salt_after_digest_in_hash,omitempty"`
// salt length
SaltLength int64 `json:"salt_length,omitempty" yaml:"salt_length,omitempty"`
}
MD5Config m d5 config
swagger:model MD5Config
func (*MD5Config) ContextValidate ¶
ContextValidate validates this m d5 config based on context it is used
func (*MD5Config) MarshalBinary ¶
MarshalBinary interface implementation
func (*MD5Config) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type MFAPreferences ¶
type MFAPreferences struct {
// preferred 2fa
// Enum: ["totp","password","otp","email_otp","sms_otp","voice_otp","webauthn","usernameless_webauthn","push","symbol","qr_code"]
Preferred2fa string `json:"preferred_2fa,omitempty" yaml:"preferred_2fa,omitempty"`
}
MFAPreferences m f a preferences
swagger:model MFAPreferences
func (*MFAPreferences) ContextValidate ¶
ContextValidate validates this m f a preferences based on context it is used
func (*MFAPreferences) MarshalBinary ¶
func (m *MFAPreferences) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MFAPreferences) UnmarshalBinary ¶
func (m *MFAPreferences) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Member ¶
type Member struct {
// dollar ref
DollarRef string `json:"$ref,omitempty" yaml:"$ref,omitempty"`
// type
Type MemberType `json:"type,omitempty" yaml:"type,omitempty"`
// value
Value string `json:"value,omitempty" yaml:"value,omitempty"`
}
Member member
swagger:model Member
func (*Member) ContextValidate ¶
ContextValidate validate this member based on the context it is used
func (*Member) MarshalBinary ¶
MarshalBinary interface implementation
func (*Member) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type MemberType ¶
type MemberType string
MemberType member type
swagger:model MemberType
func (MemberType) ContextValidate ¶
ContextValidate validates this member type based on context it is used
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 NewUser ¶
type NewUser struct {
// business metadata
BusinessMetadata map[string]interface{} `json:"business_metadata,omitempty" yaml:"business_metadata,omitempty"`
// business metadata schema id
BusinessMetadataSchemaID string `json:"business_metadata_schema_id,omitempty" yaml:"business_metadata_schema_id,omitempty"`
// credentials
Credentials []*NewUserCredential `json:"credentials" yaml:"credentials"`
// id
ID string `json:"id,omitempty" yaml:"id,omitempty"`
// identifiers
Identifiers []*NewUserIdentifier `json:"identifiers" yaml:"identifiers"`
// metadata
Metadata map[string]interface{} `json:"metadata,omitempty" yaml:"metadata,omitempty"`
// metadata schema id
MetadataSchemaID string `json:"metadata_schema_id,omitempty" yaml:"metadata_schema_id,omitempty"`
// payload
Payload map[string]interface{} `json:"payload,omitempty" yaml:"payload,omitempty"`
// payload schema id
PayloadSchemaID string `json:"payload_schema_id,omitempty" yaml:"payload_schema_id,omitempty"`
// preferences
Preferences *UserPreferences `json:"preferences,omitempty" yaml:"preferences,omitempty"`
// status
// Required: true
// Enum: ["active","inactive","deleted","new"]
Status string `json:"status" yaml:"status"`
// user type
// Enum: ["jit","standard","scim"]
UserType string `json:"user_type,omitempty" yaml:"user_type,omitempty"`
// verifiable addresses
VerifiableAddresses []*NewUserVerifiableAddress `json:"verifiable_addresses" yaml:"verifiable_addresses"`
}
NewUser new user
swagger:model NewUser
func (*NewUser) ContextValidate ¶
ContextValidate validate this new user based on the context it is used
func (*NewUser) MarshalBinary ¶
MarshalBinary interface implementation
func (*NewUser) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type NewUserCredential ¶
type NewUserCredential struct {
// Indicates if user is required to alter their credentials during their initial authentication. Currently, it is enforced only for password credentials, but it may change any time.
MustBeChanged bool `json:"must_be_changed,omitempty" yaml:"must_be_changed,omitempty"`
// Indicates if user is required to reset their credentials before first authentication.
// This flag takes precedence over MustBeChanged.
MustBeReset bool `json:"must_be_reset,omitempty" yaml:"must_be_reset,omitempty"`
// password
// Example: secret
Password string `json:"password,omitempty" yaml:"password,omitempty"`
// totp secret
// Example: BLEXAM6OPBBZTCFUOPVHDQ2HVG7PTMK3
TotpSecret string `json:"totp_secret,omitempty" yaml:"totp_secret,omitempty"`
// type
// Example: password
// Required: true
// Enum: ["password","webauthn","totp","device"]
Type string `json:"type" yaml:"type"`
// webauthn credentials
// Example: public_key
WebauthnCredentials []*WebAuthnCredential `json:"webauthn_credentials" yaml:"webauthn_credentials"`
// webauthn type
// Enum: ["regular","discoverable"]
WebauthnType string `json:"webauthn_type,omitempty" yaml:"webauthn_type,omitempty"`
}
NewUserCredential new user credential
swagger:model NewUserCredential
func (*NewUserCredential) ContextValidate ¶
ContextValidate validate this new user credential based on the context it is used
func (*NewUserCredential) MarshalBinary ¶
func (m *NewUserCredential) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NewUserCredential) UnmarshalBinary ¶
func (m *NewUserCredential) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type NewUserIdentifier ¶
type NewUserIdentifier struct {
// identifier
// Required: true
Identifier string `json:"identifier" yaml:"identifier"`
// identifier metadata
Metadata map[string]interface{} `json:"metadata,omitempty" yaml:"metadata,omitempty"`
// type
// Example: email
// Required: true
// Enum: ["email","mobile","uid","external","federated"]
Type string `json:"type" yaml:"type"`
}
NewUserIdentifier new user identifier
swagger:model NewUserIdentifier
func (*NewUserIdentifier) ContextValidate ¶
ContextValidate validates this new user identifier based on context it is used
func (*NewUserIdentifier) MarshalBinary ¶
func (m *NewUserIdentifier) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NewUserIdentifier) UnmarshalBinary ¶
func (m *NewUserIdentifier) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type NewUserVerifiableAddress ¶
type NewUserVerifiableAddress struct {
// address
// Required: true
Address string `json:"address" yaml:"address"`
// is allowed for 2FA
AllowedFor2fa bool `json:"allowed_for_2fa,omitempty" yaml:"allowed_for_2fa,omitempty"`
// message redaction
MessageRedaction *RedactionPolicy `json:"message_redaction,omitempty" yaml:"message_redaction,omitempty"`
// general purpose metadata
Metadata map[string]interface{} `json:"metadata,omitempty" yaml:"metadata,omitempty"`
// 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"`
// verified
// Required: true
Verified bool `json:"verified" yaml:"verified"`
}
NewUserVerifiableAddress new user verifiable address
swagger:model NewUserVerifiableAddress
func (*NewUserVerifiableAddress) ContextValidate ¶
func (m *NewUserVerifiableAddress) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this new user verifiable address based on the context it is used
func (*NewUserVerifiableAddress) MarshalBinary ¶
func (m *NewUserVerifiableAddress) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NewUserVerifiableAddress) UnmarshalBinary ¶
func (m *NewUserVerifiableAddress) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type OtpConfig ¶
type OtpConfig struct {
// length
Length int64 `json:"length,omitempty" yaml:"length,omitempty"`
// ttl
// Format: duration
TTL strfmt.Duration `json:"ttl,omitempty" yaml:"ttl,omitempty"`
}
OtpConfig otp config
swagger:model OtpConfig
func (*OtpConfig) ContextValidate ¶
ContextValidate validates this otp config based on context it is used
func (*OtpConfig) MarshalBinary ¶
MarshalBinary interface implementation
func (*OtpConfig) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type OtpSettings ¶
type OtpSettings struct {
// activation
Activation *OtpConfig `json:"activation,omitempty" yaml:"activation,omitempty"`
// authentication
Authentication *OtpConfig `json:"authentication,omitempty" yaml:"authentication,omitempty"`
// challenge
Challenge *OtpConfig `json:"challenge,omitempty" yaml:"challenge,omitempty"`
// enroll webauthn
EnrollWebauthn *OtpConfig `json:"enroll_webauthn,omitempty" yaml:"enroll_webauthn,omitempty"`
// pair device
PairDevice *OtpConfig `json:"pair_device,omitempty" yaml:"pair_device,omitempty"`
// RequireUserConfirmationBeforeSend is a flow-level toggle (it does not
// correspond to any of the per-purpose OtpConfig fields above) that affects
// only the hosted web login UI. When true, the OTP is not auto-sent: the user
// lands on the OTP send view and must click Continue to trigger delivery.
// Applies to primary login (LoginFlow) and forced re-authentication / MFA
// challenge (ForcedAuthnFlow). API-driven OTP triggers (the OTP send
// endpoints) are unaffected.
RequireUserConfirmationBeforeSend bool `json:"require_user_confirmation_before_send,omitempty" yaml:"require_user_confirmation_before_send,omitempty"`
// reset password
ResetPassword *OtpConfig `json:"reset_password,omitempty" yaml:"reset_password,omitempty"`
// reset totp
ResetTotp *OtpConfig `json:"reset_totp,omitempty" yaml:"reset_totp,omitempty"`
// verify address
VerifyAddress *OtpConfig `json:"verify_address,omitempty" yaml:"verify_address,omitempty"`
}
OtpSettings otp settings
swagger:model OtpSettings
func (*OtpSettings) ContextValidate ¶
ContextValidate validate this otp settings based on the context it is used
func (*OtpSettings) MarshalBinary ¶
func (m *OtpSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*OtpSettings) UnmarshalBinary ¶
func (m *OtpSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PBKDF2Config ¶
type PBKDF2Config struct {
// function
Function string `json:"function,omitempty" yaml:"function,omitempty"`
// key length
KeyLength int64 `json:"key_length,omitempty" yaml:"key_length,omitempty"`
// number of iterations
NumberOfIterations int64 `json:"number_of_iterations,omitempty" yaml:"number_of_iterations,omitempty"`
// salt
Salt string `json:"salt,omitempty" yaml:"salt,omitempty"`
// salt length
SaltLength int64 `json:"salt_length,omitempty" yaml:"salt_length,omitempty"`
}
PBKDF2Config p b k d f2 config
swagger:model PBKDF2Config
func (*PBKDF2Config) ContextValidate ¶
ContextValidate validates this p b k d f2 config based on context it is used
func (*PBKDF2Config) MarshalBinary ¶
func (m *PBKDF2Config) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PBKDF2Config) UnmarshalBinary ¶
func (m *PBKDF2Config) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PRFInputs ¶
type PRFInputs struct {
// eval
Eval *PRFValues `json:"eval,omitempty" yaml:"eval,omitempty"`
// eval by credential
EvalByCredential map[string]PRFValues `json:"evalByCredential,omitempty" yaml:"evalByCredential,omitempty"`
}
PRFInputs PRFInputs represents the AuthenticationExtensionsPRFInputsJSON IDL.
Every member is optional. A zero value is the bare availability probe, i.e. the "prf":{} input a Relying Party sends at registration to learn whether the pseudo-random function is available for the credential; the client answers with the 'enabled' output. This is why [AuthenticationExtensions.PRF] is a pointer while its LargeBlobInputs and HMACGetSecretInputs siblings are not.
EvalByCredential is only valid during authentication; the client throws a NotSupportedError when it is present during registration. Its keys are base64url encoded credential IDs which MUST each match an entry of the allowed credentials.
Specification: §10.1.4. Pseudo-random function extension (https://www.w3.org/TR/webauthn-3/#prf-extension)
swagger:model PRFInputs
func (*PRFInputs) ContextValidate ¶
ContextValidate validate this p r f inputs based on the context it is used
func (*PRFInputs) MarshalBinary ¶
MarshalBinary interface implementation
func (*PRFInputs) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type PRFOutputs ¶
type PRFOutputs struct {
// Enabled reports whether the pseudo-random function is available for the credential. It is the answer to the
// bare "prf":{} input a Relying Party sends at registration. A false value is meaningful and distinct from
// the client not reporting availability at all.
Enabled bool `json:"enabled,omitempty" yaml:"enabled,omitempty"`
// results
Results *PRFValues `json:"results,omitempty" yaml:"results,omitempty"`
}
PRFOutputs PRFOutputs represents the AuthenticationExtensionsPRFOutputsJSON IDL.
Specification: §10.1.4. Pseudo-random function extension (https://www.w3.org/TR/webauthn-3/#prf-extension)
swagger:model PRFOutputs
func (*PRFOutputs) ContextValidate ¶
ContextValidate validate this p r f outputs based on the context it is used
func (*PRFOutputs) MarshalBinary ¶
func (m *PRFOutputs) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PRFOutputs) UnmarshalBinary ¶
func (m *PRFOutputs) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PRFValues ¶
type PRFValues struct {
// first
First URLEncodedBase64 `json:"first,omitempty" yaml:"first,omitempty"`
// second
Second URLEncodedBase64 `json:"second,omitempty" yaml:"second,omitempty"`
}
PRFValues PRFValues represents the AuthenticationExtensionsPRFValuesJSON IDL. The byte values are conveyed to the client base64url encoded.
Specification: §10.1.4. Pseudo-random function extension (https://www.w3.org/TR/webauthn-3/#prf-extension)
swagger:model PRFValues
func (*PRFValues) ContextValidate ¶
ContextValidate validate this p r f values based on the context it is used
func (*PRFValues) MarshalBinary ¶
MarshalBinary interface implementation
func (*PRFValues) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type PasswordPolicy ¶
type PasswordPolicy struct {
// capital letters
CapitalLetters uint64 `json:"capital_letters,omitempty" yaml:"capital_letters,omitempty"`
// digits
Digits uint64 `json:"digits,omitempty" yaml:"digits,omitempty"`
// lowercase letters
LowercaseLetters uint64 `json:"lowercase_letters,omitempty" yaml:"lowercase_letters,omitempty"`
// min length
MinLength uint64 `json:"min_length,omitempty" yaml:"min_length,omitempty"`
// not used since
NotUsedSince uint64 `json:"not_used_since,omitempty" yaml:"not_used_since,omitempty"`
// special characters
SpecialCharacters uint64 `json:"special_characters,omitempty" yaml:"special_characters,omitempty"`
// strength
// Enum: ["any","weak","fair","strong","very_strong"]
Strength string `json:"strength,omitempty" yaml:"strength,omitempty"`
}
PasswordPolicy password policy
swagger:model PasswordPolicy
func (*PasswordPolicy) ContextValidate ¶
ContextValidate validates this password policy based on context it is used
func (*PasswordPolicy) MarshalBinary ¶
func (m *PasswordPolicy) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PasswordPolicy) UnmarshalBinary ¶
func (m *PasswordPolicy) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PasswordSettings ¶
type PasswordSettings struct {
// expires after
// Format: duration
ExpiresAfter strfmt.Duration `json:"expires_after,omitempty" yaml:"expires_after,omitempty"`
// hashing method
// Enum: ["bcrypt","pbkdf2","argon2","sha"]
HashingMethod string `json:"hashing_method,omitempty" yaml:"hashing_method,omitempty"`
}
PasswordSettings password settings
swagger:model PasswordSettings
func (*PasswordSettings) ContextValidate ¶
ContextValidate validates this password settings based on context it is used
func (*PasswordSettings) MarshalBinary ¶
func (m *PasswordSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PasswordSettings) UnmarshalBinary ¶
func (m *PasswordSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Pool ¶
type Pool struct {
// activation settings
ActivationSettings *ActivationSettings `json:"activation_settings,omitempty" yaml:"activation_settings,omitempty"`
// allow skip 2fa
AllowSkip2fa bool `json:"allow_skip_2fa,omitempty" yaml:"allow_skip_2fa,omitempty"`
// authentication mechanisms
AuthenticationMechanisms AuthenticationMechanisms `json:"authentication_mechanisms,omitempty" yaml:"authentication_mechanisms,omitempty"`
// badge color
BadgeColor string `json:"badge_color,omitempty" yaml:"badge_color,omitempty"`
// business metadata schema id
BusinessMetadataSchemaID string `json:"business_metadata_schema_id,omitempty" yaml:"business_metadata_schema_id,omitempty"`
// deleted
Deleted bool `json:"deleted,omitempty" yaml:"deleted,omitempty"`
// description
Description string `json:"description,omitempty" yaml:"description,omitempty"`
// id
ID string `json:"id,omitempty" yaml:"id,omitempty"`
// identifier case insensitive
IdentifierCaseInsensitive bool `json:"identifier_case_insensitive,omitempty" yaml:"identifier_case_insensitive,omitempty"`
// metadata
Metadata map[string]interface{} `json:"metadata,omitempty" yaml:"metadata,omitempty"`
// metadata schema id
MetadataSchemaID string `json:"metadata_schema_id,omitempty" yaml:"metadata_schema_id,omitempty"`
// mfa session ttl
// Format: duration
MfaSessionTTL strfmt.Duration `json:"mfa_session_ttl,omitempty" yaml:"mfa_session_ttl,omitempty"`
// name
// Required: true
Name string `json:"name" yaml:"name"`
// otp settings
OtpSettings *OtpSettings `json:"otp_settings,omitempty" yaml:"otp_settings,omitempty"`
// password policy
PasswordPolicy *PasswordPolicy `json:"password_policy,omitempty" yaml:"password_policy,omitempty"`
// password settings
PasswordSettings *PasswordSettings `json:"password_settings,omitempty" yaml:"password_settings,omitempty"`
// payload schema id
PayloadSchemaID string `json:"payload_schema_id,omitempty" yaml:"payload_schema_id,omitempty"`
// pool limits
PoolLimits *PoolLimits `json:"pool_limits,omitempty" yaml:"pool_limits,omitempty"`
// preferred authentication mechanism
// Example: password
// Enum: ["totp","password","otp","email_otp","sms_otp","voice_otp","webauthn","usernameless_webauthn","push","symbol","qr_code"]
PreferredAuthenticationMechanism string `json:"preferred_authentication_mechanism,omitempty" yaml:"preferred_authentication_mechanism,omitempty"`
// public registration allowed
PublicRegistrationAllowed bool `json:"public_registration_allowed,omitempty" yaml:"public_registration_allowed,omitempty"`
// reset credentials settings
ResetCredentialsSettings *ResetCredentialsSettings `json:"reset_credentials_settings,omitempty" yaml:"reset_credentials_settings,omitempty"`
// scim settings
ScimSettings *SCIMSettings `json:"scim_settings,omitempty" yaml:"scim_settings,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","email_otp","sms_otp","voice_otp","webauthn","usernameless_webauthn","push","symbol","qr_code"]
SecondFactorPreferredAuthenticationMechanism string `` /* 131-byte string literal not displayed */
// The minimal risk engine loa score value to skip the 2FA
SecondFactorThreshold float64 `json:"second_factor_threshold,omitempty" yaml:"second_factor_threshold,omitempty"`
// system
System bool `json:"system,omitempty" yaml:"system,omitempty"`
// tenant id
// Example: default
// Required: true
TenantID string `json:"tenant_id" yaml:"tenant_id"`
// totp settings
TotpSettings *TotpSettings `json:"totp_settings,omitempty" yaml:"totp_settings,omitempty"`
// webauthn settings
WebauthnSettings *WebAuthnSettings `json:"webauthn_settings,omitempty" yaml:"webauthn_settings,omitempty"`
// workspace id
WorkspaceID string `json:"workspace_id,omitempty" yaml:"workspace_id,omitempty"`
}
Pool pool
swagger:model Pool
func (*Pool) ContextValidate ¶
ContextValidate validate this pool based on the context it is used
func (*Pool) MarshalBinary ¶
MarshalBinary interface implementation
func (*Pool) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type PoolLimits ¶
type PoolLimits struct {
// max addresses
MaxAddresses int64 `json:"max_addresses,omitempty" yaml:"max_addresses,omitempty"`
// max codes
MaxCodes int64 `json:"max_codes,omitempty" yaml:"max_codes,omitempty"`
// max credentials
MaxCredentials int64 `json:"max_credentials,omitempty" yaml:"max_credentials,omitempty"`
// max identifiers
MaxIdentifiers int64 `json:"max_identifiers,omitempty" yaml:"max_identifiers,omitempty"`
// webauthn credentials capacity
WebauthnCredentialsCapacity int64 `json:"webauthn_credentials_capacity,omitempty" yaml:"webauthn_credentials_capacity,omitempty"`
}
PoolLimits PoolLimits defines limits for user sub-entries within a pool.
All values are clamped to the range [1, 100] with sensible defaults.
swagger:model PoolLimits
func (*PoolLimits) ContextValidate ¶
ContextValidate validates this pool limits based on context it is used
func (*PoolLimits) MarshalBinary ¶
func (m *PoolLimits) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PoolLimits) UnmarshalBinary ¶
func (m *PoolLimits) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PoolResponse ¶
type PoolResponse struct {
// activation settings
ActivationSettings *ActivationSettings `json:"activation_settings,omitempty" yaml:"activation_settings,omitempty"`
// allow skip 2fa
AllowSkip2fa bool `json:"allow_skip_2fa,omitempty" yaml:"allow_skip_2fa,omitempty"`
// authentication mechanisms
AuthenticationMechanisms AuthenticationMechanisms `json:"authentication_mechanisms,omitempty" yaml:"authentication_mechanisms,omitempty"`
// badge color
BadgeColor string `json:"badge_color,omitempty" yaml:"badge_color,omitempty"`
// business metadata schema id
BusinessMetadataSchemaID string `json:"business_metadata_schema_id,omitempty" yaml:"business_metadata_schema_id,omitempty"`
// deleted
Deleted bool `json:"deleted,omitempty" yaml:"deleted,omitempty"`
// description
Description string `json:"description,omitempty" yaml:"description,omitempty"`
// id
ID string `json:"id,omitempty" yaml:"id,omitempty"`
// identifier case insensitive
IdentifierCaseInsensitive bool `json:"identifier_case_insensitive,omitempty" yaml:"identifier_case_insensitive,omitempty"`
// metadata
Metadata map[string]interface{} `json:"metadata,omitempty" yaml:"metadata,omitempty"`
// metadata schema id
MetadataSchemaID string `json:"metadata_schema_id,omitempty" yaml:"metadata_schema_id,omitempty"`
// mfa session ttl
// Format: duration
MfaSessionTTL strfmt.Duration `json:"mfa_session_ttl,omitempty" yaml:"mfa_session_ttl,omitempty"`
// name
// Required: true
Name string `json:"name" yaml:"name"`
// number of jit users
NumberOfJitUsers int64 `json:"number_of_jit_users,omitempty" yaml:"number_of_jit_users,omitempty"`
// number of standard users
NumberOfStandardUsers int64 `json:"number_of_standard_users,omitempty" yaml:"number_of_standard_users,omitempty"`
// number of users
NumberOfUsers int64 `json:"number_of_users,omitempty" yaml:"number_of_users,omitempty"`
// otp settings
OtpSettings *OtpSettings `json:"otp_settings,omitempty" yaml:"otp_settings,omitempty"`
// password policy
PasswordPolicy *PasswordPolicy `json:"password_policy,omitempty" yaml:"password_policy,omitempty"`
// password settings
PasswordSettings *PasswordSettings `json:"password_settings,omitempty" yaml:"password_settings,omitempty"`
// payload schema id
PayloadSchemaID string `json:"payload_schema_id,omitempty" yaml:"payload_schema_id,omitempty"`
// pool limits
PoolLimits *PoolLimits `json:"pool_limits,omitempty" yaml:"pool_limits,omitempty"`
// preferred authentication mechanism
// Example: password
// Enum: ["totp","password","otp","email_otp","sms_otp","voice_otp","webauthn","usernameless_webauthn","push","symbol","qr_code"]
PreferredAuthenticationMechanism string `json:"preferred_authentication_mechanism,omitempty" yaml:"preferred_authentication_mechanism,omitempty"`
// public registration allowed
PublicRegistrationAllowed bool `json:"public_registration_allowed,omitempty" yaml:"public_registration_allowed,omitempty"`
// reset credentials settings
ResetCredentialsSettings *ResetCredentialsSettings `json:"reset_credentials_settings,omitempty" yaml:"reset_credentials_settings,omitempty"`
// scim settings
ScimSettings *SCIMSettings `json:"scim_settings,omitempty" yaml:"scim_settings,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","email_otp","sms_otp","voice_otp","webauthn","usernameless_webauthn","push","symbol","qr_code"]
SecondFactorPreferredAuthenticationMechanism string `` /* 131-byte string literal not displayed */
// The minimal risk engine loa score value to skip the 2FA
SecondFactorThreshold float64 `json:"second_factor_threshold,omitempty" yaml:"second_factor_threshold,omitempty"`
// system
System bool `json:"system,omitempty" yaml:"system,omitempty"`
// tenant id
// Example: default
// Required: true
TenantID string `json:"tenant_id" yaml:"tenant_id"`
// totp settings
TotpSettings *TotpSettings `json:"totp_settings,omitempty" yaml:"totp_settings,omitempty"`
// webauthn settings
WebauthnSettings *WebAuthnSettings `json:"webauthn_settings,omitempty" yaml:"webauthn_settings,omitempty"`
// workspace id
WorkspaceID string `json:"workspace_id,omitempty" yaml:"workspace_id,omitempty"`
}
PoolResponse pool response
swagger:model PoolResponse
func (*PoolResponse) ContextValidate ¶
ContextValidate validate this pool response based on the context it is used
func (*PoolResponse) MarshalBinary ¶
func (m *PoolResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PoolResponse) UnmarshalBinary ¶
func (m *PoolResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Pools ¶
type Pools struct {
// pools
Pools []*PoolResponse `json:"pools" yaml:"pools"`
}
Pools pools
swagger:model Pools
func (*Pools) ContextValidate ¶
ContextValidate validate this pools based on the context it is used
func (*Pools) MarshalBinary ¶
MarshalBinary interface implementation
func (*Pools) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type PublicKeyCredentialCreationOptions ¶
type PublicKeyCredentialCreationOptions struct {
// attestation
Attestation ConveyancePreference `json:"attestation,omitempty" yaml:"attestation,omitempty"`
// attestation formats
AttestationFormats []AttestationFormat `json:"attestationFormats" yaml:"attestationFormats"`
// authenticator selection
AuthenticatorSelection *AuthenticatorSelection `json:"authenticatorSelection,omitempty" yaml:"authenticatorSelection,omitempty"`
// challenge
Challenge URLEncodedBase64 `json:"challenge,omitempty" yaml:"challenge,omitempty"`
// exclude credentials
ExcludeCredentials []*CredentialDescriptor `json:"excludeCredentials" yaml:"excludeCredentials"`
// extensions
Extensions *AuthenticationExtensions `json:"extensions,omitempty" yaml:"extensions,omitempty"`
// hints
Hints []PublicKeyCredentialHints `json:"hints" yaml:"hints"`
// pub key cred params
PubKeyCredParams []*CredentialParameter `json:"pubKeyCredParams" yaml:"pubKeyCredParams"`
// rp
Rp *RelyingPartyEntity `json:"rp,omitempty" yaml:"rp,omitempty"`
// timeout
Timeout int64 `json:"timeout,omitempty" yaml:"timeout,omitempty"`
// user
User *UserEntity `json:"user,omitempty" yaml:"user,omitempty"`
}
PublicKeyCredentialCreationOptions PublicKeyCredentialCreationOptions represents the IDL of the same name.
In order to create a Credential via create(), the caller specifies a few parameters in a PublicKeyCredentialCreationOptions object.
WebAuthn Level 3: hints,attestationFormats.
Specification: §5.4. Options for Credential Creation (https://www.w3.org/TR/webauthn/#dictionary-makecredentialoptions)
swagger:model PublicKeyCredentialCreationOptions
func (*PublicKeyCredentialCreationOptions) ContextValidate ¶
func (m *PublicKeyCredentialCreationOptions) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this public key credential creation options based on the context it is used
func (*PublicKeyCredentialCreationOptions) MarshalBinary ¶
func (m *PublicKeyCredentialCreationOptions) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PublicKeyCredentialCreationOptions) UnmarshalBinary ¶
func (m *PublicKeyCredentialCreationOptions) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PublicKeyCredentialHints ¶
type PublicKeyCredentialHints string
PublicKeyCredentialHints PublicKeyCredentialHints represents an entry of the hints member, which conveys the Relying Party's belief about how the user will satisfy the request, in descending order of preference.
The IDL types the hints member as a sequence of strings rather than as this enumeration, and requires clients to ignore values they do not recognise, so values are deliberately not validated against the constants below: a Relying Party may send a hint ratified after this release, or one a particular user agent understands. Clients also ignore the second and later appearances of a repeated hint.
Hints may contradict the authenticator attachment and the transports of the allowed credentials. Where they do, a client which implements hints gives the hints precedence; see [PublicKeyCredentialHints.AuthenticatorAttachment] for how a registration ceremony pairs the two for the benefit of clients which do not.
WebAuthn Level 3.
Specification: §5.8.7. User-agent Hints Enumeration (https://www.w3.org/TR/webauthn-3/#enum-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 RedactionPolicy ¶
type RedactionPolicy struct {
// Controls whether phone numbers are retained or obfuscated by the provider.
// Example: retain
Address string `json:"address,omitempty" yaml:"address,omitempty"`
// Controls whether message body content is retained by the provider.
// Example: retain
Content string `json:"content,omitempty" yaml:"content,omitempty"`
}
RedactionPolicy RedactionPolicy controls message redaction at the SMS provider level.
swagger:model RedactionPolicy
func (*RedactionPolicy) ContextValidate ¶
ContextValidate validates this redaction policy based on context it is used
func (*RedactionPolicy) MarshalBinary ¶
func (m *RedactionPolicy) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RedactionPolicy) UnmarshalBinary ¶
func (m *RedactionPolicy) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RelyingPartyEntity ¶
type RelyingPartyEntity struct {
// A unique identifier for the Relying Party entity, which sets the RP ID.
ID string `json:"id,omitempty" yaml:"id,omitempty"`
// A human-palatable name for the entity. Its function depends on what the PublicKeyCredentialEntity represents:
//
// When inherited by PublicKeyCredentialRpEntity it is a human-palatable identifier for the Relying Party,
// intended only for display. For example, "ACME Corporation", "Wonderful Widgets, Inc." or "ОАО Примертех".
//
// When inherited by PublicKeyCredentialUserEntity, it is a human-palatable identifier for a user account. It is
// intended only for display, i.e., aiding the user in determining the difference between user accounts with similar
// displayNames. For example, "alexm", "alex.p.mueller@example.com" or "+14255551234".
Name string `json:"name,omitempty" yaml:"name,omitempty"`
}
RelyingPartyEntity The RelyingPartyEntity represents the PublicKeyCredentialRpEntity IDL and is used to supply additional Relying Party attributes when creating a new credential.
Specification: §5.4.2. Relying Party Parameters for Credential Generation (https://www.w3.org/TR/webauthn/#dictionary-rp-credential-params)
swagger:model RelyingPartyEntity
func (*RelyingPartyEntity) ContextValidate ¶
ContextValidate validates this relying party entity based on context it is used
func (*RelyingPartyEntity) MarshalBinary ¶
func (m *RelyingPartyEntity) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RelyingPartyEntity) UnmarshalBinary ¶
func (m *RelyingPartyEntity) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RequestActivation ¶
type RequestActivation struct {
// address
Address string `json:"address,omitempty" yaml:"address,omitempty"`
// identifier
Identifier string `json:"identifier,omitempty" yaml:"identifier,omitempty"`
}
RequestActivation request activation
swagger:model RequestActivation
func (*RequestActivation) ContextValidate ¶
ContextValidate validates this request activation based on context it is used
func (*RequestActivation) MarshalBinary ¶
func (m *RequestActivation) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RequestActivation) UnmarshalBinary ¶
func (m *RequestActivation) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RequestAddOrResetCredential ¶
type RequestAddOrResetCredential struct {
// address
// Required: true
Address string `json:"address" yaml:"address"`
// identifier
Identifier string `json:"identifier,omitempty" yaml:"identifier,omitempty"`
// user ID
UserID string `json:"userID,omitempty" yaml:"userID,omitempty"`
}
RequestAddOrResetCredential request add or reset credential
swagger:model RequestAddOrResetCredential
func (*RequestAddOrResetCredential) ContextValidate ¶
func (m *RequestAddOrResetCredential) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this request add or reset credential based on context it is used
func (*RequestAddOrResetCredential) MarshalBinary ¶
func (m *RequestAddOrResetCredential) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RequestAddOrResetCredential) UnmarshalBinary ¶
func (m *RequestAddOrResetCredential) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RequestAddWebAuthn ¶
type RequestAddWebAuthn struct {
// address
// Required: true
Address string `json:"address" yaml:"address"`
// identifier
Identifier string `json:"identifier,omitempty" yaml:"identifier,omitempty"`
// user ID
UserID string `json:"userID,omitempty" yaml:"userID,omitempty"`
// Webauthn credential type to enrol. Determines whether the message links
// to the regular (username-first) or usernameless (passkey/discoverable)
// WebAuthn enrolment flow. When omitted, defaults to regular.
// Enum: ["regular","discoverable"]
WebauthnType string `json:"webauthn_type,omitempty" yaml:"webauthn_type,omitempty"`
}
RequestAddWebAuthn request add web authn
swagger:model RequestAddWebAuthn
func (*RequestAddWebAuthn) ContextValidate ¶
ContextValidate validates this request add web authn based on context it is used
func (*RequestAddWebAuthn) MarshalBinary ¶
func (m *RequestAddWebAuthn) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RequestAddWebAuthn) UnmarshalBinary ¶
func (m *RequestAddWebAuthn) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RequestCode ¶
type RequestCode struct {
// address
Address string `json:"address,omitempty" yaml:"address,omitempty"`
// identifier
Identifier string `json:"identifier,omitempty" yaml:"identifier,omitempty"`
// code metadata
Metadata map[string]interface{} `json:"metadata,omitempty" yaml:"metadata,omitempty"`
// type
// Required: true
// Enum: ["activation","reset_password","reset_totp","enroll_webauthn","challenge","verify_address","authentication","pair_device"]
Type string `json:"type" yaml:"type"`
}
RequestCode request code
swagger:model RequestCode
func (*RequestCode) ContextValidate ¶
ContextValidate validates this request code based on context it is used
func (*RequestCode) MarshalBinary ¶
func (m *RequestCode) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RequestCode) UnmarshalBinary ¶
func (m *RequestCode) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RequestCodeForUser ¶
type RequestCodeForUser struct {
// address
Address string `json:"address,omitempty" yaml:"address,omitempty"`
// identifier
Identifier string `json:"identifier,omitempty" yaml:"identifier,omitempty"`
// code metadata
Metadata map[string]interface{} `json:"metadata,omitempty" yaml:"metadata,omitempty"`
// type
// Required: true
// Enum: ["activation","reset_password","reset_totp","enroll_webauthn","challenge","verify_address","authentication","pair_device"]
Type string `json:"type" yaml:"type"`
// user ID
UserID string `json:"userID,omitempty" yaml:"userID,omitempty"`
}
RequestCodeForUser request code for user
swagger:model RequestCodeForUser
func (*RequestCodeForUser) ContextValidate ¶
ContextValidate validates this request code for user based on context it is used
func (*RequestCodeForUser) MarshalBinary ¶
func (m *RequestCodeForUser) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RequestCodeForUser) UnmarshalBinary ¶
func (m *RequestCodeForUser) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RequestOTPCode ¶
type RequestOTPCode struct {
// address
Address string `json:"address,omitempty" yaml:"address,omitempty"`
// identifier
Identifier string `json:"identifier,omitempty" yaml:"identifier,omitempty"`
// user ID
UserID string `json:"userID,omitempty" yaml:"userID,omitempty"`
}
RequestOTPCode request o t p code
swagger:model RequestOTPCode
func (*RequestOTPCode) ContextValidate ¶
ContextValidate validates this request o t p code based on context it is used
func (*RequestOTPCode) MarshalBinary ¶
func (m *RequestOTPCode) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RequestOTPCode) UnmarshalBinary ¶
func (m *RequestOTPCode) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RequestOTPForAddress ¶
type RequestOTPForAddress struct {
// address
// Required: true
Address string `json:"address" yaml:"address"`
}
RequestOTPForAddress request o t p for address
swagger:model RequestOTPForAddress
func (*RequestOTPForAddress) ContextValidate ¶
ContextValidate validates this request o t p for address based on context it is used
func (*RequestOTPForAddress) MarshalBinary ¶
func (m *RequestOTPForAddress) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RequestOTPForAddress) UnmarshalBinary ¶
func (m *RequestOTPForAddress) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ResetCredentialsSettings ¶
type ResetCredentialsSettings struct {
// do not allow users to self reset credentials
DoNotAllowUsersToSelfResetCredentials bool `json:"do_not_allow_users_to_self_reset_credentials,omitempty" yaml:"do_not_allow_users_to_self_reset_credentials,omitempty"`
// reset password older than
// Format: date-time
ResetPasswordOlderThan strfmt.DateTime `json:"reset_password_older_than,omitempty" yaml:"reset_password_older_than,omitempty"`
// reset totp older than
// Format: date-time
ResetTotpOlderThan strfmt.DateTime `json:"reset_totp_older_than,omitempty" yaml:"reset_totp_older_than,omitempty"`
// reset webauthn older than
// Format: date-time
ResetWebauthnOlderThan strfmt.DateTime `json:"reset_webauthn_older_than,omitempty" yaml:"reset_webauthn_older_than,omitempty"`
}
ResetCredentialsSettings reset credentials settings
swagger:model ResetCredentialsSettings
func (*ResetCredentialsSettings) ContextValidate ¶
func (m *ResetCredentialsSettings) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this reset credentials settings based on context it is used
func (*ResetCredentialsSettings) MarshalBinary ¶
func (m *ResetCredentialsSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ResetCredentialsSettings) UnmarshalBinary ¶
func (m *ResetCredentialsSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ResidentKeyRequirement ¶
type ResidentKeyRequirement string
ResidentKeyRequirement ResidentKeyRequirement represents the IDL of the same name.
This enumeration’s values describe the Relying Party's requirements for client-side discoverable credentials (formerly known as resident credentials or resident keys).
Specifies the extent to which the Relying Party desires to create a client-side discoverable credential. For historical reasons the naming retains the deprecated “resident” terminology. The value SHOULD be a member of ResidentKeyRequirement but client platforms MUST ignore unknown values, treating an unknown value as if the member does not exist. If no value is given then the effective value is required if requireResidentKey is true or discouraged if it is false or absent.
Specification: §5.4.4. Authenticator Selection Criteria (https://www.w3.org/TR/webauthn/#dom-authenticatorselectioncriteria-residentkey)
Specification: §5.4.6. Resident Key Requirement Enumeration (https://www.w3.org/TR/webauthn/#enumdef-residentkeyrequirement)
swagger:model ResidentKeyRequirement
func (ResidentKeyRequirement) ContextValidate ¶
ContextValidate validates this resident key requirement based on context it is used
type ResourceType ¶
type ResourceType struct {
// description
Description string `json:"description,omitempty" yaml:"description,omitempty"`
// endpoint
Endpoint string `json:"endpoint,omitempty" yaml:"endpoint,omitempty"`
// id
ID string `json:"id,omitempty" yaml:"id,omitempty"`
// meta
Meta *SCIMv2Meta `json:"meta,omitempty" yaml:"meta,omitempty"`
// name
Name string `json:"name,omitempty" yaml:"name,omitempty"`
// schema
Schema string `json:"schema,omitempty" yaml:"schema,omitempty"`
// schema extensions
SchemaExtensions []*SchemaExtension `json:"schemaExtensions" yaml:"schemaExtensions"`
// schemas
Schemas []string `json:"schemas" yaml:"schemas"`
}
ResourceType resource type
swagger:model ResourceType
func (*ResourceType) ContextValidate ¶
ContextValidate validate this resource type based on the context it is used
func (*ResourceType) MarshalBinary ¶
func (m *ResourceType) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ResourceType) UnmarshalBinary ¶
func (m *ResourceType) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ResourceTypes ¶
type ResourceTypes struct {
// resources
Resources []*ResourceType `json:"Resources" yaml:"Resources"`
// items per page
ItemsPerPage int64 `json:"itemsPerPage,omitempty" yaml:"itemsPerPage,omitempty"`
// schemas
Schemas []string `json:"schemas" yaml:"schemas"`
// start index
StartIndex int64 `json:"startIndex,omitempty" yaml:"startIndex,omitempty"`
// total results
TotalResults int64 `json:"totalResults,omitempty" yaml:"totalResults,omitempty"`
}
ResourceTypes resource types
swagger:model ResourceTypes
func (*ResourceTypes) ContextValidate ¶
ContextValidate validate this resource types based on the context it is used
func (*ResourceTypes) MarshalBinary ¶
func (m *ResourceTypes) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ResourceTypes) UnmarshalBinary ¶
func (m *ResourceTypes) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Rfc6902PatchOperation ¶
type Rfc6902PatchOperation struct {
// Each operation must have at least one `op` member, which value indicates
// the actual operation to be performed against the target (current) configuration.
// For a detailed description of available operations,
// see the [Operations #4 section of the RFC6902 specification](https://datatracker.ietf.org/doc/html/rfc6902#section-4).
// Enum: ["add","remove","replace","move","copy","test"]
Op string `json:"op,omitempty" yaml:"op,omitempty"`
// String containing a JSON-Pointer value ([RFC6901](https://datatracker.ietf.org/doc/html/rfc6901))
// that references a location within the target configuration where the operation is performed.
//
// For available paths, reference the exported configuration.
Path string `json:"path,omitempty" yaml:"path,omitempty"`
// New object value applied to the patched (target) configuration.
Value interface{} `json:"value,omitempty" yaml:"value,omitempty"`
}
Rfc6902PatchOperation rfc6902 patch operation
swagger:model Rfc6902PatchOperation
func (*Rfc6902PatchOperation) ContextValidate ¶
ContextValidate validates this rfc6902 patch operation based on context it is used
func (*Rfc6902PatchOperation) MarshalBinary ¶
func (m *Rfc6902PatchOperation) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Rfc6902PatchOperation) UnmarshalBinary ¶
func (m *Rfc6902PatchOperation) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Rfc6902PatchOperations ¶
type Rfc6902PatchOperations []*Rfc6902PatchOperation
Rfc6902PatchOperations rfc6902 patch operations
swagger:model Rfc6902PatchOperations
func (Rfc6902PatchOperations) ContextValidate ¶
ContextValidate validate this rfc6902 patch operations based on the context it is used
type SCIMSettings ¶
type SCIMSettings struct {
// inbound input mapping
InboundInputMapping []*FieldMapping `json:"inboundInputMapping" yaml:"inboundInputMapping"`
}
SCIMSettings s c i m settings
swagger:model SCIMSettings
func (*SCIMSettings) ContextValidate ¶
ContextValidate validate this s c i m settings based on the context it is used
func (*SCIMSettings) MarshalBinary ¶
func (m *SCIMSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SCIMSettings) UnmarshalBinary ¶
func (m *SCIMSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SCIMv2AttributeType ¶
type SCIMv2AttributeType string
SCIMv2AttributeType s c i mv2 attribute type
swagger:model SCIMv2AttributeType
func (SCIMv2AttributeType) ContextValidate ¶
ContextValidate validates this s c i mv2 attribute type based on context it is used
type SCIMv2Email ¶
type SCIMv2Email struct {
// primary
Primary bool `json:"primary,omitempty" yaml:"primary,omitempty"`
// type
Type string `json:"type,omitempty" yaml:"type,omitempty"`
// value
Value string `json:"value,omitempty" yaml:"value,omitempty"`
}
SCIMv2Email s c i mv2 email
swagger:model SCIMv2Email
func (*SCIMv2Email) ContextValidate ¶
ContextValidate validates this s c i mv2 email based on context it is used
func (*SCIMv2Email) MarshalBinary ¶
func (m *SCIMv2Email) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SCIMv2Email) UnmarshalBinary ¶
func (m *SCIMv2Email) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SCIMv2ErrorResponse ¶
type SCIMv2ErrorResponse struct {
// detail
Detail string `json:"detail,omitempty" yaml:"detail,omitempty"`
// schemas
Schemas []string `json:"schemas" yaml:"schemas"`
// scim type
ScimType string `json:"scimType,omitempty" yaml:"scimType,omitempty"`
// status
Status string `json:"status,omitempty" yaml:"status,omitempty"`
}
SCIMv2ErrorResponse s c i mv2 error response
swagger:model SCIMv2ErrorResponse
func (*SCIMv2ErrorResponse) ContextValidate ¶
ContextValidate validates this s c i mv2 error response based on context it is used
func (*SCIMv2ErrorResponse) MarshalBinary ¶
func (m *SCIMv2ErrorResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SCIMv2ErrorResponse) UnmarshalBinary ¶
func (m *SCIMv2ErrorResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SCIMv2ExtensionEmail ¶
type SCIMv2ExtensionEmail struct {
// primary
Primary bool `json:"primary,omitempty" yaml:"primary,omitempty"`
// value
Value string `json:"value,omitempty" yaml:"value,omitempty"`
// verified
Verified bool `json:"verified,omitempty" yaml:"verified,omitempty"`
}
SCIMv2ExtensionEmail s c i mv2 extension email
swagger:model SCIMv2ExtensionEmail
func (*SCIMv2ExtensionEmail) ContextValidate ¶
ContextValidate validates this s c i mv2 extension email based on context it is used
func (*SCIMv2ExtensionEmail) MarshalBinary ¶
func (m *SCIMv2ExtensionEmail) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SCIMv2ExtensionEmail) UnmarshalBinary ¶
func (m *SCIMv2ExtensionEmail) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SCIMv2ExtensionPhoneNumber ¶
type SCIMv2ExtensionPhoneNumber struct {
// primary
Primary bool `json:"primary,omitempty" yaml:"primary,omitempty"`
// value
Value string `json:"value,omitempty" yaml:"value,omitempty"`
// verified
Verified bool `json:"verified,omitempty" yaml:"verified,omitempty"`
}
SCIMv2ExtensionPhoneNumber s c i mv2 extension phone number
swagger:model SCIMv2ExtensionPhoneNumber
func (*SCIMv2ExtensionPhoneNumber) ContextValidate ¶
func (m *SCIMv2ExtensionPhoneNumber) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this s c i mv2 extension phone number based on context it is used
func (*SCIMv2ExtensionPhoneNumber) MarshalBinary ¶
func (m *SCIMv2ExtensionPhoneNumber) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SCIMv2ExtensionPhoneNumber) UnmarshalBinary ¶
func (m *SCIMv2ExtensionPhoneNumber) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SCIMv2Identifier ¶
type SCIMv2Identifier struct {
// type
Type SCIMv2IdentifierType `json:"type,omitempty" yaml:"type,omitempty"`
// value
// Example: testUsername
Value string `json:"value,omitempty" yaml:"value,omitempty"`
}
SCIMv2Identifier s c i mv2 identifier
swagger:model SCIMv2Identifier
func (*SCIMv2Identifier) ContextValidate ¶
ContextValidate validate this s c i mv2 identifier based on the context it is used
func (*SCIMv2Identifier) MarshalBinary ¶
func (m *SCIMv2Identifier) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SCIMv2Identifier) UnmarshalBinary ¶
func (m *SCIMv2Identifier) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SCIMv2IdentifierType ¶
type SCIMv2IdentifierType string
SCIMv2IdentifierType s c i mv2 identifier type
swagger:model SCIMv2IdentifierType
func (SCIMv2IdentifierType) ContextValidate ¶
ContextValidate validates this s c i mv2 identifier type based on context it is used
type SCIMv2Meta ¶
type SCIMv2Meta struct {
// created
Created string `json:"created,omitempty" yaml:"created,omitempty"`
// last modified
LastModified string `json:"lastModified,omitempty" yaml:"lastModified,omitempty"`
// location
Location string `json:"location,omitempty" yaml:"location,omitempty"`
// resource type
ResourceType string `json:"resourceType,omitempty" yaml:"resourceType,omitempty"`
// version
Version string `json:"version,omitempty" yaml:"version,omitempty"`
}
SCIMv2Meta s c i mv2 meta
swagger:model SCIMv2Meta
func (*SCIMv2Meta) ContextValidate ¶
ContextValidate validates this s c i mv2 meta based on context it is used
func (*SCIMv2Meta) MarshalBinary ¶
func (m *SCIMv2Meta) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SCIMv2Meta) UnmarshalBinary ¶
func (m *SCIMv2Meta) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SCIMv2Patch ¶
type SCIMv2Patch struct {
// operations
Operations Rfc6902PatchOperations `json:"Operations,omitempty" yaml:"Operations,omitempty"`
// example ["urn:ietf:params:scim:api:messages:2.0:PatchOp"]
Schemas []string `json:"schemas" yaml:"schemas"`
}
SCIMv2Patch s c i mv2 patch
swagger:model SCIMv2Patch
func (*SCIMv2Patch) ContextValidate ¶
ContextValidate validate this s c i mv2 patch based on the context it is used
func (*SCIMv2Patch) MarshalBinary ¶
func (m *SCIMv2Patch) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SCIMv2Patch) UnmarshalBinary ¶
func (m *SCIMv2Patch) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SCIMv2PhoneNumber ¶
type SCIMv2PhoneNumber struct {
// primary
Primary bool `json:"primary,omitempty" yaml:"primary,omitempty"`
// type
Type string `json:"type,omitempty" yaml:"type,omitempty"`
// value
Value string `json:"value,omitempty" yaml:"value,omitempty"`
}
SCIMv2PhoneNumber s c i mv2 phone number
swagger:model SCIMv2PhoneNumber
func (*SCIMv2PhoneNumber) ContextValidate ¶
ContextValidate validates this s c i mv2 phone number based on context it is used
func (*SCIMv2PhoneNumber) MarshalBinary ¶
func (m *SCIMv2PhoneNumber) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SCIMv2PhoneNumber) UnmarshalBinary ¶
func (m *SCIMv2PhoneNumber) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SCIMv2Schema ¶
type SCIMv2Schema struct {
// attributes
Attributes []*Attribute `json:"attributes" yaml:"attributes"`
// description
Description string `json:"description,omitempty" yaml:"description,omitempty"`
// id
ID string `json:"id,omitempty" yaml:"id,omitempty"`
// meta
Meta *SCIMv2Meta `json:"meta,omitempty" yaml:"meta,omitempty"`
// name
Name string `json:"name,omitempty" yaml:"name,omitempty"`
// schemas
Schemas []string `json:"schemas" yaml:"schemas"`
}
SCIMv2Schema s c i mv2 schema
swagger:model SCIMv2Schema
func (*SCIMv2Schema) ContextValidate ¶
ContextValidate validate this s c i mv2 schema based on the context it is used
func (*SCIMv2Schema) MarshalBinary ¶
func (m *SCIMv2Schema) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SCIMv2Schema) UnmarshalBinary ¶
func (m *SCIMv2Schema) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SCIMv2Schemas ¶
type SCIMv2Schemas struct {
// resources
Resources []*SCIMv2Schema `json:"Resources" yaml:"Resources"`
// items per page
ItemsPerPage int64 `json:"itemsPerPage,omitempty" yaml:"itemsPerPage,omitempty"`
// schemas
Schemas []string `json:"schemas" yaml:"schemas"`
// start index
StartIndex int64 `json:"startIndex,omitempty" yaml:"startIndex,omitempty"`
// total results
TotalResults int64 `json:"totalResults,omitempty" yaml:"totalResults,omitempty"`
}
SCIMv2Schemas s c i mv2 schemas
swagger:model SCIMv2Schemas
func (*SCIMv2Schemas) ContextValidate ¶
ContextValidate validate this s c i mv2 schemas based on the context it is used
func (*SCIMv2Schemas) MarshalBinary ¶
func (m *SCIMv2Schemas) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SCIMv2Schemas) UnmarshalBinary ¶
func (m *SCIMv2Schemas) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SCIMv2UserGroup ¶
type SCIMv2UserGroup struct {
// dollar ref
DollarRef string `json:"$ref,omitempty" yaml:"$ref,omitempty"`
// type
Type GroupMembershipType `json:"type,omitempty" yaml:"type,omitempty"`
// value
Value string `json:"value,omitempty" yaml:"value,omitempty"`
}
SCIMv2UserGroup s c i mv2 user group
swagger:model SCIMv2UserGroup
func (*SCIMv2UserGroup) ContextValidate ¶
ContextValidate validate this s c i mv2 user group based on the context it is used
func (*SCIMv2UserGroup) MarshalBinary ¶
func (m *SCIMv2UserGroup) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SCIMv2UserGroup) UnmarshalBinary ¶
func (m *SCIMv2UserGroup) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SHAConfig ¶
type SHAConfig struct {
// function
Function string `json:"function,omitempty" yaml:"function,omitempty"`
// salt
Salt string `json:"salt,omitempty" yaml:"salt,omitempty"`
// salt after digest in hash
SaltAfterDigestInHash bool `json:"salt_after_digest_in_hash,omitempty" yaml:"salt_after_digest_in_hash,omitempty"`
// salt length
SaltLength int64 `json:"salt_length,omitempty" yaml:"salt_length,omitempty"`
}
SHAConfig s h a config
swagger:model SHAConfig
func (*SHAConfig) ContextValidate ¶
ContextValidate validates this s h a config based on context it is used
func (*SHAConfig) MarshalBinary ¶
MarshalBinary interface implementation
func (*SHAConfig) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Schema ¶
type Schema struct {
// created at
// Format: date-time
CreatedAt strfmt.DateTime `json:"created_at,omitempty" yaml:"created_at,omitempty"`
// description
Description string `json:"description,omitempty" yaml:"description,omitempty"`
// id
ID string `json:"id,omitempty" yaml:"id,omitempty"`
// name
// Required: true
Name string `json:"name" yaml:"name"`
// schema
// Required: true
Schema *SupportedJSONSchema `json:"schema" yaml:"schema"`
// system
System bool `json:"system,omitempty" yaml:"system,omitempty"`
// tenant id
// Example: default
// Required: true
TenantID string `json:"tenant_id" yaml:"tenant_id"`
// updated at
// Format: date-time
UpdatedAt strfmt.DateTime `json:"updated_at,omitempty" yaml:"updated_at,omitempty"`
}
Schema schema
swagger:model Schema
func (*Schema) ContextValidate ¶
ContextValidate validate this schema based on the context it is used
func (*Schema) MarshalBinary ¶
MarshalBinary interface implementation
func (*Schema) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type SchemaExtension ¶
type SchemaExtension struct {
// required
Required bool `json:"required,omitempty" yaml:"required,omitempty"`
// schema
Schema string `json:"schema,omitempty" yaml:"schema,omitempty"`
}
SchemaExtension schema extension
swagger:model SchemaExtension
func (*SchemaExtension) ContextValidate ¶
ContextValidate validates this schema extension based on context it is used
func (*SchemaExtension) MarshalBinary ¶
func (m *SchemaExtension) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SchemaExtension) UnmarshalBinary ¶
func (m *SchemaExtension) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Schemas ¶
type Schemas struct {
// schemas
Schemas []*Schema `json:"schemas" yaml:"schemas"`
}
Schemas schemas
swagger:model Schemas
func (*Schemas) ContextValidate ¶
ContextValidate validate this schemas based on the context it is used
func (*Schemas) MarshalBinary ¶
MarshalBinary interface implementation
func (*Schemas) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type SelfRegisterUser ¶
type SelfRegisterUser struct {
// identifier
// Required: true
Identifier string `json:"identifier" yaml:"identifier"`
// otp address
OtpAddress string `json:"otp_address,omitempty" yaml:"otp_address,omitempty"`
// password
Password string `json:"password,omitempty" yaml:"password,omitempty"`
// payload
Payload map[string]interface{} `json:"payload,omitempty" yaml:"payload,omitempty"`
// totp secret
TotpSecret string `json:"totp_secret,omitempty" yaml:"totp_secret,omitempty"`
// webauthn credentials
WebauthnCredentials []*WebAuthnCredential `json:"webauthn_credentials" yaml:"webauthn_credentials"`
// webauthn type
// Enum: ["regular","discoverable"]
WebauthnType string `json:"webauthn_type,omitempty" yaml:"webauthn_type,omitempty"`
}
SelfRegisterUser self register user
swagger:model SelfRegisterUser
func (*SelfRegisterUser) ContextValidate ¶
ContextValidate validate this self register user based on the context it is used
func (*SelfRegisterUser) MarshalBinary ¶
func (m *SelfRegisterUser) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SelfRegisterUser) UnmarshalBinary ¶
func (m *SelfRegisterUser) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ServiceProviderConfig ¶
type ServiceProviderConfig struct {
// authentication schemes
AuthenticationSchemes []*AuthenticationScheme `json:"authenticationSchemes" yaml:"authenticationSchemes"`
// bulk
Bulk *BulkSupport `json:"bulk,omitempty" yaml:"bulk,omitempty"`
// change password
ChangePassword *SupportedFeature `json:"changePassword,omitempty" yaml:"changePassword,omitempty"`
// documentation Uri
DocumentationURI string `json:"documentationUri,omitempty" yaml:"documentationUri,omitempty"`
// etag
Etag *SupportedFeature `json:"etag,omitempty" yaml:"etag,omitempty"`
// filter
Filter *FilterSupport `json:"filter,omitempty" yaml:"filter,omitempty"`
// meta
Meta *SCIMv2Meta `json:"meta,omitempty" yaml:"meta,omitempty"`
// patch
Patch *SupportedFeature `json:"patch,omitempty" yaml:"patch,omitempty"`
// schemas
Schemas []string `json:"schemas" yaml:"schemas"`
// sort
Sort *SupportedFeature `json:"sort,omitempty" yaml:"sort,omitempty"`
// xml data format
XMLDataFormat *SupportedFeature `json:"xmlDataFormat,omitempty" yaml:"xmlDataFormat,omitempty"`
}
ServiceProviderConfig service provider config
swagger:model ServiceProviderConfig
func (*ServiceProviderConfig) ContextValidate ¶
ContextValidate validate this service provider config based on the context it is used
func (*ServiceProviderConfig) MarshalBinary ¶
func (m *ServiceProviderConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ServiceProviderConfig) UnmarshalBinary ¶
func (m *ServiceProviderConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SetPasswordStateRequest ¶
type SetPasswordStateRequest struct {
// state
// Enum: ["valid","must_be_reset","must_be_changed"]
State string `json:"state,omitempty" yaml:"state,omitempty"`
}
SetPasswordStateRequest set password state request
swagger:model SetPasswordStateRequest
func (*SetPasswordStateRequest) ContextValidate ¶
func (m *SetPasswordStateRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this set password state request based on context it is used
func (*SetPasswordStateRequest) MarshalBinary ¶
func (m *SetPasswordStateRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SetPasswordStateRequest) UnmarshalBinary ¶
func (m *SetPasswordStateRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SupportedFeature ¶
type SupportedFeature struct {
// supported
Supported bool `json:"supported,omitempty" yaml:"supported,omitempty"`
}
SupportedFeature supported feature
swagger:model SupportedFeature
func (*SupportedFeature) ContextValidate ¶
ContextValidate validates this supported feature based on context it is used
func (*SupportedFeature) MarshalBinary ¶
func (m *SupportedFeature) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SupportedFeature) UnmarshalBinary ¶
func (m *SupportedFeature) 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 TenantDump ¶
type TenantDump struct {
// codes
Codes []*Code `json:"codes" yaml:"codes"`
// group members
GroupMembers []*GroupMember `json:"group_members" yaml:"group_members"`
// groups
Groups []*InternalGroup `json:"groups" yaml:"groups"`
// pools
Pools []*Pool `json:"pools" yaml:"pools"`
// schemas
Schemas []*Schema `json:"schemas" yaml:"schemas"`
// user credentials
UserCredentials []*UserCredential `json:"user_credentials" yaml:"user_credentials"`
// user identifiers
UserIdentifiers []*UserIdentifier `json:"user_identifiers" yaml:"user_identifiers"`
// user verifiable addresses
UserVerifiableAddresses []*UserVerifiableAddress `json:"user_verifiable_addresses" yaml:"user_verifiable_addresses"`
// users
Users []*User `json:"users" yaml:"users"`
}
TenantDump tenant dump
swagger:model TenantDump
func (*TenantDump) ContextValidate ¶
ContextValidate validate this tenant dump based on the context it is used
func (*TenantDump) MarshalBinary ¶
func (m *TenantDump) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TenantDump) UnmarshalBinary ¶
func (m *TenantDump) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TotpSettings ¶
type TotpSettings struct {
// issuer
Issuer string `json:"issuer,omitempty" yaml:"issuer,omitempty"`
}
TotpSettings totp settings
swagger:model TotpSettings
func (*TotpSettings) ContextValidate ¶
ContextValidate validates this totp settings based on context it is used
func (*TotpSettings) MarshalBinary ¶
func (m *TotpSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TotpSettings) UnmarshalBinary ¶
func (m *TotpSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type URLEncodedBase64 ¶
type URLEncodedBase64 string
URLEncodedBase64 URLEncodedBase64 holds URL-encoded base64 data as an opaque string.
Base64url-encoded data carried as an opaque string. Decoding to raw bytes, if needed, is the consumer responsibility.
swagger:model URLEncodedBase64
func (URLEncodedBase64) ContextValidate ¶
ContextValidate validates this URL encoded base64 based on context it is used
type UpdateUser ¶
type UpdateUser struct {
// business metadata
BusinessMetadata map[string]interface{} `json:"business_metadata,omitempty" yaml:"business_metadata,omitempty"`
// business metadata schema id
BusinessMetadataSchemaID string `json:"business_metadata_schema_id,omitempty" yaml:"business_metadata_schema_id,omitempty"`
// metadata
Metadata map[string]interface{} `json:"metadata,omitempty" yaml:"metadata,omitempty"`
// metadata schema id
MetadataSchemaID string `json:"metadata_schema_id,omitempty" yaml:"metadata_schema_id,omitempty"`
// payload
Payload map[string]interface{} `json:"payload,omitempty" yaml:"payload,omitempty"`
// payload schema id
PayloadSchemaID string `json:"payload_schema_id,omitempty" yaml:"payload_schema_id,omitempty"`
// preferences
Preferences *UserPreferences `json:"preferences,omitempty" yaml:"preferences,omitempty"`
// status
// Enum: ["active","inactive","deleted","new"]
Status string `json:"status,omitempty" yaml:"status,omitempty"`
}
UpdateUser update user
swagger:model UpdateUser
func (*UpdateUser) ContextValidate ¶
ContextValidate validate this update user based on the context it is used
func (*UpdateUser) MarshalBinary ¶
func (m *UpdateUser) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateUser) UnmarshalBinary ¶
func (m *UpdateUser) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateUserVerifiableAddress ¶
type UpdateUserVerifiableAddress struct {
// address
// Required: true
Address string `json:"address" yaml:"address"`
// is allowed for 2FA
AllowedFor2fa bool `json:"allowed_for_2fa,omitempty" yaml:"allowed_for_2fa,omitempty"`
// message redaction
MessageRedaction *RedactionPolicy `json:"message_redaction,omitempty" yaml:"message_redaction,omitempty"`
// general purpose metadata
Metadata map[string]interface{} `json:"metadata,omitempty" yaml:"metadata,omitempty"`
// 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"`
// verified
// Example: false
// Required: true
Verified bool `json:"verified" yaml:"verified"`
}
UpdateUserVerifiableAddress update user verifiable address
swagger:model UpdateUserVerifiableAddress
func (*UpdateUserVerifiableAddress) ContextValidate ¶
func (m *UpdateUserVerifiableAddress) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this update user verifiable address based on the context it is used
func (*UpdateUserVerifiableAddress) MarshalBinary ¶
func (m *UpdateUserVerifiableAddress) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateUserVerifiableAddress) UnmarshalBinary ¶
func (m *UpdateUserVerifiableAddress) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type User ¶
type User struct {
// business metadata
BusinessMetadata map[string]interface{} `json:"business_metadata,omitempty" yaml:"business_metadata,omitempty"`
// business metadata schema id
BusinessMetadataSchemaID string `json:"business_metadata_schema_id,omitempty" yaml:"business_metadata_schema_id,omitempty"`
// created at
// Format: date-time
CreatedAt strfmt.DateTime `json:"created_at,omitempty" yaml:"created_at,omitempty"`
// id
ID string `json:"id,omitempty" yaml:"id,omitempty"`
// metadata
Metadata map[string]interface{} `json:"metadata,omitempty" yaml:"metadata,omitempty"`
// metadata schema id
MetadataSchemaID string `json:"metadata_schema_id,omitempty" yaml:"metadata_schema_id,omitempty"`
// payload
Payload map[string]interface{} `json:"payload,omitempty" yaml:"payload,omitempty"`
// payload schema id
PayloadSchemaID string `json:"payload_schema_id,omitempty" yaml:"payload_schema_id,omitempty"`
// preferences
Preferences *UserPreferences `json:"preferences,omitempty" yaml:"preferences,omitempty"`
// status
// Example: active
// Required: true
// Enum: ["active","inactive","deleted","new"]
Status string `json:"status" yaml:"status"`
// status updated at
// Format: date-time
StatusUpdatedAt strfmt.DateTime `json:"status_updated_at,omitempty" yaml:"status_updated_at,omitempty"`
// tenant id
// Example: default
// Required: true
TenantID string `json:"tenant_id" yaml:"tenant_id"`
// updated at
// Format: date-time
UpdatedAt strfmt.DateTime `json:"updated_at,omitempty" yaml:"updated_at,omitempty"`
// user pool id
// Example: default
// Required: true
UserPoolID string `json:"user_pool_id" yaml:"user_pool_id"`
// user type
// Enum: ["jit","standard","scim"]
UserType string `json:"user_type,omitempty" yaml:"user_type,omitempty"`
}
User user
swagger:model User
func (*User) ContextValidate ¶
ContextValidate validate this user based on the context it is used
func (*User) MarshalBinary ¶
MarshalBinary interface implementation
func (*User) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type UserCredential ¶
type UserCredential struct {
// created at
// Required: true
// Format: date-time
CreatedAt strfmt.DateTime `json:"created_at" yaml:"created_at"`
// discoverable id
DiscoverableID string `json:"discoverable_id,omitempty" yaml:"discoverable_id,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"`
// payload
// Example: {"hashed_password":"###"}
// Required: true
Payload interface{} `json:"payload" yaml:"payload"`
// state
// Enum: ["valid","must_be_reset","must_be_changed"]
State string `json:"state,omitempty" yaml:"state,omitempty"`
// tenant id
// Example: default
// Required: true
TenantID string `json:"tenant_id" yaml:"tenant_id"`
// type
// Example: password
// Required: true
// Enum: ["password","webauthn","totp","device"]
Type string `json:"type" yaml:"type"`
// updated at
// Required: true
// Format: date-time
UpdatedAt strfmt.DateTime `json:"updated_at" yaml:"updated_at"`
// user id
// Required: true
UserID string `json:"user_id" yaml:"user_id"`
// user pool id
// Example: default
// Required: true
UserPoolID string `json:"user_pool_id" yaml:"user_pool_id"`
}
UserCredential user credential
swagger:model UserCredential
func (*UserCredential) ContextValidate ¶
ContextValidate validates this user credential based on context it is used
func (*UserCredential) MarshalBinary ¶
func (m *UserCredential) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UserCredential) UnmarshalBinary ¶
func (m *UserCredential) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UserEntity ¶
type UserEntity struct {
// A human-palatable name for the user account, intended only for display.
// For example, "Alex P. Müller" or "田中 倫". The Relying Party SHOULD let
// the user choose this, and SHOULD NOT restrict the choice more than necessary.
DisplayName string `json:"displayName,omitempty" yaml:"displayName,omitempty"`
// ID is the user handle of the user account entity. To ensure secure operation,
// authentication and authorization decisions MUST be made on the basis of this id
// member, not the displayName nor name members. See Section 6.1 of
// [RFC8266](https://www.w3.org/TR/webauthn/#biblio-rfc8266).
ID interface{} `json:"id,omitempty" yaml:"id,omitempty"`
// A human-palatable name for the entity. Its function depends on what the PublicKeyCredentialEntity represents:
//
// When inherited by PublicKeyCredentialRpEntity it is a human-palatable identifier for the Relying Party,
// intended only for display. For example, "ACME Corporation", "Wonderful Widgets, Inc." or "ОАО Примертех".
//
// When inherited by PublicKeyCredentialUserEntity, it is a human-palatable identifier for a user account. It is
// intended only for display, i.e., aiding the user in determining the difference between user accounts with similar
// displayNames. For example, "alexm", "alex.p.mueller@example.com" or "+14255551234".
Name string `json:"name,omitempty" yaml:"name,omitempty"`
}
UserEntity The UserEntity represents the PublicKeyCredentialUserEntity IDL and is used to supply additional user account attributes when creating a new credential.
Specification: §5.4.3 User Account Parameters for Credential Generation (https://www.w3.org/TR/webauthn/#dictdef-publickeycredentialuserentity)
swagger:model UserEntity
func (*UserEntity) ContextValidate ¶
ContextValidate validates this user entity based on context it is used
func (*UserEntity) MarshalBinary ¶
func (m *UserEntity) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UserEntity) UnmarshalBinary ¶
func (m *UserEntity) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UserGetResponse ¶
type UserGetResponse struct {
// active
Active bool `json:"active,omitempty" yaml:"active,omitempty"`
// emails
Emails []*SCIMv2Email `json:"emails" yaml:"emails"`
// external Id
// Example: someExternalID
ExternalID string `json:"externalId,omitempty" yaml:"externalId,omitempty"`
// groups
Groups []*SCIMv2UserGroup `json:"groups" yaml:"groups"`
// id
ID string `json:"id,omitempty" yaml:"id,omitempty"`
// meta
Meta *SCIMv2Meta `json:"meta,omitempty" yaml:"meta,omitempty"`
// password
// Example: wIf@O\u0026YWzdfFKSW
Password string `json:"password,omitempty" yaml:"password,omitempty"`
// phone numbers
PhoneNumbers []*SCIMv2PhoneNumber `json:"phoneNumbers" yaml:"phoneNumbers"`
// schemas
// Example: ["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:secureauthciam:2.0:User"]
Schemas []string `json:"schemas" yaml:"schemas"`
// urn ietf params scim schemas extension secureauthciam 2 0 user
UrnIetfParamsScimSchemasExtensionSecureauthciam20User *ExtensionSchemaData `` /* 159-byte string literal not displayed */
// user name
// Example: test@test.com
UserName string `json:"userName,omitempty" yaml:"userName,omitempty"`
}
UserGetResponse user get response
swagger:model UserGetResponse
func (*UserGetResponse) ContextValidate ¶
ContextValidate validate this user get response based on the context it is used
func (*UserGetResponse) MarshalBinary ¶
func (m *UserGetResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UserGetResponse) UnmarshalBinary ¶
func (m *UserGetResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UserID ¶
type UserID struct {
// id
// Required: true
ID string `json:"id" yaml:"id"`
}
UserID user ID
swagger:model UserID
func (*UserID) ContextValidate ¶
ContextValidate validates this user ID based on context it is used
func (*UserID) MarshalBinary ¶
MarshalBinary interface implementation
func (*UserID) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type UserIdentifier ¶
type UserIdentifier struct {
// created at
// Required: true
// Format: date-time
CreatedAt strfmt.DateTime `json:"created_at" yaml:"created_at"`
// id
ID string `json:"id,omitempty" yaml:"id,omitempty"`
// identifier
// Required: true
Identifier string `json:"identifier" yaml:"identifier"`
// identifier lc
// Required: true
IdentifierLc string `json:"identifier_lc" yaml:"identifier_lc"`
// general purpose metadata
Metadata map[string]interface{} `json:"metadata,omitempty" yaml:"metadata,omitempty"`
// tenant id
// Example: default
// Required: true
TenantID string `json:"tenant_id" yaml:"tenant_id"`
// type
// Example: email
// Required: true
// Enum: ["email","mobile","uid","external","federated"]
Type string `json:"type" yaml:"type"`
// updated at
// Required: true
// Format: date-time
UpdatedAt strfmt.DateTime `json:"updated_at" yaml:"updated_at"`
// user id
// Required: true
UserID string `json:"user_id" yaml:"user_id"`
// user pool id
// Example: default
// Required: true
UserPoolID string `json:"user_pool_id" yaml:"user_pool_id"`
}
UserIdentifier user identifier
swagger:model UserIdentifier
func (*UserIdentifier) ContextValidate ¶
ContextValidate validates this user identifier based on context it is used
func (*UserIdentifier) MarshalBinary ¶
func (m *UserIdentifier) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UserIdentifier) UnmarshalBinary ¶
func (m *UserIdentifier) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UserPools ¶
type UserPools struct {
// cursor
Cursor Cursor `json:"cursor,omitempty" yaml:"cursor,omitempty"`
// pools
Pools []*PoolResponse `json:"pools" yaml:"pools"`
}
UserPools user pools
swagger:model UserPools
func (*UserPools) ContextValidate ¶
ContextValidate validate this user pools based on the context it is used
func (*UserPools) MarshalBinary ¶
MarshalBinary interface implementation
func (*UserPools) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type UserPreferences ¶
type UserPreferences struct {
// Locale is the list of user's preferred languages/locales for UI and communications
// Example: en-US, es-ES
Locales []string `json:"locales" yaml:"locales"`
// mfa
Mfa *MFAPreferences `json:"mfa,omitempty" yaml:"mfa,omitempty"`
}
UserPreferences user preferences
swagger:model UserPreferences
func (*UserPreferences) ContextValidate ¶
ContextValidate validate this user preferences based on the context it is used
func (*UserPreferences) MarshalBinary ¶
func (m *UserPreferences) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UserPreferences) UnmarshalBinary ¶
func (m *UserPreferences) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UserUpsertRequest ¶
type UserUpsertRequest struct {
// active
Active bool `json:"active,omitempty" yaml:"active,omitempty"`
// emails
Emails []*SCIMv2Email `json:"emails" yaml:"emails"`
// external Id
// Example: someExternalID
ExternalID string `json:"externalId,omitempty" yaml:"externalId,omitempty"`
// password
// Example: wIf@O\u0026YWzdfFKSW
Password string `json:"password,omitempty" yaml:"password,omitempty"`
// phone numbers
PhoneNumbers []*SCIMv2PhoneNumber `json:"phoneNumbers" yaml:"phoneNumbers"`
// schemas
// Example: ["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:secureauthciam:2.0:User"]
Schemas []string `json:"schemas" yaml:"schemas"`
// urn ietf params scim schemas extension secureauthciam 2 0 user
UrnIetfParamsScimSchemasExtensionSecureauthciam20User *ExtensionSchemaData `` /* 159-byte string literal not displayed */
// user name
// Example: test@test.com
UserName string `json:"userName,omitempty" yaml:"userName,omitempty"`
}
UserUpsertRequest user upsert request
swagger:model UserUpsertRequest
func (*UserUpsertRequest) ContextValidate ¶
ContextValidate validate this user upsert request based on the context it is used
func (*UserUpsertRequest) MarshalBinary ¶
func (m *UserUpsertRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UserUpsertRequest) UnmarshalBinary ¶
func (m *UserUpsertRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UserVerifiableAddress ¶
type UserVerifiableAddress struct {
// address
// Required: true
Address string `json:"address" yaml:"address"`
// address lc
// Required: true
AddressLc string `json:"address_lc" yaml:"address_lc"`
// is allowed for 2FA
AllowedFor2fa bool `json:"allowed_for_2fa,omitempty" yaml:"allowed_for_2fa,omitempty"`
// created at
// Required: true
// Format: date-time
CreatedAt strfmt.DateTime `json:"created_at" yaml:"created_at"`
// id
ID string `json:"id,omitempty" yaml:"id,omitempty"`
// message redaction
MessageRedaction *RedactionPolicy `json:"message_redaction,omitempty" yaml:"message_redaction,omitempty"`
// general purpose metadata
Metadata map[string]interface{} `json:"metadata,omitempty" yaml:"metadata,omitempty"`
// 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"`
// tenant id
// Example: default
// Required: true
TenantID string `json:"tenant_id" yaml:"tenant_id"`
// 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"`
// user id
// Required: true
UserID string `json:"user_id" yaml:"user_id"`
// user pool id
// Example: default
// Required: true
UserPoolID string `json:"user_pool_id" yaml:"user_pool_id"`
// 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"`
}
UserVerifiableAddress user verifiable address
swagger:model UserVerifiableAddress
func (*UserVerifiableAddress) ContextValidate ¶
ContextValidate validate this user verifiable address based on the context it is used
func (*UserVerifiableAddress) MarshalBinary ¶
func (m *UserVerifiableAddress) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UserVerifiableAddress) UnmarshalBinary ¶
func (m *UserVerifiableAddress) 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 UserWithData ¶
type UserWithData struct {
// business metadata
BusinessMetadata map[string]interface{} `json:"business_metadata,omitempty" yaml:"business_metadata,omitempty"`
// business metadata schema id
BusinessMetadataSchemaID string `json:"business_metadata_schema_id,omitempty" yaml:"business_metadata_schema_id,omitempty"`
// created at
// Format: date-time
CreatedAt strfmt.DateTime `json:"created_at,omitempty" yaml:"created_at,omitempty"`
// credentials
Credentials []*UserCredential `json:"credentials" yaml:"credentials"`
// id
ID string `json:"id,omitempty" yaml:"id,omitempty"`
// identifiers
Identifiers []*UserIdentifier `json:"identifiers" yaml:"identifiers"`
// metadata
Metadata map[string]interface{} `json:"metadata,omitempty" yaml:"metadata,omitempty"`
// metadata schema id
MetadataSchemaID string `json:"metadata_schema_id,omitempty" yaml:"metadata_schema_id,omitempty"`
// payload
Payload map[string]interface{} `json:"payload,omitempty" yaml:"payload,omitempty"`
// payload schema id
PayloadSchemaID string `json:"payload_schema_id,omitempty" yaml:"payload_schema_id,omitempty"`
// preferences
Preferences *UserPreferences `json:"preferences,omitempty" yaml:"preferences,omitempty"`
// status
// Required: true
// Enum: ["active","inactive","deleted","new"]
Status string `json:"status" yaml:"status"`
// status updated at
// Format: date-time
StatusUpdatedAt strfmt.DateTime `json:"status_updated_at,omitempty" yaml:"status_updated_at,omitempty"`
// tenant id
// Example: default
// Required: true
TenantID string `json:"tenant_id" yaml:"tenant_id"`
// updated at
// Format: date-time
UpdatedAt strfmt.DateTime `json:"updated_at,omitempty" yaml:"updated_at,omitempty"`
// user pool id
// Example: default
// Required: true
UserPoolID string `json:"user_pool_id" yaml:"user_pool_id"`
// user type
// Enum: ["jit","standard","scim"]
UserType string `json:"user_type,omitempty" yaml:"user_type,omitempty"`
// verifiable addresses
VerifiableAddresses []*UserVerifiableAddress `json:"verifiable_addresses" yaml:"verifiable_addresses"`
}
UserWithData user with data
swagger:model UserWithData
func (*UserWithData) ContextValidate ¶
ContextValidate validate this user with data based on the context it is used
func (*UserWithData) MarshalBinary ¶
func (m *UserWithData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UserWithData) UnmarshalBinary ¶
func (m *UserWithData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Users ¶
type Users struct {
// users
Users []*ExtendedUser `json:"users" yaml:"users"`
}
Users Identity Users
swagger:model Users
func (*Users) ContextValidate ¶
ContextValidate validate this users based on the context it is used
func (*Users) MarshalBinary ¶
MarshalBinary interface implementation
func (*Users) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type VerifiableAddressesToSet ¶
type VerifiableAddressesToSet struct {
// addresses
Addresses []*NewUserVerifiableAddress `json:"addresses" yaml:"addresses"`
}
VerifiableAddressesToSet verifiable addresses to set
swagger:model VerifiableAddressesToSet
func (*VerifiableAddressesToSet) ContextValidate ¶
func (m *VerifiableAddressesToSet) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this verifiable addresses to set based on the context it is used
func (*VerifiableAddressesToSet) MarshalBinary ¶
func (m *VerifiableAddressesToSet) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*VerifiableAddressesToSet) UnmarshalBinary ¶
func (m *VerifiableAddressesToSet) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type VerifyCodeResult ¶
type VerifyCodeResult struct {
// id
// Required: true
ID string `json:"id" yaml:"id"`
// metadata associated with the code when it was generated
Metadata map[string]interface{} `json:"metadata,omitempty" yaml:"metadata,omitempty"`
}
VerifyCodeResult verify code result
swagger:model VerifyCodeResult
func (*VerifyCodeResult) ContextValidate ¶
ContextValidate validates this verify code result based on context it is used
func (*VerifyCodeResult) MarshalBinary ¶
func (m *VerifyCodeResult) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*VerifyCodeResult) UnmarshalBinary ¶
func (m *VerifyCodeResult) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type VerifyOTP ¶
type VerifyOTP struct {
// code
// Required: true
Code string `json:"code" yaml:"code"`
// id
ID string `json:"id,omitempty" yaml:"id,omitempty"`
// identifier
// Example: sample@email.com/+48123456789
Identifier string `json:"identifier,omitempty" yaml:"identifier,omitempty"`
// user ID
UserID string `json:"userID,omitempty" yaml:"userID,omitempty"`
}
VerifyOTP verify o t p
swagger:model VerifyOTP
func (*VerifyOTP) ContextValidate ¶
ContextValidate validates this verify o t p based on context it is used
func (*VerifyOTP) MarshalBinary ¶
MarshalBinary interface implementation
func (*VerifyOTP) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type VerifyPassword ¶
type VerifyPassword struct {
// id
ID string `json:"id,omitempty" yaml:"id,omitempty"`
// identifier
// Example: sample@email.com/+48123456789
Identifier string `json:"identifier,omitempty" yaml:"identifier,omitempty"`
// password
// Required: true
Password string `json:"password" yaml:"password"`
// user ID
UserID string `json:"userID,omitempty" yaml:"userID,omitempty"`
}
VerifyPassword verify password
swagger:model VerifyPassword
func (*VerifyPassword) ContextValidate ¶
ContextValidate validates this verify password based on context it is used
func (*VerifyPassword) MarshalBinary ¶
func (m *VerifyPassword) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*VerifyPassword) UnmarshalBinary ¶
func (m *VerifyPassword) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type VerifyPasswordResponseData ¶
type VerifyPasswordResponseData struct {
// id
// Required: true
ID string `json:"id" yaml:"id"`
// state
// Required: true
// Enum: ["valid","must_be_reset","must_be_changed"]
State string `json:"state" yaml:"state"`
}
VerifyPasswordResponseData verify password response data
swagger:model VerifyPasswordResponseData
func (*VerifyPasswordResponseData) ContextValidate ¶
func (m *VerifyPasswordResponseData) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this verify password response data based on context it is used
func (*VerifyPasswordResponseData) MarshalBinary ¶
func (m *VerifyPasswordResponseData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*VerifyPasswordResponseData) UnmarshalBinary ¶
func (m *VerifyPasswordResponseData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type VerifyPasswordResponseDataV2 ¶
type VerifyPasswordResponseDataV2 struct {
// id
// Required: true
ID string `json:"id" yaml:"id"`
// result
// Required: true
// Enum: ["password_correct","password_incorrect","password_expired","no_password","user_not_found"]
Result string `json:"result" yaml:"result"`
// state
// Required: true
// Enum: ["valid","must_be_reset","must_be_changed"]
State string `json:"state" yaml:"state"`
}
VerifyPasswordResponseDataV2 verify password response data v2
swagger:model VerifyPasswordResponseDataV2
func (*VerifyPasswordResponseDataV2) ContextValidate ¶
func (m *VerifyPasswordResponseDataV2) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this verify password response data v2 based on context it is used
func (*VerifyPasswordResponseDataV2) MarshalBinary ¶
func (m *VerifyPasswordResponseDataV2) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*VerifyPasswordResponseDataV2) UnmarshalBinary ¶
func (m *VerifyPasswordResponseDataV2) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type VerifyWebAuthnResponseData ¶
type VerifyWebAuthnResponseData struct {
// id
// Required: true
ID string `json:"id" yaml:"id"`
// result
// Required: true
// Enum: ["webauthn_correct","webauthn_incorrect","user_not_found","no_webauthn"]
Result string `json:"result" yaml:"result"`
// state
// Required: true
// Enum: ["valid","must_be_reset","must_be_changed"]
State string `json:"state" yaml:"state"`
}
VerifyWebAuthnResponseData verify web authn response data
swagger:model VerifyWebAuthnResponseData
func (*VerifyWebAuthnResponseData) ContextValidate ¶
func (m *VerifyWebAuthnResponseData) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this verify web authn response data based on context it is used
func (*VerifyWebAuthnResponseData) MarshalBinary ¶
func (m *VerifyWebAuthnResponseData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*VerifyWebAuthnResponseData) UnmarshalBinary ¶
func (m *VerifyWebAuthnResponseData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type WebAuthnCredential ¶
type WebAuthnCredential struct {
Credential
}
WebAuthnCredential web authn credential
swagger:model WebAuthnCredential
func (*WebAuthnCredential) ContextValidate ¶
ContextValidate validate this web authn credential based on the context it is used
func (WebAuthnCredential) MarshalJSON ¶
func (m WebAuthnCredential) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*WebAuthnCredential) UnmarshalJSON ¶
func (m *WebAuthnCredential) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type WebAuthnLoginBeginData ¶
type WebAuthnLoginBeginData struct {
// mediation
Mediation CredentialMediationRequirement `json:"mediation,omitempty" yaml:"mediation,omitempty"`
// public key
PublicKey *PublicKeyCredentialRequestOptions `json:"publicKey,omitempty" yaml:"publicKey,omitempty"`
// result
// Required: true
// Enum: ["webauthn_correct","webauthn_incorrect","user_not_found","no_webauthn"]
Result string `json:"result" yaml:"result"`
// session id
// Required: true
SessionID string `json:"session_id" yaml:"session_id"`
}
WebAuthnLoginBeginData WebAuthnLoginBeginData wraps the standard PublicKeyCredentialRequestOptions with a session_id that the client must echo back at complete time. The session_id keys the stored challenge so concurrent begins from different users (or the same user across tabs/integrations) do not overwrite each other — this is what the cookie store does implicitly in the browser flow.
Result mirrors the password-v2 verify response: on the happy path it is webauthn_correct and SessionID + CredentialAssertion are populated; on user_not_found / no_webauthn the challenge fields are zero-valued and only Result carries information. Callers must branch on Result before using SessionID.
swagger:model WebAuthnLoginBeginData
func (*WebAuthnLoginBeginData) ContextValidate ¶
func (m *WebAuthnLoginBeginData) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this web authn login begin data based on the context it is used
func (*WebAuthnLoginBeginData) MarshalBinary ¶
func (m *WebAuthnLoginBeginData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*WebAuthnLoginBeginData) UnmarshalBinary ¶
func (m *WebAuthnLoginBeginData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type WebAuthnSettings ¶
type WebAuthnSettings struct {
// RequireUserInteractionBeforePrompt, when true, stops the hosted web login,
// activation, and self-registration UIs from auto-initiating the browser passkey
// prompt on page load; the user must click Continue. Default false preserves
// auto-prompt behavior. API-driven WebAuthn flows are unaffected.
RequireUserInteractionBeforePrompt bool `json:"require_user_interaction_before_prompt,omitempty" yaml:"require_user_interaction_before_prompt,omitempty"`
// rp id
RpID string `json:"rp_id,omitempty" yaml:"rp_id,omitempty"`
// rp origins
RpOrigins []string `json:"rp_origins" yaml:"rp_origins"`
}
WebAuthnSettings web authn settings
swagger:model WebAuthnSettings
func (*WebAuthnSettings) ContextValidate ¶
ContextValidate validates this web authn settings based on context it is used
func (*WebAuthnSettings) MarshalBinary ¶
func (m *WebAuthnSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*WebAuthnSettings) UnmarshalBinary ¶
func (m *WebAuthnSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
Source Files
¶
- activate_self_registered_user.go
- activation_settings.go
- add_user_identifier.go
- add_user_verifiable_address.go
- address.go
- argon2_config.go
- attestation_format.go
- attribute.go
- authentication_extensions.go
- authentication_extensions_client_outputs.go
- authentication_mechanisms.go
- authentication_scheme.go
- authenticator.go
- authenticator_assertion_response.go
- authenticator_attachment.go
- authenticator_attestation_response.go
- authenticator_selection.go
- authenticator_transport.go
- base_group.go
- base_verify_o_t_p.go
- bcrypt_config.go
- begin_verify_web_authn_request.go
- bulk_support.go
- c_o_s_e_algorithm_identifier.go
- change_password.go
- change_totp_secret.go
- code.go
- code_id.go
- code_value.go
- codes.go
- complete_add_web_authn.go
- complete_address_verification.go
- complete_reset_password.go
- complete_reset_totp.go
- complete_verify_web_authn_request.go
- confirm_reset_password.go
- conveyance_preference.go
- credential.go
- credential_assertion_response.go
- credential_attestation.go
- credential_creation.go
- credential_creation_response.go
- credential_descriptor.go
- credential_extensions.go
- credential_flags.go
- credential_mediation_requirement.go
- credential_parameter.go
- credential_properties_output.go
- credential_protection_policy.go
- credential_type.go
- cursor.go
- delete_user_identifier.go
- delete_user_verifiable_address.go
- device_to_set.go
- devices_to_set.go
- error.go
- extended_user.go
- extension_schema_data.go
- field_mapping.go
- filter_support.go
- get_user_by_key.go
- group.go
- group_get_response.go
- group_member.go
- group_membership_type.go
- group_upsert_request.go
- groups.go
- h_m_a_c_get_secret_inputs.go
- h_m_a_c_get_secret_outputs.go
- hash.go
- hash_config.go
- identifier_details.go
- identifiers_to_set.go
- inspect_o_t_p.go
- inspect_o_t_p_user_operational_data.go
- internal_group.go
- large_blob_inputs.go
- large_blob_outputs.go
- large_blob_support.go
- list_groups_response.go
- list_users_response.go
- m_d5_config.go
- m_f_a_preferences.go
- member.go
- member_type.go
- name_web_authn_key.go
- new_user.go
- new_user_credential.go
- new_user_identifier.go
- new_user_verifiable_address.go
- otp_config.go
- otp_settings.go
- p_b_k_d_f2_config.go
- p_r_f_inputs.go
- p_r_f_outputs.go
- p_r_f_values.go
- password_policy.go
- password_settings.go
- pool.go
- pool_limits.go
- pool_response.go
- pools.go
- public_key_credential_creation_options.go
- public_key_credential_hints.go
- public_key_credential_request_options.go
- redaction_policy.go
- relying_party_entity.go
- request_activation.go
- request_add_or_reset_credential.go
- request_add_web_authn.go
- request_code.go
- request_code_for_user.go
- request_o_t_p_code.go
- request_o_t_p_for_address.go
- reset_credentials_settings.go
- resident_key_requirement.go
- resource_type.go
- resource_types.go
- rfc6902_patch_operation.go
- rfc6902_patch_operations.go
- s_c_i_m_settings.go
- s_c_i_mv2_attribute_type.go
- s_c_i_mv2_email.go
- s_c_i_mv2_error_response.go
- s_c_i_mv2_extension_email.go
- s_c_i_mv2_extension_phone_number.go
- s_c_i_mv2_identifier.go
- s_c_i_mv2_identifier_type.go
- s_c_i_mv2_meta.go
- s_c_i_mv2_patch.go
- s_c_i_mv2_phone_number.go
- s_c_i_mv2_schema.go
- s_c_i_mv2_schemas.go
- s_c_i_mv2_user_group.go
- s_h_a_config.go
- schema.go
- schema_extension.go
- schemas.go
- self_register_user.go
- service_provider_config.go
- set_password_state_request.go
- supported_feature.go
- supported_json_schema.go
- tenant_dump.go
- totp_settings.go
- update_user.go
- update_user_verifiable_address.go
- url_encoded_base64.go
- user.go
- user_credential.go
- user_entity.go
- user_get_response.go
- user_id.go
- user_identifier.go
- user_pools.go
- user_preferences.go
- user_upsert_request.go
- user_verifiable_address.go
- user_verification_requirement.go
- user_with_data.go
- users.go
- verifiable_addresses_to_set.go
- verify_code_result.go
- verify_o_t_p.go
- verify_password.go
- verify_password_response_data.go
- verify_password_response_data_v2.go
- verify_web_authn_response_data.go
- web_authn_credential.go
- web_authn_login_begin_data.go
- web_authn_settings.go