v4

latestOpenAPI 3.0.32026-07-312,317012.2 MB
Secret Sharing

Access a shared secret by its ID. If the secret is password protected, you must provide the password in the request body. Returns the secret value if access is granted, or an error if access is denied. The endpoint requires authentication if the shared secret is scoped to an organization.

post/api/v1/shared-secrets/{id}/access

Path parameters

idstring required

The ID of the shared secret to access.

Request body

passwordstring

The password for accessing a password-protected shared secret. Only required if the secret is password protected.

Response

Default Response

idstring required
expiresAtstring date-time required
userIdstring uuid nullable
orgIdstring uuid nullable
createdAtstring date-time required
updatedAtstring date-time required
expiresAfterViewsnumber nullable
accessTypestring
namestring nullable
lastViewedAtstring date-time nullable
typestring
{"stackTrail":"paths:/api/v1/shared-secrets/{id}/access:post:responses:200:content:application/json:schema:properties:authorizedEmails","oasType":"schema","type":"unknown","nullable":true}
identityIdstring uuid nullable
allowExternalEmailsboolean nullable
orgNamestring
secretValuestring