Signing Task - HTTP API

NOTE

Find more information on what access rights are needed for which operation at S&E Access Control Lists.

Create a signing task

NOTE

Based on the chosen signature algorithm it may be necessary that a certain format is expected as input. This is indicated by the algorithm name. For example, the SHA256_RSA_3072_PSS and SHA256_RSA_4096_PSS algorithms require a SHA256 digest as input, which is passed Base64 encoded.

1. From the Signing Task API open the POST /api/v1/signingTask endpoint.

2. Click Try it out.

3. Fill in the tenant header in the X-SE-TENANT field.

4. Fill in the Request body following the form:

   {
     "deviceConfigId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
     "inputBase64": "string",
     "name": "string"
   }

5. Click Execute

6. A successful response with 201 code will have status CREATED and will provide the signingTaskId.

Approve a signing task

1. Open the POST /api/v1/signingTask/{signingTaskId}/approval endpoint.

2. Click Try it out.

3. Fill in the signingTaskId.

4. Fill in the tenant header in the X-SE-TENANT field.

5. Fill in the Request body following the form:

   {
     "decision": "APPROVED",
     "reason": "string"
   }

6. Click Execute.

7. A successful response with 202 code will confirm your action.

Check the status of a signing task

1. Open the endpoint to GET /api/v1/signingTask/{signingTaskId}.

2. Click Try it out.

3. Fill in the signingTaskId, taken from the response body of your creation call.

   NOTE

   Another option would be to check the status of all signing tasks via GET /api/v1/signingTask.

4. Fill in the tenant header in the X-SE-TENANT field.

5. Click Execute.

6. When the task is ready the response body will have status DONE and will include the outcome of the signing task e.g.

   "decision": "APPROVED"