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

Accounts

The Account Module facilitates the creation and administration of both individual and enterprise SigningHub users, serving as the central hub for all user-related data and operations.

Account Management

APIs for creating, updating, retrieving, and administering user accounts.

Get Accounts

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

path Parameters
pageNo
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

True, if the parameter to order the result set is ascending.

sort-by
string

A parameter to specify the sorting criteria for the result set. The parameter will contain created_on | user_name | country | enterprise_name | service_plan. The default is created_on.

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)

x-search-text
string
Default: John Doe

A parameter that represents the search text, if required. This is optional and without it, the entire list is returned. Furthermore, the recommended value for the search text parameter is in Base64 encoded format or plain text.

x-user-name
string
Default: John Doe

The name of the account user to be searched.

x-user-email
string
Default: john.doe@ascertia.com

The email of the account user to be searched.

x-common-name
string
Default: John Doe

The common name of the account user to be searched.

x-enterprise-name
string
Default: Ascertia

The name of enterprise by which the account is to be searched.

x-billing-mode
string
Default: ONLINE

The billing mode will contain ONLINE | OFFLINE | NONE | TRIAL. It is optional if developers intend to ignore the billing mode.

x-payment-type
string
Default: PAY_REGULARLY

The payment type will contain PAY_REGULARLY | PAY_AS_YOU_GO.

x-service-plan-type
string
Default: INDIVIDUAL

The type of service plan by which the account is to be searched. The type will contain INDIVIDUAL | ENTERPRISE | NONE.

x-service-plan
string
Default: Basic Individual

The name of service plan to be searched. This is optional and without it, the account will be searched in all service plans. Furthermore, the recommended value for the service plan parameter is in Base64 encoded format.

x-activated
string
Default: Activated

The status of the user will contain REGISTERED | ACTIVATED

x-enabled
string
Default: False

Account enabled possible values are True (ALLOW_ACCESS) | False (DENY_ACCESS)

x-from
string
Default: 2017-01-01

The date value in the 8601 format from which onwards the account is to be searched.

x-to
string
Default: 2017-01-27

The date value in the 8601 format until which the account is to be searched.

x-country
string
Default: United States

The country of the account user to be searched.

x-national-id
string
Default: NID123

The national ID of the account user to be searched.

x-accounts
string
Default: ENTERPRISE

The type of the account user to be searched. The type will contain ALL | ENTERPRISE | INDIVIDUAL | INACTIVE | LOCKED | DORMANT | USER_FEEDBACK | GUEST | MARK_DELETED.

x-last-activity
string
Default: 1

The number of days since the last activity of the account user to be searched.

x-user-id
string
Default: 123

The ID of the account user when "x-detail" header set to true for the user detail

x-detail
string
Default: false

It identifies the user's enterprises. Set to true if enterprise details are required

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

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

path Parameters
id
required
integer <int64>

The user's ID.

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)

x-enterprise-id
string
Default: 123

Provide an integer enterprise ID (for example, "1") to access that specified enterprise.

Responses

Response samples

Content type
application/json
{
  • "billing_enabled": true,
  • "ra_enable": true,
  • "csp_enable": true,
  • "csc_enable": true,
  • "user": {
    },
  • "service_plan": {
    },
  • "usage_statistics": {
    }
}

Delete Account by ID

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

path Parameters
id
required
integer <int64>

Id of the user.

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 Account

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

path Parameters
id
required
integer <int64>

Id of the user.

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)

x-enterprise-id
string
Default: 123

Provide an integer enterprise ID (for example, "1") to access that specified enterprise.

Request Body schema:
user_name
required
string [ 1 .. 255 ] characters

user name

common_name
string or null <= 255 characters

common name

user_email
required
string [ 1 .. 255 ] characters

user email

mobile_number
string or null <= 15 characters

mobile number

job_title
string or null <= 255 characters

job title

company_name
string or null <= 255 characters

company name

