Section ID:
DOC-API-MODEL-schema-1lhjc44i8n#overview
SecretMetadata
Metadata returned by secret read operations. Secret values are not included.
Meaning and usage
Section ID: DOC-API-MODEL-schema-1lhjc44i8n#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1lhjc44i8n#fields
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
Section ID: DOC-API-MODEL-schema-1lhjc44i8n#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1lhjc44i8n#field-nameSection ID: DOC-API-MODEL-schema-1lhjc44i8n#response-field-namename | string | Optional | Name identifying the secret within its project. |
Section ID: DOC-API-MODEL-schema-1lhjc44i8n#field-projectidSection ID: DOC-API-MODEL-schema-1lhjc44i8n#response-field-projectidprojectId | string | Optional | Identifier of the project within the tenant that scopes this secret. default identifies the default project. |
Section ID: DOC-API-MODEL-schema-1lhjc44i8n#field-descriptionSection ID: DOC-API-MODEL-schema-1lhjc44i8n#response-field-descriptiondescription | string | Optional | Human-readable explanation of the secret. |
Section ID: DOC-API-MODEL-schema-1lhjc44i8n#field-labelsSection ID: DOC-API-MODEL-schema-1lhjc44i8n#response-field-labelslabels | Map from string to string | Optional | Free-form labels used to organize and identify secrets. Free-form, e.g. {"kind": "mcp-auth"}. |
Section ID: DOC-API-MODEL-schema-1lhjc44i8n#field-versionSection ID: DOC-API-MODEL-schema-1lhjc44i8n#response-field-versionversion | string (int64) | Optional | Version number of the stored secret metadata. Increments on every PutSecret. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1lhjc44i8n#field-createdbySection ID: DOC-API-MODEL-schema-1lhjc44i8n#response-field-createdbycreatedBy | string | Optional | Subject identifier recorded for the creator of this record. Subject from the X-User-ID header, when present. |
Section ID: DOC-API-MODEL-schema-1lhjc44i8n#field-createdatSection ID: DOC-API-MODEL-schema-1lhjc44i8n#response-field-createdatcreatedAt | string (date-time) | Optional | Time this record was created. |
Section ID: DOC-API-MODEL-schema-1lhjc44i8n#field-updatedatSection ID: DOC-API-MODEL-schema-1lhjc44i8n#response-field-updatedatupdatedAt | string (date-time) | Optional | Time this record was most recently updated. |
Where used
Section ID: DOC-API-MODEL-schema-1lhjc44i8n#where-used
| Reference | Relationship |
|---|---|
| Get a secret's metadata | POST /api/v1/secrets/get-metadata |
| List secrets | POST /api/v1/secrets/list |
| Create or update a secret | POST /api/v1/secrets/put |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-1lhjc44i8n