Skip to content

Latest commit

 

History

History
122 lines (86 loc) · 4.27 KB

PasswordApi.md

File metadata and controls

122 lines (86 loc) · 4.27 KB
Raw

Swagger\Client\PasswordApi

All URIs are relative to https://atlas.forsta.io/v1

Method HTTP request Description
passwordResetCreate POST /password/reset/ Sends email or SMS to a user with a one time token for password resetting.
passwordResetUpdate PUT /password/reset/{user_id}/ Confirm the password reset via token.

passwordResetCreate

\Swagger\Client\Model\PasswordResetViewPostResponse passwordResetCreate($data)

Sends email or SMS to a user with a one time token for password resetting.

Possible values for method field: "email", "sms"

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JSON Web Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\PasswordApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$data = new \Swagger\Client\Model\PasswordReset(); // \Swagger\Client\Model\PasswordReset | 

try {
    $result = $apiInstance->passwordResetCreate($data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PasswordApi->passwordResetCreate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
data \Swagger\Client\Model\PasswordReset

Return type

\Swagger\Client\Model\PasswordResetViewPostResponse

Authorization

[JSON Web Token](../../README.md#JSON Web Token)

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

passwordResetUpdate

\Swagger\Client\Model\PasswordResetViewPutResponse passwordResetUpdate($user_id, $data)

Confirm the password reset via token.

Confirm the password reset via token.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: JSON Web Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\PasswordApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$user_id = "user_id_example"; // string | 
$data = new \Swagger\Client\Model\PasswordResetConfirm(); // \Swagger\Client\Model\PasswordResetConfirm | 

try {
    $result = $apiInstance->passwordResetUpdate($user_id, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PasswordApi->passwordResetUpdate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
user_id string
data \Swagger\Client\Model\PasswordResetConfirm

Return type

\Swagger\Client\Model\PasswordResetViewPutResponse

Authorization

[JSON Web Token](../../README.md#JSON Web Token)

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]