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="2024-09-23T08:35:59.300824-05:00[America/Chicago]", comments="Generator version: 7.8.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

    • 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 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 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 Okta Workflows WebAuthn preregistration integration uses this 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 Okta Workflows WebAuthn preregistration integration uses this 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

    • 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()