Skip to main content

updateUserQuota

EmployeeFullArrayWrapper updateUserQuota(UpdateMembersQuotaRequestDto)

PUT /api/2.0/people/userquota

Change a user quota limit

Gives the listed accounts their own storage limit, replacing the portal default for each of them. The caller needs the permission to edit the portal settings, which in practice means a DocSpace administrator or the portal owner. quota is a whole number of bytes: a value of 0 or more becomes the personal limit, while any negative value switches the personal limit off and hands the account back to the portal default. The value has to fit the portal: a limit larger than the total storage the tariff allows, or larger than the portal-wide quota on a standalone installation, is rejected with 400, and so is a value that is not a whole number. System accounts are dropped from the list without an error, the accounts are processed one by one, and the answer holds the ones that were reached. Setting a limit does not free any space and does not delete anything: an account already over its new limit simply cannot add more. Use PUT api/2.0/people/resetquota to return accounts to the portal default.

Parameters​

NameInTypeDescriptionNotes
UpdateMembersQuotaRequestDtobodyUpdateMembersQuotaRequestDto[optional]

Responses​

Status codeDescriptionTypeResponse headers
200The accounts whose limit was changedEmployeeFullArrayWrapperX-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset
400The value is not a whole number of bytes, or it exceeds the storage the portal allows--
403No permissions to perform this action--
401UnauthorizedErrorApiResponse-
429Too Many Requests.ErrorApiResponseRetry-After
500Internal Server Error.ErrorApiResponse-
502Bad Gateway. Returned by the reverse proxy, response body may be HTML and not JSON.--
503Service Unavailable. Returned by the reverse proxy, response body may be HTML and not JSON.--

Return type​

EmployeeFullArrayWrapper

Authorization​

Basic, OAuth2 (scopes: read, write), ApiKeyBearer, asc_auth_key, Bearer, OpenId

HTTP request headers​

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