# The Secret object

A secret stored in Unity Catalog. Secrets are three-level namespace objects
 (catalog.schema.secret) that securely store sensitive credential data such as
 passwords, tokens, and keys.

## Attributes

- `name` (string)
  The name of the secret, relative to its parent schema.
- `owner` (string)
  The owner of the secret. Defaults to the creating principal on creation. Can be updated to
   transfer ownership of the secret to another principal.
- `effective_owner` (string)
  The effective owner of the secret, which may differ from the directly-set **owner** due to
   inheritance.
- `metastore_id` (string)
  Unique identifier of the metastore hosting the secret.
- `create_time` (string)
  The time at which this secret was created.
- `created_by` (string)
  The principal that created the secret.
- `update_time` (string)
  The time at which this secret was last updated.
- `updated_by` (string)
  The principal that last updated the secret.
- `comment` (string)
  User-provided free-form text description of the secret.
  Constraints: `[ 1 .. 65536 ] characters`
- `full_name` (string)
  The three-level (fully qualified) name of the secret, in the form of **catalog_name.schema_name.secret_name**.
- `catalog_name` (string)
  The name of the catalog where the schema and the secret reside.
- `schema_name` (string)
  The name of the schema where the secret resides.
- `value` (string)
  The secret value to store. This field is input-only and is not returned in responses — use
   the **effective_value** field (via GetSecret with **include_value** set to true) to read the
   secret value. The maximum size is 60 KiB (pre-encryption). Accepted content includes
   passwords, tokens, keys, and other sensitive credential data.
  Constraints: `[ 1 .. 61440 ] characters`
- `effective_value` (string)
  The secret value. Only populated in responses when you have the **READ_SECRET**
   privilege and **include_value** is set to true in the request. The maximum size is 60 KiB.
  Constraints: `[ 1 .. 61440 ] characters`
- `expire_time` (string)
  User-provided expiration time of the secret. This field indicates when the secret should no
   longer be used and may be displayed as a warning in the UI. It is purely informational and
   does not trigger any automatic actions or affect the secret's lifecycle.

## Example

```json
{
  "name": "string",
  "owner": "string",
  "effective_owner": "string",
  "metastore_id": "string",
  "create_time": "string",
  "created_by": "string",
  "update_time": "string",
  "updated_by": "string",
  "comment": "string",
  "full_name": "string",
  "catalog_name": "string",
  "schema_name": "string",
  "value": "string",
  "effective_value": "string",
  "expire_time": "string"
}
```