HTTP API Toolkit HTTP API Toolkit
HTTP API Toolkit HTTP API Toolkit
DocFX + Singulink = ♥

Search Results for

    Method FinishRegistrationAsync

    FinishRegistrationAsync(string, string, string, string?, CancellationToken)

    Finishes creating a passkey: verifies the new credential and returns its data, which the app then stores. The passkey is not stored by this method.

    Declaration
    public Task<RegisteredPasskey> FinishRegistrationAsync(string userId, string ceremonyId, string credentialJson, string? device = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string userId

    The user the passkey is being created for, who must be the user the registration was started for.

    string ceremonyId

    The ID of the ceremony started with BeginRegistrationAsync(PasskeyUser, string?, bool, CancellationToken).

    string credentialJson

    The credential the browser returned, as WebAuthn JSON (the PublicKeyCredential.toJSON() form).

    string device

    The device the passkey is being created from, in the format of Device, which is used in the suggested name. Optional.

    CancellationToken cancellationToken

    A token to cancel the operation.

    Returns
    Type Description
    Task<RegisteredPasskey>
    Exceptions
    Type Condition
    BadRequestApiException

    The credential is malformed.

    ValidationApiException

    The ceremony is unknown, expired or was started for another user (CeremonyExpired), or the credential failed verification (VerificationFailed).

    ConflictApiException

    The credential is already registered (AlreadyRegistered).

    FinishRegistrationAsync(ISessionToken, string, string, string?, CancellationToken)

    Finishes creating a passkey for the signed-in user: verifies the new credential and returns its data, which the app then stores. The passkey is not stored by this method.

    Declaration
    public Task<RegisteredPasskey> FinishRegistrationAsync(ISessionToken user, string ceremonyId, string credentialJson, string? device = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    ISessionToken user

    The session token of the signed-in user, who must be the user the registration was started for, and whose UserId identifies them.

    string ceremonyId

    The ID of the ceremony started with BeginRegistrationAsync(PasskeyUser, string?, bool, CancellationToken).

    string credentialJson

    The credential the browser returned, as WebAuthn JSON (the PublicKeyCredential.toJSON() form).

    string device

    The device the passkey is being created from, in the format of Device, which is used in the suggested name. Optional.

    CancellationToken cancellationToken

    A token to cancel the operation.

    Returns
    Type Description
    Task<RegisteredPasskey>
    Exceptions
    Type Condition
    BadRequestApiException

    The credential is malformed.

    ValidationApiException

    The ceremony is unknown, expired or was started for another user (CeremonyExpired), or the credential failed verification (VerificationFailed).

    ConflictApiException

    The credential is already registered (AlreadyRegistered).

    © Singulink. All rights reserved.