Merge degroff/ENG-1/issue1 (#140)

* Normalize order for static final.

* Updates

* Client library updates from enums

* latest client updates

* latest client updates

* Updated version for fusionauth-java-client to 1.55.0

* java-client build

* Domain / Client Builder sync

* Domain sync

* domain sync

* Updated version for fusionauth-java-client to 1.56.0

* domain sync

* Latest updates from top level field

* Latest issue 1 updates

* Merge wied03/ENG-1/tenant-mode-internal-user-removal (#51)

* 1st pass of "fixes"

* Added our missing identity verify API from client builder

* Data was removed from real deal

* api version removal

* Updates from client builder

* Updates

* update without InternalUser

* Updates from app

* add top-level user.phoneNumber field ENG-2208

* regen client libraries ENG-2208

* merge develop into issue1

* Merge wied03/ENG-1/ENG-1757/phone_canon_wo_internal_user (#54)

* updates from app

* updates after merge from issue 1 branch

* updates after cleanup (#56)

* sync clients with latest degroff/ENG-1/issue1

* add LoginIdType of phoneNumber (#57)

* client builder/API updates (#58)

* missed updates

* generate for identity verification external id configuration

* external Id updates

* add phone verification complete template and unverified behavior

* default phone verification strategy to FormField

* Merge wied03/ENG-1963/phone_gating (#64)

* client updates and ignore internal TODOs and comments

* Catch up

* Separate verify start and complete

* update after verify request changes

* one more phone rename

* regen client libraries

ENG-2442

* update default phone verification strategy (#82)

* phone clickable updates (#81)

* add new login API response field (#83)

* new claim/phone_number_verified (#86)

* add application.registrationConfiguration.requirePassword boolean (#89)

* Managed field update (#90)

* new API field (#91)

* remove application requirePassword, add tenant passwordEnabled (#92)

* Merge wied03/ENG-1834/passwordless_start_api (#93)

* API change for passwordless start

* Updates

* Fix this

* ENG-2608 - New APIs/method overloads (#96)

* blank??

* with our overload

* spacing

* this should work

* add report method

* use lists when possible, order is significant here

* revert overloads

* client correct/optional

* now that this overload does not have opt params, remove defaults

* Merge spencer/eng-1807/change-password-phone (#95)

* forgot password via sms
* domain changes

* Merge spencer/eng-2281/admin-sms-reset (#97)

* forgot password via sms
* domain changes
* add Buildable interface to ForgotPasswordRequest

* Merge wied03/ENG-2546/phone_passwordless_formfield (#94)

* apply updates

* field rename

* remove unneeded field

* rename to PasswordlessLoginOneTimeCode

* Merge wied03/ENG-2002/sms-send-set-pass (#99)

* new API field

* more API field stuff

* Update (with defaults removed) from fusionauth-app

* ENG-2580 - Issue 1 TODO Sweep (#100)

* generated java client updates

* more removals

* add tenant phone verification and template configs (#101)

* updated tenant phone config (#102)

* refreshrequest update (#103)

* add phoneNumber to sort criteria (#104)

* Merge wied03/ENG-2455/identity_verif_api_status (#106)

* add state to verify complete response and start request

* add state to verify complete response and start request

* client builder sb build

* Merge spencer/eng-2577/admin-phone-verif (#107)

add /api/user/verify and request to clients

* Merge wied03/ENG-1677/rate_limiting (#108)

* rate limiting config change for pwless send phone

* client update

* wrong branch, another client update

* updated stuff from issue 1 branch

* restore java client method, mark deprecated

* Restore this

* Merge wied03/ENG-2349/rename_refactor (#110)

* move user.verify package to identity.verify

* import sorting

* remove VerifySendRequest.oneTimeCode. it is not used on that endpoint (#111)

* Merge spencer/eng-2717/app-phone-templates (#113)

add Application.phoneConfiguration for phone template overrides

* remove deprecation (#114)

* Merge wied03/ENG-1822/event_serializer_remove (#115)

* sb build updates

* remove more stuff

* Merge bhalsey/ENG-2388/send_user_events_sms (#118)

* add UserIdentityUpdateEvent

* really add UserIdentityUpdateEvent

* Merge bhalsey/ENG-2047/rename_identityverifiedevent (#124)

* identity verified to user identity verified

* identity verified to user identity verified

* Merge wied03/ENG-2790/password-toggle-resolution (#123)

* remove passwordEnabled field

* equality/etc removal too

* remove identities fields from java client (#125)

* TODO was removed, resulting in blank line removal (#131)

* Re-run sb build

* Setting this causes the this.sendSetPasswordEmail legacy field to get ignored

* Catch up to app

* Merge spencer/eng-2853/userState (#133)

mark `UserState.fromUserAndRegistration` method as deprecated

* Merge wied03/ENG-3045/import_verified (#135)

* verifiedReason updates

* ripple through comment updates

* re-ripple through changes

* client update from find/replace version (#136)

* use enums on api requests (#138)

* use PasswordlessStrategy enum for API request
* use VerificationStrategy enum for API request

* naming standards (#139)

* missing client commit

* client update from incorrect version

* remove need for this version

---------

Co-authored-by: Daniel DeGroff <[email protected]>
Co-authored-by: Spencer Witt <[email protected]>
Co-authored-by: Brent Halsey <[email protected]>
Co-authored-by: Spencer Witt <[email protected]>
Co-authored-by: Brent Halsey <[email protected]>

Author: 4 people

src/main/java/io/fusionauth/client/ExceptionDelegate.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018, FusionAuth, All Rights Reserved
+ * Copyright (c) 2018-2024, FusionAuth, All Rights Reserved
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -40,7 +40,7 @@ public ExceptionDelegate() {
    * @param <U>      The error response type.
    * @return The success response type if the API call was successful.
    * @throws FusionAuthClientException If the status code was anything exception 2xx or 404 or there was a problem calling
-   *                                 the API (network or something similar).
+   *                                   the API (network or something similar).
    */
   @SuppressWarnings("unchecked")
   public <T, U> T execute(Supplier<ClientResponse<T, U>> supplier) {

src/main/java/io/fusionauth/client/FusionAuthClient.java

@@ -37,6 +37,7 @@
 import io.fusionauth.domain.LambdaType;
 import io.fusionauth.domain.OpenIdConfiguration;
 import io.fusionauth.domain.api.APIKeyRequest;
+import io.fusionauth.client.json.FusionAuthJacksonModule;
 import io.fusionauth.domain.api.APIKeyResponse;
 import io.fusionauth.domain.api.ApplicationOAuthScopeRequest;
 import io.fusionauth.domain.api.ApplicationOAuthScopeResponse;
@@ -181,6 +182,12 @@
 import io.fusionauth.domain.api.WebhookSearchResponse;
 import io.fusionauth.domain.api.email.SendRequest;
 import io.fusionauth.domain.api.email.SendResponse;
+import io.fusionauth.domain.api.identity.verify.VerifyCompleteRequest;
+import io.fusionauth.domain.api.identity.verify.VerifyCompleteResponse;
+import io.fusionauth.domain.api.identity.verify.VerifyRequest;
+import io.fusionauth.domain.api.identity.verify.VerifyStartRequest;
+import io.fusionauth.domain.api.identity.verify.VerifyStartResponse;
+import io.fusionauth.domain.api.identity.verify.VerifySendRequest;
 import io.fusionauth.domain.api.identityProvider.IdentityProviderLinkRequest;
 import io.fusionauth.domain.api.identityProvider.IdentityProviderLinkResponse;
 import io.fusionauth.domain.api.identityProvider.IdentityProviderLoginRequest;
@@ -260,7 +267,8 @@ public class FusionAuthClient {
                                                                     .configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false)
                                                                     .configure(DeserializationFeature.USE_BIG_DECIMAL_FOR_FLOATS, true)
                                                                     .configure(DeserializationFeature.USE_BIG_INTEGER_FOR_INTS, true)
-                                                                    .registerModule(new JacksonModule());
+                                                                    .registerModule(new JacksonModule())
+                                                                    .registerModule(new FusionAuthJacksonModule());
 
   private final String apiKey;
 
@@ -578,6 +586,20 @@ public ClientResponse<UserCommentResponse, Errors> commentOnUser(UserCommentRequ
         .go();
   }
 
+  /**
+   * Completes verification of an identity using verification codes from the Verify Start API.
+   *
+   * @param request The identity verify complete request that contains all the information used to verify the identity.
+   * @return The ClientResponse object.
+   */
+  public ClientResponse<VerifyCompleteResponse, Errors> completeVerifyIdentity(VerifyCompleteRequest request) {
+    return start(VerifyCompleteResponse.class, Errors.class)
+        .uri("/api/identity/verify/complete")
+        .bodyHandler(new JSONBodyHandler(request, objectMapper()))
+        .post()
+        .go();
+  }
+
   /**
    * Complete a WebAuthn authentication ceremony by validating the signature against the previously generated challenge without logging the user in
    *
@@ -4180,6 +4202,22 @@ public ClientResponse<UserResponse, Errors> retrieveUserByLoginId(String loginId
         .go();
   }
 
+  /**
+   * Retrieves the user for the loginId, using specific loginIdTypes.
+   *
+   * @param loginId The email or username of the user.
+   * @param loginIdTypes the identity types that FusionAuth will compare the loginId to.
+   * @return The ClientResponse object.
+   */
+  public ClientResponse<UserResponse, Errors> retrieveUserByLoginIdWithLoginIdTypes(String loginId, List<String> loginIdTypes) {
+    return start(UserResponse.class, Errors.class)
+        .uri("/api/user")
+        .urlParameter("loginId", loginId)
+        .urlParameter("loginIdTypes", loginIdTypes)
+        .get()
+        .go();
+  }
+
   /**
    * Retrieves the user for the given username.
    *
@@ -4383,6 +4421,29 @@ public ClientResponse<LoginReportResponse, Errors> retrieveUserLoginReportByLogi
         .go();
   }
 
+  /**
+   * Retrieves the login report between the two instants for a particular user by login Id, using specific loginIdTypes. If you specify an application id, it will only return the
+   * login counts for that application.
+   *
+   * @param applicationId (Optional) The application id.
+   * @param loginId The userId id.
+   * @param start The start instant as UTC milliseconds since Epoch.
+   * @param end The end instant as UTC milliseconds since Epoch.
+   * @param loginIdTypes the identity types that FusionAuth will compare the loginId to.
+   * @return The ClientResponse object.
+   */
+  public ClientResponse<LoginReportResponse, Errors> retrieveUserLoginReportByLoginIdAndLoginIdTypes(UUID applicationId, String loginId, long start, long end, List<String> loginIdTypes) {
+    return start(LoginReportResponse.class, Errors.class)
+        .uri("/api/report/login")
+        .urlParameter("applicationId", applicationId)
+        .urlParameter("loginId", loginId)
+        .urlParameter("start", start)
+        .urlParameter("end", end)
+        .urlParameter("loginIdTypes", loginIdTypes)
+        .get()
+        .go();
+  }
+
   /**
    * Retrieves the last number of login records for a user.
    *
@@ -5114,6 +5175,20 @@ public ClientResponse<Void, Errors> sendTwoFactorCodeForLoginUsingMethod(String
         .go();
   }
 
+  /**
+   * Send a verification code using the appropriate transport for the identity type being verified.
+   *
+   * @param request The identity verify send request that contains all the information used send the code.
+   * @return The ClientResponse object.
+   */
+  public ClientResponse<Void, Errors> sendVerifyIdentity(VerifySendRequest request) {
+    return start(Void.TYPE, Errors.class)
+        .uri("/api/identity/verify/send")
+        .bodyHandler(new JSONBodyHandler(request, objectMapper()))
+        .post()
+        .go();
+  }
+
   /**
    * Begins a login request for a 3rd party login that requires user interaction such as HYPR.
    *
@@ -5163,6 +5238,21 @@ public ClientResponse<TwoFactorStartResponse, Errors> startTwoFactorLogin(TwoFac
         .go();
   }
 
+  /**
+   * Start a verification of an identity by generating a code. This code can be sent to the User using the Verify Send API
+   * Verification Code API or using a mechanism outside of FusionAuth. The verification is completed by using the Verify Complete API with this code.
+   *
+   * @param request The identity verify start request that contains all the information used to begin the request.
+   * @return The ClientResponse object.
+   */
+  public ClientResponse<VerifyStartResponse, Errors> startVerifyIdentity(VerifyStartRequest request) {
+    return start(VerifyStartResponse.class, Errors.class)
+        .uri("/api/identity/verify/start")
+        .bodyHandler(new JSONBodyHandler(request, objectMapper()))
+        .post()
+        .go();
+  }
+
   /**
    * Start a WebAuthn authentication ceremony by generating a new challenge for the user
    *
@@ -5828,6 +5918,20 @@ public ClientResponse<Void, Errors> verifyEmailAddressByUserId(VerifyEmailReques
         .go();
   }
 
+  /**
+   * Administratively verify a user identity.
+   *
+   * @param request The identity verify request that contains information to verify the identity.
+   * @return The ClientResponse object.
+   */
+  public ClientResponse<Void, Errors> verifyIdentity(VerifyRequest request) {
+    return start(Void.TYPE, Errors.class)
+        .uri("/api/identity/verify")
+        .bodyHandler(new JSONBodyHandler(request, objectMapper()))
+        .post()
+        .go();
+  }
+
   /**
    * Confirms an application registration. The Id given is usually from an email sent to the user.
    *

src/main/java/io/fusionauth/client/FusionAuthClientException.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018, FusionAuth, All Rights Reserved
+ * Copyright (c) 2018-2024, FusionAuth, All Rights Reserved
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/io/fusionauth/client/JWTManager.java

@@ -1,5 +1,17 @@
 /*
- * Copyright (c) 2018-2023, FusionAuth, All Rights Reserved
+ * Copyright (c) 2018-2024, FusionAuth, All Rights Reserved
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
  */
 package io.fusionauth.client;
 

src/main/java/io/fusionauth/client/LambdaDelegate.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018, FusionAuth, All Rights Reserved
+ * Copyright (c) 2018-2024, FusionAuth, All Rights Reserved
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/io/fusionauth/client/json/ConnectorJacksonHelper.java

@@ -1,5 +1,17 @@
 /*
- * Copyright (c) 2020-2022, FusionAuth, All Rights Reserved
+ * Copyright (c) 2020-2024, FusionAuth, All Rights Reserved
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
  */
 package io.fusionauth.client.json;
 

src/main/java/io/fusionauth/client/json/ConnectorRequestDeserializer.java

@@ -1,5 +1,17 @@
 /*
- * Copyright (c) 2019-2023, FusionAuth, All Rights Reserved
+ * Copyright (c) 2019-2024, FusionAuth, All Rights Reserved
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
  */
 package io.fusionauth.client.json;
 

src/main/java/io/fusionauth/client/json/ConnectorResponseDeserializer.java

@@ -1,5 +1,17 @@
 /*
- * Copyright (c) 2019-2022, FusionAuth, All Rights Reserved
+ * Copyright (c) 2019-2024, FusionAuth, All Rights Reserved
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
  */
 package io.fusionauth.client.json;
 

src/main/java/io/fusionauth/client/json/FusionAuthJacksonModule.java

@@ -0,0 +1,19 @@
+/*
+ * Copyright (c) 2024-2025, FusionAuth, All Rights Reserved
+ */
+package io.fusionauth.client.json;
+
+import com.fasterxml.jackson.databind.module.SimpleModule;
+import io.fusionauth.domain.IdentityType;
+
+/**
+ * FusionAuth specific Jackson bindings. This can be used in the public FusionAuth client.
+ *
+ * @author Daniel DeGroff
+ */
+public class FusionAuthJacksonModule extends SimpleModule {
+  public FusionAuthJacksonModule() {
+    addSerializer(IdentityType.class, new IdentityTypeSerializer());
+    addDeserializer(IdentityType.class, new IdentityTypeDeserializer());
+  }
+}

src/main/java/io/fusionauth/client/json/IdentityProviderJacksonHelper.java

@@ -1,5 +1,17 @@
 /*
- * Copyright (c) 2019-2022, FusionAuth, All Rights Reserved
+ * Copyright (c) 2019-2024, FusionAuth, All Rights Reserved
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
  */
 package io.fusionauth.client.json;