SuperAI Flow Platform

Sections

Theme switcher

Delete credential

Soft-delete an integration credential.

Marks the credential as deleted without physically removing it from the database. Deleted credentials are excluded from list queries and cannot be used in workflows.

Context: This endpoint safely removes credentials while preserving audit trail. Common scenarios: - User disconnects an integration from settings UI - Credential compromise detected (delete and recreate) - Integration no longer needed for workflows - OAuth token revoked by provider

Soft deletion allows recovery if needed and maintains historical records for compliance.

Use Cases: User clicks "Disconnect" button for SharePoint integration in settings UI.

Remove compromised SFTP credentials before creating new ones with rotated password.

Clean up unused credentials to reduce organization's attack surface.

Related Endpoints: - GET /integrations/credentials - List active credentials (excludes deleted) - GET /integrations/credentials/{credential_id} - Verify credential before deletion - POST /integrations/credentials - Create new credential to replace deleted one

Security: - Soft deletion preserves audit trail for compliance - Encrypted credential data remains in database but inaccessible - Consider automatic credential rotation policies for sensitive environments - Deleted credentials cannot be restored via API (database admin required)

Notes: - Deletion is immediate and cannot be undone via API - Workflows using this credential will fail after deletion - Check for dependent workflows before deleting credentials - OAuth tokens are not revoked at provider (user must revoke separately)

Header Parameters

Authorizationstring

Path Parameters

credential_idstring Required

UUID of the credential to delete. Must belong to the authenticated user's organization.

Response

204
Object
Credential deleted 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
Forbidden - Insufficient permissions to access this resource

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?

DELETE

/

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