Reepay\UserApi

All URIs are relative to https://api.reepay.com

Method	HTTP request	Description
deleteUser	DELETE /v1/user/{id}	Delete user
getUser	GET /v1/user/{id}	Get user
getUsers	GET /v1/user	Get users
inviteUser	POST /v1/user/invite	Invite user
inviteUserAccept	POST /v1/user/invite/{token}	Accept invite
inviteUserGet	GET /v1/user/invite/{token}	Get invite
resetPassword	POST /v1/user/reset_password	Reset password request
resetPasswordWithToken	POST /v1/user/reset_password/{token}	Reset password
updateAuth	PUT /v1/user/{id}/groups	Update user groups
updatePassword	PUT /v1/user/{id}/password	Change password
updateUser	PUT /v1/user/{id}	Update user
verifyEmail	POST /v1/user/verify_email/{token}	Verify email
verifyEmailRequest	POST /v1/user/{id}/verify_email	Send verification email

deleteUser

deleteUser($id)

Delete user

Example

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

// Configure API key authorization: apiKey
Reepay\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Reepay\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure HTTP basic authorization: basicAuth
Reepay\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Reepay\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\UserApi();
$id = "id_example"; // string | User id

try {
    $apiInstance->deleteUser($id);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->deleteUser: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	User id

Return type

void (empty response body)

Authorization

apiKey, basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

getUser

\Reepay\Model\UserAccount getUser($id)

Get user

Example

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

// Configure API key authorization: apiKey
Reepay\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Reepay\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure HTTP basic authorization: basicAuth
Reepay\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Reepay\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\UserApi();
$id = "id_example"; // string | User id

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

Parameters

Name	Type	Description	Notes
id	string	User id

Return type

\Reepay\Model\UserAccount

Authorization

apiKey, basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

getUsers

\Reepay\Model\UserAccount[] getUsers()

Get users

Example

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

// Configure API key authorization: apiKey
Reepay\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Reepay\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure HTTP basic authorization: basicAuth
Reepay\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Reepay\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\UserApi();

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

Parameters

This endpoint does not need any parameter.

Return type

\Reepay\Model\UserAccount[]

Authorization

apiKey, basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

inviteUser

\Reepay\Model\UserAccount inviteUser($body)

Invite user

Example

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

// Configure API key authorization: apiKey
Reepay\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Reepay\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure HTTP basic authorization: basicAuth
Reepay\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Reepay\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\UserApi();
$body = new \Reepay\Model\InviteUser(); // \Reepay\Model\InviteUser |

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

Parameters

Name	Type	Description	Notes
body	\Reepay\Model\InviteUser		[optional]

Return type

\Reepay\Model\UserAccount

Authorization

apiKey, basicAuth

HTTP request headers

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

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

inviteUserAccept

\Reepay\Model\UserAccount inviteUserAccept($token, $body)

Accept invite

Example

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

$apiInstance = new Reepay\Api\UserApi();
$token = "token_example"; // string | Invite token
$body = new \Reepay\Model\InviteUserAccept(); // \Reepay\Model\InviteUserAccept |

try {
    $result = $apiInstance->inviteUserAccept($token, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->inviteUserAccept: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
token	string	Invite token
body	\Reepay\Model\InviteUserAccept		[optional]

Return type

\Reepay\Model\UserAccount

Authorization

No authorization required

HTTP request headers

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

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

inviteUserGet

\Reepay\Model\UserAccount inviteUserGet($token)

Get invite

Example

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

$apiInstance = new Reepay\Api\UserApi();
$token = "token_example"; // string | Invite token

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

Parameters

Name	Type	Description	Notes
token	string	Invite token

Return type

\Reepay\Model\UserAccount

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

resetPassword

resetPassword($body)

Reset password request

Example

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

$apiInstance = new Reepay\Api\UserApi();
$body = new \Reepay\Model\UserResetRequestPassword(); // \Reepay\Model\UserResetRequestPassword |

try {
    $apiInstance->resetPassword($body);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->resetPassword: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Reepay\Model\UserResetRequestPassword		[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

resetPasswordWithToken

\Reepay\Model\User resetPasswordWithToken($token, $body)

Reset password

Example

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

$apiInstance = new Reepay\Api\UserApi();
$token = "token_example"; // string | Reset password token
$body = new \Reepay\Model\UpdateUserPassword(); // \Reepay\Model\UpdateUserPassword |

try {
    $result = $apiInstance->resetPasswordWithToken($token, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->resetPasswordWithToken: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
token	string	Reset password token
body	\Reepay\Model\UpdateUserPassword		[optional]

Return type

\Reepay\Model\User

Authorization

No authorization required

HTTP request headers

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

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

updateAuth

\Reepay\Model\UserAccount updateAuth($id, $body)

Update user groups

Example

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

// Configure API key authorization: apiKey
Reepay\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Reepay\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure HTTP basic authorization: basicAuth
Reepay\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Reepay\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\UserApi();
$id = "id_example"; // string | User id
$body = new \Reepay\Model\UpdateUserGroups(); // \Reepay\Model\UpdateUserGroups |

try {
    $result = $apiInstance->updateAuth($id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->updateAuth: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	User id
body	\Reepay\Model\UpdateUserGroups		[optional]

Return type

\Reepay\Model\UserAccount

Authorization

apiKey, basicAuth

HTTP request headers

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

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

updatePassword

\Reepay\Model\UserAccount updatePassword($id, $body)

Change password

Example

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

// Configure API key authorization: apiKey
Reepay\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Reepay\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure HTTP basic authorization: basicAuth
Reepay\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Reepay\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\UserApi();
$id = "id_example"; // string | User id
$body = new \Reepay\Model\UpdateUserPassword(); // \Reepay\Model\UpdateUserPassword |

try {
    $result = $apiInstance->updatePassword($id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->updatePassword: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	User id
body	\Reepay\Model\UpdateUserPassword		[optional]

Return type

\Reepay\Model\UserAccount

Authorization

apiKey, basicAuth

HTTP request headers

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

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

updateUser

\Reepay\Model\UserAccount updateUser($id, $body)

Update user

Example

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

// Configure API key authorization: apiKey
Reepay\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Reepay\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure HTTP basic authorization: basicAuth
Reepay\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Reepay\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\UserApi();
$id = "id_example"; // string | User id
$body = new \Reepay\Model\UpdateUser(); // \Reepay\Model\UpdateUser |

try {
    $result = $apiInstance->updateUser($id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->updateUser: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	User id
body	\Reepay\Model\UpdateUser		[optional]

Return type

\Reepay\Model\UserAccount

Authorization

apiKey, basicAuth

HTTP request headers

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

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

verifyEmail

\Reepay\Model\User verifyEmail($token)

Verify email

Example

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

$apiInstance = new Reepay\Api\UserApi();
$token = "token_example"; // string | Verify email token

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

Parameters

Name	Type	Description	Notes
token	string	Verify email token

Return type

\Reepay\Model\User

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

verifyEmailRequest

verifyEmailRequest($id)

Send verification email

Example

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

// Configure API key authorization: apiKey
Reepay\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Reepay\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
// Configure HTTP basic authorization: basicAuth
Reepay\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Reepay\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$apiInstance = new Reepay\Api\UserApi();
$id = "id_example"; // string | User id

try {
    $apiInstance->verifyEmailRequest($id);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->verifyEmailRequest: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	User id

Return type

void (empty response body)

Authorization

apiKey, basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

Files

UserApi.md

Latest commit

History

UserApi.md

File metadata and controls

Reepay\UserApi

deleteUser

Example

Parameters

Return type

Authorization

HTTP request headers

getUser

Example

Parameters

Return type

Authorization

HTTP request headers

getUsers

Example

Parameters

Return type

Authorization

HTTP request headers

inviteUser

Example

Parameters

Return type

Authorization

HTTP request headers

inviteUserAccept

Example

Parameters

Return type

Authorization

HTTP request headers

inviteUserGet

Example

Parameters

Return type

Authorization

HTTP request headers

resetPassword

Example

Parameters

Return type

Authorization

HTTP request headers

resetPasswordWithToken

Example

Parameters

Return type

Authorization

HTTP request headers

updateAuth

Example

Parameters

Return type

Authorization

HTTP request headers

updatePassword

Example

Parameters

Return type

Authorization

HTTP request headers

updateUser

Example

Parameters

Return type

Authorization

HTTP request headers

verifyEmail

Example

Parameters

Return type

Authorization

HTTP request headers

verifyEmailRequest