New! Use the 1Password Credential Broker to give CI/CD and other machine workflows short-lived access to secrets, without managing service account tokens.
Use this endpoint when a customer already has a 1Password account and is switching to purchasing 1Password through you as their distributor, instead of provisioning a new account with create an entitlement.Linking creates a change-of-channel entitlement that connects a customer’s existing 1Password account to your distributor relationship.The request must identify the existing account by its 1Password domain in the metadata (for example, acme-corp.1password.com), along with the product_id to provision and the customer’s contact_info.Linking an entitlement works as follows:
The entitlement is created with a status of pending and an expire_time 5 days from creation.
1Password sends an email to the customer with their entitlement code. The email includes your distributor name and the product name.
The customer claims the code for their existing 1Password account, which completes the link and transitions the entitlement to active.
If the customer doesn’t complete linking within 5 days, the entitlement expires and its status transitions to expired.
If an entitlement for the product already exists for the customer, the request fails with a 409 error unless it has a cancelled or expired status.If the existing entitlement is cancelled or expired, it’s reactivated with a status of pending.A reactivated entitlement keeps its original id and create_time, with the contact details from the new request.
See API conventions for more information about authentication, resource paths, pagination, filtering, and error handling.
Authorizations
Authorization
string
header
required
Bearer token authentication. When a distributor is registered, they receive an opaque bearer token (prefixed op_b_). Include it in the Authorization header of every request as Bearer <token>.
Path Parameters
distributor-customer
string
required
The customer ID, as defined in the distributor's own system.
Body
application/json
The request body for linking an existing 1Password account.
product_id
string
required
The ID of the 1Password product to provision.
Minimum string length: 1
contact_info
object
required
The customer details for account activation and setup.
Show child attributes
metadata
object
required
The change of channel information. Required, and must include one_password_domain.
Show child attributes
Response
The linked change of channel entitlement.
The response for a successful entitlement link.
entitlement
object
The linked entitlement.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"1Password Developer","description":"Developer docs for 1Password. Keep secrets out of your code with the CLI, SSH agent, Environments, service accounts, SDKs, and tools for AI agents.","colors":{"primary":"#145FE4","light":"#b8d7ff","dark":"#303136"},"logo":{"light":"https://mintcdn.com/ab-634991b8/tWWm5UFlpZQ9nof8/images/logo-1password-dark.svg?fit=max\u0026auto=format\u0026n=tWWm5UFlpZQ9nof8\u0026q=85\u0026s=2c2acc6dc5f817defe70ebdef67c9b11","dark":"https://mintcdn.com/ab-634991b8/tWWm5UFlpZQ9nof8/images/logo-1password-light.svg?fit=max\u0026auto=format\u0026n=tWWm5UFlpZQ9nof8\u0026q=85\u0026s=0dae06f9dd5b1f569de5cb9fba337405"},"favicon":"https://mintcdn.com/ab-634991b8/s4Wjy03jBRs6hcHb/favicon.ico?fit=max\u0026auto=format\u0026n=s4Wjy03jBRs6hcHb\u0026q=85\u0026s=dd03b4bc604b342373aa4d3e21be4310","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","node","python","go","dotnet","java","php","powershell","ruby"]}},"background":{"color":{"light":"#ffffff","dark":"#1a1b1e"}},"navbar":{"links":[{"icon":"github","href":"https://github.com/1Password","label":"GitHub"},{"icon":"slack","href":"https://www.1password.dev/joinslack","label":"Join Slack"}],"primary":{"type":"button","label":"Try free","href":"https://1password.com/pricing/business"}},"footer":{"socials":{"github":"https://github.com/1Password","x":"https://x.com/1PasswordDev","reddit":"https://www.reddit.com/r/1Password","linkedin":"https://www.linkedin.com/company/1password","youtube":"https://www.youtube.com/1PasswordVideos","facebook":"https://www.facebook.com/1Password","instagram":"https://www.instagram.com/1password"},"links":[{"header":"Get started","items":[{"label":"Developer quickstart","href":"/get-started/developer-quickstart"},{"label":"Admin quickstart","href":"/get-started/administrator-quickstart"},{"label":"Partner quickstart","href":"/get-started/partner-quickstart"},{"label":"All setup guides","href":"/get-started"}]},{"header":"Help and resources","items":[{"label":"CLI troubleshooting","href":"/cli/app-integration"},{"label":"SSH troubleshooting","href":"/ssh/agent/troubleshooting"},{"label":"System status","href":"https://status.1password.com"},{"label":"CLI release notes","href":"/cli/release-notes"},{"label":"1Password University","href":"https://www.1password.university/?utm_ref=website-footer"},{"label":"Blog","href":"https://blog.1password.com"}]},{"header":"Community","items":[{"label":"Developer community","href":"/community"},{"label":"Events","href":"https://luma.com/1password"},{"label":"Developer Slack","href":"/joinslack"},{"label":"Newsletter","href":"https://1password.com/developer-newsletter"},{"label":"Code of Conduct","href":"/code-of-conduct"},{"label":"Projects disclaimer","href":"/community/disclaimer"}]},{"header":"Legal","items":[{"label":"Terms of Service","href":"https://1password.com/legal/terms-of-service"},{"label":"Privacy Policy","href":"https://1password.com/legal/privacy"},{"label":"Cookie Policy","href":"https://1password.com/legal/cookies"},{"label":"Accessibility","href":"https://1password.com/legal/accessibility"}]}]},"seo":{"metatags":{"canonical":"https://www.1password.dev","google-site-verification":"YserOhXnJUjFfIZ4K3qgxkVSlQZQdXtIbBiKzZ35Nvs"}},"fonts":{"heading":{"family":"Public Sans"},"body":{"family":"Public Sans"}},"banner":{"content":"**New!** Use the [1Password Credential Broker](https://www.1password.dev/brokered-access) to give CI/CD and other machine workflows short-lived access to secrets, without managing service account tokens.","dismissible":true,"color":{"light":"#145fe4","dark":"#145fe4"}},"errors":{"404":{"redirect":false,"title":"This page can't be found","description":"Our docs have moved to [www.1password.dev](https://www.1password.dev). Try searching for what you need or selecting from the list of tools."}},"contextual":{"options":["copy","view","mcp","cursor","vscode","chatgpt","claude","perplexity"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ab-634991b8","hasAudioNarration":false,"actualSubdomain":"ab-634991b8","customDomains":["www.1password.dev"],"gitSource":{"type":"github","owner":"1password","repo":"1password.dev","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"contextualFeedback":{"allowEmail":false},"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af4cc23835e7d1bb15472d7","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"CLI","count":320},{"language":"default","tag":"SDKs \u0026 APIs","count":120},{"language":"default","tag":"Shell Plugins","count":104},{"language":"default","tag":"Plugins","count":97},{"language":"default","tag":"CI/CD \u0026 infrastructure","count":92},{"language":"default","tag":"SaaS Manager API","count":88},{"language":"default","tag":"API Reference","count":64},{"language":"default","tag":"Reference","count":56},{"language":"default","tag":"SDKs","count":51},{"language":"default","tag":"Events API","count":44}]},"assistantConfig":{"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"deflection":{"enabled":true,"email":"support@1password.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"styles.css","content":":root{--op-secure-blue: #104ebb;--op-secure-blue-hover: #0e46a8;--op-iron-ore: #303136;--op-page-bg-dark: #1a1b1e;--op-white: #ffffff;--op-icy-blue: #dcebff;--op-cornflower: #b8d7ff;--op-biscuit: #fbf8f4;--op-sunbeam: #fad785;--op-tangerine: #ff8f78;--op-enable-mint: #76e0bd;--op-gold: #cbb88e;--op-status-success: #10622f;--op-status-warning: #8a4006;--op-status-error: #a71c1c;--op-status-info: var(--op-secure-blue);--op-border-ui: #949494;--op-border-ui-dark: #6b7280;--op-border-subtle: rgb(3 7 18 / 0.12);--op-border-subtle-dark: rgb(251 248 244 / 0.25);--op-border-footer-dark: rgb(251 248 244 / 0.37);--op-border-navbar-light: rgb(107 114 128 / 0.05);--op-border-navbar-dark: rgb(209 213 219 / 0.06);--op-border-card-light: rgb(3 7 18 / 0.1);--op-border-card-dark: rgb(255 255 255 / 0.1);--op-border-hero-light: rgb(255 255 255 / 0.08);--op-border-hero-dark: rgb(255 255 255 / 0.12);--op-border-badge-light: rgb(16 78 187 / 0.2);--op-border-badge-dark: rgb(184 215 255 / 0.25);--op-border-workflow-dark: rgb(251 248 244 / 0.2);--op-text-body: var(--op-iron-ore);--op-text-body-dark: var(--op-biscuit);--op-surface-card-light: var(--op-white);--op-surface-card-dark: #25262a;--op-surface-callout-light: rgb(220 235 255 / 0.45);--op-surface-callout-dark: rgb(184 215 255 / 0.08)}#content.prose{--tw-prose-body: var(--op-text-body)}.dark #content.prose{--tw-prose-body: var(--op-text-body-dark)}#content.prose :where(p,span[data-as=\"p\"],li,td,th,blockquote,figcaption):not(a.op-cta-primary span){color:var(--op-text-body)}.dark #content.prose :where(p,span[data-as=\"p\"],li,td,th,blockquote,figcaption):not(a.op-cta-primary span){color:var(--op-text-body-dark)}#content :is(p,li,div,span,button,h1,h2,h3,h4,h5,h6).text-gray-600,#content :is(p,li,div,span,button,h1,h2,h3,h4,h5,h6).text-gray-700,#content :is(p,li,span,button,h1,h2,h3,h4,h5,h6).text-gray-500{color:var(--op-text-body)}.dark #content :is(p,li,div,span,button,h1,h2,h3,h4,h5,h6).dark\\:text-gray-400,.dark #content :is(p,li,div,span,button,h1,h2,h3,h4,h5,h6).dark\\:text-gray-300,.dark #content :is(p,li,span,button,h1,h2,h3,h4,h5,h6).dark\\:text-gray-500{color:var(--op-text-body-dark)}#content .text-gray-400:not(:is(p,li,span,button,h1,h2,h3,h4,h5,h6)){color:var(--op-border-ui)}.dark #content .text-gray-400:not(:is(p,li,span,button,h1,h2,h3,h4,h5,h6)),.dark #content .text-gray-500:not(:is(p,li,span,button,h1,h2,h3,h4,h5,h6)){color:var(--op-border-ui-dark)}.dark .card-group{--background-dark: 37 38 42}.dark .card-group .card{background-color:rgb(var(--background-dark))!important}.card-group .card{border-color:var(--op-border-card-light)!important}.dark .card-group .card{border-color:var(--op-border-card-dark)!important}.op-card-surface{border:1px solid var(--op-border-card-light)}.dark .op-card-surface{border-color:var(--op-border-card-dark)}#content .hover\\:border-gray-300:hover{border-color:var(--op-iron-ore)}.dark #content .hover\\:border-gray-600:hover{border-color:var(--op-biscuit)}.community-card{border:1px solid var(--op-border-card-light);border-radius:0.5rem;background-color:var(--op-surface-card-light)}.dark .community-card{border-color:var(--op-border-card-dark);background-color:var(--op-surface-card-dark)}.community-card .community-card-chevron{color:var(--op-border-ui)}.dark .community-card .community-card-chevron{color:var(--op-cornflower)}a.community-card:hover{border-color:var(--op-secure-blue)}.dark a.community-card:hover{border-color:var(--op-cornflower)}.community-callout{border:1px solid var(--op-border-card-light);border-radius:0.5rem;background-color:var(--op-surface-callout-light)}.dark .community-callout{border-color:var(--op-border-card-dark);background-color:var(--op-surface-callout-dark)}.community-link{color:var(--op-secure-blue);text-decoration:none}.community-link:hover{color:var(--op-secure-blue-hover);text-decoration:underline}.dark .community-link{color:var(--op-cornflower)}.dark .community-link:hover{color:var(--op-white)}:is(#sidebar-content a:not([aria-current=\"page\"]),#table-of-contents,#table-of-contents a,#navbar .nav-tabs-item:not([data-active]),#navbar nav ul>li:not(#topbar-cta-button)>a,#search-bar-entry,#search-bar-entry-mobile,#assistant-entry,#assistant-entry-mobile,[data-component-name=\"theme-toggle\"]){color:var(--op-text-body)}.dark :is(#sidebar-content a:not([aria-current=\"page\"]),#table-of-contents,#table-of-contents a,#navbar .nav-tabs-item:not([data-active]),#navbar nav ul>li:not(#topbar-cta-button)>a,#search-bar-entry,#search-bar-entry-mobile,#assistant-entry,#assistant-entry-mobile,[data-component-name=\"theme-toggle\"]){color:var(--op-text-body-dark)}:is(#search-bar-entry,#search-bar-entry-mobile,#assistant-entry,#assistant-entry-mobile,[data-component-name=\"theme-toggle\"]) svg{color:inherit}#footer a.h-fit svg{background-color:var(--op-biscuit)}#footer a.h-fit:hover svg{background-color:var(--op-white)}.hero-background{background-color:var(--op-iron-ore);background-image:radial-gradient(\n ellipse 75% 100% at 100% 50%,\n rgb(20 95 228 / 0.55) 0%,\n rgb(20 95 228 / 0.2) 40%,\n transparent 70%\n )}.dark .hero-background{background-color:var(--op-page-bg-dark);background-image:radial-gradient(\n ellipse 80% 100% at 100% 50%,\n rgb(20 95 228 / 0.7) 0%,\n rgb(20 95 228 / 0.3) 45%,\n transparent 75%\n )}.hero-section{border-bottom:1px solid var(--op-border-hero-light)}.dark .hero-section{border-bottom-color:var(--op-border-hero-dark)}.hero-cta{background-color:var(--op-secure-blue);color:var(--op-white);box-shadow:0 1px 3px rgb(0 0 0 / 0.25)}.hero-cta svg,.hero-cta svg path{fill:currentColor!important;color:currentColor!important}.hero-cta:hover{background-color:var(--op-secure-blue-hover)}#content.prose a.op-cta-primary,#content a.op-cta-primary{background-color:var(--op-secure-blue);color:var(--op-white)!important;text-decoration:none}#content.prose a.op-cta-primary span[data-as=\"p\"],#content.prose a.op-cta-primary span,#content a.op-cta-primary span[data-as=\"p\"],#content a.op-cta-primary span{color:var(--op-white)!important}#content.prose a.op-cta-primary:hover,#content a.op-cta-primary:hover{background-color:var(--op-secure-blue-hover);color:var(--op-white)!important}#content.prose a.op-cta-primary:hover span[data-as=\"p\"],#content.prose a.op-cta-primary:hover span,#content a.op-cta-primary:hover span[data-as=\"p\"],#content a.op-cta-primary:hover span{color:var(--op-white)!important}#topbar-cta-button a>span.absolute{background-color:var(--op-secure-blue)!important}#topbar-cta-button a:hover>span.absolute{background-color:var(--op-secure-blue-hover)!important}#topbar-cta-button a span.z-10{color:var(--op-white)!important}#topbar-cta-button a svg{color:var(--op-white)!important}.card-group{gap:1rem}#content .card-group img[src*=\"/homepage-icons/brand/\"]{width:32px;height:32px;flex-shrink:0}.homepage-card-title{display:inline-flex;flex-wrap:wrap;align-items:center;gap:0.25rem 0.5rem}.image-button-link img{margin:10px 0}.dark #content a>div>span{color:var(--op-cornflower)!important}.docs-higlight-cards{display:grid;grid-template-columns:repeat(auto-fill, minmax(250px, 1fr));gap:1rem;margin-bottom:1rem}.highlight-card-link{color:var(--op-secure-blue)!important}.highlight-card-link:hover{color:var(--op-secure-blue-hover)!important}.dark .highlight-card-link{color:var(--op-cornflower)!important}.dark .highlight-card-link:hover{color:var(--op-white)!important}.highlight-card-link svg{background-color:var(--op-secure-blue)!important}.dark .highlight-card-link svg{background-color:var(--op-cornflower)!important}.coloredCodeWrapper .code-block>div:nth-child(3){--fade-color-light: transparent !important;--fade-color-dark: transparent !important}.badge{border-radius:0.4rem;color:var(--op-white);font-weight:700;line-height:1;padding:3px 5px}.badge--primary{background-color:var(--op-secure-blue)}.badge--secondary{background-color:var(--op-biscuit);color:var(--op-iron-ore)}.op-status-badge{display:inline-flex;flex-shrink:0;align-items:center;white-space:nowrap;vertical-align:middle;border:1px solid var(--op-border-badge-light);border-radius:0.25rem;background-color:var(--op-icy-blue);color:var(--op-iron-ore);padding:0.125rem 0.625rem;font-size:0.75rem;line-height:1rem;font-weight:600}.dark .op-status-badge{border-color:var(--op-border-badge-dark);background-color:rgb(184 215 255 / 0.12);color:var(--op-icy-blue)}.op-workflow-guide-badge{display:inline-flex;flex-shrink:0;align-items:center;white-space:nowrap;margin-top:0.75rem;border:1px solid transparent;border-radius:0.25rem;background-color:var(--op-biscuit);color:var(--op-iron-ore);padding:0.125rem 0.625rem;font-size:0.75rem;line-height:1rem;font-weight:600}.dark .op-workflow-guide-badge{border-color:var(--op-border-workflow-dark);background-color:rgb(251 248 244 / 0.1);color:var(--op-biscuit)}.op-beta-badge-inline{display:inline-flex;align-items:center;margin-left:0.5rem;vertical-align:middle}.mdx-content a[href^=\"http\"]:not([href*=\"://1password.com/\"],[href$=\"://1password.com\"],[href*=\".1password.com/\"],[href$=\".1password.com\"],[href*=\"://1password.dev/\"],[href$=\"://1password.dev\"],[href*=\".1password.dev/\"],[href$=\".1password.dev\"],[href*=\"://1password.ca/\"],[href$=\"://1password.ca\"],[href*=\".1password.ca/\"],[href$=\".1password.ca\"],[href*=\"://1password.eu/\"],[href$=\"://1password.eu\"],[href*=\".1password.eu/\"],[href$=\".1password.eu\"],[href*=\"://1password.io/\"],[href$=\"://1password.io\"],[href*=\".1password.io/\"],[href$=\".1password.io\"],[href*=\"://1password.university/\"],[href$=\"://1password.university\"],[href*=\".1password.university/\"],[href$=\".1password.university\"],[href*=\"://agilebits.com/\"],[href$=\"://agilebits.com\"],[href*=\".agilebits.com/\"],[href$=\".agilebits.com\"],[href*=\"://b5dev.com/\"],[href$=\"://b5dev.com\"],[href*=\".b5dev.com/\"],[href$=\".b5dev.com\"],[href*=\"://b5local.com/\"],[href$=\"://b5local.com\"],[href*=\".b5local.com/\"],[href$=\".b5local.com\"],[href*=\"://1infra.dev/\"],[href$=\"://1infra.dev\"],[href*=\".1infra.dev/\"],[href$=\".1infra.dev\"],[href*=\"://kolide.com/\"],[href$=\"://kolide.com\"],[href*=\".kolide.com/\"],[href$=\".kolide.com\"],[href*=\"://trelica.app/\"],[href$=\"://trelica.app\"],[href*=\".trelica.app/\"],[href$=\".trelica.app\"],[href*=\"://trelica.eu/\"],[href$=\"://trelica.eu\"],[href*=\".trelica.eu/\"],[href$=\".trelica.eu\"],[href*=\"://trelica.com/\"],[href$=\"://trelica.com\"],[href*=\".trelica.com/\"],[href$=\".trelica.com\"],[href*=\"://1password.community/\"],[href$=\"://1password.community\"],[href*=\".1password.community/\"],[href$=\".1password.community\"],[href*=\"://1pw.ca/\"],[href$=\"://1pw.ca\"],[href*=\".1pw.ca/\"],[href$=\".1pw.ca\"]):not(.card *,.op-card-surface *,.image-button-link,.community-card,.community-card *,pre *,:has(img))::after{content:\"\";display:inline-block;width:1em;height:1em;margin-left:0.25em;vertical-align:-0.125em;background-color:currentColor;-webkit-mask:var(--op-link-icon, url(\"/static/img/icons/external-link.svg\")) no-repeat center / contain;mask:var(--op-link-icon, url(\"/static/img/icons/external-link.svg\")) no-repeat center / contain}.mdx-content a:is([href*=\"://github.com/\"],[href$=\"://github.com\"],[href*=\".github.com/\"],[href$=\".github.com\"],[href*=\"://github.blog/\"],[href$=\"://github.blog\"]){--op-link-icon: url(\"/static/img/logos/github.svg\")}#content>h5,#content>h6{font-weight:700}.dark #content>h5,.dark #content>h6{color:var(--op-white)}.accordion{background-color:var(--op-icy-blue)}.dark .accordion{background-color:var(--op-surface-card-dark)}.accordion .mint-bg-white{padding:1rem}.accordion .mint-bg-white [class*=\"-mx-\"]{margin:0!important;padding:0!important;width:100%!important;--page-padding: 0px}#footer>div>div.flex.flex-col.md\\:flex-row.gap-8.justify-between.min-h-\\[76px\\]>div.flex.flex-col.sm\\:grid.max-md\\:\\!grid-cols-2.gap-8.flex-1>div>div>p{display:none!important}footer#footer.advanced-footer{display:flex!important}footer#footer{align-items:unset;background-color:var(--op-iron-ore);color:var(--op-white)}#footer img.nav-logo.dark\\:hidden{display:none!important}#footer img.nav-logo.dark\\:block{display:block!important}#footer p.font-semibold,#footer a{color:var(--op-white)}#footer>div.flex.w-full.flex-col.gap-12.justify-between.px-8.py-16.md\\:py-20.lg\\:py-28.z-20>div.h-\\[1px\\].w-full.bg-gray-100.dark\\:bg-white\\/5{background-color:var(--op-border-footer-dark)}#footer>div.flex.w-full.flex-col.gap-12.justify-between.px-8.py-16.md\\:py-20.lg\\:py-28.z-20{margin:0 auto}footer .email_form{max-width:650px;margin:auto}.codeblock_accordion{margin-top:10px}.codeblock_accordion .code-block{margin:0!important}.codeblock_accordion>div>.code-block,.codeblock_accordion>div>.code-block>div:nth-child(2){border-bottom-left-radius:0;border-bottom-right-radius:0}.codeblock_accordion .see_results_container{border-bottom-left-radius:1rem;border-bottom-right-radius:1rem}.codeblock_accordion .see_results_container .code-block,.codeblock_accordion .see_results_container .code-block>div:nth-child(2){border-top-left-radius:0;border-top-right-radius:0}.hide_bullets ul li{padding-left:0!important}.hide_bullets ul li::before{content:none!important}#navigation-items a[href^=\"/\"]:not([href^=\"//\"])>div>div:nth-child(2){display:none}a[href^=\"http\"] .flex-shrink-0 svg,a[href^=\"//\"] .flex-shrink-0 svg{display:block}h1 code,h2 code,h3 code,h4 code,h5 code,h6 code{white-space:nowrap}h2.flex.whitespace-pre-wrap span.cursor-pointer svg.icon,h4.flex.whitespace-pre-wrap span.cursor-pointer svg.icon{margin:0;vertical-align:baseline}table thead tr th code{padding-left:0!important;padding-right:0!important}.tabs.tab-container{padding:0 0.8rem 1rem;border:1px solid var(--op-border-subtle);border-radius:4px}.dark .tabs.tab-container{border-color:var(--op-border-subtle-dark)}nav-tabs-item:nth-child(3),.nav-tabs-item:nth-child(3){--tab-gap-before-divider: 8px;--nav-tabs-item-gap: 0.5rem;margin-left:var(--tab-gap-before-divider)!important;padding-left:calc(\n var(--tab-gap-before-divider) + var(--nav-tabs-item-gap)\n )!important;border-left:1px solid var(--op-border-navbar-light)}.dark nav-tabs-item:nth-child(3),.dark .nav-tabs-item:nth-child(3){border-left-color:var(--op-border-navbar-dark)}.peer.is-center~div:has(.tutorial-explorer){max-width:84rem!important}@media (max-width: 639px){.tutorial-filter-bar{display:grid!important;grid-template-columns:minmax(0, 1fr)}.tutorial-filter-search{grid-column:1 / -1;width:100%}.tutorial-filter-search input{width:100%!important}.tutorial-filter-topic,.tutorial-filter-tools{grid-column:1 / -1;width:100%}.tutorial-filter-dropdown>button,.tutorial-filter-menu{width:100%}.tutorial-filter-dropdown>button{justify-content:space-between}.tutorial-filter-menu{min-width:0!important}.tutorial-filter-sort{grid-column:1 / -1;justify-self:end;margin-left:0!important}}#navbar.is-custom .nav-tabs-item[data-active]{color:var(--op-text-body);text-shadow:none}.dark #navbar.is-custom .nav-tabs-item[data-active]{color:var(--op-text-body-dark)}#navbar.is-custom .nav-tabs-item[data-active]>div{background-color:transparent!important}#navbar.is-custom .nav-tabs-item[data-active]:hover>div{background-color:rgb(229 231 235)!important}.dark #navbar.is-custom .nav-tabs-item[data-active]:hover>div{background-color:rgb(55 65 81)!important}#footer .api-sdk-terms-notice{margin:0;padding:0 0 1.25rem;font-size:0.875rem;font-style:italic;line-height:1.5;text-align:center;color:rgb(251 248 244 / 0.8);pointer-events:auto}#footer .api-sdk-terms-notice a{position:relative;z-index:2;color:var(--op-cornflower);text-decoration:underline;text-underline-offset:2px;pointer-events:auto;cursor:pointer}a:has(>img.nav-logo){display:flex;align-items:center;gap:0.25rem}a:has(>img.nav-logo)::after{content:\"Developers\";font-weight:700;font-size:1.3125rem;line-height:1;letter-spacing:-0.01em;color:#303136;white-space:nowrap}.dark a:has(>img.nav-logo)::after,#footer a:has(>img.nav-logo)::after{color:#FFFEFB}#footer a:has(>img.nav-logo)::after{font-size:1.25rem}"}],"page":{"pagePath":"accounts-api/link-entitlement","slug":"/accounts-api/link-entitlement","pageMetadata":{"title":"Link an entitlement","sidebarTitle":"Link an entitlement","openapi":"openapi/accounts_api.yaml POST /v1/distributor-customers/{distributor-customer}/entitlements:link","description":"Create a change-of-channel entitlement to link an existing 1Password account.","href":"/accounts-api/link-entitlement"},"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: \"Create a change-of-channel entitlement to link an existing 1Password account.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,ol:`ol`,p:`p`,..._provideComponents(),...props.components},{Note,Warning}=_components;if(!Note)_missingMdxReference(`Note`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Use this endpoint when a customer already has a 1Password account and is switching to purchasing 1Password through you as their distributor, instead of provisioning a new account with `,_jsx(_components.a,{href:`/accounts-api/create-entitlement`,children:`create an entitlement`}),`.`]}),`\n`,_jsx(_components.p,{children:`Linking creates a change-of-channel entitlement that connects a customer’s existing 1Password account to your distributor relationship.`}),`\n`,_jsxs(_components.p,{children:[`The request must identify the existing account by its 1Password domain in the metadata (for example, `,_jsx(_components.code,{children:`acme-corp.1password.com`}),`), along with the `,_jsx(_components.a,{href:`/accounts-api/list-products`,children:_jsx(_components.code,{children:`product_id`})}),` to provision and the customer’s `,_jsx(_components.code,{children:`contact_info`}),`.`]}),`\n`,_jsx(_components.p,{children:`Linking an entitlement works as follows:`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`The entitlement is created with a status of `,_jsx(_components.code,{children:`pending`}),` and an `,_jsx(_components.code,{children:`expire_time`}),` 5 days from creation.`]}),`\n`,_jsx(_components.li,{children:`1Password sends an email to the customer with their entitlement code. The email includes your distributor name and the product name.`}),`\n`,_jsxs(_components.li,{children:[`The customer claims the code for their existing 1Password account, which completes the link and transitions the entitlement to `,_jsx(_components.code,{children:`active`}),`.`]}),`\n`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`If the customer doesn’t complete linking within 5 days, the entitlement expires and its status transitions to `,_jsx(_components.code,{children:`expired`}),`.`]})}),`\n`,_jsxs(Note,{children:[_jsxs(_components.p,{children:[`If an entitlement for the product already exists for the customer, the request fails with a `,_jsx(_components.code,{children:`409`}),` error unless it has a `,_jsx(_components.code,{children:`cancelled`}),` or `,_jsx(_components.code,{children:`expired`}),` status.`]}),_jsxs(_components.p,{children:[`If the existing entitlement is `,_jsx(_components.code,{children:`cancelled`}),` or `,_jsx(_components.code,{children:`expired`}),`, it’s reactivated with a status of `,_jsx(_components.code,{children:`pending`}),`.`]}),_jsxs(_components.p,{children:[`A reactivated entitlement keeps its original `,_jsx(_components.code,{children:`id`}),` and `,_jsx(_components.code,{children:`create_time`}),`, with the contact details from the new request.`]})]}),`\n`,_jsxs(_components.p,{children:[`See `,_jsx(_components.a,{href:`/accounts-api/conventions`,children:`API conventions`}),` for more information about authentication, resource paths, pagination, filtering, and error handling.`]})]})}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":"Link an entitlement","sidebarTitle":"Link an entitlement","openapi":"openapi/accounts_api.yaml POST /v1/distributor-customers/{distributor-customer}/entitlements:link","description":"Create a change-of-channel entitlement to link an existing 1Password account.","href":"/accounts-api/link-entitlement"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/ab-634991b8/5ebc0d10523e8210/static/js/analytics.js","/_mintlify/custom/ab-634991b8/5bb7437b1c9dcb44/static/js/gtag-prod-sst.js","/_mintlify/custom/ab-634991b8/ee8ea0eeb20ecd1e/static/js/gtag-sst.js","/_mintlify/custom/ab-634991b8/31610123c784b7c4/api-sdk-terms-notice.js","/_mintlify/custom/ab-634991b8/3604035e212f8294/homepage-card-icons.js"],"openApiReferenceData":{"operation":{"tags":["Entitlements"],"summary":"Link an entitlement","description":"Create a change-of-channel entitlement to link an existing 1Password account.","x-original-description":"Creates a change of channel entitlement for linking an existing 1Password account.","operationId":"linkEntitlement","parameters":["fcd2f16a-f494-42bf-9992-3c4837b693a4"],"requestBody":"62a27b43-15bf-4701-b5c1-f28835ec9dc0","responses":{"200":"d2059943-1f36-47b2-9aca-2f03fa6418b5","400":"eb28719b-d71c-4a1e-9f0a-798a13075e6c","401":"35688936-19f0-4a5c-bccc-99838935700f","404":"75bc9b26-a7cc-4b50-aa7b-3774ce5c7144","409":"2f9c21d7-6859-487d-b6db-93abda1ba38d","429":"5710e620-2dce-4515-be84-88c710c63980","500":"f06871a2-dd87-4a66-8ef4-8db02fe5081d"},"method":"post","type":"path","servers":["a514f651-95f6-4fbf-8c5d-52e2f082d3db"],"security":["23ff0151-0243-4dcb-bb13-db5bd7d77e87"],"path":"/v1/distributor-customers/{distributor-customer}/entitlements:link","baseUrlOptions":["https://api.1password.eu"],"title":"Link an entitlement","codeSamples":[],"requestExampleLanguages":["bash","node","python","go","dotnet","java","php","powershell","ruby"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"fcd2f16a-f494-42bf-9992-3c4837b693a4":{"name":"distributor-customer","in":"path","description":"The customer ID, as defined in the distributor's own system.","required":true,"schema":{"type":"string","isRequired":true,"description":"The customer ID, as defined in the distributor's own system.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"product_id":{"type":"string","minLength":1,"description":"The ID of the 1Password product to provision.","isRequired":true,"uniqueKey":"product_id","typeLabel":"string"},"contact_info":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"The customer's contact email for account activation.","isRequired":true,"uniqueKey":"contact_info.email","typeLabel":"string\u003cemail>"},"company_name":{"type":"string","minLength":1,"description":"The customer's organization name.","isRequired":true,"uniqueKey":"contact_info.company_name","typeLabel":"string"}},"required":["email","company_name"],"additionalProperties":false,"description":"The customer details for account activation and setup.","x-aep-resource":{"singular":"distributorcontactinfo"},"isRequired":true,"uniqueKey":"contact_info","typeLabel":"object"},"metadata":{"type":"object","properties":{"one_password_domain":{"type":"string","minLength":1,"description":"The 1Password domain of the customer's existing 1Password account (for example, `acme-corp.1password.com`). The domain can only be updated if the entitlement already has a domain set; it can't be added or removed.","isRequired":true,"uniqueKey":"metadata.one_password_domain","typeLabel":"string"}},"additionalProperties":false,"description":"The change of channel information. Required, and must include `one_password_domain`.","required":["one_password_domain"],"x-aep-resource":{"singular":"distributormetadata"},"isRequired":true,"uniqueKey":"metadata","typeLabel":"object"}},"required":["contact_info","metadata","product_id"],"additionalProperties":false,"description":"The request body for linking an existing 1Password account.","uniqueKey":"","typeLabel":"object"},"example":{"product_id":"1p-msp-us","contact_info":{"email":"admin@acme-corp.com","company_name":"Acme Corporation"},"metadata":{"one_password_domain":"acme-corp.1password.com"}},"examples":{"Example":{"title":"Example","value":{"product_id":"1p-msp-us","contact_info":{"email":"admin@acme-corp.com","company_name":"Acme Corporation"},"metadata":{"one_password_domain":"acme-corp.1password.com"}}}},"exampleType":"examples"}},"required":true,"exampleType":"examples"},"responses":{"d2059943-1f36-47b2-9aca-2f03fa6418b5":{"description":"The linked change of channel entitlement.","content":{"application/json":{"schema":{"type":"object","properties":{"entitlement":{"type":"object","properties":{"path":{"type":"string","description":"The canonical resource path of the entitlement (for example, \"distributor-customers/{customer_id}/entitlements/{id}\"). Use the IDs in this path to update or cancel the entitlement.","readOnly":true,"uniqueKey":"entitlement.path","typeLabel":"string"},"id":{"type":"string","description":"The unique identifier for this entitlement.","readOnly":true,"uniqueKey":"entitlement.id","typeLabel":"string"},"customer_id":{"type":"string","description":"The ID of the marketplace customer who owns this entitlement. This is the distributor-defined ID from the request path that created the entitlement.","readOnly":true,"uniqueKey":"entitlement.customer_id","typeLabel":"string"},"product_id":{"type":"string","description":"The ID of the 1Password product. Required on create; immutable thereafter.","uniqueKey":"entitlement.product_id","typeLabel":"string"},"status":{"type":"string","description":"The entitlement lifecycle state.","enum":["pending","active","cancelling","cancelled","expired","suspended"],"readOnly":true,"uniqueKey":"entitlement.status","typeLabel":"enum\u003cstring>"},"contact_info":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"The customer's contact email for account activation.","isRequired":true,"uniqueKey":"entitlement.contact_info.email","typeLabel":"string\u003cemail>"},"company_name":{"type":"string","minLength":1,"description":"The customer's organization name.","isRequired":true,"uniqueKey":"entitlement.contact_info.company_name","typeLabel":"string"}},"required":["email","company_name"],"additionalProperties":false,"description":"The customer's contact details for account setup.","x-aep-resource":{"singular":"distributorcontactinfo"},"uniqueKey":"entitlement.contact_info","typeLabel":"object"},"create_time":{"description":"The date and time the entitlement was created.","type":"string","format":"date-time","readOnly":true,"uniqueKey":"entitlement.create_time","typeLabel":"string\u003cdate-time>"},"expire_time":{"description":"The date and time the entitlement expires. Set only for change-of-channel entitlements created by linking an entitlement, and omitted for standard entitlements. Customers have 5 days to claim the emailed entitlement code against their existing 1Password account. Claiming the code completes the link; otherwise, the entitlement transitions to `expired` at this time.","type":"string","format":"date-time","readOnly":true,"uniqueKey":"entitlement.expire_time","typeLabel":"string\u003cdate-time>"}},"additionalProperties":false,"description":"The linked entitlement.","x-aep-resource":{"singular":"distributorentitlement"},"uniqueKey":"entitlement","typeLabel":"object"}},"additionalProperties":false,"description":"The response for a successful entitlement link.","uniqueKey":"","typeLabel":"object"},"example":{"entitlement":{"path":"distributor-customers/cust_789xyz/entitlements/ent_link789abc","id":"ent_link789abc","customer_id":"cust_789xyz","product_id":"1p-msp-us","status":"pending","contact_info":{"email":"admin@acme-corp.com","company_name":"Acme Corporation"},"create_time":"2026-09-15T10:30:00Z","expire_time":"2026-09-20T10:30:00Z"}},"examples":{"Example":{"title":"Example","value":{"entitlement":{"path":"distributor-customers/cust_789xyz/entitlements/ent_link789abc","id":"ent_link789abc","customer_id":"cust_789xyz","product_id":"1p-msp-us","status":"pending","contact_info":{"email":"admin@acme-corp.com","company_name":"Acme Corporation"},"create_time":"2026-09-15T10:30:00Z","expire_time":"2026-09-20T10:30:00Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"eb28719b-d71c-4a1e-9f0a-798a13075e6c":{"description":"Bad Request - Invalid parameters.","content":{"application/json":{"schema":{"type":"object","description":"Standard error response format. This format is provisional and may change in a future release.","properties":{"code":{"type":"string","description":"Error code.","example":"not_found","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable message.","example":"The requested resource was not found.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"","typeLabel":"object"},"example":{"code":"invalid_argument","message":"The 'email' field must be a valid email address."},"examples":{"Example":{"title":"Example","value":{"code":"invalid_argument","message":"The 'email' field must be a valid email address."}}},"exampleType":"examples"}},"exampleType":"examples"},"35688936-19f0-4a5c-bccc-99838935700f":{"description":"Unauthenticated - Missing or invalid credentials.","headers":{"WWW-Authenticate":{"description":"The authentication scheme to use (\"Bearer\").","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","description":"Standard error response format. This format is provisional and may change in a future release.","properties":{"code":{"type":"string","description":"Error code.","example":"not_found","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable message.","example":"The requested resource was not found.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"","typeLabel":"object"},"example":{"code":"unauthenticated","message":"Authentication required. Please provide a valid bearer token."},"examples":{"Example":{"title":"Example","value":{"code":"unauthenticated","message":"Authentication required. Please provide a valid bearer token."}}},"exampleType":"examples"}},"exampleType":"examples"},"75bc9b26-a7cc-4b50-aa7b-3774ce5c7144":{"description":"Not Found - Resource does not exist.","content":{"application/json":{"schema":{"type":"object","description":"Standard error response format. This format is provisional and may change in a future release.","properties":{"code":{"type":"string","description":"Error code.","example":"not_found","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable message.","example":"The requested resource was not found.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"","typeLabel":"object"},"example":{"code":"not_found","message":"The requested resource was not found."},"examples":{"Example":{"title":"Example","value":{"code":"not_found","message":"The requested resource was not found."}}},"exampleType":"examples"}},"exampleType":"examples"},"2f9c21d7-6859-487d-b6db-93abda1ba38d":{"description":"Conflict - Resource already exists.","content":{"application/json":{"schema":{"type":"object","description":"Standard error response format. This format is provisional and may change in a future release.","properties":{"code":{"type":"string","description":"Error code.","example":"not_found","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable message.","example":"The requested resource was not found.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"","typeLabel":"object"},"example":{"code":"already_exists","message":"An entitlement for this product already exists."},"examples":{"Example":{"title":"Example","value":{"code":"already_exists","message":"An entitlement for this product already exists."}}},"exampleType":"examples"}},"exampleType":"examples"},"5710e620-2dce-4515-be84-88c710c63980":{"description":"Too Many Requests - Limit is 1,000 requests per minute per distributor. There is no separate hourly limit.","headers":{"Retry-After":{"description":"How long to wait before retrying, in seconds.","schema":{"type":"string"}}},"content":{"text/plain":{"schema":{"type":"string","uniqueKey":"","typeLabel":"string"},"example":"Too Many Requests","examples":{"Example":{"title":"Example","value":"Too Many Requests"}},"exampleType":"examples"}},"exampleType":"examples"},"f06871a2-dd87-4a66-8ef4-8db02fe5081d":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"type":"object","description":"Standard error response format. This format is provisional and may change in a future release.","properties":{"code":{"type":"string","description":"Error code.","example":"not_found","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable message.","example":"The requested resource was not found.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"","typeLabel":"object"},"example":{"code":"internal","message":"An internal error occurred. Please try again later."},"examples":{"Example":{"title":"Example","value":{"code":"internal","message":"An internal error occurred. Please try again later."}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"23ff0151-0243-4dcb-bb13-db5bd7d77e87":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Bearer token authentication. When a distributor is registered, they receive an opaque bearer token (prefixed `op_b_`). Include it in the Authorization header of every request as `Bearer \u003ctoken>`.","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"a514f651-95f6-4fbf-8c5d-52e2f082d3db":{"url":"https://api.1password.eu","description":"1Password.eu (Europe)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Bearer token authentication. When a distributor is registered, they receive an opaque bearer token (prefixed `op_b_`). Include it in the Authorization header of every request as `Bearer \u003ctoken>`.","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer token authentication. When a distributor is registered, they receive an opaque bearer token (prefixed `op_b_`). Include it in the Authorization header of every request as `Bearer \u003ctoken>`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"openapi/accounts_api.yaml"},"subdomain":"ab-634991b8","siteName":"1Password Developer","title":"Link an entitlement - 1Password Developer","relatedPagesConfig":{"enabled":true,"limit":3,"mode":"automatic"},"contextualStarterQuestions":[{"_id":"6ad6679caa523bd8ddbba12c","deploymentId":"68a8af9a517ab813d3b84097","questionText":"Can I relink a cancelled entitlement?","status":"active","generatedBy":"contextual","path":"accounts-api/link-entitlement","createdAt":"2026-10-19T18:55:24.746Z","updatedAt":"2026-10-19T18:55:24.746Z","__v":0},{"_id":"6ad6679caa523bd8ddbba12b","deploymentId":"68a8af9a517ab813d3b84097","questionText":"What happens if linking isn't completed?","status":"active","generatedBy":"contextual","path":"accounts-api/link-entitlement","createdAt":"2026-10-19T18:55:24.746Z","updatedAt":"2026-10-19T18:55:24.746Z","__v":0},{"_id":"6ad6679caa523bd8ddbba12a","deploymentId":"68a8af9a517ab813d3b84097","questionText":"How do I link an existing account?","status":"active","generatedBy":"contextual","path":"accounts-api/link-entitlement","createdAt":"2026-10-19T18:55:24.746Z","updatedAt":"2026-10-19T18:55:24.746Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-19T18:54:48.191Z","originalFileLocation":"accounts-api/link-entitlement.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=\"Create a change-of-channel entitlement to link an existing 1Password account.\">\u003cmeta data-mint-head name=\"application-name\" content=\"1Password Developer\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ab-634991b8/cic7o6CrHhA6877e/_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=\"/mintlify-assets/_mintlify/favicons/ab-634991b8/cic7o6CrHhA6877e/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ab-634991b8/cic7o6CrHhA6877e/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/ab-634991b8/cic7o6CrHhA6877e/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/ab-634991b8/cic7o6CrHhA6877e/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ab-634991b8/cic7o6CrHhA6877e/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ab-634991b8/cic7o6CrHhA6877e/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/ab-634991b8/cic7o6CrHhA6877e/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/ab-634991b8/cic7o6CrHhA6877e/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Link an entitlement - 1Password Developer\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a change-of-channel entitlement to link an existing 1Password account.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"1Password Developer\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.1password.dev/accounts-api/link-entitlement\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ab-634991b8.mintlify.site/_mintlify/api/og/v2?division=Entitlements\u0026amp;title=Link+an+entitlement\u0026amp;description=Create+a+change-of-channel+entitlement+to+link+an+existing+1Password+account.\u0026amp;theme=4f276e23841331680610e0c6\u0026amp;signature=fee52d677996efe1975ddb9c0deddf0f20d4ed15fd677c1ff3f248c785f7dc7c\">\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=\"Link an entitlement - 1Password Developer\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a change-of-channel entitlement to link an existing 1Password account.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ab-634991b8.mintlify.site/_mintlify/api/og/v2?division=Entitlements\u0026amp;title=Link+an+entitlement\u0026amp;description=Create+a+change-of-channel+entitlement+to+link+an+existing+1Password+account.\u0026amp;theme=4f276e23841331680610e0c6\u0026amp;signature=fee52d677996efe1975ddb9c0deddf0f20d4ed15fd677c1ff3f248c785f7dc7c\">\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=\"/mintlify-assets/_mintlify/favicons/ab-634991b8/cic7o6CrHhA6877e/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"1Password Developer\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#145FE4\">\u003cmeta data-mint-head name=\"google-site-verification\" content=\"YserOhXnJUjFfIZ4K3qgxkVSlQZQdXtIbBiKzZ35Nvs\">\u003clink data-mint-head rel=\"canonical\" href=\"https://www.1password.dev/accounts-api/link-entitlement\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/accounts-api/link-entitlement.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.1password.dev/#organization\",\"name\":\"1Password Developer\",\"url\":\"https://www.1password.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/ab-634991b8/tWWm5UFlpZQ9nof8/images/logo-1password-dark.svg?fit=max\u0026auto=format\u0026n=tWWm5UFlpZQ9nof8\u0026q=85\u0026s=2c2acc6dc5f817defe70ebdef67c9b11\"}},{\"@type\":\"WebSite\",\"@id\":\"https://www.1password.dev#website\",\"name\":\"1Password Developer\",\"url\":\"https://www.1password.dev\",\"publisher\":{\"@id\":\"https://www.1password.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://www.1password.dev/accounts-api/link-entitlement#webpage\",\"url\":\"https://www.1password.dev/accounts-api/link-entitlement\",\"name\":\"Link an entitlement\",\"description\":\"Create a change-of-channel entitlement to link an existing 1Password account.\",\"dateModified\":\"2026-10-19T18:54:48.191Z\",\"isPartOf\":{\"@id\":\"https://www.1password.dev#website\"},\"breadcrumb\":{\"@id\":\"https://www.1password.dev/accounts-api/link-entitlement#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.1password.dev/accounts-api/link-entitlement#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Accounts API\",\"item\":\"https://www.1password.dev/accounts-api\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API reference\",\"item\":\"https://www.1password.dev/accounts-api/reference\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Entitlements\",\"item\":\"https://www.1password.dev/accounts-api/list-entitlements\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Link an entitlement\",\"item\":\"https://www.1password.dev/accounts-api/link-entitlement\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://www.1password.dev/accounts-api/link-entitlement#apireference\",\"headline\":\"Link an entitlement\",\"name\":\"Link an entitlement\",\"description\":\"Create a change-of-channel entitlement to link an existing 1Password account.\",\"url\":\"https://www.1password.dev/accounts-api/link-entitlement\",\"mainEntityOfPage\":{\"@id\":\"https://www.1password.dev/accounts-api/link-entitlement#webpage\"},\"dateModified\":\"2026-10-19T18:54:48.191Z\",\"publisher\":{\"@id\":\"https://www.1password.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://www.1password.dev#website\"}}]}\u003c/script>","agentPointerHref":"/accounts-api/link-entitlement.md","siteName":"1Password Developer","nav":{"global":null,"tabs":[{"tab":"Get started","pages":[{"title":"Get started","href":"/get-started/developer-quickstart"}]},{"tab":"CLI","pages":[{"title":"CLI","href":"/cli"}]},{"tab":"SSH \u0026 Git","pages":[{"title":"SSH \u0026 Git","href":"/ssh"}]},{"tab":"Environments","pages":[{"title":"Environments","href":"/environments"}]},{"tab":"AI agents","pages":[{"title":"AI agents","href":"/security-for-ai"}]},{"tab":"Service Accounts","pages":[{"title":"Service Accounts","href":"/service-accounts"}]},{"tab":"CI/CD \u0026 infrastructure","pages":[{"title":"CI/CD \u0026 infrastructure","href":"/integrations"}]},{"tab":"SDKs \u0026 APIs","menu":[{"item":"SDKs","icon":"cube","pages":[{"title":"SDKs","href":"/sdks"}]},{"item":"Events API","icon":"sensor-triangle-exclamation","pages":[{"title":"Events API","href":"/events-api"}]},{"item":"Users API","icon":"id-badge","pages":[{"title":"Users API","href":"/users-api"}]},{"item":"SaaS Manager API","icon":"chart-line","pages":[{"title":"SaaS Manager API","href":"/saas-manager-api"}]},{"item":"Partnership API","icon":"users","pages":[{"title":"Partnership API","href":"/partnership-api/reference"}]},{"item":"Accounts API","icon":"user-gear","groups":[{"group":"Accounts API","pages":[{"title":"1Password Accounts API for Partners","sidebarTitle":"Overview","href":"/accounts-api"},{"title":"Get started with the 1Password Accounts API for Partners","sidebarTitle":"Get started","href":"/accounts-api/get-started"},{"title":"API conventions","sidebarTitle":"API conventions","href":"/accounts-api/conventions"},{"group":"API reference","pages":[{"title":"Reference for the 1Password Accounts API for Partners","sidebarTitle":"Overview","href":"/accounts-api/reference"},{"group":"Entitlements","pages":[{"title":"List entitlements","sidebarTitle":"List entitlements","openapi":"openapi/accounts_api.yaml GET /v1/distributor-customers/{distributor-customer}/entitlements","href":"/accounts-api/list-entitlements"},{"title":"Create an entitlement","sidebarTitle":"Create an entitlement","openapi":"openapi/accounts_api.yaml POST /v1/distributor-customers/{distributor-customer}/entitlements","href":"/accounts-api/create-entitlement"},{"title":"Update an entitlement","sidebarTitle":"Update an entitlement","openapi":"openapi/accounts_api.yaml PATCH /v1/distributor-customers/{distributor-customer}/entitlements/{entitlement}","href":"/accounts-api/update-entitlement"},{"title":"Cancel an entitlement","sidebarTitle":"Cancel an entitlement","openapi":"openapi/accounts_api.yaml DELETE /v1/distributor-customers/{distributor-customer}/entitlements/{entitlement}","description":"Initiate cancellation of a 1Password product entitlement for a distributor customer.","href":"/accounts-api/cancel-entitlement"},{"title":"Link an entitlement","sidebarTitle":"Link an entitlement","openapi":"openapi/accounts_api.yaml POST /v1/distributor-customers/{distributor-customer}/entitlements:link","href":"/accounts-api/link-entitlement"}]},{"group":"Usage","pages":[{"title":"List customer usage","sidebarTitle":"List customer usage","openapi":"openapi/accounts_api.yaml GET /v1/distributor-customers/{distributor-customer}/usage","description":"Retrieve paginated product usage data for a distributor's customers.","href":"/accounts-api/list-customer-usage"}]},{"group":"Products","pages":[{"title":"List products","sidebarTitle":"List products","openapi":"openapi/accounts_api.yaml GET /v1/distributor-products","href":"/accounts-api/list-products"}]}]}]}]},{"item":"Web Development","icon":"code","pages":[{"title":"Web Development","href":"/web/add-1password-button-website"}]}]},{"tab":"Community","menu":[{"item":"Developer community","icon":"users","href":"/community"},{"item":"Events","icon":"calendar","href":"https://luma.com/1password"},{"item":"Newsletter","icon":"envelope","href":"https://1password.com/developer-newsletter"},{"item":"Slack","icon":"slack","href":"https://www.1password.dev/joinslack"},{"item":"1Password Academy","icon":"graduation-cap","href":"https://www.1password.academy/path/1password-developer-tools"}]},{"tab":"Agentic Autofill partner guide","hidden":true,"pages":[{"title":"Agentic Autofill partner guide","href":"/agentic-autofill/partners"}]}]},"basePath":"","title":"Link an entitlement - 1Password Developer","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-Dlc3Qr3h.js","dist-D2J8knkn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-Dq9TQuNi.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","Page-BIYvYBgk.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","AssistantPageLink-BgZ2ThuU.js"]}