-
Notifications
You must be signed in to change notification settings - Fork 8
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
Fix/update accessing kinde api topics #226
Conversation
Previous - /developer-tools/kinde-api/add-a-m2m-application-for-api-access/
Old path /docs/developer-tools/kinde-api/test-the-connection-to-kindes-api/
Old slug - /docs/developer-tools/kinde-api/get-access-token-for-connecting-securely-to-kindes-api/
Caution Review failedThe pull request is closed. WalkthroughThe changes in this pull request include several updates to documentation related to Kinde's Management API, specifically focusing on Machine-to-Machine (M2M) applications and OAuth 2.0 flows. Key modifications include the addition of new documents on scopes and troubleshooting, updates to existing documents for clarity and organization, and the removal of outdated files. Notably, the link for adding M2M applications has been updated, and the overall structure of related documents has been refined to enhance user guidance. Changes
Possibly related PRs
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
❌ Link Validation Failed
|
The link errors will be resolved by redirects |
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.
Actionable comments posted: 2
🧹 Outside diff range and nitpick comments (9)
src/content/docs/developer-tools/kinde-api/troubleshoot-kinde-api.mdx (3)
12-13
: Minor grammatical correction needed in the introduction.The introduction effectively sets the context for the troubleshooting guide. However, there's a small grammatical issue that should be addressed.
Consider revising the sentence for better subject-verb agreement:
-There's a lot of configurations and events that support API connections. Sometimes things go wrong. Here's a few common errors people come across. +There are a lot of configurations and events that support API connections. Sometimes things go wrong. Here are a few common errors people come across.
14-23
: LGTM: Clear instructions for troubleshooting null responses.The steps provided are clear and easy to follow. The link to more detailed information is helpful for users who need additional context.
Consider adding a brief explanation of what custom claims are and why they might be necessary. This could provide more context for users unfamiliar with the concept. For example:
When you request to receive data back via the API and get an unexpected or `null` response, you may need to add custom claims to the token. +Custom claims are additional pieces of information that can be included in a token to provide more context or data about the user or application. 1. In Kinde, go to **Settings > Applications** and open the relevant application.
25-33
: LGTM: Clear instructions for managing API scopes, with a minor grammatical correction.The instructions for managing API scopes are clear and align well with the PR objectives of improving documentation. This section provides valuable guidance for users encountering scope-related issues.
There's a minor grammatical issue that should be addressed:
-Access to Kinde's Management API is limited by scopes. When you create or update a M2M application, you need to review and select scopes. +Access to Kinde's Management API is limited by scopes. When you create or update an M2M application, you need to review and select scopes.🧰 Tools
🪛 LanguageTool
[misspelling] ~27-~27: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...ed by scopes. When you create or update a M2M application, you need to review and...(EN_A_VS_AN)
src/content/docs/developer-tools/kinde-api/connect-to-kinde-api.mdx (2)
17-25
: LGTM with a minor suggestionThe instructions for adding a machine-to-machine application are clear and concise. The emphasis on saving app keys is crucial for security.
Consider adding a note about the sensitivity of the Client Secret. For example, after step 5, you could add:
5. Copy the app keys. You need these details to test or initiate access requests from your application or service to Kinde's API. See Step 3 below. + + Note: Keep your Client Secret confidential. Never share it or commit it to version control.This addition would reinforce the importance of protecting sensitive credentials.
36-45
: LGTM with a minor formatting suggestionThe links to additional resources for making access token requests and the video demo are valuable additions to the documentation. They provide users with multiple ways to learn about and implement the API connection process.
For consistency with the previous sections, consider formatting the video demo section as a numbered step:
-## Video demo: Setting up and testing the API connection +## Step 4: Watch the video demo -Watch a video about connecting and testing the API connection on our YouTube channel [here](https://www.youtube.com/watch?v=xJCj0IeoB5g). +For a visual guide on setting up and testing the API connection, watch our video tutorial on YouTube [here](https://www.youtube.com/watch?v=xJCj0IeoB5g).This change would maintain the step-by-step structure of the document and potentially encourage more users to watch the video as part of the process.
src/content/docs/developer-tools/kinde-api/access-token-for-api.mdx (4)
Line range hint
2-11
: LGTM! Consider adding a description metadata.The changes to the frontmatter improve the document's organization and discoverability. The new title is more specific and action-oriented, which is great.
Consider adding a
description
field to the frontmatter. This can improve SEO and provide a quick summary for users. For example:description: Learn how to make access token requests to the Kinde API using Postman or Node.js fetch.
Line range hint
18-105
: Excellent improvements to the Postman instructions!The reorganization of steps, addition of screenshots, and clarification of instructions greatly enhance the usability of this section. The recommendation for non-production testing and the link to troubleshooting solutions are valuable additions.
Consider adding alt text to the images that describe the specific steps being illustrated. For example, for the image in step 8, you could use:
alt="Setting the audience value in Postman's Advanced Token Request settings"This would improve accessibility and provide more context for users who rely on screen readers.
Line range hint
106-125
: Good updates to the Node.js fetch section.The changes maintain consistency with the rest of the document, and the link to other SDK frameworks is a helpful addition.
Consider adding a brief explanation of the code snippet, particularly for the
audience
parameter. This would help users understand why they need to include it and how it relates to the Postman example. For instance:Note: The `audience` parameter should be set to your Kinde domain followed by "/api", similar to the Postman example above.
127-158
: Excellent addition of the "Test the various endpoints" section!This new section provides valuable guidance on how to verify the API connection and start using the endpoints. The step-by-step instructions and screenshots make it easy for users to follow along.
Consider adding a note about potential security implications of accessing user data, even in a test environment. For example:
Note: When testing with real user data, ensure you're following your organization's data protection policies and any applicable privacy regulations.This reminder could help users be mindful of data security practices from the start.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (9)
- src/content/docs/build/applications/about-applications.mdx (1 hunks)
- src/content/docs/developer-tools/kinde-api/about-m2m-scopes.mdx (1 hunks)
- src/content/docs/developer-tools/kinde-api/access-token-for-api.mdx (4 hunks)
- src/content/docs/developer-tools/kinde-api/add-a-m2m-application-for-api-access.mdx (0 hunks)
- src/content/docs/developer-tools/kinde-api/api-example-node.mdx (1 hunks)
- src/content/docs/developer-tools/kinde-api/api-rate-limits.mdx (1 hunks)
- src/content/docs/developer-tools/kinde-api/connect-to-kinde-api.mdx (1 hunks)
- src/content/docs/developer-tools/kinde-api/test-the-connection-to-kindes-api.mdx (0 hunks)
- src/content/docs/developer-tools/kinde-api/troubleshoot-kinde-api.mdx (1 hunks)
💤 Files with no reviewable changes (2)
- src/content/docs/developer-tools/kinde-api/add-a-m2m-application-for-api-access.mdx
- src/content/docs/developer-tools/kinde-api/test-the-connection-to-kindes-api.mdx
✅ Files skipped from review due to trivial changes (2)
- src/content/docs/developer-tools/kinde-api/api-example-node.mdx
- src/content/docs/developer-tools/kinde-api/api-rate-limits.mdx
🧰 Additional context used
🪛 LanguageTool
src/content/docs/developer-tools/kinde-api/about-m2m-scopes.mdx
[uncategorized] ~19-~19: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...pes when you authorize a new application or you can add scopes to an existing appli...(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~29-~29: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...edure if you already have an application and you experience a scope error or want to...(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~34-~34: A comma might be missing here.
Context: ...nt to include in the token. For maximum security only enable the minimum scopes you requ...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
src/content/docs/developer-tools/kinde-api/connect-to-kinde-api.mdx
[style] ~33-~33: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...API, then choose Manage scopes. 5. Select the scopes you want to include in the t...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~33-~33: Possible missing comma found.
Context: ...nt to include in the token. For maximum security only enable the minimum scopes you requ...(AI_HYDRA_LEO_MISSING_COMMA)
src/content/docs/developer-tools/kinde-api/troubleshoot-kinde-api.mdx
[grammar] ~11-~11: Consider using the plural verb form for the plural noun “events”.
Context: ...284476-2442-414c-af20-01ed3ef4ca4e --- There's a lot of configurations and events that...(THERE_IS_A_LOT_OF)
[misspelling] ~27-~27: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...ed by scopes. When you create or update a M2M application, you need to review and...(EN_A_VS_AN)
🔇 Additional comments (5)
src/content/docs/developer-tools/kinde-api/troubleshoot-kinde-api.mdx (2)
1-10
: LGTM: Metadata section is well-structured.The metadata provides essential information for the documentation system, including proper sidebar ordering and related article references, which will enhance navigation and user experience.
1-33
: Excellent addition to the documentation: Well-structured and informative troubleshooting guide.This new troubleshooting guide effectively addresses the PR objectives by providing clear, step-by-step instructions for common Kinde API access issues. The document is well-structured, informative, and aligns perfectly with the goal of enhancing clarity and usability of the API documentation.
Key strengths:
- Clear organization with distinct sections for different types of issues.
- Step-by-step instructions that are easy to follow.
- Relevant cross-linking to related documentation.
The minor grammatical suggestions, if implemented, will further improve the document's quality. Overall, this addition significantly enhances the user experience for developers working with the Kinde API.
🧰 Tools
🪛 LanguageTool
[grammar] ~11-~11: Consider using the plural verb form for the plural noun “events”.
Context: ...284476-2442-414c-af20-01ed3ef4ca4e --- There's a lot of configurations and events that...(THERE_IS_A_LOT_OF)
[misspelling] ~27-~27: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...ed by scopes. When you create or update a M2M application, you need to review and...(EN_A_VS_AN)
src/content/docs/developer-tools/kinde-api/connect-to-kinde-api.mdx (1)
1-13
: LGTM: Well-structured frontmatterThe frontmatter is well-organized and contains all the necessary metadata for the page. The sidebar order of 1 suggests this is a primary or introductory page in the documentation structure, which is appropriate for a guide on connecting to the API.
src/content/docs/developer-tools/kinde-api/access-token-for-api.mdx (2)
16-16
: Great improvement to the introduction!The revised introduction is more concise and provides a clear context for the reader. The link to the connection steps is a helpful addition for users who might need to review that information.
Line range hint
1-158
: Overall, excellent improvements to the documentation!The changes in this document significantly enhance its clarity, structure, and usefulness. The new title, reorganized sections, additional screenshots, and the new "Test the various endpoints" section all contribute to a much-improved user experience for developers working with the Kinde API.
To ensure consistency across the documentation, it would be beneficial to review other related documents for similar improvements. Here's a script to help identify other API-related documentation files:
This script will help identify other files that might benefit from similar updates, ensuring a consistent documentation experience across the Kinde API docs.
## Step 2: Authorize the M2M application and select scopes | ||
|
||
We recommend adding as few scopes as you need, to maintain API security. Learn more about [scopes]( | ||
|
||
1. Select **View details** on the M2M application you just created. | ||
2. On the left, select **APIs**. | ||
3. Select the three dots next to the Kinde management API, then choose **Authorize application**. | ||
4. Select the three dots next to the Kinde management API, then choose **Manage scopes**. | ||
5. Select the scopes you want to include in the token. For maximum security only enable the minimum scopes you require. | ||
6. Select **Save**. | ||
|
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.
Incomplete link and minor improvements needed
The instructions for authorizing the M2M application and selecting scopes are clear and emphasize the importance of limiting scopes for security. However, there are a few issues to address:
- There's an incomplete link in line 27. Please complete the link to the scopes documentation.
Fix the incomplete link:
-We recommend adding as few scopes as you need, to maintain API security. Learn more about [scopes](
+We recommend adding as few scopes as you need, to maintain API security. Learn more about [scopes](/developer-tools/kinde-api/about-m2m-scopes/).
- Consider adding a comma for better readability:
-5. Select the scopes you want to include in the token. For maximum security only enable the minimum scopes you require.
+5. Select the scopes you want to include in the token. For maximum security, only enable the minimum scopes you require.
- To avoid repetitive sentence beginnings, you could rephrase step 6:
-6. Select **Save**.
+6. Finally, click the **Save** button to apply your changes.
These changes will improve the overall clarity and readability of the document.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
## Step 2: Authorize the M2M application and select scopes | |
We recommend adding as few scopes as you need, to maintain API security. Learn more about [scopes]( | |
1. Select **View details** on the M2M application you just created. | |
2. On the left, select **APIs**. | |
3. Select the three dots next to the Kinde management API, then choose **Authorize application**. | |
4. Select the three dots next to the Kinde management API, then choose **Manage scopes**. | |
5. Select the scopes you want to include in the token. For maximum security only enable the minimum scopes you require. | |
6. Select **Save**. | |
## Step 2: Authorize the M2M application and select scopes | |
We recommend adding as few scopes as you need, to maintain API security. Learn more about [scopes](/developer-tools/kinde-api/about-m2m-scopes/). | |
1. Select **View details** on the M2M application you just created. | |
2. On the left, select **APIs**. | |
3. Select the three dots next to the Kinde management API, then choose **Authorize application**. | |
4. Select the three dots next to the Kinde management API, then choose **Manage scopes**. | |
5. Select the scopes you want to include in the token. For maximum security, only enable the minimum scopes you require. | |
6. Finally, click the **Save** button to apply your changes. |
🧰 Tools
🪛 LanguageTool
[style] ~33-~33: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...API, then choose Manage scopes. 5. Select the scopes you want to include in the t...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~33-~33: Possible missing comma found.
Context: ...nt to include in the token. For maximum security only enable the minimum scopes you requ...(AI_HYDRA_LEO_MISSING_COMMA)
@@ -63,7 +63,7 @@ JavaScript, React, TypeScript, Android, iOS, React Native, Expo, Flutter, Node/A | |||
|
|||
## Machine to machine (M2M) apps | |||
|
|||
Use for connecting your systems to the Kinde Management API. You can create as many M2M apps as you require. See [Add a machine to machine application for API access](/developer-tools/kinde-api/add-a-m2m-application-for-api-access/). | |||
Use for connecting your systems to the Kinde Management API. You can create as many M2M apps as you require. See [Add a machine to machine application for API access](/developer-tools/kinde-api/get-access-token-for-connecting-securely-to-kindes-api/). |
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.
💡 Codebase verification
Invalid new link
The link /developer-tools/kinde-api/get-access-token-for-connecting-securely-to-kindes-api/
does not exist. Please verify the correct path.
🔗 Analysis chain
LGTM! Verify the new link.
The updated link provides a more descriptive path, which aligns with the PR's goal of improving clarity. This change is approved.
Please run the following script to verify the existence and correctness of the new link:
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify the existence of the new link and check its content
# Test 1: Check if the new file exists
fd -t f "get-access-token-for-connecting-securely-to-kindes-api.mdx" src/content/docs/developer-tools/kinde-api
# Test 2: Verify the content of the new file
rg -i "connect.*securely.*kinde.*api" $(fd -t f "get-access-token-for-connecting-securely-to-kindes-api.mdx" src/content/docs/developer-tools/kinde-api)
# Test 3: Check for any remaining references to the old link
rg "/developer-tools/kinde-api/add-a-m2m-application-for-api-access/"
Length of output: 5122
Deploying kinde-docs-previews with Cloudflare Pages
|
❌ Link Validation Failed
|
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.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
src/content/docs/developer-tools/kinde-api/connect-to-kinde-api.mdx (2)
27-34
: Minor improvements for clarity and readability.The instructions in this section are clear and informative. However, consider the following minor adjustments:
- Add a comma for better readability in step 5:
-5. Select the scopes you want to include in the token. For maximum security only enable the minimum scopes you require. +5. Select the scopes you want to include in the token. For maximum security, only enable the minimum scopes you require.
- To avoid repetitive sentence beginnings, you could rephrase step 6:
-6. Select **Save**. +6. Finally, click the **Save** button to apply your changes.These changes will improve the overall flow and readability of the document.
🧰 Tools
🪛 LanguageTool
[style] ~33-~33: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...API, then choose Manage scopes. 5. Select the scopes you want to include in the t...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~33-~33: Possible missing comma found.
Context: ...nt to include in the token. For maximum security only enable the minimum scopes you requ...(AI_HYDRA_LEO_MISSING_COMMA)
36-45
: LGTM: Helpful resources and video demo provided.The links to additional resources and the video demo are valuable additions to the document. To further improve user experience, consider adding a brief description of what each link contains. For example:
- [Get access token using Postman](/developer-tools/kinde-api/access-token-for-api/) - Step-by-step guide for obtaining an access token - [Test endpoints using Postman](/developer-tools/kinde-api/access-token-for-api/) - Instructions for testing API endpoints - [Call the Kinde API Node.js (example)](/developer-tools/kinde-api/api-example-node/) - Code example for integrating with Node.jsThis addition would give users a better idea of what to expect from each resource.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- src/content/docs/developer-tools/kinde-api/connect-to-kinde-api.mdx (1 hunks)
🧰 Additional context used
🪛 LanguageTool
src/content/docs/developer-tools/kinde-api/connect-to-kinde-api.mdx
[style] ~33-~33: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...API, then choose Manage scopes. 5. Select the scopes you want to include in the t...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~33-~33: Possible missing comma found.
Context: ...nt to include in the token. For maximum security only enable the minimum scopes you requ...(AI_HYDRA_LEO_MISSING_COMMA)
🔇 Additional comments (2)
src/content/docs/developer-tools/kinde-api/connect-to-kinde-api.mdx (2)
1-15
: LGTM: Frontmatter and introduction are well-structured.The frontmatter contains all necessary metadata, and the introduction clearly states the document's purpose.
17-25
: LGTM: Clear instructions for adding a machine-to-machine application.The steps are well-organized and provide all necessary information for users to add a machine-to-machine application successfully.
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.
Actionable comments posted: 2
🧹 Outside diff range and nitpick comments (14)
src/content/docs/integrate/connected-apps/patreon-connected-app.mdx (1)
15-15
: Approve link update with minor suggestion.The updated link to "/developer-tools/kinde-api/about-m2m-scopes/" aligns well with the PR objectives of improving clarity and usability. This change directs users to more relevant information about M2M scopes, which is crucial for understanding the API connection process.
To further enhance clarity, consider slightly adjusting the wording:
-Before you can add Patreon as a connected app in Kinde, you need to [set up a machine to machine application](/developer-tools/kinde-api/about-m2m-scopes/) to connect to Kinde's API. +Before you can add Patreon as a connected app in Kinde, you need to understand [M2M scopes and set up a machine-to-machine application](/developer-tools/kinde-api/about-m2m-scopes/) to connect to Kinde's API.This minor change better reflects the content of the linked page and sets clearer expectations for the user.
src/content/docs/build/applications/add-and-manage-applications.mdx (2)
23-23
: Approved: Good addition of M2M application guidance.This new recommendation for M2M applications accessing the Kinde Management API is a valuable addition. It aligns well with the PR objectives of improving clarity and usability of the documentation.
Consider adding a brief explanation of what M2M applications are, for users who might be unfamiliar with the term. For example:
-We recommend following [this specific procedure](/developer-tools/kinde-api/about-m2m-scopes/) for M2M applications that will access the Kinde Management API. +For Machine-to-Machine (M2M) applications that will access the Kinde Management API, we recommend following [this specific procedure](/developer-tools/kinde-api/about-m2m-scopes/).
Line range hint
32-36
: Enhance the "Application configuration tasks" sectionThe "Application configuration tasks" section provides a good overview of important tasks. To make it even more useful for users, consider expanding this section with brief descriptions for each task. This would give users a quick understanding of why each task is important without having to navigate to another page.
Here's a suggested expansion:
## Application configuration tasks - [Get application keys](/get-started/connect/getting-app-keys/) - Obtain the necessary credentials to connect your apps securely. - Set callback URLs using the [relevant SDK](/developer-tools/about/our-sdks/) - Configure where users are redirected after authentication. - [Set up authentication](/authenticate/authentication-methods/set-up-user-authentication/) - Choose and configure the authentication methods for your application. - [Configure tokens](/build/tokens/configure-tokens/) - Set up and customize the tokens used for user sessions and API access.src/content/docs/integrate/connected-apps/github-connected-app.mdx (1)
16-16
: Approve link update with a minor suggestion.The updated link to "/developer-tools/kinde-api/about-m2m-scopes/" aligns well with the PR objectives of improving documentation clarity and structure. This change is consistent with similar updates in other files mentioned in the AI summary.
Consider slightly adjusting the link text to better match the new destination:
-Before you can add GitHub as a connected app in Kinde, you need [set up a machine to machine application](/developer-tools/kinde-api/about-m2m-scopes/) for connecting to the Kinde API. +Before you can add GitHub as a connected app in Kinde, you need to [understand machine to machine (M2M) scopes](/developer-tools/kinde-api/about-m2m-scopes/) for connecting to the Kinde API.This adjustment would more accurately reflect the content of the linked page while maintaining the context for setting up the GitHub connected app.
src/content/docs/developer-tools/sdks/backend/dotnet-sdk.mdx (1)
31-31
: Approved: Link update enhances documentation clarity.The change from "/developer-tools/kinde-api/add-a-m2m-application-for-api-access/" to "/developer-tools/kinde-api/about-m2m-scopes/" aligns well with the PR objectives. It provides users with more relevant information about M2M scopes, which is crucial for setting up and managing applications.
Consider adding a brief explanation of why understanding M2M scopes is important before creating a machine-to-machine application. This could provide more context for users new to the concept.
src/content/docs/developer-tools/kinde-api/access-token-for-api.mdx (4)
Line range hint
2-12
: LGTM! Consider adding a description.The updates to the frontmatter accurately reflect the changes in the document's focus and structure. The addition of the related article is a good practice for maintaining continuity.
Consider adding a brief
description
field to the frontmatter to improve SEO and provide a quick summary of the page content.
Line range hint
18-103
: Excellent improvements to the Postman instructions!The reorganized steps, additional details, and new images greatly enhance the clarity and usability of this section. The recommendation for non-production testing and the link to troubleshooting solutions are valuable additions.
Consider adding alt text to the image in step 8 (line 75) to improve accessibility.
Line range hint
106-125
: Good updates to the Node.js fetch section.The changes maintain consistency with the rest of the document, and the reference to other SDK frameworks is a helpful addition.
Consider wrapping the placeholders in the code example (e.g.,
<your_domain>
,<client_id>
,<client_secret>
) with backticks for better readability. For example:fetch(`${`<your_domain>`}.kinde.com/oauth2/token`, { // ... body: new URLSearchParams({ audience: "`<auth_domain>`/api", // ... client_id: `<client_id>`, client_secret: `<client_secret>`, }), })
127-158
: Excellent addition of the testing section!This new section provides valuable guidance for users to verify their API connection. The step-by-step instructions and accompanying images make the process clear and easy to follow.
Consider adding a note about potential security implications of testing with real user data, and suggest using a test account or sanitized data if possible.
src/content/docs/developer-tools/sdks/backend/nextjs-sdkv1.mdx (3)
545-545
: LGTM! Consider adding a brief explanation for the new M2M variables.The addition of
KINDE_M2M_CLIENT_ID
andKINDE_M2M_CLIENT_SECRET
environment variables is appropriate for the new M2M functionality. However, it might be helpful to add a brief explanation about their purpose and where to obtain these values.Consider adding a note like:
"These M2M variables are required for accessing the Kinde Management API. You can obtain them by creating a Machine to Machine (M2M) application in your Kinde dashboard."
545-545
: Excellent addition! Consider emphasizing the security implications.The new section on dynamically adding callback and logout redirect URLs to Kinde is a valuable addition that aligns well with the PR objectives. The instructions are clear and comprehensive.
Consider adding a note about the security implications of using M2M applications and the importance of keeping the client secret secure. For example:
"Note: The M2M client secret is sensitive information. Ensure it's kept secure and never exposed in client-side code or public repositories."
545-545
: Well-structured script! Consider adding rate limiting.The
add-urls-to-kinde.js
script is well-implemented with proper error handling and environment checks. It effectively adds the necessary URLs to Kinde using the Management API.To improve robustness, consider implementing a simple rate limiting mechanism. This can help prevent potential issues if the script is run multiple times in quick succession. For example:
const wait = (ms) => new Promise(resolve => setTimeout(resolve, ms)); // In the main execution function if (process.env.VERCEL == 1) { try { const authToken = await getAuthToken(); await addCallbackUrlToKinde(authToken); await wait(1000); // Wait 1 second between API calls await addLogoutUrlToKinde(authToken); } catch (error) { console.error("Script failed:", error); } }src/content/docs/developer-tools/sdks/backend/typescript-sdk.mdx (2)
Line range hint
38-228
: LGTM! Comprehensive configuration and integration examples added.The expanded configuration section and the addition of integration examples for both NodeJS and Browser environments greatly improve the documentation. The new sections for login, register, and logout functionality provide clear guidance for implementing core features.
One minor suggestion:
Consider adding a note about error handling in the integration examples, especially for the
handleRedirectToApp
function, to guide users on how to handle potential authentication failures.
Line range hint
464-841
: LGTM! Comprehensive feature flags section and improved token storage guidance.The new feature flags section provides clear and detailed examples for different types of flags, which will be very helpful for developers implementing this functionality. The updated token storage section now covers both NodeJS and Browser environments, improving its usefulness.
One suggestion for improvement:
Consider adding a brief explanation of best practices for secure token storage, especially for the Browser environment, to help developers avoid common security pitfalls.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (16)
- src/content/docs/build/applications/about-applications.mdx (1 hunks)
- src/content/docs/build/applications/add-and-manage-applications.mdx (1 hunks)
- src/content/docs/developer-tools/kinde-api/access-token-for-api.mdx (5 hunks)
- src/content/docs/developer-tools/kinde-api/api-example-node.mdx (2 hunks)
- src/content/docs/developer-tools/sdks/backend/dotnet-sdk.mdx (1 hunks)
- src/content/docs/developer-tools/sdks/backend/nextjs-sdk.mdx (1 hunks)
- src/content/docs/developer-tools/sdks/backend/nextjs-sdkv1.mdx (1 hunks)
- src/content/docs/developer-tools/sdks/backend/typescript-sdk.mdx (1 hunks)
- src/content/docs/developer-tools/your-apis/custom-api-scopes.mdx (1 hunks)
- src/content/docs/get-started/guides/set-up-tasks.mdx (1 hunks)
- src/content/docs/integrate/connected-apps/add-connected-apps.mdx (1 hunks)
- src/content/docs/integrate/connected-apps/discord-connected-app.mdx (1 hunks)
- src/content/docs/integrate/connected-apps/github-connected-app.mdx (1 hunks)
- src/content/docs/integrate/connected-apps/gitlab-connected-app.mdx (1 hunks)
- src/content/docs/integrate/connected-apps/patreon-connected-app.mdx (1 hunks)
- src/content/docs/releases/feature-flags/manage-feature-flags-api.mdx (1 hunks)
✅ Files skipped from review due to trivial changes (3)
- src/content/docs/developer-tools/your-apis/custom-api-scopes.mdx
- src/content/docs/integrate/connected-apps/add-connected-apps.mdx
- src/content/docs/integrate/connected-apps/gitlab-connected-app.mdx
🚧 Files skipped from review as they are similar to previous changes (2)
- src/content/docs/build/applications/about-applications.mdx
- src/content/docs/developer-tools/kinde-api/api-example-node.mdx
🧰 Additional context used
🔇 Additional comments (12)
src/content/docs/releases/feature-flags/manage-feature-flags-api.mdx (2)
18-19
: Overall document review suggestion.The link updates in the "What you need" section align well with the PR objectives of improving documentation structure and clarity. However, given these changes are part of a larger restructuring:
- Please review the entire document to ensure all information is still accurate and up-to-date, especially regarding the API functions for feature flags.
- Check if any other sections of this document require updates to maintain consistency with the new documentation structure.
#!/bin/bash # Description: Verify the consistency of API-related content in the document # Expected result: The document should contain up-to-date information about feature flag API functions # Test: Search for mentions of API functions related to feature flags rg -i "api|feature.flags?|add.flag|edit.flag|override.flag|delete.flag" src/content/docs/releases/feature-flags/manage-feature-flags-api.mdx
18-18
: Approve link update and verify content.The updated link for setting up a machine-to-machine application aligns with the PR objectives of improving documentation clarity. The new focus on M2M scopes should provide users with more comprehensive information.
Please ensure that the new page
/developer-tools/kinde-api/about-m2m-scopes/
covers the process of setting up an M2M application, or at least links to this information.✅ Verification successful
Link update verified successfully.
The new page
/developer-tools/kinde-api/about-m2m-scopes/
exists and contains relevant information about setting up M2M applications and managing scopes.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the content of the new M2M scopes page # Expected result: The new page should exist and contain relevant information about M2M applications and scopes # Test: Check if the new file exists fd -e mdx "about-m2m-scopes" src/content/docs/developer-tools/kinde-api # Test: Search for relevant content in the new file rg -i "machine.to.machine|m2m|application setup|scopes" $(fd -e mdx "about-m2m-scopes" src/content/docs/developer-tools/kinde-api)Length of output: 1196
src/content/docs/integrate/connected-apps/discord-connected-app.mdx (3)
28-36
: Approve formatting improvementsThe removal of unnecessary blank lines between steps enhances the document's readability and consistency without affecting the content or functionality of the instructions.
16-36
: Summary: Improvements in clarity and consistencyThe changes made to this file, including the updated link and formatting improvements, enhance the overall clarity and usability of the document. These modifications align well with the PR objectives of improving the structure and accessibility of the Kinde API documentation.
16-16
: Approve link update and verify new destinationThe updated link to the M2M scopes documentation is appropriate and aligns with the PR objectives of enhancing clarity and usability.
Please run the following script to verify the existence and correctness of the new link destination:
✅ Verification successful
Link destination verified successfully
The file
about-m2m-scopes.mdx
exists and contains the expected content.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the existence of the new M2M scopes documentation file # Test: Check if the file exists fd -t f "about-m2m-scopes.mdx" src/content/docs/developer-tools/kinde-api # Test: Verify the content of the file (if it exists) fd -t f "about-m2m-scopes.mdx" src/content/docs/developer-tools/kinde-api -x head -n 5 {}Length of output: 340
src/content/docs/build/applications/add-and-manage-applications.mdx (1)
Line range hint
1-58
: Overall, good improvements to the documentThe changes made to this document, particularly the addition of specific guidance for M2M applications, align well with the PR objectives of improving clarity and usability. The document structure is clear, and the content is informative.
The suggestions provided (explaining M2M applications and expanding the configuration tasks section) should further enhance the document's usefulness for users of varying experience levels.
src/content/docs/get-started/guides/set-up-tasks.mdx (1)
50-50
: Approved: Link update aligns with PR objectivesThe change from "/developer-tools/kinde-api/add-a-m2m-application-for-api-access/" to "/developer-tools/kinde-api/about-m2m-scopes/" aligns well with the PR objectives of enhancing clarity and usability. This new link likely provides a better overview of the API connection process, which is consistent with the structural improvements mentioned in the PR summary.
Please verify that the new link is functional and provides the intended information about M2M scopes. You can use the following script to check the existence of the new page:
✅ Verification successful
Verified: The new link is functional and provides the intended information about M2M scopes
The updated link
/developer-tools/kinde-api/about-m2m-scopes/
correctly points to an existing page with relevant and comprehensive information on M2M scopes and API access.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the existence of the new M2M scopes page # Test: Check if the new M2M scopes page exists fd -t f "about-m2m-scopes.mdx" src/content/docs/developer-tools/kinde-api # If the file exists, print its content for manual verification if [ $? -eq 0 ]; then echo "File found. Content:" cat $(fd -t f "about-m2m-scopes.mdx" src/content/docs/developer-tools/kinde-api) else echo "File not found. Please ensure the new page has been created." fiLength of output: 1702
src/content/docs/developer-tools/kinde-api/access-token-for-api.mdx (1)
16-16
: Great improvement to the introduction!The revised introduction provides a clear context and sets the stage for the content that follows. The reference to the previous step helps users understand where they are in the process.
src/content/docs/developer-tools/sdks/backend/typescript-sdk.mdx (4)
Line range hint
1-37
: LGTM! Improved introduction and installation instructions.The updates to the introduction provide more specific information about the supported OAuth2.0 flows, which is helpful for users. The addition of the package manager directive in the installation section makes it easier for developers to install the SDK.
Line range hint
229-463
: LGTM! Comprehensive coverage of user profiles, permissions, and organizations.The new sections on viewing user profiles, managing permissions, and handling organizations greatly enhance the documentation. The examples provided for creating organizations, logging in/registering to organizations, and checking user permissions are clear and informative. These additions will help developers effectively implement these features in their applications.
Line range hint
842-1301
: LGTM! Improved Kinde Management API section and comprehensive SDK API reference.The updates to the Kinde Management API section, including new instructions for obtaining an access token, are valuable improvements. The expanded SDK API reference with detailed descriptions of methods for both NodeJS and Browser environments is particularly noteworthy. This separation makes it easier for developers to find the relevant information for their specific environment.
Highlight:
The addition of sample outputs for many of the API methods (e.g.,
getPermission
,getUserProfile
) is especially helpful, as it gives developers a clear understanding of what to expect when using these methods.
Line range hint
1-1301
: Excellent improvements to the TypeScript SDK documentation!The changes made to this documentation file are substantial and greatly enhance its usefulness for developers. Key improvements include:
- More detailed introduction and installation instructions.
- Comprehensive configuration and integration examples for both NodeJS and Browser environments.
- New sections covering important features such as user profiles, permissions, organizations, and feature flags.
- Updated and expanded SDK API reference with clear method descriptions and sample outputs.
- Improved guidance on using the Kinde Management API.
These enhancements will significantly aid developers in implementing and utilizing the Kinde TypeScript SDK in their applications.
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.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
- astro.config.mjs (3 hunks)
- src/content/docs/developer-tools/sdks/backend/nextjs-sdk.mdx (1 hunks)
🧰 Additional context used
🔇 Additional comments (3)
astro.config.mjs (2)
68-68
: Formatting improvements enhance readability.The changes to the
github
URL andeditLink
baseUrl
improve code consistency without altering functionality.Also applies to: 107-108
46-52
: LGTM! New redirects align with documentation restructure.The added redirects are consistent with the PR objectives of improving the documentation structure. They should help maintain link integrity after the changes.
To ensure all necessary redirects are in place, please run the following script:
✅ Verification successful
Redirects successfully verified.
All old URLs have corresponding redirects in
astro.config.mjs
, and there are no remaining references elsewhere in the codebase.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify that all old URLs are properly redirected # Test: Check if all old URLs have corresponding redirects old_urls=( "/developer-tools/kinde-api/add-a-m2m-application-for-api-access/" "/developer-tools/kinde-api/get-access-token-for-connecting-securely-to-kindes-api/" "/developer-tools/kinde-api/test-the-connection-to-kindes-api/" ) for url in "${old_urls[@]}"; do if ! rg -q "$url" astro.config.mjs; then echo "Warning: No redirect found for $url" fi done # Test: Check if there are any remaining references to old URLs in other files rg -l "/developer-tools/kinde-api/(add-a-m2m-application-for-api-access|get-access-token-for-connecting-securely-to-kindes-api|test-the-connection-to-kindes-api)"Length of output: 785
src/content/docs/developer-tools/sdks/backend/nextjs-sdk.mdx (1)
Line range hint
1-1559
: Documentation updates look good overall.The changes to the documentation provide comprehensive information about the Next.js App Router SDK integration with Kinde Auth. The explanations are clear, and the code examples appear to be correct and helpful.
@@ -0,0 +1,51 @@ | |||
--- |
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.
@clairekinde11 should we make the new slug more reflective of the content something like set-up-kinde-api-access
?
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.
Will consider this in separate PR.
curl --request POST \ | ||
--url 'https://<your_subdomain>.kinde.com/oauth2/token' \ | ||
--header 'content-type: application/x-www-form-urlencoded' \ | ||
--data grant_type=client_credentials \ | ||
--data 'client_id=<your_m2m_client_id>' \ | ||
--data 'client_secret=<your_m2m_client_secret> \ | ||
--data 'audience=https://<your_subdomain>}.kinde.com/api' |
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.
@clairekinde11 this is valid
@@ -0,0 +1,241 @@ | |||
--- |
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.
@clairekinde11 do we update the slug to reflect the title?
s: applications | ||
--- | ||
|
||
Here's the process for setting up your access to the Kinde Management API. |
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.
In order to call the Kinde management API you will need a Kinde management API access token.
These tokens are generated by using an authorized M2M application to call the Kinde token endpoint.
This guide shows you how to set up a new M2M application that is authorized for Kinde management API access.
Step 1: Add a machine to machine application
- Go to Settings > Applications.
- Select Add Application.
- In the dialog that opens, give the application a name, and select Machine to Machine as the Application type.
- Select Save. App keys - including Domain details, Client ID and Client Secret - are issued for the application.
- Copy the app keys. You need these details to test or initiate access requests from your application or service to Kinde's API. See Step 3 below.
Step 2: Authorize the M2M application
Only authorized M2M applications are allowed to access the Kinde management API. Without this step you will receive an error when calling the Kinde management API.
- Select View details on the M2M application you just created.
- On the left, select APIs.
- Select the three dots next to the Kinde management API, then choose Authorize application.
Step 3: Select scopes
Each Kinde endpoint requires a specific permission to be present in the token to grant access to it. These are known as scopes. If a scope is not present in the access token the API will return an error indicating which scope is required.
To add scopes:
- Select the three dots next to the Kinde management API, then choose Manage scopes.
- Select the scopes you want to include in the token. For maximum security only enable the minimum scopes you require.
- Select Save.
Step 4: Get an access token and call the management API
Follow this guide for accessing Kinde Mangement API token. The guide includes steps for how to obtain and use a token.
To ask Kinde for an access token for calling the management API, perform a POST request to the `https://<your_subdomain>.kinde.com/oauth2/token` endpoint, using the credentials of the M2M application you created in the prerequisite step. | ||
|
||
The payload should look as follows: | ||
|
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.
I'll add a code switcher here
…o Fix/Update-accessing-Kinde-API-topics
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.
Actionable comments posted: 3
🧹 Outside diff range and nitpick comments (1)
src/content/docs/developer-tools/kinde-api/access-token-for-api.mdx (1)
295-295
: Add missing comma after "For example".A comma is typically required after the phrase "For example".
Apply this diff:
- To use this token, include it in the Authorization header of your request. For example to get all users you would call: + To use this token, include it in the Authorization header of your request. For example, to get all users you would call:🧰 Tools
🪛 LanguageTool
[typographical] ~295-~295: After the expression ‘for example’ a comma is usually used.
Context: ...thorization header of your request. For example to get all users you would call: <Tabs...(COMMA_FOR_EXAMPLE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- src/content/docs/developer-tools/kinde-api/access-token-for-api.mdx (1 hunks)
🧰 Additional context used
🪛 LanguageTool
src/content/docs/developer-tools/kinde-api/access-token-for-api.mdx
[typographical] ~295-~295: After the expression ‘for example’ a comma is usually used.
Context: ...thorization header of your request. For example to get all users you would call: <Tabs...(COMMA_FOR_EXAMPLE)
[style] ~616-~616: Consider a more expressive alternative.
Context: ...ence** to{{business_domain}}/api
. To do this: - Scroll down click **Advanced...(DO_ACHIEVE)
[uncategorized] ~617-~617: Possible missing comma found.
Context: ..._domain}}/api`. To do this: - Scroll down click Advanced. In the **Token requ...(AI_HYDRA_LEO_MISSING_COMMA)
🔇 Additional comments (1)
src/content/docs/developer-tools/kinde-api/access-token-for-api.mdx (1)
1-26
: LGTM! Clear and well-structured introduction.The frontmatter is properly configured with related articles, and the introduction provides clear prerequisites.
src/content/docs/developer-tools/kinde-api/access-token-for-api.mdx
Outdated
Show resolved
Hide resolved
```jsx | ||
fetch(`${<your_domain>}.kinde.com/oauth2/token`, { | ||
method: "POST", | ||
headers: { | ||
"content-type": "application/x-www-form-urlencoded", | ||
}, | ||
body: new URLSearchParams({ | ||
audience: "<auth_domain>/api", | ||
grant_type: "client_credentials", | ||
client_id: <client_id>, | ||
client_secret: <client_secret>, | ||
}), | ||
}) | ||
``` |
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.
Fix Node.js fetch example syntax and formatting.
The example contains several issues:
- Incorrect template literal syntax
- Inconsistent variable naming
- Incorrect audience URL format
Apply this diff:
- fetch(`${<your_domain>}.kinde.com/oauth2/token`, {
- method: "POST",
- headers: {
- "content-type": "application/x-www-form-urlencoded",
- },
- body: new URLSearchParams({
- audience: "<auth_domain>/api",
- grant_type: "client_credentials",
- client_id: <client_id>,
- client_secret: <client_secret>,
- }),
- })
+ fetch(`https://<your_subdomain>.kinde.com/oauth2/token`, {
+ method: "POST",
+ headers: {
+ "content-type": "application/x-www-form-urlencoded",
+ },
+ body: new URLSearchParams({
+ audience: "https://<your_subdomain>.kinde.com/api",
+ grant_type: "client_credentials",
+ client_id: "<your_m2m_client_id>",
+ client_secret: "<your_m2m_client_secret>"
+ })
+ })
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
```jsx | |
fetch(`${<your_domain>}.kinde.com/oauth2/token`, { | |
method: "POST", | |
headers: { | |
"content-type": "application/x-www-form-urlencoded", | |
}, | |
body: new URLSearchParams({ | |
audience: "<auth_domain>/api", | |
grant_type: "client_credentials", | |
client_id: <client_id>, | |
client_secret: <client_secret>, | |
}), | |
}) | |
``` | |
```jsx | |
fetch(`https://<your_subdomain>.kinde.com/oauth2/token`, { | |
method: "POST", | |
headers: { | |
"content-type": "application/x-www-form-urlencoded", | |
}, | |
body: new URLSearchParams({ | |
audience: "https://<your_subdomain>.kinde.com/api", | |
grant_type: "client_credentials", | |
client_id: "<your_m2m_client_id>", | |
client_secret: "<your_m2m_client_secret>" | |
}) | |
}) | |
``` |
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.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- src/content/docs/developer-tools/kinde-api/access-token-for-api.mdx (1 hunks)
🧰 Additional context used
🪛 LanguageTool
src/content/docs/developer-tools/kinde-api/access-token-for-api.mdx
[typographical] ~310-~310: After the expression ‘for example’ a comma is usually used.
Context: ...thorization header of your request. For example to get all users you would call: <Tabs...(COMMA_FOR_EXAMPLE)
[uncategorized] ~556-~556: Possible missing comma found.
Context: ...tically obtain tokens for, and interact with the Kinde management API. ## Test the ...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~562-~562: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...Here’s an example in Postman, using theusers listing
endpoint. 1. Create a new GET...(AI_HYDRA_LEO_APOSTROPHE_S_XS)
[style] ~637-~637: Consider a more expressive alternative.
Context: ...ence** to{{business_domain}}/api
. To do this: - Scroll down click **Advanced...(DO_ACHIEVE)
[uncategorized] ~638-~638: Possible missing comma found.
Context: ..._domain}}/api`. To do this: - Scroll down click Advanced. In the **Token requ...(AI_HYDRA_LEO_MISSING_COMMA)
🔇 Additional comments (4)
src/content/docs/developer-tools/kinde-api/access-token-for-api.mdx (4)
1-26
: LGTM! Clear and well-structured introduction.The frontmatter and introduction provide a clear path for users to follow, with appropriate cross-references and prerequisites.
597-597
:⚠️ Potential issueFix incomplete bracket reference.
The text contains an incomplete bracket reference.
Apply this fix:
- Add your Kinde machine to machine [application keys] as environment variables. + Add your Kinde machine-to-machine application keys as environment variables.Likely invalid or redundant comment.
484-484
:⚠️ Potential issueFix incorrect URL format in Python example.
The URL format is inconsistent with other examples and uses an incorrect endpoint path.
Apply this fix:
- conn.request("GET", "/{yourDomain}/api/v2/clients", headers=headers) + conn.request("GET", "https://<your_subdomain>.kinde.com/api/v1/users", headers=headers)Likely invalid or redundant comment.
683-696
:⚠️ Potential issueStandardize Node.js example format and placeholders.
The example uses inconsistent formatting and placeholder naming.
Apply this fix:
- fetch(`${<your_domain>}.kinde.com/oauth2/token`, { - method: "POST", - headers: { - "content-type": "application/x-www-form-urlencoded", - }, - body: new URLSearchParams({ - audience: "<auth_domain>/api", - grant_type: "client_credentials", - client_id: <client_id>, - client_secret: <client_secret>, - }), - }) + fetch(`https://<your_subdomain>.kinde.com/oauth2/token`, { + method: "POST", + headers: { + "content-type": "application/x-www-form-urlencoded" + }, + body: new URLSearchParams({ + audience: "https://<your_subdomain>.kinde.com/api", + grant_type: "client_credentials", + client_id: "<your_m2m_client_id>", + client_secret: "<your_m2m_client_secret>" + }) + })Likely invalid or redundant comment.
src/content/docs/developer-tools/kinde-api/access-token-for-api.mdx
Outdated
Show resolved
Hide resolved
@@ -12,7 +12,7 @@ app_context: | |||
|
|||
You can connect Patreon to your Kinde account so you can manage Patreon members and campaigns. | |||
|
|||
Before you can add Patreon as a connected app in Kinde, you need to [set up a machine to machine application](/developer-tools/kinde-api/add-a-m2m-application-for-api-access/) to connect to Kinde’s API. | |||
Before you can add Patreon as a connected app in Kinde, you need to [set up a machine to machine application](/developer-tools/kinde-api/about-m2m-scopes/) to connect to Kinde’s API. |
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.
@clairekinde11 the links in about 20 of these files seem to have been updated to point at /about-m2m-scopes/
which doesn't seem right. I assume we want them to point at the doc about application setup?
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.
Fixed
@DaveOrDead please merge |
@clairekinde11 there is still some outstanding feedback that needs addressing before we can merge - will reach out to discuss |
All discussed updates have been made. |
A major structural overhaul of the connect to API docs, which were reported as being a bit confusing.
Includes:
May need a link update in a separate PR.
Summary by CodeRabbit
Release Notes
New Features
Updates
Bug Fixes