Start remote desktop configuration

Creates or updates the desktop client configuration of the user. Returns an enrollment token, valid for 24 hours, and the URL the user opens to finish the setup. The user can also be notified by email.

post

Authorizations

cookieapi_token

defguard_sessionstringRequired

Path parameters

usernamestringRequired

Name of the user.

Body

application/json

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 or the request must target your own account.

application/json

404

User not found.

application/json

500

Unable to start remote desktop configuration.

application/json

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

HTTPcURLJavaScriptPython

POST /api/v1/user/{username}/start_desktop 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"
}