Admin
Admin
The admin part of the API enables authentication against SigningHub and retrieval of the connector application logs.
v1/auth/custom/new
Authenticates using client_id and client_secret, retrieving an access_token.
Header Parameters:
|
Header Parameters |
Description |
|
Content-Type (string) |
Default: application/json |
|
Accept (string) |
Default: application/json |
Body Schema:
|
Body Variable |
Description |
|
clientID (string) |
Application Name that you have configured in your Enterprise Account when configuring the integration options. |
|
clientSecret (string) |
API Key that you generated in your Enterprise Account when configuring the integration options. |
|
{ "providerConfigAttributes": [ { "key": "clientID", "value": "client_idValue" }, { "key": "clientSecret", "value": "client_sectetValue" } ] } |
|
Responses:
|
httpCode |
Response schema |
Description |
|
200 |
access_token |
OAuth user authentication access token - bearer token for subsequent authorization to other API calls. |
|
token_type |
Type of the token returned by authorization server. It is always set to "bearer". |
|
|
expires |
Number of seconds for which this access token is valid. Fixed value of 86,399 seconds (24 hours). |
|
|
{ "access_token": "string", "token_type": "string", "expires": "integer" } |
||
|
httpCode |
message |
|
400 |
Bad request (See error list) |
|
500 |
Server Error (See error list) |
/v1/logs
Retrieves the most recent logs of the connector, it's disabled on production environments.
Header Parameters:
|
Header Parameters |
Description |
|
Accept (string) |
Default: application/json |
|
apiAccessToken (string) |
The authorization token used to validate the API. |
Responses:
|
httpCode |
Response schema |
Description |
|
200 |
date |
The date and time the message was recorded |
|
level |
Indicates the level of importance of the message. It can be (debug, error, info) |
|
|
component |
Indicates the part of the system that generated the log message |
|
|
message |
The content of the message. |
|
|
date [level] component message |
||