Get device wipe status for user

GET

/service/wipe/{username}

curl --request GET \
  --url https://example.com/api/v1/service/wipe/example \
  --cookie grommunioAuthJwt=<grommunioAuthJwt>

• Default deployment path

Authorizations

• JWTCookie
• None

Parameters

Path Parameters

username

required

string

E-mail address of the user

Query Parameters

devices

Array<string>

Restrict request to these device IDs

Responses

200

List of devices returned

Media typeapplication/json

object

data

Associative array of devices

object

key

additional properties

object

status

Device status

integer

Example^generated

{
  "data": {
    "additionalProperty": {
      "status": 1
    }
  }
}

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"
}