Fluxmail

Enroll a member

Reference for POST /api/v1/auth/enroll.

POST /api/v1/auth/enroll

Reference for POST /api/v1/auth/enroll.

Authentication

This endpoint does not require authentication.

Request

curl 'http://localhost:8977/api/v1/auth/enroll' \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
  "token": "string",
  "password": "string",
  "deviceName": "string"
}'

Request body

Content type: application/json

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string",
      "minLength": 1
    },
    "password": {
      "type": "string"
    },
    "deviceName": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    }
  },
  "required": [
    "token",
    "password",
    "deviceName"
  ],
  "additionalProperties": false
}

Responses

StatusDescriptionContent type
200Successapplication/json
400Invalid requestapplication/json
401Authentication requiredapplication/json
403Permission deniedapplication/json
404Not foundapplication/json
409Conflictapplication/json
413Request body too largeapplication/json
429Too many attemptsapplication/json

200 response

{
  "type": "object",
  "properties": {
    "data": {
      "nullable": true
    }
  }
}

Last updated