Map of licensed MIC codes to entitlement levels for the token owner. Returns an empty object when the token owner is not eligible.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Ignite API","colors":{"primary":"#3B82F6","light":"#0085FF","dark":"#2563EB"},"logo":{"light":"https://mintcdn.com/tickblaze/LyaG4yU0RLGol6cN/logo/light.webp?fit=max\u0026auto=format\u0026n=LyaG4yU0RLGol6cN\u0026q=85\u0026s=fe4d152a21d32c41add95b18571f5111","dark":"https://mintcdn.com/tickblaze/LyaG4yU0RLGol6cN/logo/dark.webp?fit=max\u0026auto=format\u0026n=LyaG4yU0RLGol6cN\u0026q=85\u0026s=0d1226b0b27755d07d1e476572d8170b"},"favicon":"https://mintcdn.com/tickblaze/LyaG4yU0RLGol6cN/favicon.webp?fit=max\u0026auto=format\u0026n=LyaG4yU0RLGol6cN\u0026q=85\u0026s=1e0764bf9b8d7e85a46b34dba53db935","contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"tickblaze","hasAudioNarration":false,"actualSubdomain":"tickblaze","customDomains":[],"gitSource":{"type":"github","owner":"tickblaze","repo":"ignite_documentation","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6a92078a528c608ca302fdf5","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API reference","count":35},{"language":"default","tag":"Accounts","count":10},{"language":"default","tag":"Users","count":10},{"language":"default","tag":"Guides","count":9},{"language":"default","tag":"Trade","count":4},{"language":"default","tag":"Firm onboarding","count":3},{"language":"default","tag":"Get started","count":3},{"language":"default","tag":"Entitlements","count":3},{"language":"default","tag":"withdrawals","count":3},{"language":"default","tag":"Operations","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"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":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/users/get-user-entitlements-by-token","slug":"/api-reference/users/get-user-entitlements-by-token","pageMetadata":{"title":"Get user entitlements by token","description":"Accepts a token key in the path (`/api/users/{token}/entitlements/`), resolves the token owner, and returns data entitlements for that user if eligible.","deprecated":null,"version":null,"openapi":"/openapi.json get /api/users/{id}/entitlements/","href":"/api-reference/users/get-user-entitlements-by-token","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Accepts a token key in the path (\", _jsx(_components.code, {\n children: \"/api/users/{token}/entitlements/\"\n }), \"), resolves the token owner, and returns data entitlements for that user if eligible.\"]\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get user entitlements by token","description":"Accepts a token key in the path (`/api/users/{token}/entitlements/`), resolves the token owner, and returns data entitlements for that user if eligible.","deprecated":null,"version":null,"openapi":"/openapi.json get /api/users/{id}/entitlements/","href":"/api-reference/users/get-user-entitlements-by-token","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"api_users_entitlements_retrieve_2","description":"Accepts a token key in the path (`/api/users/{token}/entitlements/`), resolves the token owner, and returns data entitlements for that user if eligible.","summary":"Get user entitlements by token","parameters":["ecd74806-ab34-4ff6-b0d9-58115d0c83a0"],"tags":["Users"],"security":["923ee5c2-4b38-4a4a-b68c-b34387972ef0"],"responses":{"200":"659f2045-d75e-43e7-9840-56459f0528b4","401":"b56206f3-d690-43be-b9cc-6b98798221a7"},"method":"get","type":"path","servers":[],"path":"/api/users/{id}/entitlements/","baseUrlOptions":[],"title":"Get user entitlements by token","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"ecd74806-ab34-4ff6-b0d9-58115d0c83a0":{"in":"path","name":"id","schema":{"type":"integer","isRequired":true,"description":"A unique integer value identifying this user.","uniqueKey":"","typeLabel":"integer"},"description":"A unique integer value identifying this user.","required":true}},"responses":{"659f2045-d75e-43e7-9840-56459f0528b4":{"content":{"application/json":{"schema":{"type":"object","properties":{"firstPartyLicensedMics":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"firstPartyLicensedMics.additionalProperties","typeLabel":"string"},"description":"Map of licensed MIC codes to entitlement levels for the token owner. Returns an empty object when the token owner is not eligible.","isRequired":true,"uniqueKey":"firstPartyLicensedMics","typeLabel":"object"}},"required":["firstPartyLicensedMics"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"firstPartyLicensedMics":{}}}},"exampleType":"generated"}},"description":"Entitlements payload. Returns a data entitlement map when eligible; otherwise returns an empty entitlement map.","exampleType":"generated"},"b56206f3-d690-43be-b9cc-6b98798221a7":{"description":"Missing, invalid, or expired token.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"923ee5c2-4b38-4a4a-b68c-b34387972ef0":{}},"servers":{}},"originalFileLocation":"openapi.json"},"subdomain":"tickblaze","siteName":"Ignite API","title":"Get user entitlements by token - Ignite API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-28T22:11:27.448Z","originalFileLocation":"api-reference/users/get-user-entitlements-by-token.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=\"Accepts a token key in the path (/api/users/{token}/entitlements/), resolves the token owner, and returns data entitlements for that user if eligible.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Ignite API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/tickblaze/XWSaL7nm9xiQNJDY/_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/tickblaze/XWSaL7nm9xiQNJDY/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/tickblaze/XWSaL7nm9xiQNJDY/_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/tickblaze/XWSaL7nm9xiQNJDY/_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/tickblaze/XWSaL7nm9xiQNJDY/_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/tickblaze/XWSaL7nm9xiQNJDY/_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/tickblaze/XWSaL7nm9xiQNJDY/_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/tickblaze/XWSaL7nm9xiQNJDY/_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/tickblaze/XWSaL7nm9xiQNJDY/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get user entitlements by token - Ignite API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Accepts a token key in the path (/api/users/{token}/entitlements/), resolves the token owner, and returns data entitlements for that user if eligible.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Ignite API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://tickblaze.mintlify.app/api-reference/users/get-user-entitlements-by-token\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://tickblaze.mintlify.site/_mintlify/api/og/v2?division=Users\u0026amp;title=Get+user+entitlements+by+token\u0026amp;description=Accepts+a+token+key+in+the+path+%28%60%2Fapi%2Fusers%2F%7Btoken%7D%2Fentitlements%2F%60%29%2C+resolves+the+token+owner%2C+and+returns+data+entitlements+for+that+user+if+eligible.\u0026amp;theme=2fd322792c8ee4df87f64ccb\u0026amp;signature=7aa511d1e597d48ec61bafa9d917d0caf9d854c445f473c3988bb1a4fab88595\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get user entitlements by token - Ignite API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Accepts a token key in the path (/api/users/{token}/entitlements/), resolves the token owner, and returns data entitlements for that user if eligible.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://tickblaze.mintlify.site/_mintlify/api/og/v2?division=Users\u0026amp;title=Get+user+entitlements+by+token\u0026amp;description=Accepts+a+token+key+in+the+path+%28%60%2Fapi%2Fusers%2F%7Btoken%7D%2Fentitlements%2F%60%29%2C+resolves+the+token+owner%2C+and+returns+data+entitlements+for+that+user+if+eligible.\u0026amp;theme=2fd322792c8ee4df87f64ccb\u0026amp;signature=7aa511d1e597d48ec61bafa9d917d0caf9d854c445f473c3988bb1a4fab88595\">\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/tickblaze/XWSaL7nm9xiQNJDY/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Ignite API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3B82F6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://tickblaze.mintlify.app/api-reference/users/get-user-entitlements-by-token\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/users/get-user-entitlements-by-token.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://tickblaze.mintlify.app/#organization\",\"name\":\"Ignite API\",\"url\":\"https://tickblaze.mintlify.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/tickblaze/LyaG4yU0RLGol6cN/logo/light.webp?fit=max\u0026auto=format\u0026n=LyaG4yU0RLGol6cN\u0026q=85\u0026s=fe4d152a21d32c41add95b18571f5111\"}},{\"@type\":\"WebSite\",\"@id\":\"https://tickblaze.mintlify.app#website\",\"name\":\"Ignite API\",\"url\":\"https://tickblaze.mintlify.app\",\"publisher\":{\"@id\":\"https://tickblaze.mintlify.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://tickblaze.mintlify.app/api-reference/users/get-user-entitlements-by-token#webpage\",\"url\":\"https://tickblaze.mintlify.app/api-reference/users/get-user-entitlements-by-token\",\"name\":\"Get user entitlements by token\",\"description\":\"Accepts a token key in the path (/api/users/{token}/entitlements/), resolves the token owner, and returns data entitlements for that user if eligible.\",\"dateModified\":\"2026-08-28T22:11:27.448Z\",\"isPartOf\":{\"@id\":\"https://tickblaze.mintlify.app#website\"},\"breadcrumb\":{\"@id\":\"https://tickblaze.mintlify.app/api-reference/users/get-user-entitlements-by-token#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://tickblaze.mintlify.app/api-reference/users/get-user-entitlements-by-token#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Users\",\"item\":\"https://tickblaze.mintlify.app/api-reference/users/list-users\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get user entitlements by token\",\"item\":\"https://tickblaze.mintlify.app/api-reference/users/get-user-entitlements-by-token\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://tickblaze.mintlify.app/api-reference/users/get-user-entitlements-by-token#apireference\",\"headline\":\"Get user entitlements by token\",\"name\":\"Get user entitlements by token\",\"description\":\"Accepts a token key in the path (/api/users/{token}/entitlements/), resolves the token owner, and returns data entitlements for that user if eligible.\",\"url\":\"https://tickblaze.mintlify.app/api-reference/users/get-user-entitlements-by-token\",\"mainEntityOfPage\":{\"@id\":\"https://tickblaze.mintlify.app/api-reference/users/get-user-entitlements-by-token#webpage\"},\"dateModified\":\"2026-08-28T22:11:27.448Z\",\"publisher\":{\"@id\":\"https://tickblaze.mintlify.app/#organization\"},\"isPartOf\":{\"@id\":\"https://tickblaze.mintlify.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Ignite API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Ignite API","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","groups":[{"group":"Accounts","pages":[{"title":"Create a trading account","deprecated":null,"version":null,"openapi":"/openapi.json post /api/accounts/","href":"/api-reference/accounts/create-a-trading-account"},{"title":"Retrieve trading account information","deprecated":null,"version":null,"openapi":"/openapi.json get /api/accounts/{id}/","href":"/api-reference/accounts/retrieve-trading-account-information"},{"title":"Deactivate a trading account","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/accounts/{id}/deactivate/","href":"/api-reference/accounts/deactivate-a-trading-account"},{"title":"Reactivate a trading account","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/accounts/{id}/reactivate/","href":"/api-reference/accounts/reactivate-a-trading-account"},{"title":"Adjust balance for trading accounts","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/accounts/balance/","href":"/api-reference/accounts/adjust-balance-for-trading-accounts"},{"title":"Get balance, equity and reporting fields for accounts","deprecated":null,"version":null,"openapi":"/openapi.json get /api/accounts/balance-equity/","href":"/api-reference/accounts/get-balance-equity-and-reporting-fields-for-accounts"},{"title":"List disabled trading accounts","deprecated":null,"version":null,"openapi":"/openapi.json get /api/accounts/disabled/","href":"/api-reference/accounts/list-disabled-trading-accounts"},{"title":"Bulk reactivate trading accounts","deprecated":null,"version":null,"openapi":"/openapi.json post /api/accounts/reactivate/","href":"/api-reference/accounts/bulk-reactivate-trading-accounts"},{"title":"Update trading account statuses","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/accounts/status/","href":"/api-reference/accounts/update-trading-account-statuses"},{"title":"List accounts with optional field selection and nested objects","deprecated":null,"version":null,"openapi":"/openapi.json get /api/accounts/summary/","href":"/api-reference/accounts/list-accounts-with-optional-field-selection-and-nested-objects"}]},{"group":"Challenge","pages":[{"title":"List Challenges","deprecated":null,"version":null,"openapi":"/openapi.json get /api/challenges/","href":"/api-reference/challenge/list-challenges"}]},{"group":"Entitlements","pages":[{"title":"List user entitlements","deprecated":null,"version":null,"openapi":"/openapi.json get /api/entitlements/user-entitlements/","href":"/api-reference/entitlements/list-user-entitlements"},{"title":"Retrieve user entitlements by user_id","deprecated":null,"version":null,"openapi":"/openapi.json get /api/entitlements/user-entitlements/{user_id}/","href":"/api-reference/entitlements/retrieve-user-entitlements-by-user_id"},{"title":"Authorize or revoke user entitlements","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/users/{user_id}/entitlements/","href":"/api-reference/entitlements/authorize-or-revoke-user-entitlements"}]},{"group":"Status","pages":[{"title":"Health probe","deprecated":null,"version":null,"openapi":"/openapi.json get /api/health/","href":"/api-reference/status/health-probe"},{"title":"Scheduled outage status","deprecated":null,"version":null,"openapi":"/openapi.json get /api/maintenance/","href":"/api-reference/status/scheduled-outage-status"}]},{"group":"Trade","pages":[{"title":"Submit close requests for all open positions for an account","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/trade/accounts/{account_id}/positions/close/","href":"/api-reference/trade/submit-close-requests-for-all-open-positions-for-an-account"},{"title":"Submit close requests for all open positions for an account","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/trade/accounts/positions/close/","href":"/api-reference/trade/submit-close-requests-for-all-open-positions-for-an-account-1"},{"title":"List positions across accessible accounts","deprecated":null,"version":null,"openapi":"/openapi.json get /api/trade/positions/","href":"/api-reference/trade/list-positions-across-accessible-accounts"},{"title":"Submit a close request for one account and symbol","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/trade/positions/close/","href":"/api-reference/trade/submit-a-close-request-for-one-account-and-symbol"}]},{"group":"Users","pages":[{"title":"List users","deprecated":null,"version":null,"openapi":"/openapi.json get /api/users/","href":"/api-reference/users/list-users"},{"title":"Create a trader user","deprecated":null,"version":null,"openapi":"/openapi.json post /api/users/","href":"/api-reference/users/create-a-trader-user"},{"title":"Retrieve user details","deprecated":null,"version":null,"openapi":"/openapi.json get /api/users/{id}/","href":"/api-reference/users/retrieve-user-details"},{"title":"Update user contact details","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/users/{id}/","href":"/api-reference/users/update-user-contact-details"},{"title":"Get per-user account counts","deprecated":null,"version":null,"openapi":"/openapi.json get /api/users/{id}/accounts/stats/","href":"/api-reference/users/get-per-user-account-counts"},{"title":"Deactivate a user","description":"Deactivate a user with an audit reason. By default, the user's trading accounts for your firm are also blocked. Set `deactivate_accounts=false` to leave trading accounts unchanged.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/users/{id}/deactivate/","href":"/api-reference/users/deactivate-a-user"},{"title":"Get user entitlements by token","deprecated":null,"version":null,"openapi":"/openapi.json get /api/users/{id}/entitlements/","href":"/api-reference/users/get-user-entitlements-by-token"},{"title":"Reactivate a user","description":"Restore access for a previously deactivated user. This endpoint reactivates only the user profile and does not change trading accounts.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/users/{id}/reactivate/","href":"/api-reference/users/reactivate-a-user"},{"title":"List entitlement flags by user","deprecated":null,"version":null,"openapi":"/openapi.json get /api/users/entitlements/","href":"/api-reference/users/list-entitlement-flags-by-user"},{"title":"Export users CSV","deprecated":null,"version":null,"openapi":"/openapi.json get /api/users/export/","href":"/api-reference/users/export-users-csv"}]},{"group":"withdrawals","pages":[{"title":"List withdrawals","deprecated":null,"version":null,"openapi":"/openapi.json get /api/withdrawals/","href":"/api-reference/withdrawals/list-withdrawals"},{"title":"Check potential withdrawal details","deprecated":null,"version":null,"openapi":"/openapi.json get /api/withdrawals/{account_id}/request/","href":"/api-reference/withdrawals/check-potential-withdrawal-details"},{"title":"Request a withdrawal","deprecated":null,"version":null,"openapi":"/openapi.json post /api/withdrawals/{account_id}/request/","href":"/api-reference/withdrawals/request-a-withdrawal"}]},{"group":"Auth","pages":[{"title":"Authenticate a user","deprecated":null,"version":null,"openapi":"/openapi.json post /auth/login/","href":"/api-reference/auth/authenticate-a-user"},{"title":"Refresh access token","deprecated":null,"version":null,"openapi":"/openapi.json post /auth/refresh/","href":"/api-reference/auth/refresh-access-token"}]}]}]},"basePath":"","title":"Get user entitlements by token - Ignite API","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}