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

Connectors

The Connectors Module allows administrators to configure and manage integrations with third-party services, enabling secure and efficient connectivity between SigningHub and external platforms.

Get Connectors

Business applications can use this service API to get connectors. An admin who has permission to manage connectors in his role can get connectors.

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 Connector

Business applications can use this service API to add a connector. An admin who has permission to manage connectors in his role can add new connectors.

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 [ 1 .. 100 ] characters

The name of the connector.

provider
required
string non-empty

The provider will be fetched from the "Get Providers" API.

identifier
string or null

This will contain the simplified name of the provider (attribute_name) in the "Get Providers" API.

status
boolean

True, if the status of the connector is enabled.

required
Array of objects (Models.ConnectorDetailRequest)

connector details

Responses

Request samples

Content type
{
  • "name": "string",
  • "provider": "string",
  • "identifier": "string",
  • "status": true,
  • "connector_detail": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "created_on": "2019-08-24T14:15:22Z"
}

Get Basic Connectors

Business applications can use this service API to get the basic connectors. An administrator does not need the connector's "read" permission to retrieve the basic connectors.

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 Connector by ID

Business applications can use this service API to get a connector by ID. An admin who has permission to manage connectors in his role can get the connector.

path Parameters
id
required
integer <int64>

The ID of the connector.

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
{
  • "id": 0,
  • "name": "string",
  • "provider": "string",
  • "identifier": "string",
  • "status": true,
  • "for_adss": true,
  • "type": "string",
  • "purposes": [
    ],
  • "connector_detail": [
    ]
}

Update Connector

Business applications can use this service API to update a connector. An admin who has permission to manage connectors in his role can update a connector.

path Parameters
id
required
integer <int64>

The ID of the connector.

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:
status
boolean

True, if the status of the connector is enabled.

required
Array of objects (Models.ConnectorDetailRequest)

connector_detail

Responses

Request samples

Content type
{
  • "status": true,
  • "connector_detail": [
    ]
}

Response samples

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

Delete Connector

Business applications can use this service API to delete a connector. An admin who has permission to manage connectors in his role can delete a connector.

path Parameters
id
required
integer <int64>

The ID of the connector.

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"
}

Get Certificate Info

Business applications can use this service API to get the certificate info. For admin, there is no need for any permission to retrieve the certificate info.

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: multipart/form-data
file (binary Stream)
required
string <binary>
Default: ""

This is the file in the raw binary format.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Certificate (Base64)

Business applications can use this service API to get the certificate (base64). For admin, there is no need for any permission to retrieve the certificate.

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: multipart/form-data
file (binary Stream)
required
string <binary>
Default: ""

This is the file in the raw binary format.

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get SAML Connector IDP

Business applications can use this service API to get SAML connector IDP. For admin, there is no need for any permission to retrieve the SAML connector IDP.

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: multipart/form-data
file (binary Stream)
required
string <binary>
Default: ""

This is the file in the raw binary format.

Responses

Response samples

Content type
application/json
{
  • "http_post_login_url": "string",
  • "http_redirect_login_url": "string",
  • "http_post_logout_url": "string",
  • "http_redirect_logout_url": "string",
  • "certificate_subject": "string",
  • "certificate_raw_data": "string"
}

Send Message

Business applications can use this service API to send messages to users. For admin, there is no need for any permission to send SMS.

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:
mobile_number
string or null

The mobile number to send message.

name
string or null

The name of the SMS connector.

provider
required
string non-empty

The provider will be SMS.

required
Array of objects (Models.SendMessageConnectorDetailRequest)

connector_detail

Responses

Request samples

Content type
{
  • "mobile_number": "string",
  • "name": "string",
  • "provider": "string",
  • "connector_detail": [
    ]
}

Response samples

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

Export SAML Data

Business applications can use this service API to export SAML data for users. For admin, there is no need for any permission to export SAML data.

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
string or null

The name of the SAML connector.

Responses

Request samples

Content type
{
  • "name": "string"
}

Response samples

Content type
application/json
"string"