3. oAuth2 Scopes - signeasy/API GitHub Wiki

OAuth2 Scopes

OAuth2 specifications provide scoping of the authorization grant assigned to a client application. Each scope covers a set of URIs (endpoints) and an authorization token created using a scope can only be used to access the said URIs (endpoints).

Scopes defined by this implementation of OAuth2 provider are:

A registered client application can request for any of the scopes mentioned. Grant request page presented to the user will list each of the scope with the description of the scope being requested by the client application.

user:read

GET /user
GET /user/

rs:read

GET /files/pending
GET /files/pending/<id>
GET /files/pending/<:id>/download/
GET /files/pending/<:id>/status

rs:create

POST /files/pending
POST /files/pending/template
POST /files/pending/fields

rs:update

POST /files/pending/<:id>/decline
POST /files/pending/<:id>/cancel
POST /files/pending/<:id>/remind

rs:signingurl

POST /files/pending/<pending_file_id>/signing/url

original:read

GET /files/original
GET /files/original/<id>
GET /files/original/<id>/download

original:create

POST /files/original

original:update

PUT /files/original/<id>
DELETE /files/original/<id>
POST /files/original/<id>/delete

signed:create

GET /files/signed/
GET /signing/url/

signed:read

GET /files/signed
GET /files/signed/<id>
GET /files/signed/<id>/download

signed:update

PUT /files/signed/<id>
DELETE /files/signed/<id>
POST /files/signed/<id>/delete

files:read

GET /files/

template:manage

GET /library/template/
GET /library/template/<int:id>/

webhooks:manage

GET /callback/urls/
POST /callback/urls/
DELETE /callback/urls/
⚠️ **GitHub.com Fallback** ⚠️