Add Client App
Grant access to an OpenId Connect app to generate Access Tokens via the Authorization Server.
Resource URL
https://<api-domain>/api/2/api_authorizations/:id/clients
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
app_id required integer |
The ID of the OpenId Connect app to allow access through. |
scopes required array |
An array of Scope IDs that represent the scopes the app can request |
Request Body
{
"app_id": 1026152,
"scopes": [123]
}
Sample Responses
- 201 Created
- 401 Unauthorized
- 404 Not Found
- 422 Unprocessable Entity
{
"app_id": 909021,
"api_auth_id": 1022697
}
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"
}
An invalid scope id has been provided
{
"message": "Validation failed: Scopes 51 does not belong to the specified ApiAuthorizationApp",
"statusCode": 422,
"name": "UnprocessableEntityError"
}
Response Elements
id |
Unique ID for the Client App |
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 Client App
curl 'https://<api-domain>/api/2/api_authorizations/:id/clients' \
-X POST \
-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.