---
title: "Set or update an IdP user's recovery email"
method: PUT
path: "/organizations/{organizationId}/idp-users/{email}"
tags: ["Organizations"]
---

# Set or update an IdP user's recovery email

`PUT /organizations/{organizationId}/idp-users/{email}`

## Request

- Base URL: `https://api.xfa.tech`
- URL: `https://api.xfa.tech/organizations/{organizationId}/idp-users/{email}`
- Auth: HTTP bearer

## Path parameters

- `organizationId` string, required
- `email` string, required

## Request body

- SetIdpUserRecoveryEmailRequestBody
  - `recovery_email` string, required: Recovery email the one-time enrollment code is sent to

## Response `200`

IdP user upserted

- IdpUserResponse: An admin-provisioned IdP user (recovery email for first-device onboarding)
  - `organization_id` string, required: ID of the organization
  - `email` string, required: The IdP user's email
  - `recovery_email` string, required: Recovery email the one-time enrollment code is sent to
  - `timestamp` string: Creation timestamp
  - `updated_timestamp` string: Last-update timestamp
  - `source` 'manual' | 'import': How the user was provisioned. Users created before the field existed report "manual".
  - `link_sent_at` string, date-time: When an onboarding link was last emailed (RFC3339). Omitted if never sent.
  - `enrolled` boolean, nullable: Only with ?include=enrollment: whether the user already has a reusable MFA factor. null when identity could not be asked.

---

[API](https://skmtc.dev/xfa/apis/xfa-api.md) · [All operations](https://skmtc.dev/xfa/apis/xfa-api/llms.txt) · [OpenAPI document](https://skmtc.dev/xfa/apis/xfa-api/revisions/1a1be0e8972b?raw)
