# ClientRolesConfigurationApi

All URIs are relative to *http://localhost:8889/api*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**get**](#get) | **GET** /configuration/clientroles.yaml | Get client roles configuration|
|[**update**](#update) | **PUT** /configuration/clientroles.yaml | Update client roles configuration|

# **get**
> ClientsRolesConfiguration get()


### Example

```typescript
import {
    ClientRolesConfigurationApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new ClientRolesConfigurationApi(configuration);

let type: Array<'CLIENT' | 'GROUP'>; //The account holder type for which the client roles are returned. If the parameter is absent, all the clients roles are returned. (optional) (default to undefined)

const { status, data } = await apiInstance.get(
    type
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **type** | **Array<&#39;CLIENT&#39; &#124; &#39;GROUP&#39;>** | The account holder type for which the client roles are returned. If the parameter is absent, all the clients roles are returned. | (optional) defaults to undefined|


### Return type

**ClientsRolesConfiguration**

### Authorization

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

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/vnd.mambu.v2+yaml


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Client roles configuration returned. |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |
|**404** | Client roles configuration not found. |  -  |

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

# **update**
> update()


### Example

```typescript
import {
    ClientRolesConfigurationApi,
    Configuration,
    ClientsRolesConfiguration
} from './api';

const configuration = new Configuration();
const apiInstance = new ClientRolesConfigurationApi(configuration);

let clientsRolesConfiguration: ClientsRolesConfiguration; // (optional)

const { status, data } = await apiInstance.update(
    clientsRolesConfiguration
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **clientsRolesConfiguration** | **ClientsRolesConfiguration**|  | |


### Return type

void (empty response body)

### Authorization

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

### HTTP request headers

 - **Content-Type**: application/yaml
 - **Accept**: application/vnd.mambu.v2+yaml


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Client roles configuration updated. |  -  |
|**400** | A validation error occurred |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |
|**404** | Client roles configuration not found. |  -  |

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