feat: Add bulk import docs #790
Conversation
✅ Deploy Preview for admiring-bhabha-7b1be9 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| "loginMethods": [ | ||
| { | ||
| "recipeId": "emailpassword", | ||
| "tenantIds": ["public"], |
There was a problem hiding this comment.
should tenantIds with ["public"] be a mandatory input? this would be applicable only for importing multi-tenant users right?
There was a problem hiding this comment.
No, it is not a mandatory input. I only included it make it obvious that the users will be imported to the public tenant.
| { | ||
| "users": { | ||
| "type": "array", | ||
| "items": { |
There was a problem hiding this comment.
Is it possible to render this in some way? it's way too confusing. People who don't know about json schema, won't even understand this.
|
|
||
| ## Examples | ||
|
|
||
| ### Example 1: Sample Bulk User Import JSON |
There was a problem hiding this comment.
I think you must provide many more examples. All in one examples might not be very effective. It should be a step by step additions.
For example:
Start with a very simple use case, of importing emailpassword users only. then, thirdparty users.
Then probably add an example on how to assign user roles. Later metadata.
Then give examples of account linking where same user has different login methods. Talk about isPrimary. Talk about where to add user roles and metadata.
Think about this in more detail please.
| @@ -0,0 +1,253 @@ | |||
| --- | |||
| id: bulk-user-import | |||
| title: Bulk User Import | |||
There was a problem hiding this comment.
This page should probably called user accounts migration
|
|
||
| ## Step 3: Monitor the import status | ||
|
|
||
| Monitor the import status with a GET request to the bulk import API. Filter the response using the `status` query parameter, which can be 'NEW', 'PROCESSING', or 'FAILED'. Completed entries are automatically deleted. |
There was a problem hiding this comment.
You should talk about when the import is going to happen. This is because it won't happen as soon as the bulk-import API is called. It should be clear on when the user can check for the statuses. Also is it possible for the user to know if the users list he passed has been processed or not?
Summary of change
(A few sentences about this PR)
Related issues
Checklist
cd v2 && MODE=production npx docusaurus build)