docs: fix incorrect SAT quick-start example in README#42
Open
dmchaledev wants to merge 1 commit into
Open
Conversation
The SAT enrollment example posted to a fictitious /sat/v1/users path with a group_id field that doesn't exist on any schema. The real endpoint (POST /api/groups/) creates a target group with a targets array, per sat/openapi.yaml, and is what "enroll a user" maps to; POST /users/ is an unrelated admin-only system-user endpoint.
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.
Summary
The SAT "Enroll a User" quick-start example in
README.mdwas factually wrong in three compounding ways, cross-checked againstsat/openapi.yaml:https://api.hailbytes.com/sat/v1/users, but the SAT spec'sservers:block (sat/openapi.yaml:31-33) defines the server as/api, not/sat/v1.POST /users/(sat/openapi.yaml:1195-1204) is taggedAdminand described as "Creates a new system user. Requiresmodify_systempermission" — it has nothing to do with enrolling a phishing-simulation target, and has no request body defined at all.group_id, which doesn't appear on any schema in the spec.The endpoint that actually matches "enroll a user" is
POST /groups/(createGroup,sat/openapi.yaml:899-917), which creates a target group from aGroupschema containing atargetsarray of{email, first_name, last_name, ...}objects.This fixes the example to hit the real endpoint with a request body that matches the
Group/Targetschemas.Test plan
POST /api/groups/exists insat/openapi.yamland accepts aGroupbody with atargetsarray🤖 Generated with Claude Code
https://claude.ai/code/session_015e1CxUMwdy8rLKYgMuDZEL
Generated by Claude Code