Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
{
  "passwordHash": "{HASH_METHOD}<valid_password_hash>"
}


Fields

...

  • userName: the unique ID of the user (String)
  • passwordHash: the password hash to set (has formatted string)
    • HASH_METHOD: supported values are MD5, SHA, CRYPT, SMD5, SSHA, SSHA384, SSHA512

Success Response

Body

Code Block
{
  "active": true, "passwordMisentries": 0,
  "passwordLastChanged": 1465552800000
}

...

This resource is used to create a snapshot of the data of a given user.


Request

POST /intercept/snapshots

Body

Mailbox snapshotCalendar snapshotContacts snapshot
{
"username" : "someone",
"type": "mailbox",
"action": "scp",
"ssh": {
  "fingerprint": "75:5c:f9:c8:b6:f0:18:aa:23:ec:d9:67:56:ee:5f:c1.",
  "host": "upload.customer.net",
  "port": 22,
  "path": "/upload/dir",
  "username": "uploaduser"
},
"start": "2016-08-01T14:00:00Z",
"end": "2016-08-14T15:00:00Z"
}

{
"username" : "someone",
"type": "calendar",
"action": "scp",
"ssh": {
  "fingerprint": "75:5c:f9:c8:b6:f0:18:aa:23:ec:d9:67:56:ee:5f:c1.",
  "host": "upload.customer.net",
  "port": 22,
  "path": "/upload/dir",
  "username": "uploaduser"
}
}

{
"username" : "someone",
"type": "contacts",
"action": "scp",
"ssh": {
  "fingerprint": "75:5c:f9:c8:b6:f0:18:aa:23:ec:d9:67:56:ee:5f:c1.",
  "host": "upload.customer.net",
  "port": 22,
  "path": "/upload/dir",
  "username": "uploaduser"
}
}


Sucess response

Header

Location=/intercept/snapshots/{1a2b3c-..}

Body

Code Block
{
  "snapshotId": "1a2bCc-..",
  "username" : "someone",
  "type": "calendar",
  "action": "scp",
  "status": "pending"
  "lastChanged": 123456..
}


Status

200


5.17.4 List all available snapshots

...