Skip to content

docs: Body Auth #173

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.

Sign up for GitHub

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

Merged
CodeShellDev merged 2 commits into from
Jan 8, 2026
Merged

docs: Body Auth #173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c0cb3e7
add body auth
CodeShellDev Jan 2, 2026
c9f26cb
Merge branch 'docs' into feat/docs/body-auth
CodeShellDev Jan 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/usage/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ This will send `Hello, World!` to `<to>` from `<from>`.
| :---------- | :--------------------------------------------------------- |
| Bearer Auth | Add `Authorization: Bearer API_TOKEN` to headers |
| Basic Auth | Add `Authorization: Basic BASE64_STRING` (`api:API_TOKEN`) |
| Query Auth | Append `@auth=API_TOKEN` to request URL |
| Query Auth | Append `@authorization=API_TOKEN` to request URL |
| Body Auth | Set `auth` to `API_TOKEN` in the request body |

Example:

Expand Down
5 changes: 3 additions & 2 deletions src/components/HomepageFeatures/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,9 @@ const FeatureList = [
<>
The main focus of Secured Signal API is to provide a secure layer for
signal-cli-rest-api, supporting <a href="docs/usage#auth">Bearer</a>,{" "}
<a href="docs/usage#auth">Basic</a>, and{" "}
<a href="docs/usage#auth">Query Auth</a>.
<a href="docs/usage#auth">Basic</a>,{" "}
<a href="docs/usage#auth">Query Auth</a> and{" "}
<a href="docs/usage#auth">more</a>.
</>
),
},
Expand Down