Configure a Management Tool user for ACB API access — Client ID, Client Secrets, Access Token Lifetime, IP Address restriction, and the legacy Refresh Token.
Before the ACB API can be called, you need a Management Tool user configured for external application access. From Syteca 7.28, that user authenticates with a Client ID and a Client Secret using the OAuth 2.0 Client Credentials flow. This page covers creating the user and configuring both the current and the legacy authentication methods.
NOT AVAILABLE IN SAAS. This procedure applies to on-premises deployments only.
Refresh Token authentication is deprecated. It continues to work for three months after you update the Application Server, then stops. New installations of 7.28 and later cannot use it at all. See Migrate to Client ID / Client Secret authentication.
Two account types, two use cases
The ACB API can authenticate against two different account types in Syteca:
Account type
Use case
Note
Application Account(any user type except Active Directory user group)
Standard ACB use — secret retrieval, folder management, rotation, bulk operations
Cannot rotate the default admin user’s password
Internal user or AD user with administrative User Management permission
Configured with the same Application Account Settings, plus the administrative User Management permission
Application Accounts can’t have administrative permissions like User Management — that’s intentional. To rotate the admin password, you need a regular Internal or AD user with that permission, and the same external-app toggle enabled.
The Password Management application (with the Automation feature) enabled in the product license serial key.
Without these three, the Automation tab won’t appear on the Edit Secret and Edit Folder pages — making secret IDs and folder IDs inaccessible.
The User Details tab, where both authentication methods are configured, is only accessible to users with the administrative User Management permission.
Create the user
1
Open the Users page
Sign in to the Management Tool as a user with the administrative User Management permission. Click Users in the left navigation.
For rotating the default admin user’s password, use an Internal or Active Directory user — Application Accounts can’t have the administrative User Management permission, which is required for the admin-password endpoints.
4
Configure user properties
Fill in the standard user fields (Login, password, etc.) as per the Add a user procedure.
Enable external application access
For an Internal or Active Directory user, the authentication sections only appear once you turn on the external-application toggle. For an Application Account, they are present by default.
1
Open the User Details tab
Open the user and go to the User Details tab.
2
Enable the toggle
In the Application Account Settings section, move the Allow this user account to be used by external applications toggle to the right.The Client ID / Client Secret authentication and Refresh Token-Based Authentication sections appear. Turning the toggle off hides both again.
Configure Client ID and Client Secret
The Client ID / Client Secret authentication section with two configured Client Secrets.
The Client ID
Each account gets one Client ID, generated automatically. It never changes and cannot be edited. Use the Copy icon to copy it.
The Client Secrets grid
Column
Shows
Name
The secret’s name. Must be unique among the Client Secrets accessible to you.
Description
Free-text description, up to 1000 characters.
Generated Date
When the secret was created.
Expiration Date
When the secret stops working.
Actions
Rotate, Edit, and Remove.
An account can hold any number of Client Secrets. Remove All deletes every secret on the account.
Name uniqueness is scoped to what you can see. If a Client Secret with the same name exists but isn’t accessible to you, you can still create one with that name.
Add a Client Secret
1
Click Add Secret
In the Client ID / Client Secret authentication section, click Add Secret. The Add Client Secret window opens.
2
Name the secret
Name is required. Description is optional, up to 1000 characters. Name the secret after the system that will use it, so you know what breaks if you rotate it.
3
(Optional) Restrict by IP address
IP Address restriction limits this secret to specific addresses. Separate multiple addresses with a semicolon (;). Requests from any other address are rejected with 403 Forbidden.
4
Set the Access Token Lifetime
Access Token Lifetime (minutes) controls how long each issued Access Token stays valid. It is required, defaults to 15 minutes, and has a minimum of 1 minute.
This field is in minutes. The legacy Authorization token lifetime field in the Refresh Token section is in seconds. Both can be visible on this tab during the transition period.
5
Set the expiry date
Valid until defaults to today plus 30 days. The minimum validity period is 1 day and the maximum is 365 days. Pick a date with the calendar icon, or type it in the date format configured in the Management Tool.The secret stays valid until 23:59:59 on the selected date, in the Application Server’s time zone.
6
Save
Click Save. The Client Secret Generated window opens with the new secret.
The Client Secret is shown once and never again. Copy it from the Client Secret Generated window and store it in a secrets vault before closing. It is held in the database in encrypted form only, and nobody can retrieve it afterwards, including administrators. If you lose it, rotate the secret and update the consuming application.
Rotate, edit, and remove
Action
What happens
Rotate
Generates a new Client Secret and shows it once in the Client Secret Generated window. The old secret becomes invalid immediately.
Edit
Lets you change Name, IP Address restriction, and Access Token Lifetime. Valid until is read-only. To extend validity, rotate the secret instead.
Remove
Asks for confirmation, then deletes the secret.
Rotating a Client Secret invalidates the old one the moment the new one is generated. Update the consuming application in the same maintenance window, or its API calls start failing with 401 Unauthorized.
How requests are validated
Services using a Client Secret validate the secret itself, plus the IP Address restriction and the expiry date configured on it.
Condition
Response
IP address not in the secret’s IP Address restriction
403 Forbidden
Client Secret has passed its Valid until date
401 Unauthorized
Client Secret was replaced by a rotation
401 Unauthorized
Client Secret doesn’t match the Client ID
401 Unauthorized
Account lockout
Authentication attempts with an invalid Client Secret count toward the account lockout threshold configured for the user, exactly as failed password attempts do in the Management Tool. Two lockout types behave differently:
Lockout
Existing Access Tokens
New Access Tokens
Automatic, from exceeding failed authentication attempts
Stay valid until they expire
Rejected
Manual, locking the user in the Management Tool
Invalidated immediately
Rejected
Rate limiting
API requests authenticated with Client ID / Client Secret are rate limited per Client ID, not per secret or per token. Every request made with the same Client ID counts toward one quota, no matter how many Client Secrets or active Access Tokens the account holds.
The Refresh Token is a long-lived credential exchanged for short-lived Access Tokens during API operation.
The Refresh Token-Based Authentication section, with the deprecation note shown at the top.
1
Copy the Refresh Token
Click the Copy icon next to the Refresh Token field.
Treat the Refresh Token like a password. Anyone with this token can obtain Access Tokens and call the API on this user’s behalf. Store it in a secrets vault, not in source control or pipeline config.
2
(Optional) Set Authorization token lifetime
Authorization token lifetime (sec) controls how long Access Tokens stay valid.
Value
Meaning
600(default)
Access Token valid for 10 minutes
Any positive integer
Access Token valid for that many seconds
0
Access Token never expires
3
(Optional) Restrict by IP address
The IP Address restriction field limits the API consumer to a specific IP address. Requests from any other IP return 403 Forbidden.
4
Save the user
Click Save to commit the changes.
What happens when the toggle is disabled
Disabling the Allow this user account to be used by external applications toggle:
Hides the Client ID / Client Secret and Refresh Token sections.
Expires the Refresh Token immediately. Any in-flight automation calling the API on behalf of this user starts failing with 401 Unauthorized.
Re-enabling the toggle generates a new Refresh Token — the old one is permanently invalid.
Where Client Secret activity is recorded
Record
Where
Adding, editing, rotating, and removing Client Secrets
Token generation, token usage, and rejected requests
The Application Server log file
Token security events are written to C:\Program Files\Ekran System\Ekran System\Server.log at INFO level.
Each entry records the timestamp, the User ID or Client ID, the requested endpoint, the source IP address, the result, and the rejection reason where one applies.
The transition period, what changes, and how to move each integration.
Secret permissions
Grant the user Owner / Editor / PAM User roles on specific secrets and folders.
Users page
Full reference for adding and editing Syteca users.
Administrative permissions
The permissions required for ACB API access.
API reference
Base URL, authentication, status codes.
{"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":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"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/setup-user-account","slug":"/api/acb/setup-user-account","pageMetadata":{"title":"Set Up a User Account for ACB","sidebarTitle":"Set up user account","description":"Configure a Management Tool user for ACB API access — Client ID, Client Secrets, Access Token Lifetime, IP Address restriction, and the legacy Refresh Token.","icon":"user-plus","keywords":["syteca acb user account","client id client secret","client credentials flow","access token lifetime","ip address restriction acb","refresh token deprecated","application account settings"],"href":"/api/acb/setup-user-account"},"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: \"Configure a Management Tool user for ACB API access — Client ID, Client Secrets, Access Token Lifetime, IP Address restriction, and the legacy Refresh Token.\"\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`,em:`em`,li:`li`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{Card,CardGroup,Frame,Heading,Note,OptimizedImage,Step,Steps,Table,Warning}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!Frame)_missingMdxReference(`Frame`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);if(!Step)_missingMdxReference(`Step`,true);if(!Steps)_missingMdxReference(`Steps`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Before the ACB API can be called, you need a Management Tool user configured for external application access. From Syteca 7.28, that user authenticates with a `,_jsx(_components.strong,{children:`Client ID`}),` and a `,_jsx(_components.strong,{children:`Client Secret`}),` using the OAuth 2.0 Client Credentials flow. This page covers creating the user and configuring both the current and the legacy authentication methods.`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`NOT AVAILABLE IN SAAS.`}),` This procedure applies to `,_jsx(_components.strong,{children:`on-premises`}),` deployments only.`]})}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Refresh Token authentication is deprecated.`}),` It continues to work for three months after you update the Application Server, then stops. New installations of 7.28 and later cannot use it at all. See `,_jsx(_components.a,{href:`/api/acb/migrate-to-client-credentials`,children:`Migrate to Client ID / Client Secret authentication`}),`.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`two-account-types-two-use-cases`,children:`Two account types, two use cases`}),`\n`,_jsx(_components.p,{children:`The ACB API can authenticate against two different account types in Syteca:`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Account type`}),_jsx(_components.th,{children:`Use case`}),_jsx(_components.th,{children:`Note`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`Application Account`}),` `,_jsx(_components.em,{children:`(any user type except Active Directory user group)`})]}),_jsx(_components.td,{children:`Standard ACB use — secret retrieval, folder management, rotation, bulk operations`}),_jsxs(_components.td,{children:[`Cannot rotate the default `,_jsx(_components.code,{children:`admin`}),` user’s password`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Internal user or AD user with administrative User Management permission`})}),_jsxs(_components.td,{children:[`For `,_jsxs(_components.a,{href:`/api/acb/admin-password-rotation`,children:[`rotating the default `,_jsx(_components.code,{children:`admin`}),` password`]}),` from an external secrets vault`]}),_jsxs(_components.td,{children:[`Configured with the same Application Account Settings, plus the `,_jsx(_components.strong,{children:`administrative User Management permission`})]})]})]})]}),`\n`,_jsxs(_components.p,{children:[`Application Accounts can’t have administrative permissions like User Management — that’s intentional. To rotate the `,_jsx(_components.code,{children:`admin`}),` password, you need a regular Internal or AD user with that permission, and the same external-app toggle enabled.`]}),`\n`,_jsx(Heading,{level:`2`,id:`prerequisites`,children:`Prerequisites`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`An `,_jsx(_components.a,{href:`/api/acb/install`,children:`installed and registered`}),` ACB service.`]}),`\n`,_jsxs(_components.li,{children:[`A Management Tool user with the `,_jsx(_components.a,{href:`/administration/users/administrative-permissions`,children:`administrative User Management permission`}),` to create or edit the API consumer account.`]}),`\n`,_jsxs(_components.li,{children:[`For the API consumer to actually work with secrets, the user also needs:`,`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`The `,_jsx(_components.a,{href:`/administration/users/administrative-permissions`,children:`administrative Privileged Accounts Management permission`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`A `,_jsx(_components.a,{href:`/administration/licensing/assign-pam-seat-licenses`,children:`PAM seat license assigned`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`The Password Management application (with the Automation feature) enabled in the `,_jsx(_components.a,{href:`/administration/licensing/manage-serial-key`,children:`product license serial key`}),`.`]}),`\n`]}),`\n`]}),`\n`]}),`\n`,_jsx(_components.p,{children:`Without these three, the Automation tab won’t appear on the Edit Secret and Edit Folder pages — making secret IDs and folder IDs inaccessible.`}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`The `,_jsx(_components.strong,{children:`User Details`}),` tab, where both authentication methods are configured, is only accessible to users with the administrative User Management permission.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`create-the-user`,children:`Create the user`}),`\n`,_jsxs(Steps,{children:[_jsx(Step,{title:`Open the Users page`,children:_jsxs(_components.p,{children:[`Sign in to the Management Tool as a user with the administrative User Management permission. Click `,_jsx(_components.strong,{children:`Users`}),` in the left navigation.`]})}),_jsx(Step,{title:`Click Add User`,children:_jsxs(_components.p,{children:[`Click the `,_jsx(_components.strong,{children:`Add User`}),` button in the top right.`]})}),_jsxs(Step,{title:`Pick the user type`,children:[_jsxs(_components.p,{children:[`Either `,_jsx(_components.a,{href:`/administration/users/users#add-a-user`,children:`add an Internal user or an Application Account user`}),`, or edit an existing `,_jsx(_components.strong,{children:`Active Directory`}),` user.`]}),_jsx(Note,{children:_jsxs(_components.p,{children:[`For rotating the default `,_jsx(_components.code,{children:`admin`}),` user’s password, use an `,_jsx(_components.strong,{children:`Internal`}),` or `,_jsx(_components.strong,{children:`Active Directory`}),` user — Application Accounts can’t have the administrative User Management permission, which is required for the admin-password endpoints.`]})})]}),_jsx(Step,{title:`Configure user properties`,children:_jsxs(_components.p,{children:[`Fill in the standard user fields (Login, password, etc.) as per the `,_jsx(_components.a,{href:`/administration/users/users#add-a-user`,children:`Add a user`}),` procedure.`]})})]}),`\n`,_jsx(Heading,{level:`2`,id:`enable-external-application-access`,children:`Enable external application access`}),`\n`,_jsxs(_components.p,{children:[`For an `,_jsx(_components.strong,{children:`Internal`}),` or `,_jsx(_components.strong,{children:`Active Directory`}),` user, the authentication sections only appear once you turn on the external-application toggle. For an `,_jsx(_components.strong,{children:`Application Account`}),`, they are present by default.`]}),`\n`,_jsxs(Steps,{children:[_jsx(Step,{title:`Open the User Details tab`,children:_jsxs(_components.p,{children:[`Open the user and go to the `,_jsx(_components.strong,{children:`User Details`}),` tab.`]})}),_jsxs(Step,{title:`Enable the toggle`,children:[_jsxs(_components.p,{children:[`In the `,_jsx(_components.strong,{children:`Application Account Settings`}),` section, move the `,_jsx(_components.strong,{children:`Allow this user account to be used by external applications`}),` toggle to the `,_jsx(_components.strong,{children:`right`}),`.`]}),_jsxs(_components.p,{children:[`The `,_jsx(_components.strong,{children:`Client ID / Client Secret authentication`}),` and `,_jsx(_components.strong,{children:`Refresh Token-Based Authentication`}),` sections appear. Turning the toggle off hides both again.`]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`configure-client-id-and-client-secret`,children:`Configure Client ID and Client Secret`}),`\n`,_jsx(Frame,{caption:`The Client ID / Client Secret authentication section with two configured Client Secrets.`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/syteca/LUJwc0utBuZe-r0K/images/api/acb/client-id-client-secret-section.png?fit=max\u0026auto=format\u0026n=LUJwc0utBuZe-r0K\u0026q=85\u0026s=144b97c8c2cbfee0fbe31fefae4931d1`,alt:`Client ID field, Remove All link, Add Secret button, and the Client Secrets grid showing name, description, generated date and expiration date`,\"data-og-width\":`1545`,width:`1545`,\"data-og-height\":`1173`,height:`1173`,\"data-path\":`images/api/acb/client-id-client-secret-section.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/syteca/LUJwc0utBuZe-r0K/images/api/acb/client-id-client-secret-section.png?w=280\u0026fit=max\u0026auto=format\u0026n=LUJwc0utBuZe-r0K\u0026q=85\u0026s=9b6449f867da57738c36112558a4f7eb 280w, https://mintcdn.com/syteca/LUJwc0utBuZe-r0K/images/api/acb/client-id-client-secret-section.png?w=560\u0026fit=max\u0026auto=format\u0026n=LUJwc0utBuZe-r0K\u0026q=85\u0026s=4df611a5025ce08f44f741ee654186be 560w, https://mintcdn.com/syteca/LUJwc0utBuZe-r0K/images/api/acb/client-id-client-secret-section.png?w=840\u0026fit=max\u0026auto=format\u0026n=LUJwc0utBuZe-r0K\u0026q=85\u0026s=42f7d8542cab839929290d69e0825369 840w, https://mintcdn.com/syteca/LUJwc0utBuZe-r0K/images/api/acb/client-id-client-secret-section.png?w=1100\u0026fit=max\u0026auto=format\u0026n=LUJwc0utBuZe-r0K\u0026q=85\u0026s=7dceb84e949ef1459f329390c5e87b13 1100w, https://mintcdn.com/syteca/LUJwc0utBuZe-r0K/images/api/acb/client-id-client-secret-section.png?w=1650\u0026fit=max\u0026auto=format\u0026n=LUJwc0utBuZe-r0K\u0026q=85\u0026s=bc144eac8cdc911d100173b6eedd9c42 1650w, https://mintcdn.com/syteca/LUJwc0utBuZe-r0K/images/api/acb/client-id-client-secret-section.png?w=2500\u0026fit=max\u0026auto=format\u0026n=LUJwc0utBuZe-r0K\u0026q=85\u0026s=c8a544bbf91e4f48302495b84d368dfc 2500w`})}),`\n`,_jsx(Heading,{level:`3`,id:`the-client-id`,children:`The Client ID`}),`\n`,_jsxs(_components.p,{children:[`Each account gets one Client ID, generated automatically. It never changes and cannot be edited. Use the `,_jsx(_components.strong,{children:`Copy`}),` icon to copy it.`]}),`\n`,_jsx(Heading,{level:`3`,id:`the-client-secrets-grid`,children:`The Client Secrets grid`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Column`}),_jsx(_components.th,{children:`Shows`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Name`})}),_jsx(_components.td,{children:`The secret’s name. Must be unique among the Client Secrets accessible to you.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Description`})}),_jsx(_components.td,{children:`Free-text description, up to 1000 characters.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Generated Date`})}),_jsx(_components.td,{children:`When the secret was created.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Expiration Date`})}),_jsx(_components.td,{children:`When the secret stops working.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Actions`})}),_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`Rotate`}),`, `,_jsx(_components.strong,{children:`Edit`}),`, and `,_jsx(_components.strong,{children:`Remove`}),`.`]})]})]})]}),`\n`,_jsxs(_components.p,{children:[`An account can hold any number of Client Secrets. `,_jsx(_components.strong,{children:`Remove All`}),` deletes every secret on the account.`]}),`\n`,_jsx(Note,{children:_jsx(_components.p,{children:`Name uniqueness is scoped to what you can see. If a Client Secret with the same name exists but isn’t accessible to you, you can still create one with that name.`})}),`\n`,_jsx(Heading,{level:`3`,id:`add-a-client-secret`,children:`Add a Client Secret`}),`\n`,_jsxs(Steps,{children:[_jsx(Step,{title:`Click Add Secret`,children:_jsxs(_components.p,{children:[`In the `,_jsx(_components.strong,{children:`Client ID / Client Secret authentication`}),` section, click `,_jsx(_components.strong,{children:`Add Secret`}),`. The `,_jsx(_components.strong,{children:`Add Client Secret`}),` window opens.`]})}),_jsx(Step,{title:`Name the secret`,children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Name`}),` is required. `,_jsx(_components.strong,{children:`Description`}),` is optional, up to 1000 characters. Name the secret after the system that will use it, so you know what breaks if you rotate it.`]})}),_jsx(Step,{title:`(Optional) Restrict by IP address`,children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`IP Address restriction`}),` limits this secret to specific addresses. Separate multiple addresses with a semicolon (`,_jsx(_components.code,{children:`;`}),`). Requests from any other address are rejected with `,_jsx(_components.strong,{children:`403 Forbidden`}),`.`]})}),_jsxs(Step,{title:`Set the Access Token Lifetime`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Access Token Lifetime (minutes)`}),` controls how long each issued Access Token stays valid. It is required, defaults to `,_jsx(_components.strong,{children:`15 minutes`}),`, and has a minimum of `,_jsx(_components.strong,{children:`1 minute`}),`.`]}),_jsx(Note,{children:_jsxs(_components.p,{children:[`This field is in `,_jsx(_components.strong,{children:`minutes`}),`. The legacy `,_jsx(_components.strong,{children:`Authorization token lifetime`}),` field in the Refresh Token section is in `,_jsx(_components.strong,{children:`seconds`}),`. Both can be visible on this tab during the transition period.`]})})]}),_jsxs(Step,{title:`Set the expiry date`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Valid until`}),` defaults to today plus 30 days. The minimum validity period is 1 day and the maximum is 365 days. Pick a date with the calendar icon, or type it in the date format configured in the Management Tool.`]}),_jsxs(_components.p,{children:[`The secret stays valid until `,_jsx(_components.strong,{children:`23:59:59`}),` on the selected date, in the Application Server’s time zone.`]})]}),_jsx(Step,{title:`Save`,children:_jsxs(_components.p,{children:[`Click `,_jsx(_components.strong,{children:`Save`}),`. The `,_jsx(_components.strong,{children:`Client Secret Generated`}),` window opens with the new secret.`]})})]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`The Client Secret is shown once and never again.`}),` Copy it from the `,_jsx(_components.strong,{children:`Client Secret Generated`}),` window and store it in a secrets vault before closing. It is held in the database in encrypted form only, and nobody can retrieve it afterwards, including administrators. If you lose it, rotate the secret and update the consuming application.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`rotate-edit-and-remove`,children:`Rotate, edit, and remove`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Action`}),_jsx(_components.th,{children:`What happens`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Rotate`})}),_jsxs(_components.td,{children:[`Generates a new Client Secret and shows it once in the `,_jsx(_components.strong,{children:`Client Secret Generated`}),` window. The old secret becomes invalid immediately.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Edit`})}),_jsxs(_components.td,{children:[`Lets you change `,_jsx(_components.strong,{children:`Name`}),`, `,_jsx(_components.strong,{children:`IP Address restriction`}),`, and `,_jsx(_components.strong,{children:`Access Token Lifetime`}),`. `,_jsx(_components.strong,{children:`Valid until`}),` is read-only. To extend validity, rotate the secret instead.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Remove`})}),_jsx(_components.td,{children:`Asks for confirmation, then deletes the secret.`})]})]})]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`Rotating a Client Secret invalidates the old one the moment the new one is generated. Update the consuming application in the same maintenance window, or its API calls start failing with `,_jsx(_components.strong,{children:`401 Unauthorized`}),`.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`how-requests-are-validated`,children:`How requests are validated`}),`\n`,_jsx(_components.p,{children:`Services using a Client Secret validate the secret itself, plus the IP Address restriction and the expiry date configured on it.`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Condition`}),_jsx(_components.th,{children:`Response`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`IP address not in the secret’s IP Address restriction`}),_jsx(_components.td,{children:_jsx(_components.strong,{children:`403 Forbidden`})})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[`Client Secret has passed its `,_jsx(_components.strong,{children:`Valid until`}),` date`]}),_jsx(_components.td,{children:_jsx(_components.strong,{children:`401 Unauthorized`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Client Secret was replaced by a rotation`}),_jsx(_components.td,{children:_jsx(_components.strong,{children:`401 Unauthorized`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Client Secret doesn’t match the Client ID`}),_jsx(_components.td,{children:_jsx(_components.strong,{children:`401 Unauthorized`})})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`account-lockout`,children:`Account lockout`}),`\n`,_jsx(_components.p,{children:`Authentication attempts with an invalid Client Secret count toward the account lockout threshold configured for the user, exactly as failed password attempts do in the Management Tool. Two lockout types behave differently:`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Lockout`}),_jsx(_components.th,{children:`Existing Access Tokens`}),_jsx(_components.th,{children:`New Access Tokens`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Automatic, from exceeding failed authentication attempts`}),_jsx(_components.td,{children:`Stay valid until they expire`}),_jsx(_components.td,{children:`Rejected`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Manual, locking the user in the Management Tool`}),_jsx(_components.td,{children:`Invalidated immediately`}),_jsx(_components.td,{children:`Rejected`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`rate-limiting`,children:`Rate limiting`}),`\n`,_jsxs(_components.p,{children:[`API requests authenticated with Client ID / Client Secret are rate limited `,_jsx(_components.strong,{children:`per Client ID`}),`, not per secret or per token. Every request made with the same Client ID counts toward one quota, no matter how many Client Secrets or active Access Tokens the account holds.`]}),`\n`,_jsx(Heading,{level:`2`,id:`legacy-refresh-token-based-authentication`,children:`Legacy: Refresh Token-based authentication`}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`This method is deprecated. It stops working three months after you update the Application Server, and is unavailable on new 7.28 installations. See `,_jsx(_components.a,{href:`/api/acb/migrate-to-client-credentials`,children:`Migrate to Client ID / Client Secret authentication`}),`.`]})}),`\n`,_jsxs(_components.p,{children:[`The `,_jsx(_components.strong,{children:`Refresh Token`}),` is a long-lived credential exchanged for short-lived Access Tokens during API operation.`]}),`\n`,_jsx(Frame,{caption:`The Refresh Token-Based Authentication section, with the deprecation note shown at the top.`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/syteca/LUJwc0utBuZe-r0K/images/api/acb/refresh-token-section.png?fit=max\u0026auto=format\u0026n=LUJwc0utBuZe-r0K\u0026q=85\u0026s=06bbdabd5128c6bb0f78ff33bb6dbbf3`,alt:`Refresh Token-Based Authentication section showing the deprecation note, Refresh Token field, Authorization token lifetime and IP Address restriction`,\"data-og-width\":`1137`,width:`1137`,\"data-og-height\":`971`,height:`971`,\"data-path\":`images/api/acb/refresh-token-section.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/syteca/LUJwc0utBuZe-r0K/images/api/acb/refresh-token-section.png?w=280\u0026fit=max\u0026auto=format\u0026n=LUJwc0utBuZe-r0K\u0026q=85\u0026s=a84d59ddaf2f1af21b4be4f68afa6d43 280w, https://mintcdn.com/syteca/LUJwc0utBuZe-r0K/images/api/acb/refresh-token-section.png?w=560\u0026fit=max\u0026auto=format\u0026n=LUJwc0utBuZe-r0K\u0026q=85\u0026s=cfd80349003448a068b9ea29a74b6b5b 560w, https://mintcdn.com/syteca/LUJwc0utBuZe-r0K/images/api/acb/refresh-token-section.png?w=840\u0026fit=max\u0026auto=format\u0026n=LUJwc0utBuZe-r0K\u0026q=85\u0026s=515bb11565463ff6382c0644fb1496c4 840w, https://mintcdn.com/syteca/LUJwc0utBuZe-r0K/images/api/acb/refresh-token-section.png?w=1100\u0026fit=max\u0026auto=format\u0026n=LUJwc0utBuZe-r0K\u0026q=85\u0026s=b0960f2276886c7180f7cbd559f4d744 1100w, https://mintcdn.com/syteca/LUJwc0utBuZe-r0K/images/api/acb/refresh-token-section.png?w=1650\u0026fit=max\u0026auto=format\u0026n=LUJwc0utBuZe-r0K\u0026q=85\u0026s=b00ee2e45a64c96ce9d7ccb68e9b2266 1650w, https://mintcdn.com/syteca/LUJwc0utBuZe-r0K/images/api/acb/refresh-token-section.png?w=2500\u0026fit=max\u0026auto=format\u0026n=LUJwc0utBuZe-r0K\u0026q=85\u0026s=93a37a52e16de8a187b1f9509fbf8904 2500w`})}),`\n`,_jsxs(Steps,{children:[_jsxs(Step,{title:`Copy the Refresh Token`,children:[_jsxs(_components.p,{children:[`Click the `,_jsx(_components.strong,{children:`Copy`}),` icon next to the `,_jsx(_components.strong,{children:`Refresh Token`}),` field.`]}),_jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Treat the Refresh Token like a password.`}),` Anyone with this token can obtain Access Tokens and call the API on this user’s behalf. Store it in a secrets vault, not in source control or pipeline config.`]})})]}),_jsxs(Step,{title:`(Optional) Set Authorization token lifetime`,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Authorization token lifetime (sec)`}),` controls how long Access Tokens stay valid.`]}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Value`}),_jsx(_components.th,{children:`Meaning`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`600`}),` `,_jsx(_components.em,{children:`(default)`})]}),_jsx(_components.td,{children:`Access Token valid for 10 minutes`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Any positive integer`}),_jsx(_components.td,{children:`Access Token valid for that many seconds`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`0`})}),_jsxs(_components.td,{children:[`Access Token `,_jsx(_components.strong,{children:`never expires`})]})]})]})]})]}),_jsx(Step,{title:`(Optional) Restrict by IP address`,children:_jsxs(_components.p,{children:[`The `,_jsx(_components.strong,{children:`IP Address restriction`}),` field limits the API consumer to a specific IP address. Requests from any other IP return `,_jsx(_components.strong,{children:`403 Forbidden`}),`.`]})}),_jsx(Step,{title:`Save the user`,children:_jsxs(_components.p,{children:[`Click `,_jsx(_components.strong,{children:`Save`}),` to commit the changes.`]})})]}),`\n`,_jsx(Heading,{level:`3`,id:`what-happens-when-the-toggle-is-disabled`,children:`What happens when the toggle is disabled`}),`\n`,_jsxs(Warning,{children:[_jsxs(_components.p,{children:[`Disabling the `,_jsx(_components.strong,{children:`Allow this user account to be used by external applications`}),` toggle:`]}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Hides`}),` the Client ID / Client Secret and Refresh Token sections.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Expires the Refresh Token immediately.`}),` Any in-flight automation calling the API on behalf of this user starts failing with `,_jsx(_components.strong,{children:`401 Unauthorized`}),`.`]}),`\n`]}),_jsxs(_components.p,{children:[`Re-enabling the toggle generates a `,_jsx(_components.strong,{children:`new`}),` Refresh Token — the old one is permanently invalid.`]})]}),`\n`,_jsx(Heading,{level:`2`,id:`where-client-secret-activity-is-recorded`,children:`Where Client Secret activity is recorded`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Record`}),_jsx(_components.th,{children:`Where`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Adding, editing, rotating, and removing Client Secrets`}),_jsxs(_components.td,{children:[_jsx(_components.a,{href:`/administration/audit-log`,children:`Audit log`}),`, under the `,_jsx(_components.strong,{children:`User management`}),` category`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Client Secrets approaching expiry, and use of deprecated authentication`}),_jsxs(_components.td,{children:[`Transaction Log on the `,_jsx(_components.a,{href:`/administration/dashboards/system-health-dashboards`,children:`System Health dashboards`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Token generation, token usage, and rejected requests`}),_jsx(_components.td,{children:`The Application Server log file`})]})]})]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`Token security events are written to `,_jsx(_components.code,{children:`C:\\\\Program Files\\\\Ekran System\\\\Ekran System\\\\Server.log`}),` at INFO level.`]})}),`\n`,_jsx(_components.p,{children:`Each entry records the timestamp, the User ID or Client ID, the requested endpoint, the source IP address, the result, and the rejection reason where one applies.`}),`\n`,_jsx(Heading,{level:`2`,id:`next-steps`,children:`Next steps`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Task`}),_jsx(_components.th,{children:`Page`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Move existing integrations off the Refresh Token`}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/api/acb/migrate-to-client-credentials`,children:`Migrate to Client ID / Client Secret`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Grant the user permissions on specific secrets and folders`}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/api/acb/secret-permissions`,children:`Secret permissions`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Start calling the API`}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/api/acb/api-reference`,children:`API reference`})})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`related`,children:`Related`}),`\n`,_jsxs(CardGroup,{cols:2,children:[_jsx(Card,{title:`Migrate to Client ID / Client Secret`,icon:`arrow-right-left`,href:`/api/acb/migrate-to-client-credentials`,children:_jsx(_components.p,{children:`The transition period, what changes, and how to move each integration.`})}),_jsx(Card,{title:`Secret permissions`,icon:`lock-keyhole`,href:`/api/acb/secret-permissions`,children:_jsx(_components.p,{children:`Grant the user Owner / Editor / PAM User roles on specific secrets and folders.`})}),_jsx(Card,{title:`Users page`,icon:`users`,href:`/administration/users/users`,children:_jsx(_components.p,{children:`Full reference for adding and editing Syteca users.`})}),_jsx(Card,{title:`Administrative permissions`,icon:`key`,href:`/administration/users/administrative-permissions`,children:_jsx(_components.p,{children:`The permissions required for ACB API access.`})}),_jsx(Card,{title:`API reference`,icon:`square-code`,href:`/api/acb/api-reference`,children:_jsx(_components.p,{children:`Base URL, authentication, status codes.`})})]})]})}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":"Set Up a User Account for ACB","sidebarTitle":"Set up user account","description":"Configure a Management Tool user for ACB API access — Client ID, Client Secrets, Access Token Lifetime, IP Address restriction, and the legacy Refresh Token.","icon":"user-plus","keywords":["syteca acb user account","client id client secret","client credentials flow","access token lifetime","ip address restriction acb","refresh token deprecated","application account settings"],"href":"/api/acb/setup-user-account"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Two account types, two use cases","slug":"two-account-types-two-use-cases","depth":2,"children":[]},{"title":"Prerequisites","slug":"prerequisites","depth":2,"children":[]},{"title":"Create the user","slug":"create-the-user","depth":2,"children":[]},{"title":"Enable external application access","slug":"enable-external-application-access","depth":2,"children":[]},{"title":"Configure Client ID and Client Secret","slug":"configure-client-id-and-client-secret","depth":2,"children":[{"title":"The Client ID","slug":"the-client-id","depth":3,"children":[]},{"title":"The Client Secrets grid","slug":"the-client-secrets-grid","depth":3,"children":[]},{"title":"Add a Client Secret","slug":"add-a-client-secret","depth":3,"children":[]},{"title":"Rotate, edit, and remove","slug":"rotate-edit-and-remove","depth":3,"children":[]}]},{"title":"How requests are validated","slug":"how-requests-are-validated","depth":2,"children":[{"title":"Account lockout","slug":"account-lockout","depth":3,"children":[]},{"title":"Rate limiting","slug":"rate-limiting","depth":3,"children":[]}]},{"title":"Legacy: Refresh Token-based authentication","slug":"legacy-refresh-token-based-authentication","depth":2,"children":[{"title":"What happens when the toggle is disabled","slug":"what-happens-when-the-toggle-is-disabled","depth":3,"children":[]}]},{"title":"Where Client Secret activity is recorded","slug":"where-client-secret-activity-is-recorded","depth":2,"children":[]},{"title":"Next steps","slug":"next-steps","depth":2,"children":[]},{"title":"Related","slug":"related","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"syteca","siteName":"Syteca","title":"Set Up a User Account for ACB - Syteca","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-18T02:45:20.327Z","originalFileLocation":"api/acb/setup-user-account.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=\"Configure a Management Tool user for ACB API access — Client ID, Client Secrets, Access Token Lifetime, IP Address restriction, and the legacy Refresh Token.\">\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=\"Set Up a User Account for ACB - Syteca\">\u003cmeta data-mint-head property=\"og:description\" content=\"Configure a Management Tool user for ACB API access — Client ID, Client Secrets, Access Token Lifetime, IP Address restriction, and the legacy Refresh Token.\">\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/setup-user-account\">\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=\"Set Up a User Account for ACB - Syteca\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Configure a Management Tool user for ACB API access — Client ID, Client Secrets, Access Token Lifetime, IP Address restriction, and the legacy Refresh Token.\">\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/setup-user-account\">\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/setup-user-account.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/setup-user-account#webpage\",\"url\":\"https://www.syteca.com/docs/api/acb/setup-user-account\",\"name\":\"Set Up a User Account for ACB\",\"description\":\"Configure a Management Tool user for ACB API access — Client ID, Client Secrets, Access Token Lifetime, IP Address restriction, and the legacy Refresh Token.\",\"dateModified\":\"2026-11-18T02:45:20.327Z\",\"isPartOf\":{\"@id\":\"https://www.syteca.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.syteca.com/docs/api/acb/setup-user-account#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.syteca.com/docs/api/acb/setup-user-account#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Application Credentials Broker\",\"item\":\"https://www.syteca.com/docs/api/acb/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Set Up a User Account for ACB\",\"item\":\"https://www.syteca.com/docs/api/acb/setup-user-account\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://www.syteca.com/docs/api/acb/setup-user-account#article\",\"headline\":\"Set Up a User Account for ACB\",\"name\":\"Set Up a User Account for ACB\",\"description\":\"Configure a Management Tool user for ACB API access — Client ID, Client Secrets, Access Token Lifetime, IP Address restriction, and the legacy Refresh Token.\",\"url\":\"https://www.syteca.com/docs/api/acb/setup-user-account\",\"mainEntityOfPage\":{\"@id\":\"https://www.syteca.com/docs/api/acb/setup-user-account#webpage\"},\"image\":\"https://www.syteca.com/og-default.png\",\"dateModified\":\"2026-11-18T02:45:20.327Z\",\"keywords\":\"syteca acb user account, client id client secret, client credentials flow, access token lifetime, ip address restriction acb, refresh token deprecated, application account settings\",\"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/setup-user-account.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","description":"Move ACB API integrations from Refresh Token authentication to the OAuth 2.0 Client Credentials flow before the three-month transition period ends.","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","description":"Configure role-based permissions on Syteca secrets and folders so the ACB API consumer can access them — Owner / Editor / PAM User roles, the Permissions tab, and where to find Secret IDs and Folder IDs.","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}","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","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":"Set Up a User Account for ACB - Syteca","deploymentId":"dpl_81ettUQ5G7NASN425B6JKU3FX1Rg","buildId":"dpl_81ettUQ5G7NASN425B6JKU3FX1Rg","dynamics":["07c022d89b","a74be98ba7"],"chunks":["Frame-C6xGbawq.js","DynamicMarkdown-C_R66tyH.js","zoom-image-lightbox-Cr7fyDws.js","lightbox-handle-r17bVUz3.js"]}