API ReferenceSecret Store

Get secret metadata

Gets one secret metadata record. Secret value is not returned. Requires scope: secret-store.read.

Authentication

AuthorizationBearer

IBEE platform API token. Production tokens start with ibee_prod_key_; development tokens start with ibee_dev_key_. Use a token only with its matching gateway environment.

Path parameters

secret_idstringRequired
Secret ID.

Query parameters

workspace_idstringRequiredformat: "^[1-9][0-9]*$">=1 character

The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.

Response

Secret returned successfully.
idstringOptional
organization_idstringOptional
workspace_idstringOptional
store_idstringOptional
store_keystringOptional
secret_namestringOptional
statusenumOptional
created_atdatetimeOptional
updated_atdatetimeOptional

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error