Syteca ACB REST API endpoint to retrieve a secret’s metadata — type, name, description, rotation config, check-out config, heartbeat status, permissions — but NOT the password value.
GET
/
api
/
secrets
/
{id}
Get secret by ID
curl --request GET \
--url https://your-syteca-host/SytecaACB/api/secrets/{id} \
--header 'Authorization: <api-key>'
Retrieves a secret’s full metadata — type, target, configuration, last-rotation status, heartbeat status, permissions. Does NOT return the actual password value — use GET /api/secrets/{id}/password for credentials.
For ACB deployments updated from a version prior to 1.2, switch to the https://{hostname}/EkranACB server in the Playground.
Where to get the Secret ID
The Secret ID is visible on the Automation tab of the Edit Secret page — see Find the Secret ID.
Permissions required
The user owning the Access Token must have at least PAM User role on the secret.
New fields in v1.4
The response now includes five password-status fields beyond the v1.3 baseline:
403 Forbidden — user lacks at least PAM User role.
404 Not Found — secret doesn’t exist or isn’t visible.
Related
Get secret credentials
Retrieve the actual password value.
Add secret
Create a new secret.
Heartbeat
Trigger a password validity check.
Data models
SecretPasswordlessResponseDto schema.
Authorizations
Authorization
string
header
required
Access token for authentication
Path Parameters
id
integer<int32>
required
The ID of the secret to retrieve
Required range: x >= 1
Response
Secret retrieved successfully
id
integer<int32>
required
Unique identifier of the secret
name
string
required
Name of the secret
type
enum<string>
required
Type of secret
Available options:
None,
UnixAccountSSH,
UnixAccountTelnet,
WindowsAccount,
ADAccount,
WebAccount,
MSSQLAccount
login
string
required
Login username
description
string
Description of the secret
parent_folder_id
integer<int32>
ID of the parent folder
domain
string
Domain for AD accounts
computer_name
string
Computer name for Windows/Unix accounts
url
string
URL for web accounts
server
string
Server for database accounts
computers
string[]
List of computers
file_transfer
object
Show child attributes
rotation
object
Show child attributes
record_activities
boolean
Whether to record activities for this secret
check_out
object
Show child attributes
require_approval
object
Show child attributes
permissions
object
Show child attributes
check_password
object
Show child attributes
check_password_status
enum<string>
Status of the last password check (heartbeat)
Available options:
None,
Valid,
Invalid,
Failed
last_password_check_utc
string<date-time> | null
UTC timestamp of the last password check
password_rotation_status
enum<string>
Status of password rotation
Available options:
Disabled,
Enabled,
Failed
last_password_rotation_utc
string<date-time> | null
UTC timestamp of the last password rotation
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Syteca","description":"Syteca documentation - User Activity Monitoring and Privileged Access Management in a single platform.","colors":{"primary":"#2563EB","light":"#5B8DEF","dark":"#1D4ED8"},"logo":{"light":"https://mintcdn.com/syteca/ZVta4JfIcSnC47NX/logo/syteca-light.svg?fit=max\u0026auto=format\u0026n=ZVta4JfIcSnC47NX\u0026q=85\u0026s=154a18f69aa4aefa55de0de7669934c7","dark":"https://mintcdn.com/syteca/ZVta4JfIcSnC47NX/logo/syteca-dark.svg?fit=max\u0026auto=format\u0026n=ZVta4JfIcSnC47NX\u0026q=85\u0026s=07170d0c543f4264cca523f1b74b912e","href":"https://www.syteca.com/docs"},"favicon":"https://mintcdn.com/syteca/0FlD-vkHsBA1azVX/favicon.ico?fit=max\u0026auto=format\u0026n=0FlD-vkHsBA1azVX\u0026q=85\u0026s=6c6a5b9e7da5f386c9d031d55704987a","appearance":{"default":"system","strict":false},"background":{"decoration":"grid","color":{"light":"#FFFFFF","dark":"#0B0D12"}},"navbar":{"links":[{"href":"https://www.syteca.com/docs/release-notes/overview","label":"Changelog"},{"href":"https://www.syteca.com/docs/api/acb/api-reference","label":"API Reference"},{"href":"https://www.syteca.com/en/support/contact-support","label":"Support"}],"primary":{"type":"button","label":"Book a Demo","href":"https://www.syteca.com/en/book-a-demo"}},"footer":{"socials":{"youtube":"https://www.youtube.com/@syteca","linkedin":"https://www.linkedin.com/company/syteca.com"},"links":[{"header":"Product","items":[{"label":"Overview","href":"https://www.syteca.com/docs"},{"label":"Releases","href":"https://www.syteca.com/docs/release-notes/overview"},{"label":"Pricing","href":"https://syteca.com/pricing"}]},{"header":"Company","items":[{"label":"About","href":"https://www.syteca.com/en/company/about-us"}]},{"header":"Legal","items":[{"label":"Privacy","href":"https://syteca.com/privacy"},{"label":"Terms","href":"https://www.syteca.com/en/terms-of-use"}]}]},"search":{"prompt":"Syteca Documentation"},"seo":{"metatags":{"og:image":"https://www.syteca.com/og-default.png","og:site_name":"Syteca Docs","canonical":"https://www.syteca.com/docs"}},"fonts":{"heading":{"family":"Inter","weight":700},"body":{"family":"Inter","weight":400}},"icons":{"library":"lucide"},"styling":{"eyebrows":"section","codeblocks":"system","latex":false},"integrations":{"ga4":{"measurementId":"G-3SYH6XSJXQ"}},"errors":{"404":{"redirect":false}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"syteca","hasAudioNarration":false,"actualSubdomain":"syteca","customDomains":["syteca.com"],"gitSource":{"type":"github","owner":"syteca","repo":"syteca-docs-poc","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":false},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6afd11321c0e198c9c436271","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"Administration","count":97},{"language":"default","tag":"API \u0026 Integrations","count":84},{"language":"default","tag":"Application Credentials Broker","count":53},{"language":"default","tag":"Session Monitoring","count":43},{"language":"default","tag":"Endpoint Risk Control","count":31},{"language":"default","tag":"Endpoints","count":30},{"language":"default","tag":"Privileged Access Management","count":26},{"language":"default","tag":"Release Notes","count":24},{"language":"default","tag":"Get Started","count":18},{"language":"default","tag":"Syteca changelog","count":18}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":":root{--syteca-brand: #2563EB;--syteca-brand-strong: #1D4ED8;--syteca-brand-soft: #EFF6FF;--syteca-accent-green: #16A34A;--syteca-accent-amber: #D97706;--syteca-accent-violet: #7C3AED;--syteca-accent-rose: #DB2777;--syteca-accent-cyan: #0891B2;--syteca-accent-teal: #0D9488}html.dark{--syteca-brand: #5B8DEF;--syteca-brand-strong: #7AA1F3;--syteca-brand-soft: #14213D}.prose h1{letter-spacing:-0.025em}.prose h2{letter-spacing:-0.015em}a[class*=\"rounded-\"][class*=\"border\"]:hover{transform:translateY(-1px);transition:transform 150ms ease, box-shadow 150ms ease, border-color 150ms ease}.prose pre,.prose code{font-family:\"JetBrains Mono\", \"SF Mono\", \"Menlo\", \"Consolas\", monospace}.prose table thead th{border-bottom:2px solid var(--syteca-brand);font-weight:600}.prose table tbody td{padding-top:0.55rem;padding-bottom:0.55rem}figure figcaption{font-size:13px;color:rgb(113 113 122 / 1);margin-top:0.6rem}nav[aria-label=\"Sidebar\"] a{padding-top:0.3rem;padding-bottom:0.3rem;font-size:13.5px}.demo-bar{display:none}"}],"page":{"pagePath":"api/acb/endpoints/get-secret","slug":"/api/acb/endpoints/get-secret","pageMetadata":{"title":"Get Secret","sidebarTitle":"GET /api/secrets/{id}","description":"Syteca ACB REST API endpoint to retrieve a secret's metadata — type, name, description, rotation config, check-out config, heartbeat status, permissions — but NOT the password value.","icon":"info","keywords":["acb get secret endpoint","syteca secret details api","secretpasswordlessresponsedto","secret metadata acb"],"openapi":"GET /api/secrets/{id}","href":"/api/acb/endpoints/get-secret"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Syteca ACB REST API endpoint to retrieve a secret’s metadata — type, name, description, rotation config, check-out config, heartbeat status, permissions — but NOT the password value.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Card,CardGroup,Heading,Note}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Retrieves a secret’s full metadata — type, target, configuration, last-rotation status, heartbeat status, permissions. `,_jsx(_components.strong,{children:`Does NOT return the actual password value`}),` — use `,_jsx(_components.a,{href:`/api/acb/endpoints/get-secret-credentials`,children:_jsx(_components.code,{children:`GET /api/secrets/{id}/password`})}),` for credentials.`]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`For ACB deployments updated from a version prior to 1.2, switch to the `,_jsx(_components.code,{children:`https://{hostname}/EkranACB`}),` server in the Playground.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`where-to-get-the-secret-id`,children:`Where to get the Secret ID`}),`\n`,_jsxs(_components.p,{children:[`The Secret ID is visible on the `,_jsx(_components.strong,{children:`Automation tab`}),` of the Edit Secret page — see `,_jsx(_components.a,{href:`/api/acb/secret-permissions#find-the-secret-id-and-folder-id`,children:`Find the Secret ID`}),`.`]}),`\n`,_jsx(Heading,{level:`3`,id:`permissions-required`,children:`Permissions required`}),`\n`,_jsxs(_components.p,{children:[`The user owning the Access Token must have at least `,_jsx(_components.strong,{children:`PAM User`}),` role on the secret.`]}),`\n`,_jsx(Heading,{level:`3`,id:`new-fields-in-v1-4`,children:`New fields in v1.4`}),`\n`,_jsx(_components.p,{children:`The response now includes five password-status fields beyond the v1.3 baseline:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`check_password`}),` — heartbeat configuration (`,_jsx(_components.a,{href:`/api/acb/data-models#checkpassword`,children:`CheckPassword`}),`)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`check_password_status`}),` — last heartbeat result (`,_jsx(_components.a,{href:`/api/acb/data-models#passwordcheckstatus`,children:`PasswordCheckStatus`}),`)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`last_password_check_utc`}),` — when the last heartbeat ran`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`password_rotation_status`}),` — current rotation state (`,_jsx(_components.a,{href:`/api/acb/data-models#passwordrotationstatus`,children:`PasswordRotationStatus`}),`)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`last_password_rotation_utc`}),` — when the password was last rotated`]}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`errors`,children:`Errors`}),`\n`,_jsxs(_components.p,{children:[`See `,_jsx(_components.a,{href:`/api/acb/api-reference#status-codes`,children:`Status codes`}),`. Common errors:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`403 Forbidden`}),` — user lacks at least PAM User role.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`404 Not Found`}),` — secret doesn’t exist or isn’t visible.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`related`,children:`Related`}),`\n`,_jsxs(CardGroup,{cols:2,children:[_jsx(Card,{title:`Get secret credentials`,icon:`key`,href:`/api/acb/endpoints/get-secret-credentials`,children:`Retrieve the actual password value.`}),_jsx(Card,{title:`Add secret`,icon:`plus`,href:`/api/acb/endpoints/add-secret`,children:`Create a new secret.`}),_jsx(Card,{title:`Heartbeat`,icon:`activity`,href:`/api/acb/endpoints/heartbeat`,children:`Trigger a password validity check.`}),_jsx(Card,{title:`Data models`,icon:`braces`,href:`/api/acb/data-models`,children:`SecretPasswordlessResponseDto schema.`})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":"system","config":{},"pageMetadata":{"title":"Get Secret","sidebarTitle":"GET /api/secrets/{id}","description":"Syteca ACB REST API endpoint to retrieve a secret's metadata — type, name, description, rotation config, check-out config, heartbeat status, permissions — but NOT the password value.","icon":"info","keywords":["acb get secret endpoint","syteca secret details api","secretpasswordlessresponsedto","secret metadata acb"],"openapi":"GET /api/secrets/{id}","href":"/api/acb/endpoints/get-secret"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Where to get the Secret ID","slug":"where-to-get-the-secret-id","depth":3,"children":[]},{"title":"Permissions required","slug":"permissions-required","depth":3,"children":[]},{"title":"New fields in v1.4","slug":"new-fields-in-v1-4","depth":3,"children":[]},{"title":"Errors","slug":"errors","depth":3,"children":[]},{"title":"Related","slug":"related","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Secrets"],"summary":"Get secret by ID","description":"Syteca ACB REST API endpoint to retrieve a secret's metadata — type, name, description, rotation config, check-out config, heartbeat status, permissions — but NOT the password value.","operationId":"getSecret","parameters":["bcd1b4a1-1cce-4061-8656-d24732801241"],"responses":{"200":"6fdd0cc0-c345-4e94-8f86-01e0e95a6a4d","403":"d1365d57-043a-4e1c-b4d6-916406c0baaa","404":"12a6449f-c924-408c-ac77-45ba51c5feb0"},"method":"get","type":"path","servers":["d0cce847-e56e-44e0-940e-172881ac3fdc","99b62726-8899-4713-9469-ab23c71ec912"],"security":["b5236216-b497-48c4-bbeb-1690b4b49bee"],"path":"/api/secrets/{id}","baseUrlOptions":["https://your-syteca-host/SytecaACB","https://your-syteca-host/EkranACB"],"title":"Get secret by ID","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"bcd1b4a1-1cce-4061-8656-d24732801241":{"name":"id","in":"path","required":true,"description":"The ID of the secret to retrieve","schema":{"type":"integer","format":"int32","minimum":1,"isRequired":true,"description":"The ID of the secret to retrieve","uniqueKey":"","typeLabel":"integer\u003cint32>"}}},"responses":{"6fdd0cc0-c345-4e94-8f86-01e0e95a6a4d":{"description":"Secret retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"Unique identifier of the secret","isRequired":true,"uniqueKey":"id","typeLabel":"integer\u003cint32>"},"name":{"type":"string","description":"Name of the secret","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"type":{"type":"string","enum":["None","UnixAccountSSH","UnixAccountTelnet","WindowsAccount","ADAccount","WebAccount","MSSQLAccount"],"description":"Type of secret","isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"login":{"type":"string","description":"Login username","isRequired":true,"uniqueKey":"login","typeLabel":"string"},"description":{"type":"string","description":"Description of the secret","uniqueKey":"description","typeLabel":"string"},"parent_folder_id":{"type":"integer","format":"int32","description":"ID of the parent folder","uniqueKey":"parent_folder_id","typeLabel":"integer\u003cint32>"},"domain":{"type":"string","description":"Domain for AD accounts","uniqueKey":"domain","typeLabel":"string"},"computer_name":{"type":"string","description":"Computer name for Windows/Unix accounts","uniqueKey":"computer_name","typeLabel":"string"},"url":{"type":"string","description":"URL for web accounts","uniqueKey":"url","typeLabel":"string"},"server":{"type":"string","description":"Server for database accounts","uniqueKey":"server","typeLabel":"string"},"computers":{"type":"array","items":{"type":"string","uniqueKey":"computers.items.[INDEX]","typeLabel":"string"},"description":"List of computers","uniqueKey":"computers","typeLabel":"string[]"},"file_transfer":{"type":"object","properties":{"protocol":{"type":"string","enum":["Sftp","Scp","Ftp"],"description":"File transfer protocol","isRequired":true,"uniqueKey":"file_transfer.protocol","typeLabel":"enum\u003cstring>"},"port":{"type":"integer","format":"int32","minimum":0,"maximum":65535,"default":22,"description":"Port number for file transfer","isRequired":true,"uniqueKey":"file_transfer.port","typeLabel":"integer\u003cint32>"}},"required":["protocol","port"],"uniqueKey":"file_transfer","typeLabel":"object"},"rotation":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether rotation is enabled","isRequired":true,"uniqueKey":"rotation.enabled","typeLabel":"boolean"},"rotate_every_min":{"type":"integer","format":"int32","minimum":1,"description":"Rotation interval in minutes","isRequired":true,"uniqueKey":"rotation.rotate_every_min","typeLabel":"integer\u003cint32>"}},"required":["enabled","rotate_every_min"],"uniqueKey":"rotation","typeLabel":"object"},"record_activities":{"type":"boolean","description":"Whether to record activities for this secret","uniqueKey":"record_activities","typeLabel":"boolean"},"check_out":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether check-out is enabled","isRequired":true,"uniqueKey":"check_out.enabled","typeLabel":"boolean"},"rotate_on_checkin":{"type":"boolean","description":"Whether to rotate password on check-in","isRequired":true,"uniqueKey":"check_out.rotate_on_checkin","typeLabel":"boolean"},"auto_checkin_after_min":{"type":"integer","format":"int32","default":60,"description":"Auto check-in timeout in minutes","isRequired":true,"uniqueKey":"check_out.auto_checkin_after_min","typeLabel":"integer\u003cint32>"}},"required":["enabled","rotate_on_checkin","auto_checkin_after_min"],"uniqueKey":"check_out","typeLabel":"object"},"require_approval":{"type":"object","properties":{"require_approval_type":{"type":"string","enum":["None","RequiredForAll","RequiredForOwners","RequiredForNonOwners"],"description":"Secret usage permission type","isRequired":true,"uniqueKey":"require_approval.require_approval_type","typeLabel":"enum\u003cstring>"},"approver_users":{"type":"array","items":{"type":"string","uniqueKey":"require_approval.approver_users.items.[INDEX]","typeLabel":"string"},"description":"List of approver users","uniqueKey":"require_approval.approver_users","typeLabel":"string[]"},"approver_user_groups":{"type":"array","items":{"type":"string","uniqueKey":"require_approval.approver_user_groups.items.[INDEX]","typeLabel":"string"},"description":"List of approver user groups","uniqueKey":"require_approval.approver_user_groups","typeLabel":"string[]"},"require_owners_and_approvers":{"type":"boolean","default":false,"description":"Whether to require both owners and approvers","uniqueKey":"require_approval.require_owners_and_approvers","typeLabel":"boolean"},"working_dates":{"type":"object","properties":{"from":{"type":"string","format":"date-time","description":"Start date","isRequired":true,"uniqueKey":"require_approval.working_dates.from","typeLabel":"string\u003cdate-time>"},"to":{"type":"string","format":"date-time","description":"End date","isRequired":true,"uniqueKey":"require_approval.working_dates.to","typeLabel":"string\u003cdate-time>"}},"required":["from","to"],"uniqueKey":"require_approval.working_dates","typeLabel":"object"},"working_hours":{"type":"object","properties":{"from":{"type":"string","format":"time","description":"Start time","isRequired":true,"uniqueKey":"require_approval.working_hours.from","typeLabel":"string\u003ctime>"},"to":{"type":"string","format":"time","description":"End time","isRequired":true,"uniqueKey":"require_approval.working_hours.to","typeLabel":"string\u003ctime>"}},"required":["from","to"],"uniqueKey":"require_approval.working_hours","typeLabel":"object"},"working_days":{"type":"array","items":{"type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"description":"Day of the week","uniqueKey":"require_approval.working_days.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Working days of the week","uniqueKey":"require_approval.working_days","typeLabel":"enum\u003cstring>[]"}},"required":["require_approval_type"],"uniqueKey":"require_approval","typeLabel":"object"},"permissions":{"type":"object","properties":{"inherit_users_and_roles":{"type":"boolean","default":false,"description":"Whether to inherit users and roles from parent","uniqueKey":"permissions.inherit_users_and_roles","typeLabel":"boolean"},"inherit_features":{"type":"boolean","default":false,"description":"Whether to inherit features from parent","uniqueKey":"permissions.inherit_features","typeLabel":"boolean"},"users":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"User or group name","isRequired":true,"uniqueKey":"permissions.users.items.[INDEX].name","typeLabel":"string"},"access_type":{"type":"string","enum":["None","PAMUser","Owner","Viewer"],"description":"Secret permission type","isRequired":true,"uniqueKey":"permissions.users.items.[INDEX].access_type","typeLabel":"enum\u003cstring>"},"features":{"type":"array","items":{"type":"string","enum":["CopyPassword","ViewPassword","FileTransfer"],"description":"Additional features for permissions","uniqueKey":"permissions.users.items.[INDEX].features.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Additional features granted","uniqueKey":"permissions.users.items.[INDEX].features","typeLabel":"enum\u003cstring>[]"}},"required":["name","access_type"],"uniqueKey":"permissions.users.items.[INDEX]","typeLabel":"object"},"description":"User permissions","uniqueKey":"permissions.users","typeLabel":"object[]"},"user_groups":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"User or group name","isRequired":true,"uniqueKey":"permissions.user_groups.items.[INDEX].name","typeLabel":"string"},"access_type":{"type":"string","enum":["None","PAMUser","Owner","Viewer"],"description":"Secret permission type","isRequired":true,"uniqueKey":"permissions.user_groups.items.[INDEX].access_type","typeLabel":"enum\u003cstring>"},"features":{"type":"array","items":{"type":"string","enum":["CopyPassword","ViewPassword","FileTransfer"],"description":"Additional features for permissions","uniqueKey":"permissions.user_groups.items.[INDEX].features.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Additional features granted","uniqueKey":"permissions.user_groups.items.[INDEX].features","typeLabel":"enum\u003cstring>[]"}},"required":["name","access_type"],"uniqueKey":"permissions.user_groups.items.[INDEX]","typeLabel":"object"},"description":"User group permissions","uniqueKey":"permissions.user_groups","typeLabel":"object[]"}},"uniqueKey":"permissions","typeLabel":"object"},"check_password":{"type":"object","properties":{"enabled":{"type":"boolean","default":false,"description":"Whether heartbeat password checking is enabled","isRequired":true,"uniqueKey":"check_password.enabled","typeLabel":"boolean"},"check_every":{"type":"integer","format":"int32","default":30,"description":"Interval for password check.","isRequired":true,"uniqueKey":"check_password.check_every","typeLabel":"integer\u003cint32>"},"check_period_type":{"type":"string","enum":["Minute","Hour","Day"],"description":"Period type for the password check interval","isRequired":true,"uniqueKey":"check_password.check_period_type","typeLabel":"enum\u003cstring>"}},"required":["enabled","check_every","check_period_type"],"uniqueKey":"check_password","typeLabel":"object"},"check_password_status":{"type":"string","enum":["None","Valid","Invalid","Failed"],"description":"Status of the last password check (heartbeat)","uniqueKey":"check_password_status","typeLabel":"enum\u003cstring>"},"last_password_check_utc":{"oneOf":[{"type":"string","format":"date-time","description":"UTC timestamp of the last password check","uniqueKey":"last_password_check_utc.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"UTC timestamp of the last password check","uniqueKey":"last_password_check_utc.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_password_check_utc","typeLabel":"string\u003cdate-time> | null"},"password_rotation_status":{"type":"string","enum":["Disabled","Enabled","Failed"],"description":"Status of password rotation","uniqueKey":"password_rotation_status","typeLabel":"enum\u003cstring>"},"last_password_rotation_utc":{"oneOf":[{"type":"string","format":"date-time","description":"UTC timestamp of the last password rotation","uniqueKey":"last_password_rotation_utc.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"UTC timestamp of the last password rotation","uniqueKey":"last_password_rotation_utc.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_password_rotation_utc","typeLabel":"string\u003cdate-time> | null"}},"required":["id","name","type","login"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":123,"name":"\u003cstring>","type":"None","login":"\u003cstring>","description":"\u003cstring>","parent_folder_id":123,"domain":"\u003cstring>","computer_name":"\u003cstring>","url":"\u003cstring>","server":"\u003cstring>","computers":["\u003cstring>"],"file_transfer":{"protocol":"Sftp","port":22},"rotation":{"enabled":true,"rotate_every_min":2},"record_activities":true,"check_out":{"enabled":true,"rotate_on_checkin":true,"auto_checkin_after_min":60},"require_approval":{"require_approval_type":"None","approver_users":["\u003cstring>"],"approver_user_groups":["\u003cstring>"],"require_owners_and_approvers":false,"working_dates":{"from":"2023-11-07T05:31:56Z","to":"2023-11-07T05:31:56Z"},"working_hours":{"from":"\u003cstring>","to":"\u003cstring>"},"working_days":["Sunday"]},"permissions":{"inherit_users_and_roles":false,"inherit_features":false,"users":[{"name":"\u003cstring>","access_type":"None","features":["CopyPassword"]}],"user_groups":[{"name":"\u003cstring>","access_type":"None","features":["CopyPassword"]}]},"check_password":{"enabled":false,"check_every":30,"check_period_type":"Minute"},"check_password_status":"None","last_password_check_utc":"2023-11-07T05:31:56Z","password_rotation_status":"Disabled","last_password_rotation_utc":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"d1365d57-043a-4e1c-b4d6-916406c0baaa":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"message":{"type":"string","description":"Error message","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["status","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":123,"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"12a6449f-c924-408c-ac77-45ba51c5feb0":{"description":"Secret not found","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"message":{"type":"string","description":"Error message","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["status","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":123,"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"b5236216-b497-48c4-bbeb-1690b4b49bee":{"AccessTokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Access token for authentication","scopes":[],"schemeName":"AccessTokenAuth"}}},"servers":{"d0cce847-e56e-44e0-940e-172881ac3fdc":{"url":"https://your-syteca-host/SytecaACB","description":"On-premises Syteca ACB service (v1.2 or later)","variables":{"hostname":{"default":"your-syteca-host.example.com","description":"Your Syteca Application Server hostname"}}},"99b62726-8899-4713-9469-ab23c71ec912":{"url":"https://your-syteca-host/EkranACB","description":"Legacy URL prefix for ACB deployments updated from pre-v1.2","variables":{"hostname":{"default":"your-syteca-host.example.com","description":"Your Syteca Application Server hostname"}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","description":"Access token for authentication","scopes":[],"schemeName":"AccessTokenAuth"},"schema":{"title":"Authorization","type":"string","description":"Access token for authentication","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"AccessTokenAuth","name":"Authorization"}],"title":"AccessTokenAuth"}]},"originalFileLocation":"api-specs/acb-secrets.yaml"},"subdomain":"syteca","siteName":"Syteca","title":"Get Secret - Syteca","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-10T08:34:20.410Z","originalFileLocation":"api/acb/endpoints/get-secret.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Syteca ACB REST API endpoint to retrieve a secret\u0026#x27;s metadata — type, name, description, rotation config, check-out config, heartbeat status, permissions — but NOT the password value.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Syteca\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/syteca/6kVJ1RNAbG010Toj/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/syteca/6kVJ1RNAbG010Toj/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/syteca/6kVJ1RNAbG010Toj/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/syteca/6kVJ1RNAbG010Toj/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/syteca/6kVJ1RNAbG010Toj/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/syteca/6kVJ1RNAbG010Toj/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/syteca/6kVJ1RNAbG010Toj/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/syteca/6kVJ1RNAbG010Toj/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/syteca/6kVJ1RNAbG010Toj/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Secret - Syteca\">\u003cmeta data-mint-head property=\"og:description\" content=\"Syteca ACB REST API endpoint to retrieve a secret\u0026#x27;s metadata — type, name, description, rotation config, check-out config, heartbeat status, permissions — but NOT the password value.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Syteca Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.syteca.com/docs/api/acb/endpoints/get-secret\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://www.syteca.com/og-default.png\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get Secret - Syteca\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Syteca ACB REST API endpoint to retrieve a secret\u0026#x27;s metadata — type, name, description, rotation config, check-out config, heartbeat status, permissions — but NOT the password value.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://www.syteca.com/og-default.png\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/syteca/6kVJ1RNAbG010Toj/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Syteca\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2563EB\">\u003clink data-mint-head rel=\"canonical\" href=\"https://www.syteca.com/docs/api/acb/endpoints/get-secret\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api/acb/endpoints/get-secret.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.syteca.com/#organization\",\"name\":\"Syteca\",\"url\":\"https://www.syteca.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/syteca/ZVta4JfIcSnC47NX/logo/syteca-light.svg?fit=max\u0026auto=format\u0026n=ZVta4JfIcSnC47NX\u0026q=85\u0026s=154a18f69aa4aefa55de0de7669934c7\"}},{\"@type\":\"WebSite\",\"@id\":\"https://www.syteca.com/docs#website\",\"name\":\"Syteca\",\"url\":\"https://www.syteca.com/docs\",\"publisher\":{\"@id\":\"https://www.syteca.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://www.syteca.com/docs/api/acb/endpoints/get-secret#webpage\",\"url\":\"https://www.syteca.com/docs/api/acb/endpoints/get-secret\",\"name\":\"Get Secret\",\"description\":\"Syteca ACB REST API endpoint to retrieve a secret's metadata — type, name, description, rotation config, check-out config, heartbeat status, permissions — but NOT the password value.\",\"dateModified\":\"2026-08-10T08:34:20.410Z\",\"isPartOf\":{\"@id\":\"https://www.syteca.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.syteca.com/docs/api/acb/endpoints/get-secret#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.syteca.com/docs/api/acb/endpoints/get-secret#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Application Credentials Broker\",\"item\":\"https://www.syteca.com/docs/api/acb/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Endpoints\",\"item\":\"https://www.syteca.com/docs/api/acb/endpoints/get-access-token\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get Secret\",\"item\":\"https://www.syteca.com/docs/api/acb/endpoints/get-secret\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://www.syteca.com/docs/api/acb/endpoints/get-secret#apireference\",\"headline\":\"Get Secret\",\"name\":\"Get Secret\",\"description\":\"Syteca ACB REST API endpoint to retrieve a secret's metadata — type, name, description, rotation config, check-out config, heartbeat status, permissions — but NOT the password value.\",\"url\":\"https://www.syteca.com/docs/api/acb/endpoints/get-secret\",\"mainEntityOfPage\":{\"@id\":\"https://www.syteca.com/docs/api/acb/endpoints/get-secret#webpage\"},\"image\":\"https://www.syteca.com/og-default.png\",\"dateModified\":\"2026-08-10T08:34:20.410Z\",\"keywords\":\"acb get secret endpoint, syteca secret details api, secretpasswordlessresponsedto, secret metadata acb\",\"publisher\":{\"@id\":\"https://www.syteca.com/#organization\"},\"isPartOf\":{\"@id\":\"https://www.syteca.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Syteca\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Syteca\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/api/acb/endpoints/get-secret.md","siteName":"Syteca","nav":{"global":null,"tabs":[{"tab":"Get Started","pages":[{"title":"Get Started","href":"/get-started/what-is-syteca"}]},{"tab":"Session Monitoring","pages":[{"title":"Session Monitoring","href":"/session-monitoring/overview"}]},{"tab":"Privileged Access Management","pages":[{"title":"Privileged Access Management","href":"/pam/overview"}]},{"tab":"Endpoint Risk Control","pages":[{"title":"Endpoint Risk Control","href":"/risk/overview"}]},{"tab":"Administration","pages":[{"title":"Administration","href":"/administration/overview"}]},{"tab":"API \u0026 Integrations","groups":[{"group":"Overview","pages":[{"title":"API \u0026 Integrations","sidebarTitle":"Overview","icon":"plug","href":"/api/overview"}]},{"group":"Application Credentials Broker","pages":[{"title":"Syteca Application Credentials Broker (ACB)","sidebarTitle":"Overview","icon":"key-square","href":"/api/acb/overview"},{"title":"Install the ACB Service","sidebarTitle":"Install","icon":"download","href":"/api/acb/install"},{"title":"Migrate to Client ID / Client Secret Authentication","sidebarTitle":"Migrate to Client ID / Client Secret","icon":"arrow-right-left","href":"/api/acb/migrate-to-client-credentials"},{"title":"Set Up a User Account for ACB","sidebarTitle":"Set up user account","icon":"user-plus","href":"/api/acb/setup-user-account"},{"title":"Edit Secret and Folder Permissions for ACB","sidebarTitle":"Secret permissions","icon":"lock-keyhole","href":"/api/acb/secret-permissions"},{"title":"Syteca ACB API Reference","sidebarTitle":"API reference","icon":"square-code","href":"/api/acb/api-reference"},{"title":"Syteca ACB Data Models","sidebarTitle":"Data models","icon":"braces","href":"/api/acb/data-models"},{"title":"Syteca ACB CLI Reference","sidebarTitle":"CLI","icon":"terminal","href":"/api/acb/cli"},{"title":"Rotate the Built-in Admin Password","sidebarTitle":"Admin password rotation","icon":"key-square","href":"/api/acb/admin-password-rotation"},{"group":"Endpoints","pages":[{"title":"Get Access Token","sidebarTitle":"POST /get_access_token","icon":"key-round","openapi":"POST /get_access_token","href":"/api/acb/endpoints/get-access-token"},{"title":"Get Bearer Access Token","sidebarTitle":"POST /api/token","icon":"key-round","openapi":"POST /api/token","href":"/api/acb/endpoints/get-api-token"},{"title":"Get Secret Details (Old)","sidebarTitle":"POST /get_secret_details","icon":"key","openapi":"POST /get_secret_details","href":"/api/acb/endpoints/get-secret-details"},{"title":"Get Folder","sidebarTitle":"GET /api/folders/{id}","icon":"folder-open","openapi":"GET /api/folders/{id}","href":"/api/acb/endpoints/get-folder"},{"title":"Add Folder","sidebarTitle":"POST /api/folders","icon":"folder-plus","openapi":"POST /api/folders","href":"/api/acb/endpoints/add-folder"},{"title":"Update Folder","sidebarTitle":"PATCH /api/folders/{id}","icon":"folder-pen","openapi":"PATCH /api/folders/{id}","href":"/api/acb/endpoints/update-folder"},{"title":"Delete Folder","sidebarTitle":"DELETE /api/folders/{id}","description":"Syteca ACB REST API endpoint to delete a folder. Requires the folder to be empty (no child folders or secrets).","icon":"folder-minus","openapi":"DELETE /api/folders/{id}","href":"/api/acb/endpoints/delete-folder"},{"title":"Get Secret","sidebarTitle":"GET /api/secrets/{id}","icon":"info","openapi":"GET /api/secrets/{id}","href":"/api/acb/endpoints/get-secret"},{"title":"Get Secret by Name","sidebarTitle":"GET /api/secrets","description":"Syteca ACB REST API endpoint to retrieve a secret by its name.","icon":"info","openapi":"GET /api/secrets","href":"/api/acb/endpoints/get-secret-name"},{"title":"Get Secret Credentials","sidebarTitle":"GET /api/secrets/{id}/password","icon":"key","openapi":"GET /api/secrets/{id}/password","href":"/api/acb/endpoints/get-secret-credentials"},{"title":"Add Secret","sidebarTitle":"POST /api/secrets","icon":"plus","openapi":"POST /api/secrets","href":"/api/acb/endpoints/add-secret"},{"title":"Update Secret","sidebarTitle":"PATCH /api/secrets/{id}","icon":"file-pen","openapi":"PATCH /api/secrets/{id}","href":"/api/acb/endpoints/update-secret"},{"title":"Delete Secret","sidebarTitle":"DELETE /api/secrets/{id}","icon":"trash","openapi":"DELETE /api/secrets/{id}","href":"/api/acb/endpoints/delete-secret"},{"title":"Rotate Secret Password","sidebarTitle":"POST /api/secrets/{id}/rotate-secret-password","icon":"refresh-ccw","openapi":"POST /api/secrets/{id}/rotate-secret-password","href":"/api/acb/endpoints/rotate-secret-password"},{"title":"Force Check-In","sidebarTitle":"POST /api/secrets/{id}/force-checkin","icon":"undo","openapi":"POST /api/secrets/{id}/force-checkin","href":"/api/acb/endpoints/force-checkin"},{"title":"Heartbeat (Check Password)","sidebarTitle":"POST /api/secrets/{id}/heartbeat","icon":"activity","openapi":"POST /api/secrets/{id}/heartbeat","href":"/api/acb/endpoints/heartbeat"},{"title":"Bulk Add Secrets and Folders","sidebarTitle":"POST /api/bulk/add-secrets-and-folders","icon":"layers","openapi":"POST /api/bulk/add-secrets-and-folders","href":"/api/acb/endpoints/bulk-add"},{"title":"Verify Admin Password","sidebarTitle":"POST /api/auth/verify","icon":"check","openapi":"POST /api/auth/verify","href":"/api/acb/endpoints/verify-password"}]},{"group":"Users","pages":[{"title":"Change Admin Password","sidebarTitle":"PUT /api/users/admin/password","icon":"refresh-ccw","openapi":"PUT /api/users/admin/password","href":"/api/acb/endpoints/change-admin-password"},{"title":"Create Internal User","sidebarTitle":"POST /api/user-management/users/internal","icon":"user-plus","openapi":"POST /api/user-management/users/internal","href":"/api/acb/endpoints/create-internal-user"},{"title":"Create Domain User","sidebarTitle":"POST /api/user-management/users/domain","icon":"user-cog","openapi":"POST /api/user-management/users/domain","href":"/api/acb/endpoints/create-domain-user"},{"title":"Get User Details","sidebarTitle":"GET /api/user-management/users/{userId}","icon":"user-search","openapi":"GET /api/user-management/users/{userId}","href":"/api/acb/endpoints/get-user-details"},{"title":"Delete User","sidebarTitle":"DELETE /api/user-management/users/{userId}","icon":"user-x","openapi":"DELETE /api/user-management/users/{userId}","href":"/api/acb/endpoints/delete-user"},{"title":"Update Admin Permissions","sidebarTitle":"PUT /api/user-management/users/{userId}/admin-permissions","icon":"shield-check","openapi":"PUT /api/user-management/users/{userId}/admin-permissions","href":"/api/acb/endpoints/update-admin-permissions"},{"title":"Update Client Access Permissions","sidebarTitle":"PUT /api/user-management/users/{userId}/client-access","icon":"laptop","openapi":"PUT /api/user-management/users/{userId}/client-access","href":"/api/acb/endpoints/update-client-access"},{"title":"Update User-to-User Access Permissions","sidebarTitle":"PUT /api/user-management/users/{userId}/user-access","icon":"users-round","openapi":"PUT /api/user-management/users/{userId}/user-access","href":"/api/acb/endpoints/update-user-access"},{"title":"Add User to Group","sidebarTitle":"POST /api/user-management/user-groups/{groupId}/users","icon":"users","openapi":"POST /api/user-management/user-groups/{groupId}/users","href":"/api/acb/endpoints/add-user-to-group"},{"title":"Remove User from Group","sidebarTitle":"DELETE /api/user-management/user-groups/{groupId}/users/{userId}","icon":"user-minus","openapi":"DELETE /api/user-management/user-groups/{groupId}/users/{userId}","href":"/api/acb/endpoints/remove-user-from-group"}]},{"group":"Folders","pages":[{"title":"Get folder by ID","deprecated":null,"version":null,"openapi":"/api-specs/acb-secrets.yaml get /api/folders/{id}","href":"/api-reference/folders/get-folder-by-id"},{"title":"Delete folder","deprecated":null,"version":null,"openapi":"/api-specs/acb-secrets.yaml delete /api/folders/{id}","href":"/api-reference/folders/delete-folder"},{"title":"Update folder","deprecated":null,"version":null,"openapi":"/api-specs/acb-secrets.yaml patch /api/folders/{id}","href":"/api-reference/folders/update-folder"},{"title":"Add new folder","deprecated":null,"version":null,"openapi":"/api-specs/acb-secrets.yaml post /api/folders","href":"/api-reference/folders/add-new-folder"}]},{"group":"Secrets","pages":[{"title":"Get secret by ID","deprecated":null,"version":null,"openapi":"/api-specs/acb-secrets.yaml get /api/secrets/{id}","href":"/api-reference/secrets/get-secret-by-id"},{"title":"Delete secret","deprecated":null,"version":null,"openapi":"/api-specs/acb-secrets.yaml delete /api/secrets/{id}","href":"/api-reference/secrets/delete-secret"},{"title":"Update secret","deprecated":null,"version":null,"openapi":"/api-specs/acb-secrets.yaml patch /api/secrets/{id}","href":"/api-reference/secrets/update-secret"},{"title":"Get secret credentials","deprecated":null,"version":null,"openapi":"/api-specs/acb-secrets.yaml get /api/secrets/{id}/password","href":"/api-reference/secrets/get-secret-credentials"},{"title":"Add new secret","deprecated":null,"version":null,"openapi":"/api-specs/acb-secrets.yaml post /api/secrets","href":"/api-reference/secrets/add-new-secret"},{"title":"Rotate secret password","deprecated":null,"version":null,"openapi":"/api-specs/acb-secrets.yaml post /api/secrets/{id}/rotate-secret-password","href":"/api-reference/secrets/rotate-secret-password"},{"title":"Force check-in secret","deprecated":null,"version":null,"openapi":"/api-specs/acb-secrets.yaml post /api/secrets/{id}/force-checkin","href":"/api-reference/secrets/force-check-in-secret"},{"title":"Check secret password (Heartbeat)","deprecated":null,"version":null,"openapi":"/api-specs/acb-secrets.yaml post /api/secrets/{id}/heartbeat","href":"/api-reference/secrets/check-secret-password-heartbeat"}]},{"group":"Bulk Operations","pages":[{"title":"Bulk add secrets and folders","deprecated":null,"version":null,"openapi":"/api-specs/acb-secrets.yaml post /api/bulk/add-secrets-and-folders","href":"/api-reference/bulk-operations/bulk-add-secrets-and-folders"}]},{"group":"Old Endpoints","pages":[{"title":"Exchange Refresh Token for Access Token","deprecated":null,"version":null,"openapi":"/api-specs/acb-secrets.yaml post /get_access_token","href":"/api-reference/old-endpoints/exchange-refresh-token-for-access-token"},{"title":"Get secret credentials (pre-v1.3 endpoint)","deprecated":null,"version":null,"openapi":"/api-specs/acb-secrets.yaml post /get_secret_details","href":"/api-reference/old-endpoints/get-secret-credentials-pre-v13-endpoint"}]},{"group":"Authentication","pages":[{"title":"Exchange Client ID / Client Secret for Access Token","deprecated":null,"version":null,"openapi":"/api-specs/acb-secrets.yaml post /api/token","href":"/api-reference/authentication/exchange-client-id-client-secret-for-access-token"}]}]},{"group":"Data Connector API","pages":[{"title":"Syteca API Data Connector","sidebarTitle":"Overview","icon":"plug-2","href":"/api/data-connector/overview"},{"title":"Install the Data Connector","sidebarTitle":"Install","icon":"download","href":"/api/data-connector/install"},{"title":"Manage the Data Connector","sidebarTitle":"Manage","icon":"settings","href":"/api/data-connector/manage"},{"title":"Syteca API Reference","sidebarTitle":"API reference","icon":"square-code","href":"/api/data-connector/api-reference"},{"group":"Endpoints","pages":[{"title":"List Clients","sidebarTitle":"GET /client","icon":"server","href":"/api/data-connector/endpoints/get-clients"},{"title":"List Sessions","sidebarTitle":"GET /sessions","icon":"list","href":"/api/data-connector/endpoints/get-sessions"},{"title":"List Sessions with Productivity","sidebarTitle":"POST /sessions","icon":"bar-chart-3","href":"/api/data-connector/endpoints/post-sessions"},{"title":"Application Statistics","sidebarTitle":"GET /statistics/getapp","icon":"app-window","href":"/api/data-connector/endpoints/get-application-statistics"},{"title":"URL Statistics","sidebarTitle":"GET /statistics/geturl","icon":"globe","href":"/api/data-connector/endpoints/get-url-statistics"},{"title":"List Users","sidebarTitle":"GET /user","icon":"users","href":"/api/data-connector/endpoints/get-users"},{"title":"User Productivity","sidebarTitle":"GET /user/getproductivity","icon":"user-check","href":"/api/data-connector/endpoints/get-user-productivity"},{"title":"List Alerts","sidebarTitle":"GET /alerts","icon":"bell-ring","href":"/api/data-connector/endpoints/get-alerts"},{"title":"List Endpoint Access Requests","sidebarTitle":"GET /AccessRequests/GetEndpointAccessRequests","icon":"shield-check","href":"/api/data-connector/endpoints/get-endpoint-access-requests"}]},{"title":"Power BI Report Templates and SSL/TLS Fix","sidebarTitle":"Power BI templates","icon":"chart-pie","href":"/api/data-connector/power-bi-example"}]},{"group":"SSO \u0026 LDAP","pages":[{"title":"SSO Integration","sidebarTitle":"Overview","icon":"key","href":"/administration/integrations/sso"},{"title":"Configure Azure SSO Integration","sidebarTitle":"Azure SSO","icon":"microsoft","href":"/administration/integrations/sso-azure"},{"title":"Configure Okta SSO Integration","sidebarTitle":"Okta SSO","icon":"shield","href":"/administration/integrations/sso-okta"},{"title":"Configure Google Workspace SSO","sidebarTitle":"Google Workspace SSO","icon":"key-round","href":"/administration/integrations/sso-google"},{"title":"Configure ForgeRock SSO Integration","sidebarTitle":"ForgeRock SSO","icon":"lock","href":"/administration/integrations/sso-forgerock"},{"title":"Configure Keycloak SSO Integration","sidebarTitle":"Keycloak SSO","icon":"key","href":"/administration/integrations/keycloak-sso"},{"title":"Add LDAP Targets Manually","sidebarTitle":"LDAP targets","icon":"network","href":"/administration/integrations/ldap-targets"},{"title":"Connect Microsoft Entra Domain Services (LDAPS)","sidebarTitle":"Entra ID Domain Services","icon":"cloud","href":"/administration/integrations/entra-id-domain-services"},{"title":"Configuring LDAP Integration in a Kerberos-Only Authentication Environment","sidebarTitle":"Kerberos-Only LDAP Integration","icon":"key-round","href":"/administration/integrations/kerberos-ldap-integration"}]},{"group":"SIEM \u0026 Ticketing systems","pages":[{"title":"SIEM Integration","sidebarTitle":"SIEM integration","icon":"file-text","href":"/administration/integrations/siem"},{"title":"Ticketing System Integration","sidebarTitle":"Ticketing system","icon":"ticket","href":"/administration/integrations/ticketing-system"},{"title":"API Bridge for Ticketing Systems","sidebarTitle":"API Bridge","icon":"webhook","href":"/api/integrations/api-bridge"},{"title":"Request a Session ID","sidebarTitle":"/connect","openapi":"api-spec/api-bridge-openapi.yaml POST /connect","href":"/api/integrations/connect"},{"title":"Get the Ticket Status","sidebarTitle":"/ticket-status","openapi":"api-spec/api-bridge-openapi.yaml GET /ticket-status","href":"/api/integrations/ticket-status"},{"title":"Add a Comment to a Ticket","sidebarTitle":"Add Comment","openapi":"api-spec/api-bridge-openapi.yaml POST /add-ticket-comment","href":"/api/integrations/add-ticket-comment"},{"title":"Configure Syteca Integration with Venn","sidebarTitle":"Venn Integration","icon":"app-window","href":"/administration/integrations/venn"}]}]},{"tab":"Release Notes","pages":[{"title":"Release Notes","href":"/release-notes/overview"}]},{"tab":"Resources","pages":[{"title":"Resources","href":"/resources/overview"}]}]},"basePath":"","title":"Get Secret - Syteca","deploymentId":"dpl_81ettUQ5G7NASN425B6JKU3FX1Rg","buildId":"dpl_81ettUQ5G7NASN425B6JKU3FX1Rg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-GKHRyhW5.js","utils-CXMoydtj.js","cloneDeep-Cl7CR73B.js","_Uint8Array-7sQhd3aE.js","isObject-FP1Yky1u.js","utils-ABJ_F6Yn.js","addUniqueKeysToSchema-B7v39GOQ.js","snippetPresets-CgibLHmh.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C2n3VqMC.js","isEqual-BKe3Q7nP.js","usePlaygroundInputsStore-Iji6acs6.js","shallow-Db9K5ulX.js","getApiPlaygroundDisplay-BGnJQBSj.js","CodeSnippet-DlQqWRja.js","CodeSnippets-JF3Bj6-U.js","Page-Ctn-BHcp.js","getPastedJson-B0pIrOza.js","icon-UPBYC1Wr.js","MethodPill-CoVRW5MG.js","DuplicateIcon-BuNnsqwg.js","createIcon-Cj9cJegl.js","DynamicMarkdown-C_R66tyH.js","SectionHeading-C6RB-y9f.js","axios-vUo_bRtp.js","Markdown-g2PbGssl.js","dist-DbZ3bm7k.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-BGnit25E.js"]}