# OmsorgCoreClient\UsersApi

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

| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**apiUsersGet()**](UsersApi.md#apiUsersGet) | **GET** /api/users |  |
| [**apiUsersIdPermissionOverridesGet()**](UsersApi.md#apiUsersIdPermissionOverridesGet) | **GET** /api/users/{id}/permission-overrides |  |
| [**apiUsersIdPermissionOverridesOverrideIdDelete()**](UsersApi.md#apiUsersIdPermissionOverridesOverrideIdDelete) | **DELETE** /api/users/{id}/permission-overrides/{overrideId} |  |
| [**apiUsersIdPermissionOverridesPost()**](UsersApi.md#apiUsersIdPermissionOverridesPost) | **POST** /api/users/{id}/permission-overrides |  |
| [**apiUsersIdPut()**](UsersApi.md#apiUsersIdPut) | **PUT** /api/users/{id} |  |
| [**apiUsersIdResetPasswordPost()**](UsersApi.md#apiUsersIdResetPasswordPost) | **POST** /api/users/{id}/reset-password |  |
| [**apiUsersPost()**](UsersApi.md#apiUsersPost) | **POST** /api/users |  |


## `apiUsersGet()`

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



### Example

```php
<?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[]**](../Model/UserResponse.md)

### Authorization

[Bearer](../../README.md#Bearer)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `apiUsersIdPermissionOverridesGet()`

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



### Example

```php
<?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[]**](../Model/UserPermissionOverrideResponse.md)

### Authorization

[Bearer](../../README.md#Bearer)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `apiUsersIdPermissionOverridesOverrideIdDelete()`

```php
apiUsersIdPermissionOverridesOverrideIdDelete($id, $override_id)
```



### Example

```php
<?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](../../README.md#Bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `apiUsersIdPermissionOverridesPost()`

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



### Example

```php
<?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**](../Model/AddUserPermissionOverrideRequest.md)|  | [optional] |

### Return type

[**\OmsorgCoreClient\Model\UserPermissionOverrideResponse**](../Model/UserPermissionOverrideResponse.md)

### Authorization

[Bearer](../../README.md#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]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `apiUsersIdPut()`

```php
apiUsersIdPut($id, $update_user_request)
```



### Example

```php
<?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**](../Model/UpdateUserRequest.md)|  | [optional] |

### Return type

void (empty response body)

### Authorization

[Bearer](../../README.md#Bearer)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `apiUsersIdResetPasswordPost()`

```php
apiUsersIdResetPasswordPost($id, $reset_user_password_request)
```



### Example

```php
<?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**](../Model/ResetUserPasswordRequest.md)|  | [optional] |

### Return type

void (empty response body)

### Authorization

[Bearer](../../README.md#Bearer)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `apiUsersPost()`

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



### Example

```php
<?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**](../Model/CreateUserRequest.md)|  | [optional] |

### Return type

[**\OmsorgCoreClient\Model\UserResponse**](../Model/UserResponse.md)

### Authorization

[Bearer](../../README.md#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]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
