about summary refs log tree commit diff
path: root/docs/Using-the-API/OAuth-details.md
diff options
context:
space:
mode:
authorAnthony Bellew <anthonyreflected@gmail.com>2017-01-25 20:53:57 -0700
committerGitHub <noreply@github.com>2017-01-25 20:53:57 -0700
commit3d890c407356c8e0e7dd9b64e8e232ededcff8e8 (patch)
treea22df9a8737250f97a6024943af3445a163917b3 /docs/Using-the-API/OAuth-details.md
parentfebe2449bb14f3d877fb934ceb6d52e320712bac (diff)
parent905c82917959a5afe24cb85c62c0b0ba13f0da8b (diff)
Merge pull request #3 from tootsuite/master
Updating to current
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).