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 |
Advanced Power BI reporting by integrating workspace-level reports into the application, utilizing embed tokens to securely render interactive reports within iframes.
Get Workspaces
Business applications can use this service API to get the power bi reports. An admin who has permission to manage the account and advanced resports in his role can get the 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) |
Responses
Response samples
- 200
- 401
- 403
- 500
[- {
- "id": "string",
- "name": "string"
}
]Update Workspace
Business applications can use this service API to update the power bi reports. An admin who has permission to manage the account and advanced resports in his role can update the reports setting.
path Parameters
| enterpriseId required | integer <int32> The enterprise id of the user. |
| workspaceId required | string The workspace ID. Pass a valid workspace ID to assign the user to a workspace. Pass nothing to unassign the user's workspace. |
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
- 500
{- "message": "string"
}Get Power BI Reports
Business applications can use this service API to get the power bi reports. An admin who has permission to manage the account and advanced resports in his role can get the reports.
path Parameters
| workspaceId required | string The workspace 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
- 200
- 401
- 403
- 500
{- "id": "string",
- "name": "string"
}Get PowerBI Embed Token
Business applications can use this service API to generate an embed token for securely embedding Power BI reports. An admin with the necessary permissions to manage the account and access advanced reports can request an embed token. This token enables authorized users to view reports within the application
path Parameters
| workspaceId required | string This is the workspace ID. |
| reportId required | string This is the report 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
- 200
- 401
- 403
- 500
{- "token": "string"
}