about summary refs log tree commit diff
path: root/docs/Using-the-API/OAuth-details.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/Using-the-API/OAuth-details.md')
-rw-r--r--docs/Using-the-API/OAuth-details.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/Using-the-API/OAuth-details.md b/docs/Using-the-API/OAuth-details.md
new file mode 100644
index 000000000..d0b5abd40
--- /dev/null
+++ b/docs/Using-the-API/OAuth-details.md
@@ -0,0 +1,12 @@
+OAuth details
+=============
+
+We use the [Doorkeeper gem for OAuth](https://github.com/doorkeeper-gem/doorkeeper/wiki), so you can refer to their docs on specifics of the end-points.
+
+The API is divided up into access scopes:
+
+- `read`: Read data
+- `write`: Post statuses and upload media for statuses
+- `follow`: Follow, unfollow, block, unblock
+
+Multiple scopes can be requested during the authorization phase with the `scope` query param (space-separate the scopes).