Package com.okta.sdk.resource.api

Class WebAuthnPreregistrationApi

java.lang.Object
com.okta.sdk.resource.api.WebAuthnPreregistrationApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2026-03-13T17:36:05.533634+05:30[Asia/Kolkata]", comments="Generator version: 7.15.0") public class WebAuthnPreregistrationApi extends Object

  • Constructor Details

    • WebAuthnPreregistrationApi

      public WebAuthnPreregistrationApi()

    • WebAuthnPreregistrationApi

      public WebAuthnPreregistrationApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • activatePreregistrationEnrollment

      public EnrollmentActivationResponse activatePreregistrationEnrollment(EnrollmentActivationRequest body) throws ApiException
      Activate a preregistered WebAuthn factor Activates a preregistered WebAuthn factor. As part of this operation, Okta first decrypts and verifies the factor PIN and enrollment data sent by the fulfillment provider.
      Parameters:
      body - Enrollment activation request (optional)
      Returns:
      EnrollmentActivationResponse
      Throws:
      ApiException - if fails to make API call

    • activatePreregistrationEnrollment

      public EnrollmentActivationResponse activatePreregistrationEnrollment(EnrollmentActivationRequest body, Map<String,String> additionalHeaders) throws ApiException
      Activate a preregistered WebAuthn factor Activates a preregistered WebAuthn factor. As part of this operation, Okta first decrypts and verifies the factor PIN and enrollment data sent by the fulfillment provider.
      Parameters:
      body - Enrollment activation request (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      EnrollmentActivationResponse
      Throws:
      ApiException - if fails to make API call

    • assignFulfillmentErrorWebAuthnPreregistrationFactor

      public void assignFulfillmentErrorWebAuthnPreregistrationFactor(String userId, String authenticatorEnrollmentId) throws ApiException
      Assign the fulfillment error status to a WebAuthn preregistration factor Assigns the fulfillment error status to a WebAuthn preregistration factor for a user. The `/mark-error` path indicates that the specific `FULFILLMENT_ERRORED` AuthFactor status is set on the enrollment.
      Parameters:
      userId - ID of an existing Okta user (required)
      authenticatorEnrollmentId - ID for a WebAuthn preregistration factor in Okta (required)
      Throws:
      ApiException - if fails to make API call

    • assignFulfillmentErrorWebAuthnPreregistrationFactor

      public void assignFulfillmentErrorWebAuthnPreregistrationFactor(String userId, String authenticatorEnrollmentId, Map<String,String> additionalHeaders) throws ApiException
      Assign the fulfillment error status to a WebAuthn preregistration factor Assigns the fulfillment error status to a WebAuthn preregistration factor for a user. The `/mark-error` path indicates that the specific `FULFILLMENT_ERRORED` AuthFactor status is set on the enrollment.
      Parameters:
      userId - ID of an existing Okta user (required)
      authenticatorEnrollmentId - ID for a WebAuthn preregistration factor in Okta (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • deleteWebAuthnPreregistrationFactor

      public void deleteWebAuthnPreregistrationFactor(String userId, String authenticatorEnrollmentId) throws ApiException
      Delete a WebAuthn preregistration factor Deletes a specific WebAuthn preregistration factor for a user
      Parameters:
      userId - ID of an existing Okta user (required)
      authenticatorEnrollmentId - ID for a WebAuthn preregistration factor in Okta (required)
      Throws:
      ApiException - if fails to make API call

    • deleteWebAuthnPreregistrationFactor

      public void deleteWebAuthnPreregistrationFactor(String userId, String authenticatorEnrollmentId, Map<String,String> additionalHeaders) throws ApiException
      Delete a WebAuthn preregistration factor Deletes a specific WebAuthn preregistration factor for a user
      Parameters:
      userId - ID of an existing Okta user (required)
      authenticatorEnrollmentId - ID for a WebAuthn preregistration factor in Okta (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • enrollPreregistrationEnrollment

      public EnrollmentInitializationResponse enrollPreregistrationEnrollment(EnrollmentInitializationRequest body) throws ApiException
      Enroll a preregistered WebAuthn factor Enrolls a preregistered WebAuthn factor. This WebAuthn factor has a longer challenge timeout period to accommodate the fulfillment request process. As part of this operation, Okta generates elliptic curve (EC) key-pairs used to encrypt the factor PIN and enrollment data sent by the fulfillment provider.
      Parameters:
      body - Enrollment initialization request (optional)
      Returns:
      EnrollmentInitializationResponse
      Throws:
      ApiException - if fails to make API call

    • enrollPreregistrationEnrollment

      public EnrollmentInitializationResponse enrollPreregistrationEnrollment(EnrollmentInitializationRequest body, Map<String,String> additionalHeaders) throws ApiException
      Enroll a preregistered WebAuthn factor Enrolls a preregistered WebAuthn factor. This WebAuthn factor has a longer challenge timeout period to accommodate the fulfillment request process. As part of this operation, Okta generates elliptic curve (EC) key-pairs used to encrypt the factor PIN and enrollment data sent by the fulfillment provider.
      Parameters:
      body - Enrollment initialization request (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      EnrollmentInitializationResponse
      Throws:
      ApiException - if fails to make API call

    • generateFulfillmentRequest

      public void generateFulfillmentRequest(FulfillmentRequest body) throws ApiException
      Generate a fulfillment request Generates a fulfillment request by sending a WebAuthn preregistration event to start the flow. The WebAuthn preregistration integration for Okta Workflows uses a preregistration event to populate the fulfillment request.
      Parameters:
      body - Fulfillment request (optional)
      Throws:
      ApiException - if fails to make API call

    • generateFulfillmentRequest

      public void generateFulfillmentRequest(FulfillmentRequest body, Map<String,String> additionalHeaders) throws ApiException
      Generate a fulfillment request Generates a fulfillment request by sending a WebAuthn preregistration event to start the flow. The WebAuthn preregistration integration for Okta Workflows uses a preregistration event to populate the fulfillment request.
      Parameters:
      body - Fulfillment request (optional)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • listWebAuthnPreregistrationFactors

      public List<WebAuthnPreregistrationFactor> listWebAuthnPreregistrationFactors(String userId) throws ApiException
      List all WebAuthn preregistration factors Lists all WebAuthn preregistration factors for the specified user
      Parameters:
      userId - ID of an existing Okta user (required)
      Returns:
      List<WebAuthnPreregistrationFactor>
      Throws:
      ApiException - if fails to make API call

    • listWebAuthnPreregistrationFactors

      public List<WebAuthnPreregistrationFactor> listWebAuthnPreregistrationFactors(String userId, Map<String,String> additionalHeaders) throws ApiException
      List all WebAuthn preregistration factors Lists all WebAuthn preregistration factors for the specified user
      Parameters:
      userId - ID of an existing Okta user (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<WebAuthnPreregistrationFactor>
      Throws:
      ApiException - if fails to make API call

    • listWebAuthnPreregistrationFactorsPaged

      public Iterable<WebAuthnPreregistrationFactor> listWebAuthnPreregistrationFactorsPaged(String userId)
      List all WebAuthn preregistration factors (Paginated) Lists all WebAuthn preregistration factors for the specified user This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks. Use this method in a for-each loop to automatically fetch all pages without manual cursor management.
      Parameters:
      userId - ID of an existing Okta user (required)
      Returns:
      Iterable<WebAuthnPreregistrationFactor> lazy iterable over all pages

    • listWebAuthnPreregistrationFactorsPaged

      public Iterable<WebAuthnPreregistrationFactor> listWebAuthnPreregistrationFactorsPaged(String userId, Map<String,String> additionalHeaders)
      List all WebAuthn preregistration factors (Paginated with additional headers) Lists all WebAuthn preregistration factors for the specified user This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks.
      Parameters:
      userId - ID of an existing Okta user (required)
      additionalHeaders - additional headers for this call
      Returns:
      Iterable<WebAuthnPreregistrationFactor> lazy iterable over all pages

    • sendPin

      public void sendPin(PinRequest body) throws ApiException
      Send a PIN to user Sends the decoded PIN for the specified WebAuthn preregistration enrollment. PINs are sent to the user's email. To resend the PIN, call this operation again.
      Parameters:
      body - Send PIN request (optional)
      Throws:
      ApiException - if fails to make API call

    • sendPin

      public void sendPin(PinRequest body, Map<String,String> additionalHeaders) throws ApiException
      Send a PIN to user Sends the decoded PIN for the specified WebAuthn preregistration enrollment. PINs are sent to the user's email. To resend the PIN, call this operation again.
      Parameters:
      body - Send PIN request (optional)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • getObjectMapper

      protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()