Get Authorization Server Scopes
Get a list of scopes available on the Authorization Server.
Resource URL
https://<api-domain>/api/2/api_authorizations/:id/scopes
Header Parameters
Authorization required string | Set to Set The access token must have been generated using an API credential pair created using the scope required to call this API. This API can be called using any one of the following scopes: |
Resource Parameters
id required integer | The id of the authorization server. |
Sample Responses
- 200 OK
- 401 Unauthorized
- 404 Not Found
[
{
"id": 25,
"value": "read:contacts",
"description": "Read some contacts"
},
...
]
Typically, this error means that your access token value is invalid.
{
"message": "Unauthorized",
"statusCode": 401,
"name": "UnauthorizedError"
}
Invalid API Authorization Server ID
{
"message": "The resource with the given id could not be found",
"statusCode": 404,
"name": "NotFoundError"
}
Postman Collection
Replace sample variables indicated by {{ }}
with your actual values.
Download for API Authorization Management
Sample Code
cURL
Replace sample values indicated by < >
with your actual values.
List Scopes
curl 'https://<api-domain>/api/2/api_authorizations/:id/scopes' \
-X GET \
-H "Authorization: bearer <access_token>"
Have a Question?

Found a bug? Submit a support ticket.

Have a product idea or request? Share it with us in our Ideas Portal.