API referenceSecrets

Update secret

<span class="badge">Commercial & Enterprise</span> Update the description, value, or allowed workspaces for a secret. If a value for a parameter is not specified, it will remain the same. <Note>Only organization admins can update secrets.</Note>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

IB-ContextstringOptional
Specify whether to use your community account or organization account to complete the request. To use your community account, define as your user ID. To use your organization account, define as your organization ID. If unspecified, defaults to community account context. See [Authorization and context identification](/api-sdk/authorization#ib-context-header) for details.

Request

This endpoint expects an object.
aliasstringRequired
Name of the secret to update.
descriptionstringOptional
New description of the secret.
valuestringOptional
New content of the secret.
allowed_workspaces_typeenumOptional
New designation of which workspaces in this organization are allowed to use this secret in custom functions.
Allowed values:
allowed_workspaceslist of stringsOptional
New designation of which workspaces are allowed to use this secret, if only some are.

Response

Secret updated successfully.