This site is also used by our own engineers for API references.
This article explains how Client Secrets work in KDesk, including templates, secret records, access controls, reveal protection, ticket linking, and member permissions. What Client Secrets Are Client Secrets are secure operational records used to store sensitive client-facing or environment-specific information inside a workspace. They support structured fields, masked sensitive values,…
This article explains how Client Secrets work in KDesk, including templates, secret records, access controls, reveal protection, ticket linking, and member permissions.
Client Secrets are secure operational records used to store sensitive client-facing or environment-specific information inside a workspace. They support structured fields, masked sensitive values, restricted access, and ticket linkage so teams can keep high-risk data out of normal ticket comments and payloads.
Templates define the structure. Client Secret records hold the actual data and access policy.
Templates let a team standardize how secrets are stored. A template can include fields such as API keys, tenant identifiers, instructions, attachments, and recovery notes. Supported field types currently include Text, Choice, Message, and File.
Each field can be marked as required, and non-file fields can also be marked as sensitive. Sensitive fields stay masked by default and require an explicit reveal action later. File fields are stored on the Client Secret itself and are intentionally kept out of normal ticket payloads.
A Client Secret record starts from a template and adds the real operational data. Staff can set the name, description, active state, expiration date, related tickets, related contacts, static assignments, and dynamic access rules.
Client Secrets can also be linked to tickets so members working a ticket can find the relevant secure record from the ticket itself without copying the secret into comments or messages.
KDesk supports two access patterns for Client Secrets:
A Client Secret can also carry related tickets and related contacts, which are used by some of the dynamic rules.
Any matching dynamic rule can grant access. This makes Client Secrets useful for ticket-driven operations where the correct users change from one ticket to another.
Sensitive fields are never shown in plain text by default. Members must explicitly click Reveal to view them. If the workspace requires extra protection, KDesk can force an email verification step before reveal actions are allowed.
When reveal verification is enabled, KDesk sends a verification code to the member’s email address. The member enters that code to unlock reveal actions, and then they can reveal the requested sensitive field. This creates a tighter control point around high-risk data exposure.
Client Secrets can have an expiration date. Expiration helps teams identify credentials or operational values that should be rotated. Expired secrets can still remain in the system for tracking, but revealing an expired secret may be restricted to higher-permission users and may prompt for extra confirmation.
On a ticket, the Client Secrets panel shows the secrets relevant to that ticket when the feature is enabled and the member has access. Members can view fields, reveal sensitive values, download attached files, and link accessible secrets to the ticket when their permissions allow it.
This keeps operational context attached to the work item without forcing teams to expose secrets in comments, emails, or general ticket metadata.
The main Client Secrets page only appears when the workspace has Client Secrets enabled and the signed-in member has one of the Client Secret permissions above.
Team Settings includes three workspace-level controls for this module:
If you are documenting this for your team, the clearest explanation is: Client Secrets are structured secure records for operationally sensitive data. Templates define the field layout, secrets hold the real values, access can be direct or rule-based, and sensitive fields require an intentional reveal step instead of showing up automatically in ticket content.
This article explains how billing currently works in KD...
Form Template Builder The Form Template Builder is w...
This article explains how Approvals work for customers ...