-
Notifications
You must be signed in to change notification settings - Fork 196
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
📝 Docs update #456
Merged
Merged
📝 Docs update #456
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
162121e
:memo: Docs update
naelob b7ff242
:sparkles: New docs
naelob 7d65840
:sparkles: New features in api
naelob d879f11
:bug: Fix docs
naelob 1f611db
:pencil2: Fix typo
naelob dddb15d
:sparkles: Added docs updates
naelob File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -2,4 +2,79 @@ | |||||
title: "Import Your Existing Users" | ||||||
description: "" | ||||||
icon: "users" | ||||||
--- | ||||||
--- | ||||||
|
||||||
## Using the UI | ||||||
|
||||||
#### You can add a single linked user | ||||||
|
||||||
<Frame type="glass"> | ||||||
<video | ||||||
controls | ||||||
className="w-full aspect-video" | ||||||
src="/images/linkedusers.mp4" | ||||||
></video> | ||||||
</Frame> | ||||||
|
||||||
#### You can add a batch of linked users by using the drag n drop tool | ||||||
|
||||||
<Frame type="glass"> | ||||||
<video | ||||||
controls | ||||||
className="w-full aspect-video" | ||||||
src="/images/linkedusers.mp4" | ||||||
></video> | ||||||
</Frame> | ||||||
|
||||||
## Using our API | ||||||
|
||||||
This code adds a single/batch of linked accounts inside Panora. It helps us have an exact mapping of your existing users insdie our system. | ||||||
|
||||||
<CodeGroup> | ||||||
```shell Import a single existing user | ||||||
curl --request POST \ | ||||||
--url https://api.panora.dev/linked-users \ | ||||||
--header 'Authorization: Bearer <MY_API_KEY>' \ | ||||||
--header 'Content-Type: application/json' \ | ||||||
--data '{ | ||||||
"linked_user_origin_id": "acme_user_1", # your remote id (id representing your existing user inside your system) | ||||||
"alias": "acme", # your company name | ||||||
"id_project": "ikloqqkq90-djsddhjs-prs12dj", | ||||||
}' | ||||||
``` | ||||||
```shell Import a batch of existing users | ||||||
curl --request POST \ | ||||||
--url https://api.panora.dev/linked-users/batch \ | ||||||
--header 'Authorization: Bearer <MY_API_KEY>' \ | ||||||
--header 'Content-Type: application/json' \ | ||||||
--data '{ | ||||||
"linked_user_origin_ids": ["acme_user_1", "acme_user_2", "acme_user_3"], # array of remote ids (ids representing your existing users inside your system) | ||||||
"alias": "acme", # your company name | ||||||
"id_project": "ikloqqkq90-djsddhjs-prs12dj", | ||||||
}' | ||||||
``` | ||||||
</CodeGroup> | ||||||
|
||||||
# How to fetch linked users | ||||||
|
||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Consider adding a comma for better readability. - You must know how to fetch linked users as you'll have to use them in the UI widget prop.
+ You must know how to fetch linked users, as you'll have to use them in the UI widget prop. Committable suggestion
Suggested change
|
||||||
You must know how to fetch linked users as you'll have to use them in the UI widget prop. | ||||||
|
||||||
## Fetch using our library functions | ||||||
|
||||||
At any point in your code, if you have successfully added your linked users (see above) you'll be able to fetch them by calling : | ||||||
|
||||||
- `linkedUserFromRemoteId(remote_id: string)` where `remote_id` is the id of the user inside your system and this function returns a [LinkedUser object](/glossary/linked-account-object). | ||||||
- `fetchLinkedUsers()` where this function returns an array of [LinkedUser objects](/glossary/linked-account-object) for your projectId. | ||||||
|
||||||
<CodeGroup> | ||||||
```shell linkedUserFromRemoteId | ||||||
curl --request GET \ | ||||||
--url https://api.panora.dev/linked-users/fromRemoteId?remoteId=acme_id_1 \ | ||||||
--header 'Authorization: Bearer <MY_API_KEY>' \ | ||||||
``` | ||||||
```shell fetchLinkedUsers | ||||||
curl --request GET \ | ||||||
--url https://api.panora.dev/linked-users \ | ||||||
--header 'Authorization: Bearer <MY_API_KEY>' \ | ||||||
``` | ||||||
</CodeGroup> |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please correct the grammatical error in the introduction to the section on creating a custom field mapping.
Committable suggestion