Yapily\ApplicationUsersApi

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

Method	HTTP request	Description
addUserUsingPOST	POST /users	Add an application user
deleteUserUsingDELETE	DELETE /users/{userUuid}	Delete an application user and sub-resources (including consent resources on institution APIs if they exist)
getDeleteUsersJobUsingGET	GET /delete-users/{job-id}	Get details of a user deletion job
getDeleteUsersJobsUsingGET	GET /delete-users	Get details of all user deletion jobs
getUserUsingGET	GET /users/{userUuid}	Get an application user
getUsersUsingGET	GET /users	Get application users
startDeleteUsersJobUsingPOST	POST /delete-users	Start a job to delete application users by specifying their identifiers

addUserUsingPOST

\Yapily\Model\ApplicationUser addUserUsingPOST($new_application_user)

Add an application user

Example

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

// Configure HTTP basic authorization: basicAuth
$config = Yapily\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure OAuth2 access token for authorization: tokenAuth
$config = Yapily\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Yapily\Api\ApplicationUsersApi(
    // 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
);
$new_application_user = new \Yapily\Model\NewApplicationUser(); // \Yapily\Model\NewApplicationUser | newApplicationUser

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

Parameters

Name	Type	Description	Notes
new_application_user	\Yapily\Model\NewApplicationUser	newApplicationUser

Return type

\Yapily\Model\ApplicationUser

Authorization

basicAuth, tokenAuth

HTTP request headers

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

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

deleteUserUsingDELETE

\Yapily\Model\ApiResponseOfUserDeleteResponse deleteUserUsingDELETE($user_uuid)

Delete an application user and sub-resources (including consent resources on institution APIs if they exist)

Example

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

// Configure HTTP basic authorization: basicAuth
$config = Yapily\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure OAuth2 access token for authorization: tokenAuth
$config = Yapily\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Yapily\Api\ApplicationUsersApi(
    // 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_uuid = "user_uuid_example"; // string | userUuid

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

Parameters

Name	Type	Description	Notes
user_uuid	string	userUuid

Return type

\Yapily\Model\ApiResponseOfUserDeleteResponse

Authorization

basicAuth, tokenAuth

HTTP request headers

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

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

getDeleteUsersJobUsingGET

\Yapily\Model\ApiResponseOfBulkUserDeleteDetails getDeleteUsersJobUsingGET($job_id)

Get details of a user deletion job

Example

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

// Configure HTTP basic authorization: basicAuth
$config = Yapily\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure OAuth2 access token for authorization: tokenAuth
$config = Yapily\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Yapily\Api\ApplicationUsersApi(
    // 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
);
$job_id = "job_id_example"; // string | job-id

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

Parameters

Name	Type	Description	Notes
job_id	string	job-id

Return type

\Yapily\Model\ApiResponseOfBulkUserDeleteDetails

Authorization

basicAuth, tokenAuth

HTTP request headers

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

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

getDeleteUsersJobsUsingGET

\Yapily\Model\ApiListResponseOfBulkUserDelete getDeleteUsersJobsUsingGET()

Get details of all user deletion jobs

Example

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

// Configure HTTP basic authorization: basicAuth
$config = Yapily\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure OAuth2 access token for authorization: tokenAuth
$config = Yapily\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Yapily\Api\ApplicationUsersApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\Yapily\Model\ApiListResponseOfBulkUserDelete

Authorization

basicAuth, tokenAuth

HTTP request headers

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

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

getUserUsingGET

\Yapily\Model\ApplicationUser getUserUsingGET($user_uuid)

Get an application user

Example

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

// Configure HTTP basic authorization: basicAuth
$config = Yapily\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure OAuth2 access token for authorization: tokenAuth
$config = Yapily\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Yapily\Api\ApplicationUsersApi(
    // 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_uuid = "user_uuid_example"; // string | userUuid

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

Parameters

Name	Type	Description	Notes
user_uuid	string	userUuid

Return type

\Yapily\Model\ApplicationUser

Authorization

basicAuth, tokenAuth

HTTP request headers

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

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

getUsersUsingGET

\Yapily\Model\ApplicationUser[] getUsersUsingGET()

Get application users

Example

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

// Configure HTTP basic authorization: basicAuth
$config = Yapily\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure OAuth2 access token for authorization: tokenAuth
$config = Yapily\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Yapily\Api\ApplicationUsersApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\Yapily\Model\ApplicationUser[]

Authorization

basicAuth, tokenAuth

HTTP request headers

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

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

startDeleteUsersJobUsingPOST

\Yapily\Model\ApiResponseOfBulkUserDeleteDetails startDeleteUsersJobUsingPOST($user_delete_request)

Start a job to delete application users by specifying their identifiers

Example

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

// Configure HTTP basic authorization: basicAuth
$config = Yapily\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure OAuth2 access token for authorization: tokenAuth
$config = Yapily\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Yapily\Api\ApplicationUsersApi(
    // 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_delete_request = new \Yapily\Model\UserDeleteRequest(); // \Yapily\Model\UserDeleteRequest | userDeleteRequest

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

Parameters

Name	Type	Description	Notes
user_delete_request	\Yapily\Model\UserDeleteRequest	userDeleteRequest

Return type

\Yapily\Model\ApiResponseOfBulkUserDeleteDetails

Authorization

basicAuth, tokenAuth

HTTP request headers

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

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

FilesExpand file tree

ApplicationUsersApi.md

Latest commit

History

ApplicationUsersApi.md

File metadata and controls

Yapily\ApplicationUsersApi

addUserUsingPOST

Example

Parameters

Return type

Authorization

HTTP request headers

deleteUserUsingDELETE

Example

Parameters

Return type

Authorization

HTTP request headers

getDeleteUsersJobUsingGET

Example

Parameters

Return type

Authorization

HTTP request headers

getDeleteUsersJobsUsingGET

Example

Parameters

Return type

Authorization

HTTP request headers

getUserUsingGET

Example

Parameters

Return type

Authorization

HTTP request headers

getUsersUsingGET

Example

Parameters

Return type

Authorization

HTTP request headers

startDeleteUsersJobUsingPOST

Example

Parameters

Return type

Authorization

HTTP request headers