Documentation Powered by Redocly

SigningHub Admin API Guide

Download OpenAPI specification:Download

Welcome

Welcome to SigningHub, a high trust digital signing solution for all your paperless business transactions. It is ideal for those organisations that recognise the value of using cryptographic digital signatures to protect their users and their documents against unauthorised or accidental or fraudulent changes.
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. 
Intended Readership
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

Operator Logs

The Log Module records each operator action with timestamps and detailed information, ensuring a comprehensive and effective audit trail.

Get Admin Activities

Business applications can use this service API to get an administrator logs.

path Parameters
page
required
integer <int32>

Page number to be retrieved.

records
required
integer <int32>

Total number of records to be retrieved in a page.

query Parameters
asc
boolean
Default: false

Order the result set by ascending or descending

sort-by
string
Default: "created_on"

Sort the result by created_on

header Parameters
x-search-text
string
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)

x-total-records
string
Default: 212

The total number of records found with the provided search criteria.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Operator Logs

Business applications can use this service API to get an operator logs.

path Parameters
page
required
integer <int32>

Page number to be retrieved.

records
required
integer <int32>

Total number of records to be retrieved in a page.

query Parameters
name
string

The name of the administrator who performed the activity.

email
string

The email of the administrator who performed the activity.

module
string

The module in which the action was performed , and possible values are ADMIN_ACTIVITY_MODULE_ACCOUNTS, ADMIN_ACTIVITY_MODULE_PROFILE, ADMIN_ACTIVITY_MODULE_CONFIGURATIONS, ADMIN_ACTIVITY_MODULE_SERVICE_PLAN,ADMIN_ACTIVITY_MODULE_BILLINGS, ADMIN_ACTIVITY_MODULE_ACCESS_CONTROL, MAIN_REPORTS

date-from
string

The start date for filtering logs (format: YYYY-MM-DD).

date-to
string

The end date for filtering logs (format: YYYY-MM-DD).

activity
string

The activity performed by the administrator, and possible values are ADMIN_ACTIVITY_ADDED, COMMON_ACTIVITY_CLONED, ADMIN_ACTIVITY_DELETED, ADMIN_ACTIVITY_UPDATED, ADMIN_ACTIVITY_RESET_SERVICE_PLAN, LOGGED_OUT, LOGGED_IN, ADMIN_ACTIVITY_DOWNLOADED, ADMIN_ACTIVITY_CHANGE_PASSWORD, LOG_ACTIVITY_ACTION_RESET_BRANDING, LOG_REQUESTED_PASSWORD_CHANGE, ADMIN_ACTIVITY_MODULE_PASSWORD_UPDATE, ADMIN_ACTIVITY_USER_ACCOUNT_UNLOCKED, ADMIN_ACTIVITY_PUBLISH_CHANGES, COMMON_REVOKE, ADMIN_ACTIVITY_DORMANT, ADMIN_ACTIVITY_ARCHIVED

sort-by
string

Specifies the column to sort the results set by created_on and administrator_email and the default column is "created_on".

asc
boolean

Determines the sorting order of the result set. true for ascending order, false for descending order.

header Parameters
x-search-text
string

The search text is header and optional parameter; if omitted, the entire list is returned. it is recommended to provide the search text in Base64-encoded format.

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)

x-total-records
string
Default: 212

The total number of records found with the provided search criteria.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Operator Log Details

Business applications can use this service API to get an operator log details.

path Parameters
id
required
integer <int64>

The ID of the operator log.

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

Content type
application/json
[
  • {
    }
]

Get Operator Log Searches

Business applications can use this service API to get an operator log searches.

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

Content type
application/json
[
  • {
    }
]

Add Operator Log Search

Business applications can use this service API to add an operator log search.

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:
search_name
required
string [ 1 .. 200 ] characters

Search.

required
object (Models.OperatorLogSearcheCriteriaRequest)

OperatorLogSearcheCriteriaRequest

Responses

Request samples

Content type
{
  • "search_name": "string",
  • "criteria": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "created_on": "string"
}

Delete Operator Log Search

Business applications can use this service API to delete an operator log search.

path Parameters
id
required
integer <int64>

The ID of the operator log search.

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

Content type
application/json
{
  • "message": "string"
}

Update Operator Log Search

Business applications can use this service API to update an operator log search.

path Parameters
id
required
integer <int64>

The Id of the operator log search.

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:
search_name
required
string [ 1 .. 200 ] characters

Search.

required
object (Models.OperatorLogSearcheCriteriaRequest)

OperatorLogSearcheCriteriaRequest

Responses

Request samples

Content type
{
  • "search_name": "string",
  • "criteria": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string"
}