SigningHub Admin API Guide
Download OpenAPI specification:Download
Browse through the API content by selecting the relevant pages from the left panel. To quickly find specific web service information, enter search criteria in the search box on top left.
More about SigningHub
To know more about SigningHub, explore the following links:
- Go to SigningHub Knowledge Base to view all the relevant information of SigningHub.
-
Visit the Ascertia Community Portal to find answers to contact SigningHub support staff through the
Live Chat provision
.
Our
support staff may be occupied with other priority tasks so live chat is offered on
an "as available" basis.
This guide is intended for developers who will integrate SigningHub into their respective web applications using the RESTful web services, and user interface offered by SigningHub. It is assumed that the reader has a basic knowledge of REST, Java, C#, HTML, JavaScript, HTTP and TLS/SSL. There is no Software Developers Kit (SDK) for the integration, instead the integration uses HTML Forms and JSON so that integration is simple from any language including .Net, Java, PHP etc.
| Main Tags | Most Popular Pages |
|---|---|
|
➤
Welcome
➤ Prerequisites ➤ Access Token ➤ Updates ➤ APIs Developer Guide ➤ Appendix |
➤
Authentication
➤ Service Plans ➤ Account Management ➤ Billing Management ➤ Access Control ➤ Operator Logs ➤ Advanced Reports |
Designed and developed a comprehensive System Settings module to centrally manage global application configurations, feature toggles, and administrative controls.
Get System Settings
Business applications can use this service API to get system settings. An admin who has permission to manage global settings in his role can read system settings.
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Responses
Response samples
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "attribute_choices": [
- {
- "key": "string",
- "value": "string"
}
], - "default_value": "string",
- "validation_rule": {
- "required": true,
- "min_length": 0,
- "max_length": 0,
- "min": 0,
- "max": 0
}, - "attribute_name": "string",
- "attribute_value": "string",
- "field_type": "string",
- "group_name": "string",
- "sort_order": 0
}
]Update System Settings
Business applications can use this service API to update global settings for users. An administrator with the appropriate role permissions to manage Global Settings can update these settings.
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Request Body schema:
| setting_section required | string non-empty The section where settings need to be updated. |
Array of objects or null (Models.SystemSettingsRequest) system_settings |
Responses
Request samples
- Payload
{- "setting_section": "string",
- "system_settings": [
- {
- "attribute_name": "string",
- "attribute_value": "string"
}
]
}Response samples
- 400
- 401
- 403
- 500
{- "message": "string"
}Reset to Default
Business applications can use this service API to reset system settings to default. An admin who has permission to manage global settings in his role can reset system settings.
path Parameters
| section required | string Allowed Value: |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Responses
Response samples
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "attribute_choices": [
- {
- "key": "string",
- "value": "string"
}
], - "default_value": "string",
- "validation_rule": {
- "required": true,
- "min_length": 0,
- "max_length": 0,
- "min": 0,
- "max": 0
}, - "attribute_name": "string",
- "attribute_value": "string",
- "field_type": "string",
- "group_name": "string",
- "sort_order": 0
}
]