ra_id
string or null <= 255 characters

User ID of the user registered in SAM service inside SigningHub Engine (ADSS Server).

national_id
string or null <= 255 characters

national id

csc_id
string or null <= 255 characters

Cloud Signature Consortium (CSC) user Id that will be required when signing(CSC) via client credential flow

csp_id
string or null <= 255 characters

csp id

country
string or null

country

language
string or null

language

enabled
boolean

User's access level possible values are True (ALLOW_ACCESS) | False (DENY_ACCESS)

default
boolean

True if the enterprise is set to the enterprise default; otherwise, false.

Responses

Request samples

Content type
{
  • "user_name": "string",
  • "common_name": "string",
  • "user_email": "string",
  • "mobile_number": "string",
  • "job_title": "string",
  • "company_name": "string",
  • "ra_id": "string",
  • "national_id": "string",
  • "csc_id": "string",
  • "csp_id": "string",
  • "country": "string",
  • "language": "string",
  • "enabled": true,
  • "default": true
}

Response samples

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

Get Guest User Info

Business applications can use this service API to get an GuestUser Info. An admin who has permission to manage the account in his role can get guest user info.

path Parameters
id
required
integer <int64>

The user's ID.

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
{
  • "name": "string",
  • "user_email": "string",
  • "mobile_number": "string",
  • "nid": "string"
}

Update Guest Account

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

path Parameters
id
required
integer <int64>

Id of the user.

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

user name

national_id
string or null <= 255 characters

national id

mobile_number
string or null <= 15 characters

mobile number

Responses

Request samples

Content type
{
  • "user_name": "string",
  • "national_id": "string",
  • "mobile_number": "string"
}

Response samples

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

Get Account by Email

Business applications can use this service API to get an account by email. An admin who has permission to manage the account in his role can get an account by email.

path Parameters
emailAddress
required
string

The user’s email address.

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)

x-enterprise-id
string
Default: 123

Provide an integer enterprise ID (for example, "1") to access that specified enterprise.

Responses

Response samples

Content type
application/json
{
  • "billing_enabled": true,
  • "ra_enable": true,
  • "csp_enable": true,
  • "csc_enable": true,
  • "user": {
    },
  • "service_plan": {
    },
  • "usage_statistics": {
    }
}

Assign AI Client to Account

Business applications can use this service API to assign an AI client to a user account. An admin who has permission to manage accounts can assign AI clients.

path Parameters
id
required
integer <int64>

The user's ID.

clientId
required
integer <int32>

The AI client ID to assign.

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)

x-enterprise-id
string
Default: 123

Provide an integer enterprise ID (for example, "1") to access that specified enterprise.

Responses

Response samples

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

Unassign AI Client from Account

Business applications can use this service API to unassign an AI client from a user account. An admin who has permission to manage accounts can unassign AI clients.

path Parameters
id
required
integer <int64>

The user's ID.

clientId
required
integer <int32>

The AI client ID to unassign.

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)

x-enterprise-id
string
Default: 123

Provide an integer enterprise ID (for example, "1") to access that specified enterprise.

Responses

Response samples

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

Check Existing User

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

Register User Account

Business applications can use this service API to register a new user with either a Trial or an Online service plan. We utilize the billing response. We capture the billing based on the transaction key, whether it's a placeholder or a confirmed transaction.

This process depends on the service plan. If the service plan is online, then the billing response is mandatory.

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:
service_plan_id
integer <int32>

The id of service plan

user_name
required
string [ 1 .. 255 ] characters

Name of user that is to be registered.

common_name
required
string [ 1 .. 255 ] characters

Name of user that is to be registered.

user_email
required
string [ 1 .. 255 ] characters

Email Address of the user to be registered.

job_title
string or null <= 255 characters

Job title of the user. (Optional)

company_name
string or null <= 255 characters

Company name for the user. (Optional)

enterprise_name
string or null <= 255 characters

Enterprise name, If service plan type is enterprise.

