Update credential secret

put

https://{example.com}/beyondtrust/api/public/v3/secrets-safe/secrets/{secretId}

Updates a secret based on the given ID.

Required Permission(s)

Any of the following:

Secrets Safe (Read)
Workforce Passwords (Read)

API Versions

Version 3.3 - Adds TOTP support for credential secrets
Version 3.1 - Using Owners collection
Version 3.0 - Using obsolete owner properties

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

secretId

uuid

required

ID of the secret

Query Params

version

string

Defaults to 3.0

API version for response format

Body Params

Model data with which to perform the operation

Description

string | null

Additional information relevant to the secret

Notes

string | null

Notes relevant to the secret

Owners

array of objects | null

List of owners of the secret

Owners

Password

string | null

Credential password

PasswordRuleID

int32 | null

0 to 32767

Password will be auto-generated using the specified password policy

Title

string

required

length between 0 and 256

Title of the secret

TotpEnabled

boolean | null

Whether a time-based one-time code (TOTP) is enabled for this credential. On update: null leaves the current setting unchanged, false disables it, true provisions or replaces it (requires TotpSecretKey)

TotpSecretKey

string | null

The TOTP secret key (Base32) or an otpauth:// URI. Required when TotpEnabled is true. Never returned in responses

Urls

array of objects | null

List of URLs relevant to the secret

Urls

Username

string

required

length between 0 and 256

Credential username

Headers

content-type

string

enum

Defaults to application/*+json

Generated from available request content types

Allowed:

Responses

204

No content when successful

400Invalid secret ID or request data

403Insufficient permissions to edit this secret

404Secret not found or not a credential secret