Set a product administrator

PUT /api/2.0/settings/security/administrator

Request

Sets the selected user as a product administrator with the ID specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Content-Typeenum of string

Can be one of: application/json, application/*+json, text/json.

Body

Security request parameters

productIdstringformat: uuid

Product ID

userIdstringformat: uuid

User ID

administratorboolean

Administrator or not

Examples

PUT /api/2.0/settings/security/administrator HTTP/1.1
Accept: application/json
Content-Length: 134
Content-Type: application/json
Host: example.com

{
  "productId": "18e95d00-6efd-48a6-b792-ff6329d45733",
  "userId": "9ec96e43-57c7-46db-b0aa-fd387f38929c",
  "administrator": true
}
curl --request PUT \
  --url https://example.com/api/2.0/settings/security/administrator \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "productId": "18e95d00-6efd-48a6-b792-ff6329d45733",
  "userId": "9ec96e43-57c7-46db-b0aa-fd387f38929c",
  "administrator": true
}'

Responses

200

Object with the user security information: product ID, user ID, administrator or not

401

Unauthorized

402

Your pricing plan does not support this option

Get Help

  • If you have any questions about ONLYOFFICE DocSpace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).