{"_path":"/getting-started/auth-helpers","_draft":false,"_partial":false,"_empty":false,"title":"Auth Helpers","description":"Helper functions for working with authentication in Apollo.","excerpt":{"type":"root","children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Nuxt Apollo provides three (3) auth helpers which can be easily plugged into your authentication flow to interface with configured Apollo clients."}]},{"type":"element","tag":"h2","props":{"id":"gettoken"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"getToken"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Retrieve the auth token token for the specified client."}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"This adheres to the "},{"type":"element","tag":"a","props":{"href":"/recipes/authentication#auth-hook"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"apollo:auth"}]},{"type":"text","value":" hook"}]},{"type":"text","value":". and will attempt to automatically retrieve the token from the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"apollo:auth"}]},{"type":"text","value":" hook."}]},{"type":"element","tag":"code","props":{"code":"const { getToken } = useApollo()\n\nconst token = getToken()\n\nconst otherToken = getToken('<client_name>')\n","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"const { getToken } = useApollo()\n\nconst token = getToken()\n\nconst otherToken = getToken('<client_name>')\n"}]}]}]},{"type":"element","tag":"h3","props":{"id":"gettoken-reference"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"getToken"}]},{"type":"text","value":" Reference"}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"client"}]},{"type":"text","value":": The Apollo client who's token should be retrieved."}]}]},{"type":"element","tag":"h2","props":{"id":"onlogin"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"onLogin"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Used to apply the given auth token to the specified Apollo client. This is required if your GraphQL API expects authentication to be passed via a HTTP header."}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default, this function will reset the Apollo client cache and re-execute all queries, this behavior can be averted by passing "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"false"}]},{"type":"text","value":" as the third parameter ("},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"skipResetStore"}]},{"type":"text","value":")."}]},{"type":"element","tag":"code","props":{"code":"const { onLogin } = useApollo()\n\nfunction handleLogin() {\n  // your login flow...\n\n  onLogin(token)\n}\n","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"const { onLogin } = useApollo()\n\nfunction handleLogin() {\n  // your login flow...\n\n  onLogin(token)\n}\n"}]}]}]},{"type":"element","tag":"h3","props":{"id":"onlogin-reference"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"onLogin"}]},{"type":"text","value":" Reference"}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"token"}]},{"type":"text","value":": The token to be applied."}]},{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"client"}]},{"type":"text","value":": The Apollo client to authenticate."},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"text","value":"Default: "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"default"}]}]}]}]},{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"skipResetStore"}]},{"type":"text","value":": Whether to skip resetting the Apollo client cache."},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"text","value":"Default: "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"false"}]}]}]}]}]},{"type":"element","tag":"h2","props":{"id":"onlogout"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"onLogout"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Used to remove the auth token from the specified Apollo client."}]},{"type":"element","tag":"code","props":{"code":"const { onLogout } = useApollo()\n\nfunction handleLogout() {\n  // your logout flow...\n\n  onLogout()\n}\n","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"const { onLogout } = useApollo()\n\nfunction handleLogout() {\n  // your logout flow...\n\n  onLogout()\n}\n"}]}]}]},{"type":"element","tag":"h3","props":{"id":"onlogout-reference"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"onLogout"}]},{"type":"text","value":" Reference"}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"client"}]},{"type":"text","value":": The Apollo client to de-authenticate."},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"text","value":"Default: "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"default"}]}]}]}]},{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"skipResetStore"}]},{"type":"text","value":": Whether to skip resetting the Apollo client cache."},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"text","value":"Default: "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"false"}]}]}]}]}]}]},"body":{"type":"root","children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Nuxt Apollo provides three (3) auth helpers which can be easily plugged into your authentication flow to interface with configured Apollo clients."}]},{"type":"element","tag":"h2","props":{"id":"gettoken"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"getToken"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Retrieve the auth token token for the specified client."}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"This adheres to the "},{"type":"element","tag":"a","props":{"href":"/recipes/authentication#auth-hook"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"apollo:auth"}]},{"type":"text","value":" hook"}]},{"type":"text","value":". and will attempt to automatically retrieve the token from the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"apollo:auth"}]},{"type":"text","value":" hook."}]},{"type":"element","tag":"code","props":{"code":"const { getToken } = useApollo()\n\nconst token = getToken()\n\nconst otherToken = getToken('<client_name>')\n","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-fe6d9b"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-4c5063"},"children":[{"type":"text","value":" { "}]},{"type":"element","tag":"span","props":{"class":"ct-611769"},"children":[{"type":"text","value":"getToken"}]},{"type":"element","tag":"span","props":{"class":"ct-4c5063"},"children":[{"type":"text","value":" } "}]},{"type":"element","tag":"span","props":{"class":"ct-a19c01"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-4c5063"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-22ffe9"},"children":[{"type":"text","value":"useApollo"}]},{"type":"element","tag":"span","props":{"class":"ct-4c5063"},"children":[{"type":"text","value":"()"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-fe6d9b"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-4c5063"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-611769"},"children":[{"type":"text","value":"token"}]},{"type":"element","tag":"span","props":{"class":"ct-4c5063"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a19c01"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-4c5063"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-22ffe9"},"children":[{"type":"text","value":"getToken"}]},{"type":"element","tag":"span","props":{"class":"ct-4c5063"},"children":[{"type":"text","value":"()"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-fe6d9b"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-4c5063"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-611769"},"children":[{"type":"text","value":"otherToken"}]},{"type":"element","tag":"span","props":{"class":"ct-4c5063"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a19c01"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-4c5063"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-22ffe9"},"children":[{"type":"text","value":"getToken"}]},{"type":"element","tag":"span","props":{"class":"ct-4c5063"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-612c71"},"children":[{"type":"text","value":"'<client_name>'"}]},{"type":"element","tag":"span","props":{"class":"ct-4c5063"},"children":[{"type":"text","value":")"}]}]}]}]}]},{"type":"element","tag":"h3","props":{"id":"gettoken-reference"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"getToken"}]},{"type":"text","value":" Reference"}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"client"}]},{"type":"text","value":": The Apollo client who's token should be retrieved."}]}]},{"type":"element","tag":"h2","props":{"id":"onlogin"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"onLogin"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Used to apply the given auth token to the specified Apollo client. This is required if your GraphQL API expects authentication to be passed via a HTTP header."}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default, this function will reset the Apollo client cache and re-execute all queries, this behavior can be averted by passing "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"false"}]},{"type":"text","value":" as the third parameter ("},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"skipResetStore"}]},{"type":"text","value":")."}]},{"type":"element","tag":"code","props":{"code":"const { onLogin } = useApollo()\n\nfunction handleLogin() {\n  // your login flow...\n\n  onLogin(token)\n}\n","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-fe6d9b"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-4c5063"},"children":[{"type":"text","value":" { "}]},{"type":"element","tag":"span","props":{"class":"ct-611769"},"children":[{"type":"text","value":"onLogin"}]},{"type":"element","tag":"span","props":{"class":"ct-4c5063"},"children":[{"type":"text","value":" } "}]},{"type":"element","tag":"span","props":{"class":"ct-a19c01"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-4c5063"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-22ffe9"},"children":[{"type":"text","value":"useApollo"}]},{"type":"element","tag":"span","props":{"class":"ct-4c5063"},"children":[{"type":"text","value":"()"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-fe6d9b"},"children":[{"type":"text","value":"function"}]},{"type":"element","tag":"span","props":{"class":"ct-4c5063"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-22ffe9"},"children":[{"type":"text","value":"handleLogin"}]},{"type":"element","tag":"span","props":{"class":"ct-4c5063"},"children":[{"type":"text","value":"() {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-4c5063"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-407972"},"children":[{"type":"text","value":"// your login flow..."}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-4c5063"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-22ffe9"},"children":[{"type":"text","value":"onLogin"}]},{"type":"element","tag":"span","props":{"class":"ct-4c5063"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-3d39f0"},"children":[{"type":"text","value":"token"}]},{"type":"element","tag":"span","props":{"class":"ct-4c5063"},"children":[{"type":"text","value":")"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-4c5063"},"children":[{"type":"text","value":"}"}]}]}]}]}]},{"type":"element","tag":"h3","props":{"id":"onlogin-reference"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"onLogin"}]},{"type":"text","value":" Reference"}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"token"}]},{"type":"text","value":": The token to be applied."}]},{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"client"}]},{"type":"text","value":": The Apollo client to authenticate."},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"text","value":"Default: "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"default"}]}]}]}]},{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"skipResetStore"}]},{"type":"text","value":": Whether to skip resetting the Apollo client cache."},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"text","value":"Default: "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"false"}]}]}]}]}]},{"type":"element","tag":"h2","props":{"id":"onlogout"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"onLogout"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Used to remove the auth token from the specified Apollo client."}]},{"type":"element","tag":"code","props":{"code":"const { onLogout } = useApollo()\n\nfunction handleLogout() {\n  // your logout flow...\n\n  onLogout()\n}\n","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-fe6d9b"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-4c5063"},"children":[{"type":"text","value":" { "}]},{"type":"element","tag":"span","props":{"class":"ct-611769"},"children":[{"type":"text","value":"onLogout"}]},{"type":"element","tag":"span","props":{"class":"ct-4c5063"},"children":[{"type":"text","value":" } "}]},{"type":"element","tag":"span","props":{"class":"ct-a19c01"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-4c5063"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-22ffe9"},"children":[{"type":"text","value":"useApollo"}]},{"type":"element","tag":"span","props":{"class":"ct-4c5063"},"children":[{"type":"text","value":"()"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-fe6d9b"},"children":[{"type":"text","value":"function"}]},{"type":"element","tag":"span","props":{"class":"ct-4c5063"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-22ffe9"},"children":[{"type":"text","value":"handleLogout"}]},{"type":"element","tag":"span","props":{"class":"ct-4c5063"},"children":[{"type":"text","value":"() {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-4c5063"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-407972"},"children":[{"type":"text","value":"// your logout flow..."}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-4c5063"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-22ffe9"},"children":[{"type":"text","value":"onLogout"}]},{"type":"element","tag":"span","props":{"class":"ct-4c5063"},"children":[{"type":"text","value":"()"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-4c5063"},"children":[{"type":"text","value":"}"}]}]}]}]}]},{"type":"element","tag":"h3","props":{"id":"onlogout-reference"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"onLogout"}]},{"type":"text","value":" Reference"}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"client"}]},{"type":"text","value":": The Apollo client to de-authenticate."},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"text","value":"Default: "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"default"}]}]}]}]},{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"skipResetStore"}]},{"type":"text","value":": Whether to skip resetting the Apollo client cache."},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"text","value":"Default: "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"false"}]}]}]}]}]},{"type":"element","tag":"style","children":[{"type":"text","value":".ct-3d39f0{color:#E06C75}.ct-407972{color:#7F848E}.ct-612c71{color:#98C379}.ct-22ffe9{color:#61AFEF}.ct-a19c01{color:#56B6C2}.ct-611769{color:#E5C07B}.ct-4c5063{color:#ABB2BF}.ct-fe6d9b{color:#C678DD}"}]}],"toc":{"title":"","searchDepth":2,"depth":2,"links":[{"id":"gettoken","depth":2,"text":"getToken","children":[{"id":"gettoken-reference","depth":3,"text":"getToken Reference"}]},{"id":"onlogin","depth":2,"text":"onLogin","children":[{"id":"onlogin-reference","depth":3,"text":"onLogin Reference"}]},{"id":"onlogout","depth":2,"text":"onLogout","children":[{"id":"onlogout-reference","depth":3,"text":"onLogout Reference"}]}]}},"_type":"markdown","_id":"content:1.getting-started:4.auth-helpers.md","_source":"content","_file":"1.getting-started/4.auth-helpers.md","_extension":"md"}