Merge pull request #136 from FusionAuth/lyle/ENG-2742/change-password-using-jwt

changePasswordUsingJWT

Author: lyleschemmerling

fusionauth-netcore-client/src/io/fusionauth/FusionAuthClient.cs

@@ -153,6 +153,7 @@ public Task<ClientResponse<ChangePasswordResponse>> ChangePasswordAsync(string c
     }
 
     /// <inheritdoc/>
+    [Obsolete("This method has been renamed to ChangePasswordUsingJWTAsync, use that method instead.")]
     public Task<ClientResponse<ChangePasswordResponse>> ChangePasswordByJWTAsync(string encodedJWT, ChangePasswordRequest request) {
       return buildAnonymousClient()
           .withUri("/api/user/change-password")
@@ -171,6 +172,16 @@ public Task<ClientResponse<RESTVoid>> ChangePasswordByIdentityAsync(ChangePasswo
           .goAsync<RESTVoid>();
     }
 
+    /// <inheritdoc/>
+    public Task<ClientResponse<ChangePasswordResponse>> ChangePasswordUsingJWTAsync(string encodedJWT, ChangePasswordRequest request) {
+      return buildAnonymousClient()
+          .withUri("/api/user/change-password")
+          .withAuthorization("Bearer " + encodedJWT)
+          .withJSONBody(request)
+          .withMethod("Post")
+          .goAsync<ChangePasswordResponse>();
+    }
+
     /// <inheritdoc/>
     public Task<ClientResponse<RESTVoid>> CheckChangePasswordUsingIdAsync(string changePasswordId) {
       return buildAnonymousClient()

fusionauth-netcore-client/src/io/fusionauth/FusionAuthSyncClient.cs

@@ -86,6 +86,7 @@ public ClientResponse<ChangePasswordResponse> ChangePassword(string changePasswo
     }
 
     /// <inheritdoc/>
+    [Obsolete("This method has been renamed to ChangePasswordUsingJWT, use that method instead.")]
     public ClientResponse<ChangePasswordResponse> ChangePasswordByJWT(string encodedJWT, ChangePasswordRequest request) {
       return client.ChangePasswordByJWTAsync(encodedJWT, request).GetAwaiter().GetResult();
     }
@@ -95,6 +96,11 @@ public ClientResponse<RESTVoid> ChangePasswordByIdentity(ChangePasswordRequest r
       return client.ChangePasswordByIdentityAsync(request).GetAwaiter().GetResult();
     }
 
+    /// <inheritdoc/>
+    public ClientResponse<ChangePasswordResponse> ChangePasswordUsingJWT(string encodedJWT, ChangePasswordRequest request) {
+      return client.ChangePasswordUsingJWTAsync(encodedJWT, request).GetAwaiter().GetResult();
+    }
+
     /// <inheritdoc/>
     public ClientResponse<RESTVoid> CheckChangePasswordUsingId(string changePasswordId) {
       return client.CheckChangePasswordUsingIdAsync(changePasswordId).GetAwaiter().GetResult();

fusionauth-netcore-client/src/io/fusionauth/IFusionAuthClient.cs

@@ -138,6 +138,7 @@ public interface IFusionAuthAsyncClient {
     /// contacted because it is down or experiencing a failure, the response will contain an Exception, which could be an
     /// IOException.
     /// </returns>
+    [Obsolete("This method has been renamed to ChangePasswordUsingJWTAsync, use that method instead.")]
     Task<ClientResponse<ChangePasswordResponse>> ChangePasswordByJWTAsync(string encodedJWT, ChangePasswordRequest request);
 
     /// <summary>
@@ -155,6 +156,23 @@ public interface IFusionAuthAsyncClient {
     /// </returns>
     Task<ClientResponse<RESTVoid>> ChangePasswordByIdentityAsync(ChangePasswordRequest request);
 
+    /// <summary>
+    /// Changes a user's password using their access token (JWT) instead of the changePasswordId
+    /// A common use case for this method will be if you want to allow the user to change their own password.
+    /// 
+    /// Remember to send refreshToken in the request body if you want to get a new refresh token when login using the returned oneTimePassword.
+    /// This is an asynchronous method.
+    /// </summary>
+    /// <param name="encodedJWT"> The encoded JWT (access token).</param>
+    /// <param name="request"> The change password request that contains all the information used to change the password.</param>
+    /// <returns>
+    /// When successful, the response will contain the log of the action. If there was a validation error or any
+    /// other type of error, this will return the Errors object in the response. Additionally, if FusionAuth could not be
+    /// contacted because it is down or experiencing a failure, the response will contain an Exception, which could be an
+    /// IOException.
+    /// </returns>
+    Task<ClientResponse<ChangePasswordResponse>> ChangePasswordUsingJWTAsync(string encodedJWT, ChangePasswordRequest request);
+
     /// <summary>
     /// Check to see if the user must obtain a Trust Token Id in order to complete a change password request.
     /// When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change
@@ -5087,6 +5105,7 @@ public interface IFusionAuthSyncClient {
    /// contacted because it is down or experiencing a failure, the response will contain an Exception, which could be an
    /// IOException.
    /// </returns>
+   [Obsolete("This method has been renamed to ChangePasswordUsingJWTAsync, use that method instead.")]
    ClientResponse<ChangePasswordResponse> ChangePasswordByJWT(string encodedJWT, ChangePasswordRequest request);
 
    /// <summary>
@@ -5103,6 +5122,22 @@ public interface IFusionAuthSyncClient {
    /// </returns>
    ClientResponse<RESTVoid> ChangePasswordByIdentity(ChangePasswordRequest request);
 
+   /// <summary>
+   /// Changes a user's password using their access token (JWT) instead of the changePasswordId
+   /// A common use case for this method will be if you want to allow the user to change their own password.
+   /// 
+   /// Remember to send refreshToken in the request body if you want to get a new refresh token when login using the returned oneTimePassword.
+   /// </summary>
+   /// <param name="encodedJWT"> The encoded JWT (access token).</param>
+   /// <param name="request"> The change password request that contains all the information used to change the password.</param>
+   /// <returns>
+   /// When successful, the response will contain the log of the action. If there was a validation error or any
+   /// other type of error, this will return the Errors object in the response. Additionally, if FusionAuth could not be
+   /// contacted because it is down or experiencing a failure, the response will contain an Exception, which could be an
+   /// IOException.
+   /// </returns>
+   ClientResponse<ChangePasswordResponse> ChangePasswordUsingJWT(string encodedJWT, ChangePasswordRequest request);
+
    /// <summary>
    /// Check to see if the user must obtain a Trust Token Id in order to complete a change password request.
    /// When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change