Start enrollment for a user

Returns an enrollment token, valid for 24 hours, and the URL the user opens to finish enrollment in a browser or in the desktop client. The user can also be notified by email.

post

Authorizations

defguard_sessionstringRequired

Path parameters

usernamestringRequired

Name of the user.

Body

emailstring · nullableOptional

send_enrollment_notificationbooleanOptional

token_expiration_timestring · nullableOptional

Responses

201

Enrollment token and URL.

application/json

objectOptional

400

Invalid enrollment request.

application/json

401

Session is missing or invalid.

application/json

403

Requires admin privileges.

application/json

404

User not found.

application/json

500

Unable to start enrollment.

application/json

post/api/v1/user/{username}/start_enrollment

POST /api/v1/user/{username}/start_enrollment HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "email": null,
  "send_enrollment_notification": true,
  "token_expiration_time": null
}

{
  "enrollment_token": "5nT2xK9wQpR7vL1yZbH3cD8fG5aQeJmU",
  "enrollment_url": "https://vpn.example.com/enrollment"
}