mobile_number
string or null <= 255 characters

Mobile number of the user. (Optional)

country
string or null

Country name for the user. All values in the appendix - Country list are accepted. (Optional)

language
string or null

Language selected for the user. All values in the appendix - Language list are accepted. For example en-US

user_csp_id
string or null

The user CSP id to identify the user.

user_ra_id
string or null

The remote authorisation user id.

national_id
string or null

The user national id.

security_answer
string or null <= 255 characters

The answer to the security answer, required during new user registration.

security_question
string or null <= 255 characters

The answer to the security question, required during new user registration.

send_activation_email
boolean

Indicates whether to send an activation email to the user's registration email address upon account creation.

send_registration_email
boolean

Indicates whether to send registration email to the user's registration email address upon account creation.

csc_id
string or null

Cloud Signature Consortium (CSC) user Id that will be required when signing(CSC) via client credential flow

password
string or null <= 255 characters

The unique password set by the user during registration for securing their account.

confirm_password
string or null <= 255 characters

The confirm password set by the user during registration for securing their account.

Responses

Request samples

Content type
{
  • "service_plan_id": 0,
  • "user_name": "string",
  • "common_name": "string",
  • "user_email": "string",
  • "job_title": "string",
  • "company_name": "string",
  • "enterprise_name": "string",
  • "mobile_number": "string",
  • "country": "string",
  • "language": "string",
  • "user_csp_id": "string",
  • "user_ra_id": "string",
  • "national_id": "string",
  • "security_answer": "string",
  • "security_question": "string",
  • "send_activation_email": true,
  • "send_registration_email": true,
  • "csc_id": "string",
  • "password": "string",
  • "confirm_password": "string"
}

Response samples

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

Account Enterprises

APIs for managing account relationships with enterprises, enterprise users, and enterprise assignments.

Get Enterprise Users

Business applications can use this service API to get the enterprise users. An admin who has permission to manage the account in his role can get the enterprise users.

path Parameters
enterpriseid
required
integer <int32>

The ID of the enterprise.

pageNo
required
integer <int32>

Page number to be retrieved.

records
required
integer <int32>

Total number of records to be retrieved in a page.

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-search-text
string
Default: John Doe

A parameter that represents the search text, if required. This is optional and without it, the entire list is returned. Furthermore, the recommended value for the search text parameter is in Base64 encoded format or plain text.

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 User Enterprises

Business applications can use this service API to get the user enterprises information

path Parameters
pageNo
required
integer <int32>
recordPerPage
required
integer <int32>
userId
required
integer <int64>
query Parameters
sort-by
string (Enumerations.UserEnterprisesSortedBy)
Enum: "CREATEDON" "NAME" "DEFAULT"
asc
boolean
Default: false
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-enterprise-id
string
Default: 123

Provide an integer enterprise ID (for example, "1") to access that specified enterprise.

x-total-records
string
Default: 212

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Saved Searches

APIs for managing saved searches and search preferences.

Get Saved Searches

Business applications can use this service API to get the saved searches. An admin who has permission to manage the account in his role can get the saved 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
[
  • {
    }
]

Save Search

Business applications can use this service API to save a search. An admin who has permission to manage the account in his role can save a 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:
user_name
string or null <= 255 characters

The name of the user is a criterion in the search filter that will be used to filter accounts.

user_email
string or null <= 255 characters

The email of the user is a criterion in the search filter that will be used to filter accounts.

common_name
string or null <= 255 characters

The common name of the user is a criterion in the search filter that will be used to filter accounts.

enterprise_name
string or null <= 255 characters

The name of the enterprise to which the user belongs is a criterion in the search filter that will be used to filter accounts.

billing_mode
string or null <= 255 characters

The billing mode is a criterion in the search filter that will be used to filter accounts. It will contain ONLINE_BILLING | OFFLINE_BILLING | NO_BILLING | NO_BILLING_TRIAL.

