Start User Data Export — POST /api/v1/users/{user_id}/data-export
Start User Data Export
Queue an export of one person’s data (any user, the admin included). 404 user_not_found.
Endpoint: POST /api/v1/users/{user_id}/data-export
Authentication: Send a signed-in user’s access token in Authorization: Bearer <access token>. API keys are refused.
- A minimum role applies. The source code names it.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Default | Description |
|---|---|---|---|---|---|
user_id | path | yes | string (uuid) | ||
X-API-Key | header | no | string or null | API key, as an alternative to the access token (see Authentication). |
Request body
Section titled “Request body”No request body.
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
202 | Successful Response | SubjectJobRead (application/json) |
422 | Validation Error | HTTPValidationError (application/json) |
It can also return 401 if your credential is missing or expired, 403 if your credential does not allow this request, and 404 if the item does not exist or you cannot see it. Your role, your project membership and the key’s scope decide what a credential allows. See Errors and retries.
More details
Section titled “More details”- Group: Subject rights
- Operation ID:
start_user_data_export_api_v1_users__user_id__data_export_post - Source code:
backend/app/routers/subject_rights.py, line 159 - Specification: OpenAPI JSON