{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Shuffll Engage authentication and access","projectTitle":"Shuffll Developers","lang":"en","image":"/assets/icon-light.cf77c9f50f367b5652a57cbdbd6d9a5881b87349c1b0643a9f667e0d2e220f90.42541b0d.png","description":"Understand Shuffll Engage workspace access, scoped API keys, human administration, and OAuth discovery for MCP clients.","siteUrl":"https://api-docs.shuffll.com","jsonLd":{"@context":"https://schema.org","@graph":[{"@type":"Organization","@id":"https://shuffll.com/#organization","name":"Shuffll","url":"https://shuffll.com"},{"@type":"WebSite","@id":"https://api-docs.shuffll.com/#website","name":"Shuffll Developers","url":"https://api-docs.shuffll.com","inLanguage":"en","publisher":{"@id":"https://shuffll.com/#organization"}},{"@type":"WebAPI","@id":"https://api-docs.shuffll.com/engage#api","name":"Shuffll Engage API and MCP","url":"https://engage.shuffll.com","documentation":["https://api-docs.shuffll.com/engage","https://api-docs.shuffll.com/openapi/engage.json"],"serviceType":"Video campaign API and MCP","provider":{"@id":"https://shuffll.com/#organization"}},{"@type":"WebAPI","@id":"https://api-docs.shuffll.com/guides#api","name":"Shuffll Video Production API","url":"https://api.shuffll.com/api/v1","documentation":["https://api-docs.shuffll.com/apis","https://api-docs.shuffll.com/openapi/video-production.yaml"],"serviceType":"Video production REST API","provider":{"@id":"https://shuffll.com/#organization"}}]},"llmstxt":{"hide":false,"title":"Shuffll Engage API and MCP — Shuffll Developers","description":"Shuffll Engage connects agentic creation, catalog-driven campaigns, overlays and multilingual video through API and MCP. Video Production covers individual video projects.","details":{"content":"Start with [Shuffll Engage](https://api-docs.shuffll.com/engage). Read [which API to use](https://api-docs.shuffll.com/choose-api) and the [FAQ](https://api-docs.shuffll.com/faq) for scope, endpoints, and authentication. REST references are separate: [Engage](https://api-docs.shuffll.com/engage/openapi) and [Video Production](https://api-docs.shuffll.com/apis). Machine-readable OpenAPI downloads: [Engage JSON](https://api-docs.shuffll.com/openapi/engage.json) and [Video Production YAML](https://api-docs.shuffll.com/openapi/video-production.yaml). Legacy flat-video-v1 restrictions apply to that rendering workflow. Check live workspace access and operation-specific environment requirements.\n"},"sections":[{"title":"Shuffll Engage API and MCP","includeFiles":["engage/**/*.md"]},{"title":"Choose an API and get answers","includeFiles":["choose-api.md","faq.md"]},{"title":"Shuffll Video Production API","includeFiles":["guides/*.md","integrations/*.md"]},{"title":"Support","includeFiles":["contact.md"]}]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"shuffll-engage-authentication-and-access","__idx":0},"children":["Shuffll Engage authentication and access"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"scoped-machine-keys","__idx":1},"children":["Scoped machine keys"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Send ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization: Bearer <YOUR_API_KEY>"]}," over HTTPS. A machine key is bound to its tenant; do not attach human workspace selectors to machine requests. Keep keys in server-side secret storage or an MCP client's private credential settings. Never place keys in query strings, prompts, shared configuration or logs."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Keys are subject to current scopes, workspace policy, hierarchy, expiry and revocation. Delegated key lifetimes cannot exceed their issuer's lifetime. Revoking a key disables its delegated descendants. Rotation overlap defaults to zero."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["REST key issue/rotation returns the new secret once. An idempotent replay may show completion with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["secretAvailable: false"]},"; inspect metadata and rotate if a usable secret is still needed. MCP never returns the raw key secret: when configured, authorized key-management tools return a short-lived human claim link."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"human-administration","__idx":2},"children":["Human administration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Initial API enablement and access-control changes require a verified human administrator. Human sessions can select a permitted workspace using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Engage-Meta-Organization"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Engage-Organization"]},"; the server verifies the selection against persisted authority. Machine and OAuth principals cannot use these selectors to switch tenants."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"oauth","__idx":3},"children":["OAuth"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For OAuth-capable MCP clients, follow the hosted endpoint's protected-resource and authorization-server discovery metadata. Tenant API enablement alone does not grant OAuth access or additional scopes. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/engage/mcp"},"children":["MCP setup"]}," for connection guidance and ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/engage/release-status"},"children":["API scope and availability"]}," for workflow boundaries."]}]},"headings":[{"value":"Shuffll Engage authentication and access","id":"shuffll-engage-authentication-and-access","depth":1},{"value":"Scoped machine keys","id":"scoped-machine-keys","depth":2},{"value":"Human administration","id":"human-administration","depth":2},{"value":"OAuth","id":"oauth","depth":2}],"frontmatter":{"seo":{"title":"Shuffll Engage authentication and access","description":"Understand Shuffll Engage workspace access, scoped API keys, human administration, and OAuth discovery for MCP clients."}},"lastModified":"2026-10-25T17:27:35.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/engage/authentication","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}