Skip to content

UsersManagementApi.md

Latest commit

 

History

History
380 lines (267 loc) · 14.9 KB

UsersManagementApi.md

File metadata and controls

380 lines (267 loc) · 14.9 KB

Aurigma\BackOffice\UsersManagementApi

All URIs are relative to http://localhost, except if the operation defines another base path.

Method HTTP request Description
usersManagementCreate() POST /api/backoffice/v1/users Creates a new tenant user.
usersManagementDelete() DELETE /api/backoffice/v1/users/{id} Deletes an existing tenant user.
usersManagementGet() GET /api/backoffice/v1/users/{id} Returns a tenant user by user identifier.
usersManagementGetAll() GET /api/backoffice/v1/users Returns a tenant users list.
usersManagementGetAllRoles() GET /api/backoffice/v1/users/roles Returns all tenant user roles, relevant to the specified query parameters.

usersManagementCreate()

usersManagementCreate($tenant_id, $users_management_create_request): \Aurigma\BackOffice\Model\TenantUserDto

Creates a new tenant user.

Example

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


// Configure API key authorization: ApiKey
$config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

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

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

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


$apiInstance = new Aurigma\BackOffice\Api\UsersManagementApi(
    // 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
);
$tenant_id = 56; // int | Tenant identifier.
$users_management_create_request = new \Aurigma\BackOffice\Model\UsersManagementCreateRequest(); // \Aurigma\BackOffice\Model\UsersManagementCreateRequest | User creation model.

try {
    $result = $apiInstance->usersManagementCreate($tenant_id, $users_management_create_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersManagementApi->usersManagementCreate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
tenant_id int Tenant identifier. [optional]
users_management_create_request \Aurigma\BackOffice\Model\UsersManagementCreateRequest User creation model. [optional]

Return type

\Aurigma\BackOffice\Model\TenantUserDto

Authorization

ApiKey, OAuth2ClientCredentials, OAuth2Implicit, Bearer

HTTP request headers

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

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

usersManagementDelete()

usersManagementDelete($id, $tenant_id)

Deletes an existing tenant user.

Example

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


// Configure API key authorization: ApiKey
$config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

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

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

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


$apiInstance = new Aurigma\BackOffice\Api\UsersManagementApi(
    // 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
);
$id = 56; // int | User identifier.
$tenant_id = 56; // int | Tenant identifier.

try {
    $apiInstance->usersManagementDelete($id, $tenant_id);
} catch (Exception $e) {
    echo 'Exception when calling UsersManagementApi->usersManagementDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id int User identifier.
tenant_id int Tenant identifier. [optional]

Return type

void (empty response body)

Authorization

ApiKey, OAuth2ClientCredentials, OAuth2Implicit, Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

usersManagementGet()

usersManagementGet($id, $tenant_id): \Aurigma\BackOffice\Model\TenantUserDto

Returns a tenant user by user identifier.

Example

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


// Configure API key authorization: ApiKey
$config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

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

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

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


$apiInstance = new Aurigma\BackOffice\Api\UsersManagementApi(
    // 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
);
$id = 56; // int | User identifier.
$tenant_id = 56; // int | Tenant identifier.

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

Parameters

Name Type Description Notes
id int User identifier.
tenant_id int Tenant identifier. [optional]

Return type

\Aurigma\BackOffice\Model\TenantUserDto

Authorization

ApiKey, OAuth2ClientCredentials, OAuth2Implicit, Bearer

HTTP request headers

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

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

usersManagementGetAll()

usersManagementGetAll($tenant_id): \Aurigma\BackOffice\Model\PagedOfTenantUserDto

Returns a tenant users list.

Example

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


// Configure API key authorization: ApiKey
$config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

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

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

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


$apiInstance = new Aurigma\BackOffice\Api\UsersManagementApi(
    // 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
);
$tenant_id = 56; // int | Tenant identifier.

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

Parameters

Name Type Description Notes
tenant_id int Tenant identifier. [optional]

Return type

\Aurigma\BackOffice\Model\PagedOfTenantUserDto

Authorization

ApiKey, OAuth2ClientCredentials, OAuth2Implicit, Bearer

HTTP request headers

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

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

usersManagementGetAllRoles()

usersManagementGetAllRoles($search, $skip, $take, $sorting, $tenant_id): \Aurigma\BackOffice\Model\PagedOfTenantUserRoleDto

Returns all tenant user roles, relevant to the specified query parameters.

Example

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


// Configure API key authorization: ApiKey
$config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

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

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

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


$apiInstance = new Aurigma\BackOffice\Api\UsersManagementApi(
    // 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
);
$search = 'search_example'; // string | Search string for partial match.
$skip = 56; // int | Defines page start offset from beginning of sorted result list.
$take = 56; // int | Defines page length (how many consequent items of sorted result list should be taken).
$sorting = 'sorting_example'; // string | Defines sorting order of result list e.g.: \"Title ASC, LastModified DESC\".
$tenant_id = 56; // int | Tenant identifier.

try {
    $result = $apiInstance->usersManagementGetAllRoles($search, $skip, $take, $sorting, $tenant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersManagementApi->usersManagementGetAllRoles: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
search string Search string for partial match. [optional]
skip int Defines page start offset from beginning of sorted result list. [optional]
take int Defines page length (how many consequent items of sorted result list should be taken). [optional]
sorting string Defines sorting order of result list e.g.: &quot;Title ASC, LastModified DESC&quot;. [optional]
tenant_id int Tenant identifier. [optional]

Return type

\Aurigma\BackOffice\Model\PagedOfTenantUserRoleDto

Authorization

ApiKey, OAuth2ClientCredentials, OAuth2Implicit, Bearer

HTTP request headers

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

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