Save the authorization keys

POST /api/2.0/settings/authservice

Request

Saves the authorization keys.

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

Request parameters for authorization service

namestring

Name

titlestring

Title

descriptionstring

Description

instructionstring

Instruction

canSetboolean

Specifies if the authentication service can be set or not

propsarray of object

List of authorization keys

namestring

Name

valuestring

Value

titlestring

Title

Examples

POST /api/2.0/settings/authservice HTTP/1.1
Accept: application/json
Content-Length: 322
Content-Type: application/json
Host: example.com

{
  "name": "Alexander West",
  "title": "unbranded_metal_chair_usb_soft",
  "description": "some text",
  "instruction": "some text",
  "canSet": true,
  "props": [
    {
      "value": {
        "name": "Cristian Osinski",
        "value": "some text",
        "title": "open_source_kids_handcrafted"
      }
    }
  ]
}
curl --request POST \
  --url https://example.com/api/2.0/settings/authservice \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Alexander West",
  "title": "unbranded_metal_chair_usb_soft",
  "description": "some text",
  "instruction": "some text",
  "canSet": true,
  "props": [
    {
      "value": {
        "name": "Cristian Osinski",
        "value": "some text",
        "title": "open_source_kids_handcrafted"
      }
    }
  ]
}'

Responses

200

Boolean value: true if the authorization keys are changed

400

Bad keys

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