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

Access Control

The Access Control Module manages role-based access with fine-grained authorization, allowing read, add/edit, and delete permissions across modules and submodules. Operators can add, edit, and delete role-based administrators to delegate and control restricted access within SigningHub based on administrative requirements.

Operator Management

APIs for managing operators, operator profiles, and operator certificates used for administrative access.

Get Operators

Business applications can use this service API to get operators. An admin, who has permissions to manage operators in his role, can read operators.

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

Business applications can use this service API to add operator for Users. An admin who has permissions to manage Operators in his role, can add new 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 [ 1 .. 255 ] characters

Name

email
required
string [ 1 .. 255 ] characters

Email address

mobile_number
string or null <= 15 characters

Mobile Number

certificate_base64
required
string non-empty

Certificate string int base64 format

required
object (Models.OperatorRoleRequest)

OperatorRoleRequest

status
boolean

True, if the operator status is active and possible values are True and False

Responses

Request samples

Content type
{
  • "name": "string",
  • "email": "string",
  • "mobile_number": "string",
  • "certificate_base64": "string",
  • "role": {
    },
  • "status": true
}

Response samples

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

Get Operator by ID

Business applications can use this service API to get operator. An admin, who has permissions to manage operator in his role, can read operator.

path Parameters
id
required
integer <int64>

Id of 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)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "email": "string",
  • "mobile_number": "string",
  • "certificate_cn": "string",
  • "certificate_base64": "string",
  • "status": true,
  • "role": {
    },
  • "picture": "string",
  • "created_on": "string"
}

Update Operator

Business applications can use this service API to update operator. An admin, who has permissions to manage operators in his role, can update operator.

path Parameters
id
required
integer <int64>

Id of 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 [ 1 .. 255 ] characters

Name

mobile_number
string or null <= 15 characters

Mobile Number

certificate_base64
string or null

Certificate string in base64 format

required
object (Models.OperatorRoleRequest)

OperatorRoleRequest

status
boolean

True, if the operator status is active and possible values are True and False

Responses

Request samples

Content type
{
  • "name": "string",
  • "mobile_number": "string",
  • "certificate_base64": "string",
  • "role": {
    },
  • "status": true
}

Response samples

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

Delete Operator

Business applications can use this service API to delete operator. An admin, who has permissions to manage operators in his role, can delete operator.

path Parameters
id
required
integer <int64>

Id of 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)

Responses

Response samples

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

Get Operator Certificate

Business applications can use this service API to get operator certificate. An admin, who has permissions to manage operator certificates in his role, can read operator certificate.

path Parameters
id
required
integer <int64>

Id of 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)

Responses

Response samples

Content type
application/json
"string"

Role Management

APIs for managing roles, role assignments, and operator-role relationships used for access control.

Get Roles

Business applications can use this service API to get roles. An admin, who has permissions to manage roles in his role, can read roles.

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 Role

Business applications can use this service API to add role. An admin, who has permissions to manage Roles in his role, can add new role.

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

Name

description
string or null <= 255 characters

Description

required
Array of objects (Models.AdministratorRoleDetailRequest)

Details of the role

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "role_detail": [
    ]
}

Response samples

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

Get Role Operators

Business applications can use this service API to get role operators. An admin, who has permissions to manage roles in his role, can read role operators.

path Parameters
id
required
integer <int64>

Id of the role.

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

Business applications can use this service API to get a role for Users. An admin, who has permissions to manage roles in his role, can read role.

path Parameters
id
required
integer <int64>

Id of the role.

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",
  • "description": "string",
  • "role_detail": [
    ]
}

Update Role

Business applications can use this service API to update role. An admin, who has permissions to manage roles in his role, can update role.

path Parameters
id
required
integer <int64>

Id of the role.

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 .. 255 ] characters

Name

description
string or null

Description

Array of objects or null (Models.AdministratorRoleDetailRequest)

Details of the role

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "role_detail": [
    ]
}

Response samples

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

Delete Role

Business applications can use this service API to delete role. An admin, who has permissions to manage roles in his role, can delete role.

path Parameters
id
required
integer <int32>

Id of the role.

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