payment_type
string or null <= 255 characters

The payment type is a criterion in the search filter that will be used to filter accounts. It will contain NONE | PAY_REGULARLY | PAY_AS_YOU_GO.

service_plan_name
string or null <= 100 characters

The name of the service plan is a criterion in the search filter that will be used to filter accounts.

activated
boolean or null

If the status of the user is activated. true (ACTIVATED) | false REGISTERED

enabled
boolean or null

True, if the access level of the user is allowed. Possible values are false (DENY_ACCESS) | true (ALLOW_ACCESS)

created_on_from
string or null

The from date is a criterion in the search filter that will be used to filter accounts. The value is expected to follow the ISO 8601 format. Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields, the hh:mm:ss +00 can be ignored.

created_on_to
string or null

The to date is a criterion in the search filter that will be used to filter accounts. The value is expected to follow the ISO 8601 format. Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields, the hh:mm:ss +00 can be ignored.

country
string or null <= 255 characters

The country of the user is a criterion in the search filter that will be used to filter accounts. All values in the appendix - Country list are accepted.

national_id
string or null <= 255 characters

The national ID number of the user is a criterion in the search filter that will be used to filter accounts.

last_accessed_days
string or null [ 1 .. 9999 ]

The number of days since the user last accessed accounts is a criterion in the search filter that will be used to filter accounts.

search_name
required
string [ 1 .. 200 ] characters

The name of the search filter.

Responses

Request samples

Content type
{
  • "user_name": "string",
  • "user_email": "string",
  • "common_name": "string",
  • "enterprise_name": "string",
  • "billing_mode": "string",
  • "payment_type": "string",
  • "service_plan_name": "string",
  • "activated": true,
  • "enabled": true,
  • "created_on_from": "string",
  • "created_on_to": "string",
  • "country": "string",
  • "national_id": "string",
  • "last_accessed_days": "string",
  • "search_name": "string"
}

Response samples

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

Get Saved Search by ID

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

path Parameters
id
required
integer <int64>

The ID of the saved 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
{
  • "criteria": {
    },
  • "id": 0,
  • "default": true,
  • "operator_name": "string",
  • "search_name": "string"
}

Update Saved Search

Business applications can use this service API to update a saved search. An admin who has permission to manage the account in his role can update a saved search.

path Parameters
id
required
integer <int64>

ID of the saved 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:
user_name
string or null <= 255 characters

The name of the user is a criterion in the search filter that will be used to filter accounts.

user_email
string or null <= 255 characters

The email of the user is a criterion in the search filter that will be used to filter accounts.

common_name
string or null <= 255 characters

The common name of the user is a criterion in the search filter that will be used to filter accounts.

enterprise_name
string or null <= 255 characters

The name of the enterprise to which the user belongs is a criterion in the search filter that will be used to filter accounts.

billing_mode
string or null <= 255 characters

The billing mode is a criterion in the search filter that will be used to filter accounts. It will contain ONLINE_BILLING | OFFLINE_BILLING | NO_BILLING | NO_BILLING_TRIAL.

payment_type
string or null <= 255 characters

The payment type is a criterion in the search filter that will be used to filter accounts. It will contain NONE | PAY_REGULARLY | PAY_AS_YOU_GO.

service_plan_name
string or null <= 100 characters

The name of the service plan is a criterion in the search filter that will be used to filter accounts.

activated
boolean or null

If the status of the user is activated. true (ACTIVATED) | false REGISTERED

enabled
boolean or null

True, if the access level of the user is allowed. Possible values are false (DENY_ACCESS) | true (ALLOW_ACCESS)

created_on_from
string or null

The from date is a criterion in the search filter that will be used to filter accounts. The value is expected to follow the ISO 8601 format. Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields, the hh:mm:ss +00 can be ignored.

created_on_to
string or null

The to date is a criterion in the search filter that will be used to filter accounts. The value is expected to follow the ISO 8601 format. Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields, the hh:mm:ss +00 can be ignored.

