SigningHub Admin API Guide
Download OpenAPI specification:Download
Browse through the API content by selecting the relevant pages from the left panel. To quickly find specific web service information, enter search criteria in the search box on top left.
More about SigningHub
To know more about SigningHub, explore the following links:
- Go to SigningHub Knowledge Base to view all the relevant information of SigningHub.
-
Visit the Ascertia Community Portal to find answers to contact SigningHub support staff through the
Live Chat provision
.
Our
support staff may be occupied with other priority tasks so live chat is offered on
an "as available" basis.
This guide is intended for developers who will integrate SigningHub into their respective web applications using the RESTful web services, and user interface offered by SigningHub. It is assumed that the reader has a basic knowledge of REST, Java, C#, HTML, JavaScript, HTTP and TLS/SSL. There is no Software Developers Kit (SDK) for the integration, instead the integration uses HTML Forms and JSON so that integration is simple from any language including .Net, Java, PHP etc.
| Main Tags | Most Popular Pages |
|---|---|
|
➤
Welcome
➤ Prerequisites ➤ Access Token ➤ Updates ➤ APIs Developer Guide ➤ Appendix |
➤
Authentication
➤ Service Plans ➤ Account Management ➤ Billing Management ➤ Access Control ➤ Operator Logs ➤ Advanced Reports |
Authentication profiles provide the ways through which the end users may authenticate themselves to SigningHub. In addition to the conventional email/ password based authentication, SigningHub also allows the authentication facility through different external Identity Providers (IdP) i.e. Active Directory, Google, Linked-in, Salesforce, SSL Client, Office 365, Active Directory Federation Services (ADFS) etc.
Get Authentication Profiles
Business applications can use this service API to get authentication profiles. An admin, who has permissions to manage authentication profiles in his role, can get authentication profiles.
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Responses
Response samples
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "name": "string",
- "description": "string",
- "sort_order": 0,
- "private": true,
- "status": true,
- "created_on": "string",
- "profile_detail": [
- {
- "id": 0,
- "attribute_name": "string",
- "attribute_value": "string"
}
]
}
]Add Authentication Profile
Business applications can use this service API to add an authentication profile. An admin, who has permissions to manage authentication profiles in his role, can add new authentication profile.
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 of the authentication profile |
| description | string or null <= 255 characters Description of the authentication profile |
| sort_order | integer or null <int32> [ 1 .. 9999 ] Sort Order of the authentication profile |
| private | boolean Private of the authentication profile |
| status | boolean Status of the authentication profile |
Array of objects or null (Models.ProfileDetailRequest) Details of the authentication profile |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "sort_order": 1,
- "private": true,
- "status": true,
- "profile_detail": [
- {
- "attribute_name": "string",
- "attribute_value": "string"
}
]
}Response samples
- 201
- 400
- 401
- 403
- 404
- 422
- 500
{- "id": 0,
- "created_on": "string"
}Get Basic Authentication Profiles
Business applications can use this service API to get basic authentication profiles. For admin, there is no need of any permission to retrieve basic authentication profiles.
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Responses
Response samples
- 200
- 401
- 500
[- {
- "id": 0,
- "name": "string"
}
]Get Authentication Profile by ID
Business applications can use this service API to get an authentication profile by id. An admin, who has permissions to manage authentication profiles in his role, can get authentication profile.
path Parameters
| id required | integer <int64> Id of the authentication profile. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "id": 0,
- "name": "string",
- "description": "string",
- "sort_order": 0,
- "private": true,
- "status": true,
- "created_on": "string",
- "profile_detail": [
- {
- "id": 0,
- "attribute_name": "string",
- "attribute_value": "string"
}
]
}Delete Authentication Profile
Business applications can use this service API to delete an authentication profile. An admin, who has permissions to manage authentication profiles in his role, can delete authentication profile.
path Parameters
| id required | integer <int64> Id of the authentication profile. |
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
- 401
- 403
- 404
- 500
{- "message": "string"
}Update Authentication Profile
Business applications can use this service API to update an authentication profile. An admin, who has permissions to manage authentication profiles in his role, can update authentication profile.
path Parameters
| id required | integer <int64> Id of the authentication profile. |
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 of the authentication profile |
| description | string or null <= 255 characters Description of the authentication profile |
| sort_order | integer or null <int32> [ 1 .. 9999 ] Sort Order of the authentication profile |
| private | boolean Private of the authentication profile |
| status | boolean Status of the authentication profile |
Array of objects or null (Models.ProfileDetailRequest) Details of the authentication profile |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "sort_order": 1,
- "private": true,
- "status": true,
- "profile_detail": [
- {
- "attribute_name": "string",
- "attribute_value": "string"
}
]
}Response samples
- 401
- 403
- 404
- 422
- 500
{- "message": "string"
}