diff --git a/src/main/api/checkChangePasswordUsingLoginId.json b/src/main/api/checkChangePasswordUsingLoginId.json index 70c92aef..d5746628 100644 --- a/src/main/api/checkChangePasswordUsingLoginId.json +++ b/src/main/api/checkChangePasswordUsingLoginId.json @@ -15,11 +15,11 @@ { "name": "loginId", "comments": [ - "The loginId of the User that you intend to change the password for." + "The loginId (email or username) of the User that you intend to change the password for." ], "type": "urlParameter", - "parameterName": "username", + "parameterName": "loginId", "javaType": "String" } ] -} \ No newline at end of file +} diff --git a/src/main/api/checkChangePasswordUsingLoginIdAndLoginIdTypes.json b/src/main/api/checkChangePasswordUsingLoginIdAndLoginIdTypes.json new file mode 100644 index 00000000..fd6e90e0 --- /dev/null +++ b/src/main/api/checkChangePasswordUsingLoginIdAndLoginIdTypes.json @@ -0,0 +1,34 @@ +{ + "uri": "/api/user/change-password", + "comments": [ + "Check to see if the user must obtain a Trust Request 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", + "your password, you must obtain a Trust Request Id by completing a Two-Factor Step-Up authentication.", + "", + "An HTTP status code of 400 with a general error code of [TrustTokenRequired] indicates that a Trust Token is required to make a POST request to this API." + ], + "method": "get", + "methodName": "checkChangePasswordUsingLoginIdAndLoginIdTypes", + "successResponse": "Void", + "errorResponse": "Errors", + "params": [ + { + "name": "loginId", + "comments": [ + "The loginId of the User that you intend to change the password for." + ], + "type": "urlParameter", + "parameterName": "loginId", + "javaType": "String" + }, + { + "name": "loginIdTypes", + "comments": [ + "The identity types that FusionAuth will compare the loginId to." + ], + "type": "urlParameter", + "parameterName": "loginIdTypes", + "javaType": "List" + } + ] +} diff --git a/src/main/api/retrieveUserByLoginIdWithLoginIdTypes.json b/src/main/api/retrieveUserByLoginIdWithLoginIdTypes.json index 343d9097..b9e63b21 100644 --- a/src/main/api/retrieveUserByLoginIdWithLoginIdTypes.json +++ b/src/main/api/retrieveUserByLoginIdWithLoginIdTypes.json @@ -20,7 +20,7 @@ { "name": "loginIdTypes", "comments": [ - "the identity types that FusionAuth will compare the loginId to." + "The identity types that FusionAuth will compare the loginId to." ], "type": "urlParameter", "parameterName": "loginIdTypes", diff --git a/src/main/api/retrieveUserLoginReportByLoginIdAndLoginIdTypes.json b/src/main/api/retrieveUserLoginReportByLoginIdAndLoginIdTypes.json index 5417cf73..590a79eb 100644 --- a/src/main/api/retrieveUserLoginReportByLoginIdAndLoginIdTypes.json +++ b/src/main/api/retrieveUserLoginReportByLoginIdAndLoginIdTypes.json @@ -48,7 +48,7 @@ { "name": "loginIdTypes", "comments": [ - "the identity types that FusionAuth will compare the loginId to." + "The identity types that FusionAuth will compare the loginId to." ], "type": "urlParameter", "parameterName": "loginIdTypes",