country
string or null <= 255 characters

The country of the user is a criterion in the search filter that will be used to filter accounts. All values in the appendix - Country list are accepted.

national_id
string or null <= 255 characters

The national ID number of the user is a criterion in the search filter that will be used to filter accounts.

last_accessed_days
string or null [ 1 .. 9999 ]

The number of days since the user last accessed accounts is a criterion in the search filter that will be used to filter accounts.

search_name
required
string [ 1 .. 200 ] characters

The name of the search filter.

Responses

Request samples

Content type
{
  • "user_name": "string",
  • "user_email": "string",
  • "common_name": "string",
  • "enterprise_name": "string",
  • "billing_mode": "string",
  • "payment_type": "string",
  • "service_plan_name": "string",
  • "activated": true,
  • "enabled": true,
  • "created_on_from": "string",
  • "created_on_to": "string",
  • "country": "string",
  • "national_id": "string",
  • "last_accessed_days": "string",
  • "search_name": "string"
}

Response samples

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

Delete Saved Search

Business applications can use this service API to delete a saved search. An admin who has permission to manage the account in his role can delete a saved search.

path Parameters
id
required
integer <int64>

ID of the saved 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"
}

Activity & Logs

APIs for retrieving account activity, alerts, audit information, and enterprise logs.

Get Account Alerts

Business applications can use this service API to get account alerts. An admin who has permissions to manage the account in his role can get account alerts.

path Parameters
user_id
required
integer <int64>

The user's ID.

pageNo
required
integer <int32>

The page number to be retrieved.

records
required
integer <int32>

The total number of records to be retrieved in a page.

query Parameters
asc
boolean

True, if the parameter to order the result set is ascending.

sort-by
string

A parameter to specify the sorting criteria for the result set. The parameter will contain created_on | type. The default value is 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-search-text
string
Default: John Doe

A parameter that represents the search text, if required. This is optional and without it, the entire list is returned. Furthermore, the recommended value for the search text parameter is in Base64 encoded format or plain text.

x-total-records
string
Default: 212

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Reset Usage Statistics

Business applications can use this service API to reset statistics. An admin, who has permissions to manage account in his role, can reset usage statistics.

path Parameters
user_id
required
integer <int64>

Id of the user.

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)

x-enterprise-id
string
Default: 123

Provide an integer enterprise ID (for example, "1") to access that specified enterprise.

Responses

Response samples

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

Get User Activity by User ID

Business applications can use this service API to get the user activity by ID. An admin who has permission to manage the account in his role can get the user activity by user ID.

path Parameters
user_id
required
integer <int64>

The user’s ID for the activity which needs to be retrieved.

pageNo
required
integer <int32>

The page number to be retrieved.

records
required
integer <int32>

The total number of records to be retrieved in a page.

query Parameters
asc
boolean

True, if the parameter to order the result set is ascending.

sort-by
string

A parameter to specify the sorting criteria for the result set. The parameter will contain 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-search-text
string
Default: John Doe

A parameter that represents the search text, if required. This is optional and without it, the entire list is returned. Furthermore, the recommended value for the search text parameter is in Base64 encoded format or plain text.

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 Enterprise Logs

Business applications can use to get the enterprise logs with respect to search and advanced search filters with query parameters.

path Parameters
enterpriseid
required
integer <int64>

Enterprise id for enterprise logs.

pageNo
required
integer <int32>

Page number to be retrieved.

recordPerPage
required
integer <int32>

Total number of records to be retrieved in a page.

query Parameters
user-name
string

The user-name for which the enterprise logs to be retrieved.

performed-by
string

The email address for which the enterprise logs to be retrieved.

type
string (Enumerations.SearchByType)
Enum: "ALL" "ADDED" "UPDATED" "DELETED" "CLONED" "DOWNLOADED" "EXPORTED" "IMPORTED" "INVITED"

