omsorg/omsorgWeb/mitarbeiter-app/api-client-php/docs/Api/UsersApi.md

OmsorgCoreClient\UsersApi

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

Method	HTTP request	Description
apiUsersGet()	GET /api/users
apiUsersIdPermissionOverridesGet()	GET /api/users/{id}/permission-overrides
apiUsersIdPermissionOverridesOverrideIdDelete()	DELETE /api/users/{id}/permission-overrides/{overrideId}
apiUsersIdPermissionOverridesPost()	POST /api/users/{id}/permission-overrides
apiUsersIdPut()	PUT /api/users/{id}
apiUsersIdResetPasswordPost()	POST /api/users/{id}/reset-password
apiUsersPost()	POST /api/users

apiUsersGet()

apiUsersGet(): \OmsorgCoreClient\Model\UserResponse[]

Example

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


// Configure Bearer (JWT) authorization: Bearer
$config = OmsorgCoreClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OmsorgCoreClient\Api\UsersApi(
    // 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->apiUsersGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->apiUsersGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\OmsorgCoreClient\Model\UserResponse[]

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: text/plain, application/json, text/json

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

apiUsersIdPermissionOverridesGet()

apiUsersIdPermissionOverridesGet($id): \OmsorgCoreClient\Model\UserPermissionOverrideResponse[]

Example

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


// Configure Bearer (JWT) authorization: Bearer
$config = OmsorgCoreClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OmsorgCoreClient\Api\UsersApi(
    // 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 = 'id_example'; // string

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

Parameters

Name	Type	Description	Notes
id	string

Return type

\OmsorgCoreClient\Model\UserPermissionOverrideResponse[]

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: text/plain, application/json, text/json

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

apiUsersIdPermissionOverridesOverrideIdDelete()

apiUsersIdPermissionOverridesOverrideIdDelete($id, $override_id)

Example

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


// Configure Bearer (JWT) authorization: Bearer
$config = OmsorgCoreClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OmsorgCoreClient\Api\UsersApi(
    // 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 = 'id_example'; // string
$override_id = 'override_id_example'; // string

try {
    $apiInstance->apiUsersIdPermissionOverridesOverrideIdDelete($id, $override_id);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->apiUsersIdPermissionOverridesOverrideIdDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string
override_id	string

Return type

void (empty response body)

Authorization

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]

apiUsersIdPermissionOverridesPost()

apiUsersIdPermissionOverridesPost($id, $add_user_permission_override_request): \OmsorgCoreClient\Model\UserPermissionOverrideResponse

Example

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


// Configure Bearer (JWT) authorization: Bearer
$config = OmsorgCoreClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OmsorgCoreClient\Api\UsersApi(
    // 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 = 'id_example'; // string
$add_user_permission_override_request = new \OmsorgCoreClient\Model\AddUserPermissionOverrideRequest(); // \OmsorgCoreClient\Model\AddUserPermissionOverrideRequest

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

Parameters

Name	Type	Description	Notes
id	string
add_user_permission_override_request	\OmsorgCoreClient\Model\AddUserPermissionOverrideRequest		[optional]

Return type

\OmsorgCoreClient\Model\UserPermissionOverrideResponse

Authorization

Bearer

HTTP request headers

• Content-Type: application/json, text/json, application/*+json
• Accept: text/plain, application/json, text/json

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

apiUsersIdPut()

apiUsersIdPut($id, $update_user_request)

Example

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


// Configure Bearer (JWT) authorization: Bearer
$config = OmsorgCoreClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OmsorgCoreClient\Api\UsersApi(
    // 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 = 'id_example'; // string
$update_user_request = new \OmsorgCoreClient\Model\UpdateUserRequest(); // \OmsorgCoreClient\Model\UpdateUserRequest

try {
    $apiInstance->apiUsersIdPut($id, $update_user_request);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->apiUsersIdPut: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string
update_user_request	\OmsorgCoreClient\Model\UpdateUserRequest		[optional]

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: application/json, text/json, application/*+json
• Accept: Not defined

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

apiUsersIdResetPasswordPost()

apiUsersIdResetPasswordPost($id, $reset_user_password_request)

Example

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


// Configure Bearer (JWT) authorization: Bearer
$config = OmsorgCoreClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OmsorgCoreClient\Api\UsersApi(
    // 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 = 'id_example'; // string
$reset_user_password_request = new \OmsorgCoreClient\Model\ResetUserPasswordRequest(); // \OmsorgCoreClient\Model\ResetUserPasswordRequest

try {
    $apiInstance->apiUsersIdResetPasswordPost($id, $reset_user_password_request);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->apiUsersIdResetPasswordPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string
reset_user_password_request	\OmsorgCoreClient\Model\ResetUserPasswordRequest		[optional]

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: application/json, text/json, application/*+json
• Accept: Not defined

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

apiUsersPost()

apiUsersPost($create_user_request): \OmsorgCoreClient\Model\UserResponse

Example

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


// Configure Bearer (JWT) authorization: Bearer
$config = OmsorgCoreClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OmsorgCoreClient\Api\UsersApi(
    // 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
);
$create_user_request = new \OmsorgCoreClient\Model\CreateUserRequest(); // \OmsorgCoreClient\Model\CreateUserRequest

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

Parameters

Name	Type	Description	Notes
create_user_request	\OmsorgCoreClient\Model\CreateUserRequest		[optional]

Return type

\OmsorgCoreClient\Model\UserResponse

Authorization

Bearer

HTTP request headers

• Content-Type: application/json, text/json, application/*+json
• Accept: text/plain, application/json, text/json

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