Bulk start user enrollment

Disabled users are skipped and counted in the skipped response field. Already enrolled users are enrolled again. The request is rejected when any of the given IDs does not exist or is your own.

post

Authorizations

cookieapi_token

defguard_sessionstringRequired

Body

application/json

send_enrollment_notificationbooleanOptional

Whether to send enrollment email to each user (uses user's stored email).

token_expiration_timestring · nullableOptional

Token expiration override in humantime format, for example 24h. Falls back to the system setting.

usersinteger · int64[]Required

Responses

200

Enrollment started.

application/json

objectOptional

400

The list contains unknown user IDs or your own account.

application/json

401

Session is missing or invalid.

application/json

403

Requires admin privileges.

application/json

500

Unable to start enrollments.

application/json

post/api/v1/user/bulk-start-enrollment

HTTPcURLJavaScriptPython

POST /api/v1/user/bulk-start-enrollment HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "send_enrollment_notification": true,
  "token_expiration_time": "24h",
  "users": [
    1,
    4,
    6,
    23,
    35
  ]
}

{
  "skipped": 1,
  "started": 3
}