SuperAI Flow Platform

Sections

Theme switcher

Update credential

Update existing integration credentials with new values.

Replaces credential data (passwords, tokens, connection details) for an existing credential. Use this endpoint to rotate passwords, update connection strings, or refresh OAuth tokens.

Context: Credential updates are necessary for several operational scenarios: - Password rotation policies require periodic credential updates - SFTP server configuration changes (hostname, port) - Database connection string modifications - SSH key rotation for key-based authentication - OAuth token refresh (though typically handled automatically)

Updates preserve credential_id, allowing workflows to continue using the same reference.

Use Cases: Rotate SFTP password after security audit requires credential changes.

Update PostgreSQL connection string after database server migration.

Replace SSH private key after key compromise detected.

Related Endpoints: - GET /integrations/credentials/{credential_id} - Get credential metadata before updating - POST /integrations/sftp/test-connection - Test new SFTP credentials before updating - POST /integrations/postgres/test-connection - Test new PostgreSQL credentials before updating - DELETE /integrations/credentials/{credential_id} - Delete credential instead of updating

Security: - New credentials are encrypted before storage (same as creation) - Old credential data is overwritten (not preserved in database) - Audit trail tracks who performed the update via modified_by field - Test new credentials before updating to prevent workflow disruption

Notes: - Always test new credentials before updating to avoid breaking workflows - Workflows using this credential will use new values immediately - OAuth credentials are typically auto-refreshed (manual update rarely needed) - Consider creating new credential instead of updating if provider changes

Header Parameters

Authorizationstring

Path Parameters

credential_idstring Required

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

Body Parameters

credential_typestring Required
Enum values:
api_keygoogle_oauthsharepoint_oauthoauth2user_passwordkey_file
credentialsobject Required

Response

200
Object
Credential updated successfully

Response Attributes

created_atstring Required
google_emailnull
idstring Required
modified_bystring Required
providerstring Required

API-friendly version of ProviderEnum without spaces

Enum values:
microsoftsharepointsftpaws_sesgooglepostgresqlinternal_postgresql
updated_atstring Required
user_idnull
400
Object
Invalid request data or 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?

PATCH

/

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