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:
- This API needs to be enabled by cidaas by adding the scope
cidaas:bulk_user_create - Please share issuer-url and client-id with cidaas support to enable this functionality
- 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 themessagefield
Process States:
CREATED: User was successfully createdUPDATED: Existing user was successfully updatedFAILED: User migration failed (see message field for details)
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 413
- 417
- 429
Bulk migration completed successfully
Bad Request - Invalid request format or parameters
Unauthorized - Invalid or missing authentication
Forbidden - Missing required scope 'cidaas:bulk_user_create'
Not Found - Endpoint not found
Payload Too Large - Exceeds maximum of 1000 users per request
Expectation Failed - Validation or processing errors
Too Many Requests - Rate limit exceeded