Function putUserMigration

PUT /migration/users – Creates or updates a user migration record.

---

📥 Request

Headers:

• Authorization: Bearer <access_token> (required)
• Content-Type: application/json or application/x-www-form-urlencoded (required)

Body:

• provider: The authentication provider (optional). Defaults to auth0-user.
• users: PutUserMigrationRequest

Path Parameters:

• None

Query Parameters:

• None

---

📤 Response

• 200 OK – Returns a JSON-stringified PutUserMigrationResponse object.

---

❗ Errors

Status Code	Meaning	When it Happens
400	Bad Request	Missing or invalid fields in request body
401	Unauthorized	Missing or invalid authentication token
500	Internal Server Error	Unexpected error

Error Response Format

{
  "error": "Detailed error message here"
}
Copy

---

📦 Examples

📥 Auth0 Request

PUT /migration/users
{
  "users":
  [
    {
      "email": "user1@districtB.com",
      "familyName": "Doe",
      "givenName": "John",
      "passwordHash": "hashedPassword123",
      "erpUserId": "erp123",
      "erpTenants": ["tenant1", "tenant2"],
      "userMetadata": {
          "siteId": "siteId",
          "homeroomId": "homeroomId",
       },
       "appMetadata": {
			"key": "value"
       },
    },
    {
      "email": "user2@districtB.com",
      "familyName": "Smith",
      "givenName": "Jane",
      "passwordHash": "hashedPassword456",
      "erpUserId": "erp456",
      "erpTenants": ["tenant2", "tenant3"],
      "userMetadata": {
          "siteId": "siteId",
          "homeroomId": "homeroomId",
       },
        "appMetadata": {
		 		"key": "value"
        },
    }
  ]
}
}
Copy

📥 Cognito Request

PUT /migration/users
{
  "provider": "cognito-user",
  "users":
  [
    {
      "email": "user1@districtB.com",
      "familyName": "Doe",
      "givenName": "John",
      "passwordHash": "hashedPassword123",
      "erpUserId": "erp123",
      "erpTenants": ["tenant1", "tenant2"],
      "userMetadata": {
          "siteId": "siteId",
          "homeroomId": "homeroomId",
       },
       "appMetadata": {
			"key": "value"
       },
    },
    {
      "email": "user2@districtB.com",
      "familyName": "Smith",
      "givenName": "Jane",
      "passwordHash": "hashedPassword456",
      "erpUserId": "erp456",
      "erpTenants": ["tenant2", "tenant3"],
      "userMetadata": {
          "siteId": "siteId",
          "homeroomId": "homeroomId",
       },
        "appMetadata": {
		 		"key": "value"
        },
    }
  ]
}
Copy

📤 Response Example

  {
    "saved": 1
  }
Copy

---