Add an Authorization Server Scope
Add a scope to 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: |
Content-Type required string |
Set to application/json . |
Resource Parameters
id required integer | The id of the authorization server. |
Request Parameters
value required string |
A value representing the api scope that with be authorized |
description required string |
A description of what access the scope enables |
Request Body
{
"value": "custom:scope",
"description": "A custom scope"
}
Sample Responses
- 200 OK
- 401 Unauthorized
- 404 Not Found
- 422 Unprocessable Entity
{
"id": 323005
}
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"
}
The scope already exists
{
"message": "Validation failed: Value has already been taken",
"statusCode": 422,
"name": "UnprocessableEntityError"
}
Response Elements
id |
Unique ID for the Scope |
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.
Add a Scope
curl 'https://<api-domain>/api/2/scopes' \
-X POST \
-H "Authorization: bearer <access_token>" \ -d '{
"value": "custom:scope",
"description": "A custom scope"
}'
Have a Question?

Found a bug? Submit a support ticket.

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