diff options
| author | rubenwardy <rw@rubenwardy.com> | 2020-05-19 17:24:57 +0100 |
|---|---|---|
| committer | rubenwardy <rw@rubenwardy.com> | 2020-05-19 17:24:57 +0100 |
| commit | a36e233051b35d3ca44b5bd38f8f6262c16c1833 (patch) | |
| tree | 036363e023375185581d0ac50a84eab33c55c199 /app/flatpages/help/api.md | |
| parent | 8484c0f0aa8bcb02a234c816a75a423737b0297c (diff) | |
| download | cheatdb-a36e233051b35d3ca44b5bd38f8f6262c16c1833.tar.xz | |
Fix API auth crash and add more error messagesv1.25.1
Diffstat (limited to 'app/flatpages/help/api.md')
| -rw-r--r-- | app/flatpages/help/api.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/app/flatpages/help/api.md b/app/flatpages/help/api.md index 8387caa..2b7bacd 100644 --- a/app/flatpages/help/api.md +++ b/app/flatpages/help/api.md @@ -9,6 +9,8 @@ Authentication is done using Bearer tokens: You can use the `/api/whoami` to check authentication. +Tokens can be attained by visiting "API Tokens" on your profile page. + ## Endpoints ### Misc @@ -16,7 +18,7 @@ You can use the `/api/whoami` to check authentication. * GET `/api/whoami/` - Json dictionary with the following keys: * `is_authenticated` - True on successful API authentication * `username` - Username of the user authenticated as, null otherwise. - * 403 will be thrown on unsupported authentication type, invalid access token, or other errors. + * 4xx status codes will be thrown on unsupported authentication type, invalid access token, or other errors. ### Packages |