Add autorize api usage toturial#121
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a new Client SDK tutorial that teaches how to drive the Caido Autorize community plugin from an external Node/TypeScript script, and exposes it in the Tutorials sidebar (closing #116).
Changes:
- Introduces a step-by-step tutorial for installing/configuring Autorize, creating a template, waiting for results, and interpreting authorization outcomes.
- Adds the new tutorial page to the VitePress Tutorials sidebar under “Client SDK”.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
src/tutorials/client/autorize.md |
New tutorial page covering end-to-end Autorize API usage via the Client SDK, including a full runnable script. |
.vitepress/sidebars/tutorials.ts |
Adds “Using the Autorize API” to the Tutorials sidebar navigation. |
Comments suppressed due to low confidence (2)
src/tutorials/client/autorize.md:345
- Cleanup deletes the template and updates config without checking their
APIResultenvelopes. If either operation fails, the script will silently continue and may leave templates/user profiles behind. Handle{ kind: "Error" }here (and consider putting cleanup in afinallyblock in the full script).
// 8. Cleanup
await pkg.deleteTemplate(templateId);
await pkg.updateConfig({ userProfiles: [] });
}
src/tutorials/client/autorize.md:320
- Same issue as earlier:
expectedResultsusescfg.value.userProfiles.lengthrather than counting only enabled profiles. If disabled profiles exist, the combined script can hang in the results polling loop. Base the expected count on enabled profiles.
// 6. Wait for all results
let template = created.value;
const expectedResults = 1 + cfg.value.userProfiles.length + (cfg.value.testNoAuth ? 1 : 0);
while (template.results.length < expectedResults) {
await new Promise((resolve) => setTimeout(resolve, 1500));
Corb3nik
approved these changes
May 21, 2026
Member
Corb3nik
left a comment
There was a problem hiding this comment.
Another great tutorial. 🙇♂️
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This closes #116