The type for which the enterprise logs to be retrieved.

module
string (Enumerations.SearchByModule)
Enum: "ALL" "PROFILE" "USERS" "ROLES" "CONTACTS" "GROUPS" "TEMPLATES" "LIBRARY" "ELECTRONIC_SEALS" "NOTIFICATIONS" "INTEGRATIONS" "BRANDING" "ADVANCED" "REPORTS" "DOCUMENTS" "ADVANCED_REPORTS" "STAMPS" "AI_TOOLS" "AI_CLIENT" "IDENTITY_VERIFICATION"

The module for which the enterprise logs to be retrieved.

created-from
string <date-time>

The created-from for which the enterprise logs to be retrieved.

created-to
string <date-time>

The created-to for which the enterprise logs to be retrieved.

sort-by
string (Enumerations.EnterpriseLogSortBy)
Enum: "CreatedOn" "Module" "Type" "PerformedBy"

Sorted the result by CreatedOn, Module, Type And Name.

asc
boolean

Sorted the result by ascending or descending order.

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)

x-search-text
string
Default: am9obg==

A parameter that represents the search text, if required. This is optional and without it, the entire list is returned. Furthermore, the recommended value for the search text parameter is in Base64 encoded format or plain text.

x-total-records
string
Default: 10

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

x-enterprise-name
string
Default: Ascertia

The name of enterprise to be shown on logs screen.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Enterprise Log Detail

Business applications can use this service API to get details about a particular enterprise log. The action is identified by the enterpriseId and log_id provided in the resource URL.

path Parameters
enterpriseid
required
integer <int64>

Enterprise id of the enterprise for which the log details are to be retrieved.

log_id
required
integer <int64>

Log id of the enterprise log for which the log details to be retrieved.

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
[
  • {
    }
]

Billing Management

APIs for managing account billing information, subscriptions, and service plans.

Get Account Billing

Business applications can use this service API to get the account billings. An admin who has permission to manage the account in his role can get the account billing.

path Parameters
user_id
required
integer <int64>

The ID of the user.

pageNo
required
integer <int32>

The page number to be retrieved.

records
required
integer <int32>

The total number of records to be retrieved in a page.

query Parameters
asc
boolean

True, if the parameter to order the result set is ascending.

sort-by
string

A parameter to specify the sorting criteria for the result set. The parameter will contain date, payment_number, amount and user_amount.

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-enterprise-id
string
Default: 123

Provide an integer enterprise ID (for example, "1") to access that specified enterprise.

x-search-text
string
Default: John Doe

A parameter that represents the search text, if required. This is optional and without it, the entire list is returned. Furthermore, the recommended value for the search text parameter is in Base64 encoded format or plain text.

x-total-records
string
Default: 212

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Change User Service Plan

Applications can call this API update a user's service plan. This requires SigningHub Administrator permission.

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)

x-enterprise-id
string
Default: 123

Provide an integer enterprise ID (for example, "1") to access that specified enterprise.

Request Body schema:
user_email
required
string non-empty

Email address of the account owner.

service_plan
required
string non-empty

New Service Plan name, which is to be assigned to the user.

enterprise_name
string or null <= 255 characters

The enterprise name in the case of changing from an individual to an enterprise service plan.

Responses

Request samples

Content type
{
  • "user_email": "string",
  • "service_plan": "string",
  • "enterprise_name": "string"
}

Response samples

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

Signing Certificates

APIs for managing user signing certificates, certificate assignments, updates, and revocation.

Get Admin Account Signing Certificates

path Parameters
userId
required
integer <int64>
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)

x-enterprise-id
string
Default: 123

Provide an integer enterprise ID (for example, "1") to access that specified enterprise.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add User Signing Certificate

path Parameters
userId
required
integer <int64>
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)

x-enterprise-id
string
Default: 123

Provide an integer enterprise ID (for example, "1") to access that specified enterprise.

Request Body schema: multipart/form-data
capacity_name
required
string <= 100 characters

