Skip to content

Latest commit

 

History

History
146 lines (91 loc) · 3.82 KB

AccountApi.md

File metadata and controls

146 lines (91 loc) · 3.82 KB
Raw

AccountApi

All URIs are relative to http://http:/v1

Method HTTP request Description
accountPasswordCheckTokenPost POST /account/password/check-token Validate password reset token
accountPasswordForgotPost POST /account/password/forgot Request password reset link
accountPasswordResetPost POST /account/password/reset Reset a forgotten password with a token

accountPasswordCheckTokenPost

accountPasswordCheckTokenPost(body)

Validate password reset token

The second step in the forgotten password reset procedure is to ensure that the password reset token is still valid. Each token can be used at most once and it is valid for a limited duration.

Example

// Import classes:
//import org.openapitools.client.api.AccountApi;

AccountApi apiInstance = new AccountApi();
String body = "body_example"; // String | 
try {
    apiInstance.accountPasswordCheckTokenPost(body);
} catch (ApiException e) {
    System.err.println("Exception when calling AccountApi#accountPasswordCheckTokenPost");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body String

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json;charset=utf-8
  • Accept: /

accountPasswordForgotPost

accountPasswordForgotPost(body)

Request password reset link

This is the starting point of the forgotten password recovery process. It sends a password reset link with a pasword reset token to the given user's email address if such user and email address exist.

Example

// Import classes:
//import org.openapitools.client.api.AccountApi;

AccountApi apiInstance = new AccountApi();
ForgotPasswordData body = new ForgotPasswordData(); // ForgotPasswordData | 
try {
    apiInstance.accountPasswordForgotPost(body);
} catch (ApiException e) {
    System.err.println("Exception when calling AccountApi#accountPasswordForgotPost");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body ForgotPasswordData

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json;charset=utf-8
  • Accept: /

accountPasswordResetPost

accountPasswordResetPost(body)

Reset a forgotten password with a token

The final step of the forgotten password reset procedure performs password reset with a token obtained from the email message sent by the POST /password/forgot endpoint and the new password and its confirmation. If @password@ or @confirmPassword@ are missing, then this endpoint performs a mere token validation like the @/password/check-token@ endpoint.

Example

// Import classes:
//import org.openapitools.client.api.AccountApi;

AccountApi apiInstance = new AccountApi();
UpdatePasswordData body = new UpdatePasswordData(); // UpdatePasswordData | 
try {
    apiInstance.accountPasswordResetPost(body);
} catch (ApiException e) {
    System.err.println("Exception when calling AccountApi#accountPasswordResetPost");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body UpdatePasswordData

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json;charset=utf-8
  • Accept: /