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 |
It includes functionality to retrieve the currently logged-in operator's details, update operator profile information, and change the operator's password. These APIs are essential for maintaining and managing user session integrity and personal settings.
Get Operator
Business applications can use this service API to retrieve the logged-in operator. An administrator with access control management permissions in their role can also retrieve the logged-in operator.
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
- 400
- 401
- 403
- 500
{- "id": 0,
- "name": "string",
- "email": "string",
- "status": 0,
- "mobile_number": "string",
- "picture": "string",
- "is_password_generated": true,
- "role": {
- "id": 0,
- "name": "string",
- "description": "string",
- "status": 0,
- "details": [
- {
- "add_update": true,
- "attribute_name": "string",
- "delete": true,
- "read": true
}
]
}
}Update Operator
Business applications can use this service API to update the logged-in operator. For admin, there is no need of any role permission to update the operator.
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:
| name required | string non-empty The name of the operator. |
| picture | string or null The picture of the operator. |
| mobile_number | string or null The mobile number of the operator. |
Responses
Request samples
- Payload
{- "name": "string",
- "picture": "string",
- "mobile_number": "string"
}Response samples
- 400
- 401
- 403
- 500
{- "message": "string"
}Change Password
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:
| old_password required | string non-empty old password |
| new_password required | string non-empty new password |
Responses
Request samples
- Payload
{- "old_password": "string",
- "new_password": "string"
}Response samples
- 401
- 403
- 500
{- "message": "string"
}Get Providers
Business applications can use this service API to get providers. For admin, there is no need for any permission to get providers.
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
- 500
[- {
- "id": 0,
- "attribute_name": "string",
- "for_adss": 0,
- "attribute_key": "string",
- "status": true,
- "purposes": [
- "string"
], - "connection_provider_parameter": [
- {
- "id": 0,
- "connection_provider_id": 0,
- "attribute_key": "string",
- "attribute_value": "string",
- "field_type": "string",
- "sort_order": 0,
- "type": 0,
- "attribute_choices": [
- {
- "Key": "string",
- "Value": "string"
}
]
}
], - "connection_provider_detail": [
- {
- "id": 0,
- "connection_provider_id": 0,
- "purpose": "string",
- "type": "string",
- "identifier": "string"
}
]
}
]Get CSP Header
Business applications can use this service API to get admin csp header. For admin, there is no need for get admin csp header.
header Parameters
| 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
- 500
"string"