Its termed as Capacity Name basically friendly name of certificate that could consist of Letters and numbers

certificate_alias
required
string <= 255 characters

Unique Guid Id

default
boolean

Default signing certificate

level_of_assurance
required
string

Possible values are ADVANCED_ELECTRONIC_SIGNATURE, HIGH_TRUST_ADVANCED, QUALIFIED_ELECTRONIC_SIGNATURE

key_protection_option
required
string

Key protection options, possible values are USER_PASSWORD, REMOTE_AUTHORISATION

file_stream
required
string <binary>

Stream of certificate

Responses

Response samples

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

Get User Signing Certificate by ID

path Parameters
userId
required
integer <int64>
userCertificateId
required
integer <int64>
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)

x-enterprise-id
string
Default: 123

Provide an integer enterprise ID (for example, "1") to access that specified enterprise.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "enterprise_id": 0,
  • "capacity_name": "string",
  • "certificate_alias": "string",
  • "certificate_dn": "string",
  • "level_of_assurance": "string",
  • "key_protection_option": "string",
  • "default": true,
  • "custom": true
}

Update User Signing Certificates

path Parameters
userId
required
integer <int64>

Id of the user

userCertificateId
required
integer <int64>

Id of 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
capacity_name
required
string <= 100 characters

Its termed as Capacity Name basically friendly name of certificate that could consist of Letters and numbers

certificate_alias
required
string <= 255 characters

Unique Guid Id

default
boolean

Default signing certificate

level_of_assurance
required
string

Possible values are ADVANCED_ELECTRONIC_SIGNATURE, HIGH_TRUST_ADVANCED, QUALIFIED_ELECTRONIC_SIGNATURE

file_stream
string <binary>

Stream of certificate

Responses

Response samples

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

Delete User Signing Certificates

path Parameters
userId
required
integer <int64>

Id of the user

userCertificateId
required
integer <int64>

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

Responses

Response samples

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

Add User Signing Certificate with base64

path Parameters
userId
required
integer <int64>
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)

x-enterprise-id
string
Default: 123

Provide an integer enterprise ID (for example, "1") to access that specified enterprise.

Request Body schema:
capacity_name
required
string [ 1 .. 100 ] characters

Its termed as Capacity Name basically friendly name of certificate that could consist of Letters and numbers

certificate_alias
required
string [ 1 .. 255 ] characters

Unique Guid Id

default
boolean

Default signing certificate

level_of_assurance
required
string non-empty

Possible values are ADVANCED_ELECTRONIC_SIGNATURE, HIGH_TRUST_ADVANCED, QUALIFIED_ELECTRONIC_SIGNATURE

key_protection_option
required
string non-empty

Key protection options, possible values are USER_PASSWORD, REMOTE_AUTHORISATION

certificate
required
string non-empty

Base64 of certificate

Responses

Request samples

Content type
{
  • "capacity_name": "string",
  • "certificate_alias": "string",
  • "default": true,
  • "level_of_assurance": "string",
  • "key_protection_option": "string",
  • "certificate": "string"
}

Response samples

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

Update User Signing Certificates Base64

path Parameters
userId
required
integer <int64>

Id of the user

userCertificateId
required
integer <int64>

Id of 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:
capacity_name
required
string [ 1 .. 100 ] characters

Its termed as Capacity Name basically friendly name of certificate that could consist of Letters and numbers

certificate_alias
required
string [ 1 .. 255 ] characters

Unique Guid Id

default
boolean

Default signing certificate

level_of_assurance
required
string non-empty

Possible values are ADVANCED_ELECTRONIC_SIGNATURE, HIGH_TRUST_ADVANCED, QUALIFIED_ELECTRONIC_SIGNATURE

certificate
string or null

Base64 of certificate

Responses

Request samples

Content type
{
  • "capacity_name": "string",
  • "certificate_alias": "string",
  • "default": true,
  • "level_of_assurance": "string",
  • "certificate": "string"
}

