• Scopes Resource
  • Endpoint
    • Parameters
  • Response
    • Status Codes (HTTP)

#Scopes Resource

In OAuth2 terms, scopes are a set of permissions which require user consent.

You've probably seen logins like Google that warn you about the data the third-party application is requesting and give you the option to accept or refuse the request.

#Endpoint

Consider the following specs in designing your scopes endpoint:

#Parameters

#Response

#Status Codes (HTTP)

The response should be a json array containing a list of scopes with the following structure:

[
    {
        "id": "*",
        "title": "Read and Write all data.",
        "icon": "fa-user-shield",
        "description": null,
        "url": null
    },
    {
        "id": "profile",
        "title": "Access to information like name, birthday and gender.",
        "icon": "fa-user-shield",
        "description": null,
        "url": null
    },
    ...
]