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 |
The AI Client Manager module enables administrators to manage AI clients that can be assigned to enterprise accounts. AI clients are registered on the external AI server and provide access to AI-powered features within SigningHub.
Get AI Clients
Business applications can use this service API to get all AI clients. An admin who has read permission for AI Client Manager in his role can get all AI clients.
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
- 400
- 401
- 403
- 500
[- {
- "id": 0,
- "name": "string",
- "provider": {
- "service": "OPEN_AI",
- "api_key": "string"
}
}
]Add AI Client
Business applications can use this service API to create a new AI client. An admin who has add/update permission for AI Client Manager in his role can create an AI client.
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:
Request containing the AI client name
| name required | string [ 1 .. 255 ] characters Name of the AI Client |
required | object (Models.AddAIClientProvider) AI Client Provider Details |
Responses
Request samples
- Payload
{- "name": "string",
- "provider": {
- "service": "OPEN_AI",
- "api_key": "string"
}
}Response samples
- 201
- 400
- 401
- 403
- 422
- 500
{- "id": 0,
- "name": "string",
- "provider": {
- "service": "OPEN_AI",
- "api_key": "string"
}
}Get AI Client by ID
Business applications can use this service API to get an AI client by ID. An admin who has read permission for AI Client Manager in his role can get the AI client.
path Parameters
| id required | integer <int32> The ID of the AI client |
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
- 400
- 401
- 403
- 404
- 500
{- "id": 0,
- "name": "string",
- "provider": {
- "service": "OPEN_AI",
- "api_key": "string"
}
}Update AI Client
Business applications can use this service API to update an existing AI client. An admin who has add/update permission for AI Client Manager in his role can update an AI client.
path Parameters
| id required | integer <int32> The ID of the AI client to update |
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:
Request containing the new AI client name
| name required | string [ 1 .. 255 ] characters Name of the AI Client |
object (Models.UpdateAIClientProvider) AI Client Provider Details |
Responses
Request samples
- Payload
{- "name": "string",
- "provider": {
- "service": "OPEN_AI",
- "api_key": "string"
}
}Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "name": "string",
- "provider": {
- "service": "OPEN_AI",
- "api_key": "string"
}
}Delete AI Client
Business applications can use this service API to delete an AI client. An admin who has delete permission for AI Client Manager in his role can delete an AI client. When an AI client is deleted, it will be unlinked from all associated accounts.
path Parameters
| id required | integer <int32> The ID of the AI client to delete |
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
- 400
- 401
- 403
- 404
- 500
{- "message": "string"
}