Skip to main content

UpdateApiSecretApiResource

Updates an API secret for an API resource.

Examples​

Basic usage:

octo-cli -c UpdateApiSecretApiResource `
-n "myAPI" `
-s "sha256-value" `
-e "2026-12-31"

Options​

ShortLongRequiredDescription
-n--nameyesName of API resource
-s--secretValueyesValue sha256 encoded of the secret
-e--expirationDatenoExpiration date of secret
-d--descriptionnoDescription of API secret

Notes​

Writing API secrets needs the tenant role SecretManagement. TenantManagement or UserManagement still pass while the identity cluster runs with SecretManagementRoleEnforcement=Warn or RoleEnforcement=Warn; they are refused only when SecretManagementRoleEnforcement=Enforce and RoleEnforcement is not Warn. A refused call (HTTP 403) prints the message of the identity service, which names the missing role; without a message the generic access-denied text is shown.

-s is the stored hash as GetApiSecretsApiResource lists it. It is sent in the request body, never in the request URL. Requires an identity service of the later 3.5.x update or newer (an older one answers 405).