Authenticate API requests with an account-owned OpenPMM API credential.
An API credential belongs to one account. It can have access to all workspaces or selected workspaces. The dashboard creates a selected-access credential from Workspace settings → API keys.OpenPMM shows the API key secret one time. Send the secret as a bearer token.POST /signup-intents, POST /cli-authorizations, and
POST /cli-authorizations/token do not need an API key. They form the
short-lived browser handoff that creates a credential before one exists.
Never expose a key in browser code, mobile binaries, logs, or URLs.
Use separate keys for separate deployments or integrations.
Revoke a key when you do not need it.
Revoke and replace a key when another person or system can have access to it.
Do not extract a key from the OpenPMM CLI credential store. A direct API
integration must use its own least-privilege credential. Let the CLI manage
the credential that it creates.
Call GET /account to get the account and credential context. Call GET /workspaces to list the workspaces that the credential can use.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"OpenPMM","description":"Official documentation for the OpenPMM social publishing API, hosted MCP server, and first-party @openpmm/cli package","colors":{"primary":"#C83F1D","light":"#FF9A3D","dark":"#D84420"},"logo":"https://mintcdn.com/open-pmm/Y4bqcTFv_MCkrIIC/logo/openpmm.png?fit=max\u0026auto=format\u0026n=Y4bqcTFv_MCkrIIC\u0026q=85\u0026s=cdc550716e5a29bb13424cc795a18490","favicon":"https://mintcdn.com/open-pmm/Y4bqcTFv_MCkrIIC/favicon.ico?fit=max\u0026auto=format\u0026n=Y4bqcTFv_MCkrIIC\u0026q=85\u0026s=da4a9698e6119ac0274a1d31b0dc1248","api":{"playground":{"display":"simple"}},"appearance":{"default":"system","strict":false},"navbar":{"primary":{"type":"button","label":"Login","href":"https://app.openpmm.com"}},"seo":{"organization":{"name":"OpenPMM","url":"https://www.openpmm.com","sameAs":["https://github.com/OpenPMM/cli","https://www.npmjs.com/package/@openpmm/cli"]},"indexing":"navigable","trailingSlash":false},"integrations":{"telemetry":{"enabled":false}},"contextual":{"options":["copy","view","chatgpt","claude","cursor"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"OpenPMM","icon":"house","href":"https://www.openpmm.com"},{"anchor":"Dashboard","icon":"grid-2","href":"https://app.openpmm.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"open-pmm","hasAudioNarration":false,"actualSubdomain":"open-pmm","customDomains":["www.openpmm.com"],"gitSource":{"type":"github","owner":"openpmm","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6adf6b44d7cf896c8ad89e52","collectionId":"07a2f178-b073-447c-8eae-951e7ea8443b","liveDeploymentHistoryId":"6adf6b44d7cf896c8ad89e52","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6adf6b44d7cf896c8ad89e52","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"API reference","count":71},{"language":"default","tag":"Guides","count":29},{"language":"default","tag":"CLI","count":12},{"language":"default","tag":"Publishing guides","count":11},{"language":"default","tag":"Get started","count":10},{"language":"default","tag":"Media guidelines","count":10},{"language":"default","tag":"Posts","count":10},{"language":"default","tag":"Inbox","count":9},{"language":"default","tag":"Workflows","count":8},{"language":"default","tag":"Destinations","count":7}]},"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":"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":"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":"llms-txt-v2","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"reference/authentication","slug":"/reference/authentication","pageMetadata":{"title":"Authentication","description":"Authenticate API requests with an account-owned OpenPMM API credential.","href":"/reference/authentication"},"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: \"Authenticate API requests with an account-owned OpenPMM API credential.\"\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={code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`An API credential belongs to one account. It can have access to all workspaces or selected workspaces. The dashboard creates a selected-access credential from `,_jsx(_components.strong,{children:`Workspace settings`}),` → `,_jsx(_components.strong,{children:`API keys`}),`.`]}),`\n`,_jsx(_components.p,{children:`OpenPMM shows the API key secret one time. Send the secret as a bearer token.`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`POST /signup-intents`}),`, `,_jsx(_components.code,{children:`POST /cli-authorizations`}),`, and\n`,_jsx(_components.code,{children:`POST /cli-authorizations/token`}),` do not need an API key. They form the\nshort-lived browser handoff that creates a credential before one exists.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --request`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` GET`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --url`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.openpmm.com/v1/me`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$OPENPMM_API_KEY`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`The header format is:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`http`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`http`,children:_jsxs(_components.code,{language:`http`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`Authorization`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Bearer \u003capi-key>`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`key-handling`,children:`Key handling`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Store keys in a server-side secret manager.`}),`\n`,_jsx(_components.li,{children:`Never expose a key in browser code, mobile binaries, logs, or URLs.`}),`\n`,_jsx(_components.li,{children:`Use separate keys for separate deployments or integrations.`}),`\n`,_jsx(_components.li,{children:`Revoke a key when you do not need it.`}),`\n`,_jsx(_components.li,{children:`Revoke and replace a key when another person or system can have access to it.`}),`\n`]}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Do not extract a key from the OpenPMM CLI credential store. A direct API\nintegration must use its own least-privilege credential. Let the CLI manage\nthe credential that it creates.`})}),`\n`,_jsxs(_components.p,{children:[`Call `,_jsx(_components.code,{children:`GET /account`}),` to get the account and credential context. Call `,_jsx(_components.code,{children:`GET /workspaces`}),` to list the workspaces that the credential can use.`]})]})}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":{"config":{},"pageMetadata":{"title":"Authentication","description":"Authenticate API requests with an account-owned OpenPMM API credential.","href":"/reference/authentication"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Key handling","slug":"key-handling","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"open-pmm","siteName":"OpenPMM","title":"Authentication - OpenPMM","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-25T07:26:48.794Z","originalFileLocation":"reference/authentication.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=\"Authenticate API requests with an account-owned OpenPMM API credential.\">\u003cmeta data-mint-head name=\"application-name\" content=\"OpenPMM\">\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/open-pmm/Q6BZMi2O6IrklsYx/_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/open-pmm/Q6BZMi2O6IrklsYx/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/open-pmm/Q6BZMi2O6IrklsYx/_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/open-pmm/Q6BZMi2O6IrklsYx/_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/open-pmm/Q6BZMi2O6IrklsYx/_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/open-pmm/Q6BZMi2O6IrklsYx/_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/open-pmm/Q6BZMi2O6IrklsYx/_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/open-pmm/Q6BZMi2O6IrklsYx/_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/open-pmm/Q6BZMi2O6IrklsYx/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Authentication - OpenPMM\">\u003cmeta data-mint-head property=\"og:description\" content=\"Authenticate API requests with an account-owned OpenPMM API credential.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"OpenPMM\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.openpmm.com/docs/reference/authentication\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://open-pmm.mintlify.app/_mintlify/api/og/v2?division=Using+the+API\u0026amp;title=Authentication\u0026amp;description=Authenticate+API+requests+with+an+account-owned+OpenPMM+API+credential.\u0026amp;theme=d3f8c8d79f1e36f864055b30\u0026amp;signature=a1afbb0e3f40db7168254b656d5d533ff48a047126e61fef657b5ad8f01b2ed3\">\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=\"Authentication - OpenPMM\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Authenticate API requests with an account-owned OpenPMM API credential.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://open-pmm.mintlify.app/_mintlify/api/og/v2?division=Using+the+API\u0026amp;title=Authentication\u0026amp;description=Authenticate+API+requests+with+an+account-owned+OpenPMM+API+credential.\u0026amp;theme=d3f8c8d79f1e36f864055b30\u0026amp;signature=a1afbb0e3f40db7168254b656d5d533ff48a047126e61fef657b5ad8f01b2ed3\">\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/open-pmm/Q6BZMi2O6IrklsYx/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"OpenPMM\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#C83F1D\">\u003clink data-mint-head rel=\"canonical\" href=\"https://www.openpmm.com/docs/reference/authentication\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/reference/authentication.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.openpmm.com/#organization\",\"name\":\"OpenPMM\",\"url\":\"https://www.openpmm.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/open-pmm/Y4bqcTFv_MCkrIIC/logo/openpmm.png?fit=max\u0026auto=format\u0026n=Y4bqcTFv_MCkrIIC\u0026q=85\u0026s=cdc550716e5a29bb13424cc795a18490\"},\"sameAs\":[\"https://github.com/OpenPMM/cli\",\"https://www.npmjs.com/package/@openpmm/cli\"]},{\"@type\":\"WebSite\",\"@id\":\"https://www.openpmm.com/docs#website\",\"name\":\"OpenPMM\",\"url\":\"https://www.openpmm.com/docs\",\"publisher\":{\"@id\":\"https://www.openpmm.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://www.openpmm.com/docs/reference/authentication#webpage\",\"url\":\"https://www.openpmm.com/docs/reference/authentication\",\"name\":\"Authentication\",\"description\":\"Authenticate API requests with an account-owned OpenPMM API credential.\",\"dateModified\":\"2026-08-25T07:26:48.794Z\",\"isPartOf\":{\"@id\":\"https://www.openpmm.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.openpmm.com/docs/reference/authentication#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.openpmm.com/docs/reference/authentication#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Using the API\",\"item\":\"https://www.openpmm.com/docs/reference/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Authentication\",\"item\":\"https://www.openpmm.com/docs/reference/authentication\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://www.openpmm.com/docs/reference/authentication#article\",\"headline\":\"Authentication\",\"name\":\"Authentication\",\"description\":\"Authenticate API requests with an account-owned OpenPMM API credential.\",\"url\":\"https://www.openpmm.com/docs/reference/authentication\",\"mainEntityOfPage\":{\"@id\":\"https://www.openpmm.com/docs/reference/authentication#webpage\"},\"dateModified\":\"2026-08-25T07:26:48.794Z\",\"publisher\":{\"@id\":\"https://www.openpmm.com/#organization\"},\"isPartOf\":{\"@id\":\"https://www.openpmm.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"OpenPMM\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"OpenPMM","nav":{"global":{"anchors":[{"anchor":"OpenPMM","icon":"house","href":"https://www.openpmm.com"},{"anchor":"Dashboard","icon":"grid-2","href":"https://app.openpmm.com"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp/overview"}]},{"tab":"CLI","pages":[{"title":"CLI","href":"/cli/overview"}]},{"tab":"API reference","groups":[{"group":"Using the API","pages":[{"title":"API overview","description":"Learn the OpenPMM API base URL, request rules, response format, and versioning.","href":"/reference/overview"},{"title":"Authentication","href":"/reference/authentication"},{"title":"Pagination","description":"Read paginated OpenPMM list responses with cursors and request limits correctly.","href":"/reference/pagination"},{"title":"Idempotency","href":"/reference/idempotency"},{"title":"Errors","href":"/reference/errors"},{"title":"API changelog","href":"/reference/changelog"}]},{"group":"Signup","pages":[{"title":"Create Signup Link","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json post /signup-intents","href":"/api-reference/signup/create-signup-link"}]},{"group":"CLI authorization","pages":[{"title":"Start CLI Authorization","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json post /cli-authorizations","href":"/api-reference/cli-authorization/start-cli-authorization"},{"title":"Get CLI Credential","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json post /cli-authorizations/token","href":"/api-reference/cli-authorization/get-cli-credential"}]},{"group":"Account","pages":[{"title":"Get Account","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json get /account","href":"/api-reference/account/get-account"}]},{"group":"Team","pages":[{"title":"List Account Members","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json get /account/members","href":"/api-reference/team/list-account-members"},{"title":"Remove Account Member","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json delete /account/members/{user_id}","href":"/api-reference/team/remove-account-member"},{"title":"List Invitations","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json get /account/invitations","href":"/api-reference/team/list-invitations"},{"title":"Create Invitation","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json post /account/invitations","href":"/api-reference/team/create-invitation"},{"title":"Revoke Invitation","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json delete /account/invitations/{invitation_id}","href":"/api-reference/team/revoke-invitation"},{"title":"Resend Invitation","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json post /account/invitations/{invitation_id}/resend","href":"/api-reference/team/resend-invitation"}]},{"group":"Workspaces","pages":[{"title":"List Workspaces","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json get /workspaces","href":"/api-reference/account/list-workspaces"},{"title":"Get Workspace","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json get /workspaces/{workspace_id}","href":"/api-reference/workspaces/get-workspace"},{"title":"Update Workspace","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json patch /workspaces/{workspace_id}","href":"/api-reference/workspaces/update-workspace"}]},{"group":"Feedback","pages":[{"title":"Submit Feedback","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json post /workspaces/{workspace_id}/feedback","href":"/api-reference/feedback/submit-feedback"}]},{"group":"Posts","pages":[{"title":"Create Post","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json post /workspaces/{workspace_id}/posts","href":"/api-reference/posts/create-post"},{"title":"List Posts","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json get /workspaces/{workspace_id}/posts","href":"/api-reference/posts/list-posts"},{"title":"Move Queued Posts","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json post /workspaces/{workspace_id}/posts/move-in-queue","href":"/api-reference/posts/move-queued-posts"},{"title":"Get Post","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json get /workspaces/{workspace_id}/posts/{post}","href":"/api-reference/posts/get-post"},{"title":"Update Post","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json patch /workspaces/{workspace_id}/posts/{post}","href":"/api-reference/posts/update-post"},{"title":"Delete Post","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json delete /workspaces/{workspace_id}/posts/{post}","href":"/api-reference/posts/delete-post"},{"title":"Publish Posts","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json post /workspaces/{workspace_id}/posts/publish","href":"/api-reference/posts/publish-posts"},{"title":"Cancel Post","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json post /workspaces/{workspace_id}/posts/{post}/cancel","href":"/api-reference/posts/cancel-post"},{"title":"Reschedule Post","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json post /workspaces/{workspace_id}/posts/{post}/reschedule","href":"/api-reference/posts/reschedule-post"},{"title":"Retry Post","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json post /workspaces/{workspace_id}/posts/{post}/retry","href":"/api-reference/posts/retry-post"}]},{"group":"Assets","pages":[{"title":"List Assets","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json get /workspaces/{workspace_id}/assets","href":"/api-reference/assets/list-assets"},{"title":"Get Asset","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json get /workspaces/{workspace_id}/assets/{asset_id}","href":"/api-reference/assets/get-asset"},{"title":"Delete Asset","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json delete /workspaces/{workspace_id}/assets/{asset_id}","href":"/api-reference/assets/delete-asset"},{"title":"Create Asset Upload","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json post /workspaces/{workspace_id}/asset-uploads","href":"/api-reference/assets/create-asset-upload"},{"title":"Get Asset Upload","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json get /workspaces/{workspace_id}/asset-uploads/{upload_id}","href":"/api-reference/assets/get-asset-upload"},{"title":"Complete Asset Upload","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json post /workspaces/{workspace_id}/asset-uploads/{upload_id}/complete","href":"/api-reference/assets/complete-asset-upload"}]},{"group":"Analytics","pages":[{"title":"Get Analytics Report","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json get /workspaces/{workspace_id}/analytics","href":"/api-reference/analytics/get-analytics-report"},{"title":"Get Post Analytics","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json get /workspaces/{workspace_id}/analytics/posts/{post}","href":"/api-reference/analytics/get-post-analytics"},{"title":"Refresh Post Analytics","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json post /workspaces/{workspace_id}/analytics/posts/{post}/refresh","href":"/api-reference/analytics/refresh-post-analytics"},{"title":"Get Group Analytics","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json get /workspaces/{workspace_id}/analytics/post-groups/{group}","href":"/api-reference/analytics/get-group-analytics"},{"title":"Refresh Group Analytics","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json post /workspaces/{workspace_id}/analytics/post-groups/{group}/refresh","href":"/api-reference/analytics/refresh-group-analytics"}]},{"group":"Inbox","pages":[{"title":"Get Inbox Summary","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json get /workspaces/{workspace_id}/inbox","href":"/api-reference/inbox/get-inbox-summary"},{"title":"List Threads","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json get /workspaces/{workspace_id}/inbox/threads","href":"/api-reference/inbox/list-threads"},{"title":"Get Thread","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json get /workspaces/{workspace_id}/inbox/threads/{thread}","href":"/api-reference/inbox/get-thread"},{"title":"Resolve Thread","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json post /workspaces/{workspace_id}/inbox/threads/{thread}/resolve","href":"/api-reference/inbox/resolve-thread"},{"title":"List Comments","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json get /workspaces/{workspace_id}/inbox/comments","href":"/api-reference/inbox/list-comments"},{"title":"Get Comment","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json get /workspaces/{workspace_id}/inbox/comments/{comment}","href":"/api-reference/inbox/get-comment"},{"title":"Update Comment","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json patch /workspaces/{workspace_id}/inbox/comments/{comment}","href":"/api-reference/inbox/update-comment"},{"title":"Create Reply","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json post /workspaces/{workspace_id}/inbox/comments/{comment}/replies","href":"/api-reference/inbox/create-reply"},{"title":"Refresh Inbox","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json post /workspaces/{workspace_id}/inbox/refresh","href":"/api-reference/inbox/refresh-inbox"}]},{"group":"Destinations","pages":[{"title":"List Destinations","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json get /workspaces/{workspace_id}/destinations","href":"/api-reference/destinations/list-destinations"},{"title":"Get Destination","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json get /workspaces/{workspace_id}/destinations/{destination_id}","href":"/api-reference/destinations/get-destination"},{"title":"Update Destination","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json patch /workspaces/{workspace_id}/destinations/{destination_id}","href":"/api-reference/destinations/update-destination"},{"title":"Refresh Destinations","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json post /workspaces/{workspace_id}/destinations/refresh","href":"/api-reference/destinations/refresh-destinations"},{"title":"Disconnect Destination","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json post /workspaces/{workspace_id}/destinations/{destination_id}/disconnect","href":"/api-reference/destinations/disconnect-destination"},{"title":"Start Destination Connection","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json post /workspaces/{workspace_id}/destination-connection-sessions","href":"/api-reference/destinations/start-destination-connection"},{"title":"Get Connection Status","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json get /workspaces/{workspace_id}/destination-connection-sessions/{session_id}","href":"/api-reference/destinations/get-connection-status"}]},{"group":"Slack Notifications","pages":[{"title":"Get Notification Settings","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json get /workspaces/{workspace_id}/notification-settings","href":"/api-reference/slack-notifications/get-notification-settings"},{"title":"Update Notification Settings","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json patch /workspaces/{workspace_id}/notification-settings","href":"/api-reference/slack-notifications/update-notification-settings"},{"title":"Start Slack Connection","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json post /account/slack-connection-sessions","href":"/api-reference/slack-notifications/start-slack-connection"},{"title":"Get Slack Connection","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json get /account/slack-connection-sessions/{session_id}","href":"/api-reference/slack-notifications/get-slack-connection"},{"title":"Disconnect Slack","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json delete /account/slack-connection","href":"/api-reference/slack-notifications/disconnect-slack"},{"title":"List Slack Channels","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json get /workspaces/{workspace_id}/slack-channels","href":"/api-reference/slack-notifications/list-slack-channels"},{"title":"Create Slack Test","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json post /workspaces/{workspace_id}/slack-notification-tests","href":"/api-reference/slack-notifications/create-slack-test"}]},{"group":"Webhooks","pages":[{"title":"List Webhook Endpoints","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json get /workspaces/{workspace_id}/webhook-endpoints","href":"/api-reference/webhooks/list-webhook-endpoints"},{"title":"Create Webhook Endpoint","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json post /workspaces/{workspace_id}/webhook-endpoints","href":"/api-reference/webhooks/create-webhook-endpoint"},{"title":"Get Webhook Endpoint","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json get /workspaces/{workspace_id}/webhook-endpoints/{endpoint_id}","href":"/api-reference/webhooks/get-webhook-endpoint"},{"title":"Update Webhook Endpoint","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json patch /workspaces/{workspace_id}/webhook-endpoints/{endpoint_id}","href":"/api-reference/webhooks/update-webhook-endpoint"},{"title":"Delete Webhook Endpoint","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json delete /workspaces/{workspace_id}/webhook-endpoints/{endpoint_id}","href":"/api-reference/webhooks/delete-webhook-endpoint"},{"title":"Rotate Webhook Secret","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json post /workspaces/{workspace_id}/webhook-endpoints/{endpoint_id}/rotate-secret","href":"/api-reference/webhooks/rotate-webhook-secret"},{"title":"Test Webhook Endpoint","deprecated":null,"version":null,"openapi":"https://api.openpmm.com/v1/openapi.json post /workspaces/{workspace_id}/webhook-endpoints/{endpoint_id}/test","href":"/api-reference/webhooks/test-webhook-endpoint"}]}]}]},"title":"Authentication - OpenPMM","buildId":"dpl_DGmhKsAzJdVqypJzon18vViniWRY","deploymentId":"dpl_DGmhKsAzJdVqypJzon18vViniWRY","dynamics":[],"chunks":[]}