Set device wipe status for user

POST

/service/wipe/{username}

curl --request POST \
  --url https://example.com/api/v1/service/wipe/example \
  --header 'Content-Type: application/json' \
  --cookie grommunioAuthJwt=<grommunioAuthJwt> \
  --data '{ "password": "example", "remoteIP": "example", "status": 0, "time": 1 }'

• Default deployment path

Authorizations

• JWTCookie
• None

Parameters

Path Parameters

username

required

string

E-mail address of the user

Header Parameters

X-Csrf-Token

string

CSRF Token

Query Parameters

devices

Array<string>

Restrict request to these device IDs

Request Body^required

Media typeapplication/json

object

password

Password of the logged in user (with login) or the device owner (without login). Required when initiating wipe.

string

remoteIP

Source IP of the status update (default is the request origin).

string

status

required

integer

Allowed values: 0 1 2 4 8 16 32 64

time

UNIX timestamp of the status update (default is time of the request)

integer

Responses

201

States changed

400

Validation of input parameters failed

Media typeapplication/json

object

message

string

errors

List of errors encountered during validation

Array<string>

Example^generated

{
  "message": "example",
  "errors": [
    "example"
  ]
}

404

The requested resource could not be found

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

500

An error occurred while processing the request

Media typeapplication/json

object

message

String representation of the exception

string

Example^generated

{
  "message": "example"
}

503

The database query failed

Media typeapplication/json

object

message

Description of the error

string

Example^generated

{
  "message": "example"
}