aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMinteck <contact@minteck.org>2022-04-06 21:52:16 +0200
committerMinteck <contact@minteck.org>2022-04-06 21:52:16 +0200
commit9989797ecd50074ea8006613ce4b03e3b38f0e89 (patch)
tree9539df25f47f4da122b1bfcbbd3e0a2ab1a125dd /README.md
parent01632caf82659e4e8025b4fad91ff7388b369770 (diff)
downloadcloudsdale-9989797ecd50074ea8006613ce4b03e3b38f0e89.tar.gz
cloudsdale-9989797ecd50074ea8006613ce4b03e3b38f0e89.tar.bz2
cloudsdale-9989797ecd50074ea8006613ce4b03e3b38f0e89.zip
Admin panel done
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 2 insertions, 7 deletions
diff --git a/README.md b/README.md
index aa224fb..540d6ea 100644
--- a/README.md
+++ b/README.md
@@ -9,15 +9,10 @@ As per Cloudburst's requirements, this project features a REST-ful API that allo
### Endpoints
The following endpoints are available on the API:
-* Publicly accessible endpoints:
* `pluralkit` (PluralKit data, read-only)
* `projects` (projects list, read-only)
-* Endpoints that require admin authentication:
- * `users` (add/remove administrators)
- * `project-manager` (projects list, read-write)
- * `pluralkit-config` (PluralKit data, read-write)
+ * `contact` (contact info)
(visit `/api` on the live website for all available endpoints)
-### Authentication
-Authentication is made using the `pcdAdminToken` cookie, which is set when OAuth2 with GitHub is completed and the website confirmed the user is an allowed administrator. \ No newline at end of file
+Admin panel data is not accessible from the API for security reasons (the real reason is laziness). If you really need access to the data, you may parse it manually from the HTML code. \ No newline at end of file