Credentials

This document explains how to manage credentials for DocStudio Automations.

Some automation types need stored credentials to access external systems or services. Create credentials before adding the type to a workflow. Then set credentialsId to the credential ID.

Get available credential types

Retrieve the credential types available for the account:

GET /api/v1/automation/account/{accountId}/credential-types

The response includes schemas for types used by available automation types. Use the schema to identify required credential values.

Create credentials

Create a stored credential:

POST /api/v1/automation/account/{accountId}/credentials

Provide the configuration required by the selected credential type. A successful request returns the created credential ID.

Add the credential ID to the workflow item:

{
  "id": "11111111-1111-1111-1111-111111111111",
  "type": "automation-type",
  "config": {},
  "credentialsId": "<credential-uuid>",
  "next": []
}

Add credentialsId only when the selected automation type requires stored credentials.

List stored credentials

Retrieve the stored credentials available for the account:

GET /api/v1/automation/account/{accountId}/credentials

Delete credentials

Delete a stored credential:

DELETE /api/v1/automation/account/{accountId}/credentials/{id}

Use the ID of the credential to remove. This operation removes the selected stored credential.

Related topics

• Create an Automation

• Automation types