Documentation Index
Fetch the complete documentation index at: https://docs.royaltyport.com/llms.txt
Use this file to discover all available pages before exploring further.
What are Secrets?
Secrets are encrypted credentials stored securely within the Automations environment. They provide authentication for steps that connect to external services — like API keys for HTTP requests, SFTP credentials for file transfers, or OAuth tokens for protected APIs.Creating a Secret
Secret Types
| Type | Fields | Use Case |
|---|---|---|
| Basic Auth | Username, Password | HTTP basic authentication |
| Bearer Token | Token | Bearer token authentication |
| API Key | Key name, Key value | API key header authentication |
| SFTP Password | Username, Password | SFTP password-based login |
| SFTP Private Key | Username, Private key | SFTP key-based login |
| OAuth2 Client Credentials | Client ID, Client secret, Token URL | OAuth2 client credentials flow |
| JSON Credentials | JSON content | Service account or custom credentials |
Using Secrets in Steps
When configuring a step that supports authentication (HTTP Request, SFTP, Code), select a secret from the auth dropdown in the step configuration panel. The secret’s credentials are injected at runtime.Mode Scoping
Secrets are scoped per mode:- Test secrets are used during test executions
- Live secrets are used during production executions
- During deployment, you choose which test secrets to copy to the live environment
Deleting Secrets
Secrets can only be deleted in test mode. Click the delete button on a secret row, then confirm the deletion.Related Documentation
Steps
Configure authentication on HTTP Request, SFTP, and Code steps.
Test & Deploy
Secrets are copied from test to live during deployment.