Response samples

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

Revoke User Signing Certificates

path Parameters
userId
required
integer <int64>

Id of the user

userCertificateId
required
integer <int64>

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

Responses

Response samples

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

Account Lifecycle

APIs for account maintenance operations such as password resets, account archival, dormancy, unlocking, and bulk actions.

Unlock User Account

path Parameters
id
required
integer <int64>
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"
}

Delete Bulk Account

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

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:

Ids of the users.

Array
integer <int64>

Responses

Request samples

Content type
[
  • 0
]

Response samples

Content type
application/json
[
  • {
    }
]

Export Accounts

Business applications can use this service API to export the accounts to an Excel file. An admin who has permission to manage the account in his role can export the accounts.

path Parameters
pageNo
required
integer <int32>

The page number to be retrieved.

records
required
integer <int32>

The total number of records to be retrieved in a page.

query Parameters
asc
boolean

True, if the parameter to order the result set is ascending.

sort-by
string

A parameter to specify the sorting criteria for the result set. The parameter will contain created_on | user_name | country | enterprise_name | service_plan. The default is created_on.

header Parameters
object (Models.AccountHeaderRequest)
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.

x-user-name
string
Default: John Doe

The name of the account user to be searched.

x-user-email
string
Default: john.doe@ascertia.com

The email of the account user to be searched.

x-common-name
string
Default: John Doe

The common name of the account user to be searched.

x-enterprise-name
string
Default: Ascertia

The name of enterprise by which the account is to be searched.

x-billing-mode
string
Default: ONLINE

The billing mode will contain ONLINE | OFFLINE | NONE | TRIAL. It is optional if developers intend to ignore the billing mode.

x-payment-type
string
Default: PAY_REGULARLY

The payment type will contain PAY_REGULARLY | PAY_AS_YOU_GO.

x-service-plan-type
string
Default: INDIVIDUAL

The type of service plan by which the account is to be searched. The type will contain INDIVIDUAL | ENTERPRISE | NONE.

x-service-plan
string
Default: Basic Individual

The name of service plan to be searched. This is optional and without it, the account will be searched in all service plans. Furthermore, the recommended value for the service plan parameter is in Base64 encoded format.

x-activated
string
Default: True

The status of the user will contain REGISTERED | ACTIVATED

x-enabled
string
Default: True

Account enabled possible values are True (ALLOW_ACCESS) | False (DENY_ACCESS)

x-from
string
Default: 2017-05-01

The date value in the 8601 format from which onwards the account is to be searched.

x-to
string
Default: 2017-05-22

The date value in the 8601 format until which the account is to be searched.

x-country
string
Default: United States

The country of the account user to be searched.

x-accounts
string
Default: ENTERPRISE

The type of the account user to be searched. The type will contain ALL | ENTERPRISE | INDIVIDUAL | INACTIVE | LOCKED | DORMANT | USER_FEEDBACK | GUEST | MARK_DELETED.

x-user-id
string
Default: 123

The ID of the account user when "x-detail" header set to true for the user detail

x-detail
string
Default: false

It identifies the user's enterprises. Set to true if enterprise details are required

Responses

Response samples

Content type
application/json
"string"

Mark Account as Dormant

Business applications can use this service API to mark account as dormant. An admin, who has permissions to manage account in his role, can mark account as dormant.

path Parameters
userId
required
integer <int64>

ID of the user.

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

Archive Account

Business applications can use this service API to archive account. An admin, who has permissions to manage account in his role, can archive account. The archive option is available only if it is enabled in the license and in the global settings

path Parameters
userId
required
integer <int64>

ID of the user.

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

Reset Account Password

Business applications can use this service API to reset a user’s password. An administrator with the appropriate role permissions to manage accounts can reset the account password.

path Parameters
user_id
required
integer <int64>

The ID of the user who can reset his/her 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)

Responses

Response samples

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