FusionAuth Webauthn API is one of 37 APIs that FusionAuth publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include WebAuthn. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
10 operations
across 8 paths,
and defines 56 schemas.
It is described by OpenAPI 3.2.0, at version 1.66.0.
Requests are made against 2 base URLs: http://localhost:9011, https://sandbox.fusionauth.io.
The identity and technical contract details declared by the specification.
UserVerificationRequirement
string
Used to express whether the Relying Party requires user verification for the current operation.
WebAuthnAssertResponse
object
API response for completing WebAuthn assertion
1 property
WebAuthnRegisterCompleteResponse
object
API response for completing WebAuthn credential registration or assertion
1 property
WebAuthnStartResponse
object
API response for starting a WebAuthn authentication ceremony
1 property
Errors
object
Standard error domain object that can also be used as the response from an API call.
2 properties
WebAuthnPublicKeyAuthenticationRequest
object
Request to authenticate with WebAuthn
5 properties
User
object
The public, global view of a User. This object contains all global information about the user including birthdate, registration information preferred languages…
40 properties
ContentStatus
string
Status for content like usernames, profile attributes, etc.
WebAuthnCredentialResponse
object
WebAuthn Credential API response
2 properties
UserRegistration
object
User registration information for a single application.
16 properties
MetaData
object
3 properties
AttestationType
string
Used to indicate what type of attestation was included in the authenticator response for a given WebAuthn credential at the time it was created
GroupMember
object
A User's membership into a Group
5 properties
PublicKeyCredentialRequestOptions
object
Provides the authenticator with the data it needs to generate an assertion.
5 properties
WebAuthnAuthenticatorRegistrationResponse
object
The authenticator's response for the registration ceremony in its encoded format
2 properties
UserTwoFactorConfiguration
object
2 properties
AuthenticatorAttachment
string
Describes the authenticator attachment modality .
WebAuthnExtensionsClientOutputs
object
Contains extension output for requested extensions during a WebAuthn ceremony
1 property
WebAuthnAuthenticatorAuthenticationResponse
object
The authenticator's response for the authentication ceremony in its encoded format
4 properties
CredentialPropertiesOutput
object
Contains the output for the {@code credProps} extension
1 property
WebAuthnRegisterStartResponse
object
API response for starting a WebAuthn registration ceremony
1 property
WebAuthnCredentialImportRequest
object
API request to import an existing WebAuthn credential(s)
2 properties
WebAuthnPublicKeyRegistrationRequest
object
Request to register a new public key with WebAuthn
6 properties
CoseAlgorithmIdentifier
string
A number identifying a cryptographic algorithm. Values should be registered with the IANA COSE Algorithms registry
BreachedPasswordStatus
string
LoginResponse
object
19 properties
Locale
string
A Locale object represents a specific geographical, political, or cultural region.
ZonedDateTime
integer
The number of milliseconds since the unix epoch: January 1, 1970 00:00:00 UTC. This value is always in UTC.
DeviceInfo
object
5 properties
UserIdentity
object
11 properties
WebAuthnWorkflow
string
Identifies the WebAuthn workflow. This will affect the parameters used for credential creation and request based on the Tenant configuration.
WebAuthnRegistrationExtensionOptions
object
Options to request extensions during credential registration
1 property
WebAuthnRegisterStartRequest
object
API request to start a WebAuthn registration ceremony
5 properties
Error
object
Defines an error.
3 properties
ZoneId
string
Timezone Identifier
LocalDate
string
A date without a time-zone in the ISO-8601 calendar system, such as 2007-12-03.
PublicKeyCredentialUserEntity
object
Supply additional information about the user account when creating a new credential
3 properties
PublicKeyCredentialType
string
Defines valid credential types. This is an extension point in the WebAuthn spec. The only defined value at this time is "public-key"
PublicKeyCredentialRelyingPartyEntity
object
Supply additional information about the Relying Party when creating a new credential
2 properties
AttestationConveyancePreference
string
Used to communicate whether and how authenticator attestation should be delivered to the Relying Party
PublicKeyCredentialParameters
object
Supply information on credential type and algorithm to the authenticator .
2 properties
LoginPreventedResponse
object
The summary of the action that is preventing login to be returned on the login response.
10 properties
AuthenticatorSelectionCriteria
object
Used by the Relying Party to specify their requirements for authenticator attributes. Fields use the deprecated "resident key" terminology to refer to client-s…
4 properties
WebAuthnCredential
object
A User's WebAuthnCredential. Contains all data required to complete WebAuthn authentication ceremonies.
18 properties
IdentityType
object
Model identity types provided by FusionAuth.
1 property
AuthenticatorConfiguration
object
3 properties
PublicKeyCredentialCreationOptions
object
Allows the Relying Party to specify desired attributes of a new credential.
9 properties
ChangePasswordReason
string
PublicKeyCredentialDescriptor
object
Contains attributes for the Relying Party to refer to an existing public key credential as an input parameter.
3 properties
WebAuthnRegisterCompleteRequest
object
Request to complete the WebAuthn registration ceremony for a new credential,.
4 properties
WebAuthnLoginRequest
object
Request to complete the WebAuthn registration ceremony
9 properties
TwoFactorMethod
object
7 properties
WebAuthnStartRequest
object
API request to start a WebAuthn authentication ceremony
7 properties
IdentityVerifiedReason
string
Models the reason that {@link UserIdentityverified} was set to true or false.
ResidentKeyRequirement
string
Describes the Relying Party's requirements for client-side discoverable credentials (formerly known as "resident keys")
The full machine-readable OpenAPI contract behind this narrative.
Other APIs FusionAuth publishes across the network.