Skip to main content
Version: 4.0.0

Migrate (add or update) user entities

POST 
/users-srv/user/bulk

Migrating to cidaas mostly also implies to migrate users and if applicable also their hashed passwords.

The users might even have further fields (customFields), groups or roles that might need migration. This specification helps to understand the object that is transferred to cidaas to migrate users.

For detailed step-by-step guidance, see the User Migration Documentation.

Important Notes:

  • Maximum 1000 users per request
  • The response includes individual status for each user migration attempt
  • Failed migrations will have sub: "ANONYMOUS" and include error details in the message field
  • Optional account fields createdTime and lastLoggedInTime preserve historical registration and last-login dates from your source system when provided (ISO 8601)

Process States:

  • CREATED: User was successfully created
  • UPDATED: Existing user was successfully updated
  • FAILED: User migration failed (see message field for details)

Common Errors & Troubleshooting:

  • 507 / "invalid email passed": Returned when an email fails validation. Key causes and solutions:
    • Disposable email address: Rejection occurs if allow_disposable_email is false on the client App. Set allow_disposable_email: true in App settings if disposable or test emails are expected.
    • Invalid email domain MX record: The email domain lacks active/resolvable MX or A DNS records. Ensure email domains in the import batch have valid DNS records.
  • 400 Bad Request: Missing required fields or invalid data types.
  • 413 Payload Too Large: Batch size exceeds 1000 users.

Request​

Responses​

Bulk migration completed successfully