# QuotaAdministrationApi

All URIs are relative to *http://localhost:8081*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**clearUserQuota**](#clearuserquota) | **DELETE** /api/v1/admin/quotas/users/{username} | Remove one user\'s own limit|
|[**getUser**](#getuser) | **GET** /api/v1/admin/quotas/users/{username} | Get one user\'s storage|
|[**listUsers**](#listusers) | **GET** /api/v1/admin/quotas/users | List users\' storage|
|[**overview**](#overview) | **GET** /api/v1/admin/quotas | Quota overview|
|[**setUserQuota**](#setuserquota) | **PUT** /api/v1/admin/quotas/users/{username} | Set one user\'s own limit|

# **clearUserQuota**
> QuotaUsage clearUserQuota()

The group or default limit applies again.

### Example

```typescript
import {
    QuotaAdministrationApi,
    Configuration
} from '@openfilz-sdk/typescript';

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

let username: string; // (default to undefined)

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **username** | [**string**] |  | defaults to undefined|


### Return type

**QuotaUsage**

### Authorization

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

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | OK |  -  |

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

# **getUser**
> QuotaUsage getUser()


### Example

```typescript
import {
    QuotaAdministrationApi,
    Configuration
} from '@openfilz-sdk/typescript';

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

let username: string; // (default to undefined)

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **username** | [**string**] |  | defaults to undefined|


### Return type

**QuotaUsage**

### Authorization

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

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | OK |  -  |

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

# **listUsers**
> QuotaUserPage listUsers()

Every user storage is charged to, with usage, effective limit and its source. Sort by usage (default), percent, limit or name.

### Example

```typescript
import {
    QuotaAdministrationApi,
    Configuration
} from '@openfilz-sdk/typescript';

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

let search: string; //Case-insensitive filter on the user name (optional) (default to undefined)
let sort: string; //usage | percent | limit | name (optional) (default to 'usage')
let order: string; //asc | desc (optional) (default to 'desc')
let page: number; // (optional) (default to 0)
let size: number; // (optional) (default to 25)

const { status, data } = await apiInstance.listUsers(
    search,
    sort,
    order,
    page,
    size
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **search** | [**string**] | Case-insensitive filter on the user name | (optional) defaults to undefined|
| **sort** | [**string**] | usage | percent | limit | name | (optional) defaults to 'usage'|
| **order** | [**string**] | asc | desc | (optional) defaults to 'desc'|
| **page** | [**number**] |  | (optional) defaults to 0|
| **size** | [**number**] |  | (optional) defaults to 25|


### Return type

**QuotaUserPage**

### Authorization

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

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | OK |  -  |

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

# **overview**
> QuotaOverview overview()

Deployment-wide limits (MB, 0 = no limit), instance usage and the number of user overrides.

### Example

```typescript
import {
    QuotaAdministrationApi,
    Configuration
} from '@openfilz-sdk/typescript';

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

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

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


### Return type

**QuotaOverview**

### Authorization

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

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | OK |  -  |

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

# **setUserQuota**
> QuotaUsage setUserQuota(userQuotaRequest)

quotaMb > 0 = this user\'s limit, 0 = no limit for this user. Takes precedence over group and default limits.

### Example

```typescript
import {
    QuotaAdministrationApi,
    Configuration,
    UserQuotaRequest
} from '@openfilz-sdk/typescript';

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

let username: string; // (default to undefined)
let userQuotaRequest: UserQuotaRequest; //

const { status, data } = await apiInstance.setUserQuota(
    username,
    userQuotaRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **userQuotaRequest** | **UserQuotaRequest**|  | |
| **username** | [**string**] |  | defaults to undefined|


### Return type

**QuotaUsage**

### Authorization

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

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | OK |  -  |

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