SECRET: Secret
The SECRET entity: A stored credential, API key, password, token, or other sensitive value.
Default definition. This article describes the default
SECRET definition shipped with DemandFlow. Administrators can add, remove, rename, or re-type fields, change which ones are required, and alter the layout from the Definitions screen in Settings. Your tenant's current schema may differ from what is shown here. To read the current definition at any time, GET the DEFINITION object whose id matches SECRET.Entity properties
| Property | Value |
|---|---|
| Entity code | SECRET |
| Display name | Secret |
| Plural | Secrets |
| Level | 560 |
Use cases
General-purpose secret records. A stored credential, API key, password, token, or other sensitive value.
Fields
Details
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Name |
secretType | enum | Yes | Type Valid ids: 1 (API Key), 2 (Password), 3 (Token), 4 (Certificate), 5 (Connection String), 6 (Other). |
status | enum | Yes | Status Valid ids: 1 (Active), 2 (Expired), 3 (Revoked), 4 (Rotated). |
description | text (multi-line) | Description |
Secret Value
| Field | Type | Required | Notes |
|---|---|---|---|
secretValue | password | Secret Value | |
url | text (URL) | URL / Endpoint | |
username | text | Username / Client ID | |
expiryDate | date | Expiry Date |
Additional panels
- Activity timeline panel attached.
Relationships
- No declared relationships in the default definition.
Creating a Secret via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "SECRET",
"level": 560,
"comboKey": "SUB:|ENT:",
"name": "Example name",
"secretType": "1",
"status": "1",
"description": "Example Description"
} Listing Secrets records
GET /v1/entities/SECRET/SUB