Offline mode

Save the Offline mode settings.

Changed on

Only administrators can call this endpoint. Saving the settings is what enables Offline mode for the organisation. The settings are held in a single row, so saving again updates that row instead of creating a second one.

post/offline/settings.json

Request

Request body

max_session_durationinteger required

How long a user stays authenticated offline before having to enter their passphrase again, in seconds.

data_retention_periodinteger required

Maximum number of days encrypted data is kept on a user's device.

max_itemsinteger required

Maximum number of items a single user can mark as available offline.

Example request

{
  "max_session_duration": 3600,
  "data_retention_period": 7,
  "max_items": 1000
}

Response

Operation is successful

Example response

{
  "header": {
    "servertime": 1720702619,
    "message": "The operation was successful.",
    "url": "/auth/verify.json",
    "code": 200
  },
  "body": {
    "max_session_duration": 3600,
    "data_retention_period": 7,
    "max_items": 1000
  }
}

Changes