# UserRolesConfigurationApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**get**](#get) | **GET** /configuration/userroles.yaml | Get user roles configuration|
|[**getTemplate**](#gettemplate) | **GET** /configuration/userroles/template.yaml | Get user roles configuration template|
|[**update**](#update) | **PUT** /configuration/userroles.yaml | Update user roles configuration|

# **get**
> RolesConfiguration get()


### Example

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

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

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

### Parameters
This endpoint does not have any parameters.


### Return type

**RolesConfiguration**

### 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** | User roles configuration returned. |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |

[[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)

# **getTemplate**
> RolesConfiguration getTemplate()


### Example

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

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

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

### Parameters
This endpoint does not have any parameters.


### Return type

**RolesConfiguration**

### 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** | User roles configuration template returned. |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |

[[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 {
    UserRolesConfigurationApi,
    Configuration,
    RolesConfiguration
} from './api';

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

let xMambuAsync: boolean; // (optional) (default to undefined)
let xMambuCallback: string; // (optional) (default to undefined)
let rolesConfiguration: RolesConfiguration; // (optional)

const { status, data } = await apiInstance.update(
    xMambuAsync,
    xMambuCallback,
    rolesConfiguration
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **rolesConfiguration** | **RolesConfiguration**|  | |
| **xMambuAsync** | [**boolean**] |  | (optional) defaults to undefined|
| **xMambuCallback** | [**string**] |  | (optional) defaults to undefined|


### 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** | User roles configuration updated.  |  -  |
|**400** | A validation error occurred |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |
|**404** | User 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)