Set the audit trail settings

POST /api/2.0/security/audit/settings/lifetime

Request

Sets the audit trail settings for the current portal.

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

Audit trail settings

settingsobject
loginHistoryLifeTimeintegerformat: int32

Login history lifetime

auditTrailLifeTimeintegerformat: int32

Audit trail lifetime

Examples

POST /api/2.0/security/audit/settings/lifetime HTTP/1.1
Accept: application/json
Content-Length: 88
Content-Type: application/json
Host: example.com

{
  "settings": {
    "loginHistoryLifeTime": 1234,
    "auditTrailLifeTime": 1234
  }
}
curl --request POST \
  --url https://example.com/api/2.0/security/audit/settings/lifetime \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "settings": {
    "loginHistoryLifeTime": 1234,
    "auditTrailLifeTime": 1234
  }
}'

Responses

200

Audit trail settings

loginHistoryLifeTimeintegerformat: int32

Login history lifetime

auditTrailLifeTimeintegerformat: int32

Audit trail lifetime

400

Exception in LoginHistoryLifeTime or AuditTrailLifeTime

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