SuperAI Flow Platform

Sections

Theme switcher

Get credential secrets

Retrieve decrypted credential secrets for integration use.

Returns the actual credential data (passwords, tokens, keys) in decrypted form. This endpoint is restricted to service accounts only for security. Regular users cannot retrieve plaintext credentials after creation.

Context: This endpoint provides access to sensitive credential data for system-level operations. It is primarily used by: - Service accounts executing workflows that need integration credentials - Internal services performing integration health checks - System processes that need to establish external connections - Automated credential rotation and renewal workflows

Regular user accounts cannot access this endpoint to prevent credential exposure.

Use Cases: Service account retrieves SFTP credentials to execute file download task in workflow.

Internal health check service validates PostgreSQL credential by attempting connection.

Automated token refresh service retrieves OAuth refresh_token for renewal.

Related Endpoints: - GET /integrations/credentials - List credentials (metadata only, no secrets) - POST /integrations/credentials - Create new credential - PATCH /integrations/credentials/{credential_id} - Update credential

Security: - Service accounts only - regular users cannot retrieve plaintext credentials - Credentials are decrypted in-memory only (never logged or persisted unencrypted) - Organization isolation enforced at query level - Audit logging recommended for production use - Consider rotating credentials if this endpoint is compromised

Notes: - This endpoint is intended for internal system use, not direct customer API calls - Sensitive data should be handled securely and never exposed in logs or responses - OAuth tokens are automatically refreshed if expired before returning

Header Parameters

Authorizationstring

Path Parameters

credential_idstring Required

UUID of the credential to retrieve sensitive data from. User must own this credential or have service account permissions.

Response

200
Object
Credential secrets retrieved successfully
400
Object
Invalid credential ID

Response Attributes

errorobject Required

Standard error detail structure.

This model matches the error format returned by the centralized exception handlers in app/api/errors/handlers.py.

Show child attributes

request_idnull
401
Object
Unauthorized - Missing or invalid authentication credentials

Response Attributes

errorobject Required

Standard error detail structure.

This model matches the error format returned by the centralized exception handlers in app/api/errors/handlers.py.

Show child attributes

request_idnull
403
Object
Service account required

Response Attributes

errorobject Required

Standard error detail structure.

This model matches the error format returned by the centralized exception handlers in app/api/errors/handlers.py.

Show child attributes

request_idnull
404
Object
Credential not found

Response Attributes

errorobject Required

Standard error detail structure.

This model matches the error format returned by the centralized exception handlers in app/api/errors/handlers.py.

Show child attributes

request_idnull
422
Object
Validation Error

Response Attributes

detailarray

Show child attributes

500
Object
Internal Server Error - An unexpected error occurred

Response Attributes

errorobject Required

Standard error detail structure.

This model matches the error format returned by the centralized exception handlers in app/api/errors/handlers.py.

Show child attributes

request_idnull
Was this section helpful?

What made this section unhelpful for you?

GET

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?

View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot