> For the complete documentation index, see [llms.txt](https://docs.defguard.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.defguard.net/for-developers/rest-api/core/user/start-remote-desktop-configuration.md).

# 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.

```json
{"openapi":"3.1.0","info":{"title":"defguard Core API","version":"2.0.3"},"tags":[{"name":"user","description":"User accounts, their MFA methods, enrollment and bulk operations."}],"security":[{"cookie":[]},{"api_token":[]}],"components":{"securitySchemes":{"cookie":{"type":"apiKey","in":"cookie","name":"defguard_session"},"api_token":{"type":"http","scheme":"bearer"}},"schemas":{"StartEnrollmentRequest":{"type":"object","properties":{"email":{"type":["string","null"]},"send_enrollment_notification":{"type":"boolean"},"token_expiration_time":{"type":["string","null"]}}},"ApiErrorResponse":{"type":"object","description":"Body returned with error responses.","required":["msg"],"properties":{"code":{"type":["string","null"],"description":"Machine-readable error code, returned for selected errors."},"msg":{"type":"string","description":"Human-readable error message."}}}}},"paths":{"/api/v1/user/{username}/start_desktop":{"post":{"tags":["user"],"summary":"Start remote desktop configuration","description":"Creates or updates the desktop client configuration of the user. Returns an enrollment\ntoken, valid for 24 hours, and the URL the user opens to finish the setup. The user can\nalso be notified by email.","operationId":"start_remote_desktop_configuration","parameters":[{"name":"username","in":"path","description":"Name of the user.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartEnrollmentRequest"}}},"required":true},"responses":{"201":{"description":"Enrollment token and URL.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid enrollment request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"401":{"description":"Session is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"403":{"description":"Requires admin privileges or the request must target your own account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"404":{"description":"User not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"500":{"description":"Unable to start remote desktop configuration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}}}}}}}
```