diff --git a/.version b/.version index 5da133a8..ee92fa74 100644 --- a/.version +++ b/.version @@ -1 +1 @@ -v2.22.0 \ No newline at end of file +v2.22.1 \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 93367865..18e6a133 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Change Log +## [v2.22.1](https://github.com/auth0/auth0-react/tree/v2.22.1) (2026-07-29) +[Full Changelog](https://github.com/auth0/auth0-react/compare/v2.22.0...v2.22.1) + +**Changed** +- chore(deps): bump @auth0/auth0-spa-js minimum version to ^2.24.1 [\#1182](https://github.com/auth0/auth0-react/pull/1182) ([yogeshchoudhary147](https://github.com/yogeshchoudhary147)) + ## [v2.22.0](https://github.com/auth0/auth0-react/tree/v2.22.0) (2026-07-17) [Full Changelog](https://github.com/auth0/auth0-react/compare/v2.21.0...v2.22.0) diff --git a/docs/assets/hierarchy.js b/docs/assets/hierarchy.js index 6a088f78..3a2f4d7e 100644 --- a/docs/assets/hierarchy.js +++ b/docs/assets/hierarchy.js @@ -1 +1 @@ -window.hierarchyData = "eJyVlU2P0zAQhv+Lz15o893eUPkQUmHR7gIHtAcrmTTWunZwHCS06n9n0orFSVo8PVly3skz83o8fmbWGNex9Y9smfE4SXmU5I+cWagVlE4ajd+eGW4OixZ7YGv2xbR9uzU7qW/bk4SzJ6krto7SjLPeKhRJ7cDWooTu9Uz/qnF7hUGlEh3+n7muuhl+cPMSNHxspKosaMwtSuPHA2e4eFl8APdgnkB/l645EmjJXAoj5IQpoENeCh83omwgADyJri05zpKhZFw83taUQt07Y8UOxuhlVPxFHwnInYkvpnDaGGhF5NEe5B5M795Za+z/QL4uwBiVmKSrocRk4Vv6qRZ38LOXFqogeKoNF5jEybSPN0KXoBQBd0ZOIKarKZHq60xMoBWz+m5b0DTUizLMSRf+PHjTuwa0k6UYblIQdkZOIMaZ3yWy66Te3UFtoWuO9zncLRdiCOwsnrPvS9NCR6V6agJvtfCHjP4llKw2Rtdy11uaxxeDwnR8CEZTVoOVZRDo664ZAjhyOE4AjjeTY/dy7CyOZ83Rc44+8CxZ8qxIeY7P0pBcsvSS+9rB29a0nw3eyWCGMzHBisIfTWimxjcxCPJ1YUY+elpxpFHG3tU253nE81XOiyjiRYJrHg124vYYvpWd8+6nsYQOvxhFKH41LV5bo9Qef0SyYawO87D8MW/TCBzmehdun5mYQJse7Te8IvVvCspTEjjTU/zny3tRUg/xfFCIfjj8AdpWaE8=" \ No newline at end of file +window.hierarchyData = "eJyVlctu2zAQRf+Fa6ax+ZS1K9wHCjhNkaTtIsiCkEcWEZpUSalAEfjfC9lISkt2Sa8MyHd05l4ORy/IO9cFVD6KucCUcUyYfMLIQ22g6rSzAZUviDA5/Fi1BVSib67t25XbaHvbHiQYPWu7RiXhAqPeG1QibTvwtaogXE/075puaxBGlVEhoBJ1YX01vODqrWj4s9Fm7cGi8pFw+rTDiHAadfEZugf3DPan7po9Ia+Zc2UZPe0wooxHLXxZqqqBBPAgutQyFWywTAWLeCtXKXPfOa82cIyek+IVvSdAuJ6Iz7ZweDDQChLRHvQWXN999N75/4FiXYJxZJHxxWCRzeJIb2p1B7967WGdBI+1aYOMsvEcL5WtwJgM3Al5BpEvxsTcXCfiDFox8Xfbgs1DvSnTHD6L98H7vmvAdrpSw01Kwk7IM4hUxFOiQ9B2cwe1h9Ds73N6Ws7UZLAFnbLvK9dCyKVG6gzeYhYvGftbGb1eOlvrTe/zMj5blKaLuTjasha8rpLAWHfJEqAFwWzGMaMMs4JhPpOYU4G5oJgvZliwORYFx5LJYVkINo+a+x7gQ+var85WkOxwIs6IoohX09JZC1X63sa6NEMefVpvapWz9i6OWUqC5ULighBcMIkLSYY4pSTH8JUOXXQ/nc+Y8LNVGeYXY/PWO2O2YNMxT9VpXkFGfpeNMgbsJj0+E3EGbXy0P8Dr+k8OKlJmcMan+C+XT6rKPcTTRSn6bvcX2lZoTw==" \ No newline at end of file diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css index 2d9bb903..bccfce99 100644 --- a/docs/assets/highlight.css +++ b/docs/assets/highlight.css @@ -124,4 +124,4 @@ .hl-12 { color: var(--hl-12); } .hl-13 { color: var(--hl-13); } .hl-14 { color: var(--hl-14); } -pre, code { background: var(--code-background); } +pre, code, math[display='block'] { background: var(--code-background); } diff --git a/docs/assets/main.js b/docs/assets/main.js index 8182ceec..b0eda9ed 100644 --- a/docs/assets/main.js +++ b/docs/assets/main.js @@ -1,6 +1,6 @@ "use strict"; window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This member is normally hidden due to your filter settings.","hierarchy_expand":"Expand","hierarchy_collapse":"Collapse","folder":"Folder","search_index_not_available":"The search index is not available","search_no_results_found_for_0":"No results found for {0}","kind_1":"Project","kind_2":"Module","kind_4":"Namespace","kind_8":"Enumeration","kind_16":"Enumeration Member","kind_32":"Variable","kind_64":"Function","kind_128":"Class","kind_256":"Interface","kind_512":"Constructor","kind_1024":"Property","kind_2048":"Method","kind_4096":"Call Signature","kind_8192":"Index Signature","kind_16384":"Constructor Signature","kind_32768":"Parameter","kind_65536":"Type Literal","kind_131072":"Type Parameter","kind_262144":"Accessor","kind_524288":"Get Signature","kind_1048576":"Set Signature","kind_2097152":"Type Alias","kind_4194304":"Reference","kind_8388608":"Document"}; -"use strict";(()=>{var Ke=Object.create;var he=Object.defineProperty;var Ge=Object.getOwnPropertyDescriptor;var Ze=Object.getOwnPropertyNames;var Xe=Object.getPrototypeOf,Ye=Object.prototype.hasOwnProperty;var et=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var tt=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ze(e))!Ye.call(t,i)&&i!==n&&he(t,i,{get:()=>e[i],enumerable:!(r=Ge(e,i))||r.enumerable});return t};var nt=(t,e,n)=>(n=t!=null?Ke(Xe(t)):{},tt(e||!t||!t.__esModule?he(n,"default",{value:t,enumerable:!0}):n,t));var ye=et((me,ge)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=(function(e){return function(n){e.console&&console.warn&&console.warn(n)}})(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,l],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +(()=>{var Ke=Object.create;var he=Object.defineProperty;var Ge=Object.getOwnPropertyDescriptor;var Ze=Object.getOwnPropertyNames;var Xe=Object.getPrototypeOf,Ye=Object.prototype.hasOwnProperty;var et=(t,e)=>()=>{try{return e||t((e={exports:{}}).exports,e),e.exports}catch(n){throw e=0,n}};var tt=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ze(e))!Ye.call(t,i)&&i!==n&&he(t,i,{get:()=>e[i],enumerable:!(r=Ge(e,i))||r.enumerable});return t};var nt=(t,e,n)=>(n=t!=null?Ke(Xe(t)):{},tt(e||!t||!t.__esModule?he(n,"default",{value:t,enumerable:!0}):n,t));var ye=et((me,ge)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=(function(e){return function(n){e.console&&console.warn&&console.warn(n)}})(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,l],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. `,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(oc?d+=2:a==c&&(n+=r[l+1]*i[d+1],l+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var c=s.node.edges["*"];else{var c=new t.TokenSet;s.node.edges["*"]=c}if(s.str.length==0&&(c.final=!0),i.push({node:c,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),f=s.str.charAt(1),p;f in s.node.edges?p=s.node.edges[f]:(p=new t.TokenSet,s.node.edges[f]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),c=0;c1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}if(s.type===t.QueryLexer.TERM)return t.QueryParser.parseTerm;var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},(function(e,n){typeof define=="function"&&define.amd?define(n):typeof me=="object"?ge.exports=n():e.lunr=n()})(this,function(){return t})})()});var M,G={getItem(){return null},setItem(){}},K;try{K=localStorage,M=K}catch{K=G,M=G}var S={getItem:t=>M.getItem(t),setItem:(t,e)=>M.setItem(t,e),disableWritingLocalStorage(){M=G},disable(){localStorage.clear(),M=G},enable(){M=K}};window.TypeDoc||={disableWritingLocalStorage(){S.disableWritingLocalStorage()},disableLocalStorage:()=>{S.disable()},enableLocalStorage:()=>{S.enable()}};window.translations||={copy:"Copy",copied:"Copied!",normally_hidden:"This member is normally hidden due to your filter settings.",hierarchy_expand:"Expand",hierarchy_collapse:"Collapse",search_index_not_available:"The search index is not available",search_no_results_found_for_0:"No results found for {0}",folder:"Folder",kind_1:"Project",kind_2:"Module",kind_4:"Namespace",kind_8:"Enumeration",kind_16:"Enumeration Member",kind_32:"Variable",kind_64:"Function",kind_128:"Class",kind_256:"Interface",kind_512:"Constructor",kind_1024:"Property",kind_2048:"Method",kind_4096:"Call Signature",kind_8192:"Index Signature",kind_16384:"Constructor Signature",kind_32768:"Parameter",kind_65536:"Type Literal",kind_131072:"Type Parameter",kind_262144:"Accessor",kind_524288:"Get Signature",kind_1048576:"Set Signature",kind_2097152:"Type Alias",kind_4194304:"Reference",kind_8388608:"Document"};var pe=[];function X(t,e){pe.push({selector:e,constructor:t})}var Z=class{alwaysVisibleMember=null;constructor(){this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){pe.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!rt(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function rt(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var fe=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var Ie=nt(ye(),1);async function R(t){let e=Uint8Array.from(atob(t),s=>s.charCodeAt(0)),r=new Blob([e]).stream().pipeThrough(new DecompressionStream("deflate")),i=await new Response(r).text();return JSON.parse(i)}var Y="closing",ae="tsd-overlay";function it(){let t=Math.abs(window.innerWidth-document.documentElement.clientWidth);document.body.style.overflow="hidden",document.body.style.paddingRight=`${t}px`}function st(){document.body.style.removeProperty("overflow"),document.body.style.removeProperty("padding-right")}function Ee(t,e){t.addEventListener("animationend",()=>{t.classList.contains(Y)&&(t.classList.remove(Y),document.getElementById(ae)?.remove(),t.close(),st())}),t.addEventListener("cancel",n=>{n.preventDefault(),ve(t)}),e?.closeOnClick&&document.addEventListener("click",n=>{t.open&&!t.contains(n.target)&&ve(t)},!0)}function xe(t){if(t.open)return;let e=document.createElement("div");e.id=ae,document.body.appendChild(e),t.showModal(),it()}function ve(t){if(!t.open)return;document.getElementById(ae)?.classList.add(Y),t.classList.add(Y)}var I=class{el;app;constructor(e){this.el=e.el,this.app=e.app}};var be=document.head.appendChild(document.createElement("style"));be.dataset.for="filters";var le={};function Le(t){for(let e of t.split(/\s+/))if(le.hasOwnProperty(e)&&!le[e])return!0;return!1}var ee=class extends I{key;value;constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),be.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } `,this.app.updateIndexVisibility()}fromLocalStorage(){let e=S.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){S.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),le[`tsd-is-${this.el.name}`]=this.value,this.app.filterChanged(),this.app.updateIndexVisibility()}};var we=0;async function Se(t,e){if(!window.searchData)return;let n=await R(window.searchData);t.data=n,t.index=Ie.Index.load(n.index),e.innerHTML=""}function _e(){let t=document.getElementById("tsd-search-trigger"),e=document.getElementById("tsd-search"),n=document.getElementById("tsd-search-input"),r=document.getElementById("tsd-search-results"),i=document.getElementById("tsd-search-script"),s=document.getElementById("tsd-search-status");if(!(t&&e&&n&&r&&i&&s))throw new Error("Search controls missing");let o={base:document.documentElement.dataset.base};o.base.endsWith("/")||(o.base+="/"),i.addEventListener("error",()=>{let a=window.translations.search_index_not_available;Pe(s,a)}),i.addEventListener("load",()=>{Se(o,s)}),Se(o,s),ot({trigger:t,searchEl:e,results:r,field:n,status:s},o)}function ot(t,e){let{field:n,results:r,searchEl:i,status:s,trigger:o}=t;Ee(i,{closeOnClick:!0});function a(){xe(i),n.setSelectionRange(0,n.value.length)}o.addEventListener("click",a),n.addEventListener("input",fe(()=>{at(r,n,s,e)},200)),n.addEventListener("keydown",l=>{if(r.childElementCount===0||l.ctrlKey||l.metaKey||l.altKey)return;let d=n.getAttribute("aria-activedescendant"),f=d?document.getElementById(d):null;if(f){let p=!1,v=!1;switch(l.key){case"Home":case"End":case"ArrowLeft":case"ArrowRight":v=!0;break;case"ArrowDown":case"ArrowUp":p=l.shiftKey;break}(p||v)&&ke(n)}if(!l.shiftKey)switch(l.key){case"Enter":f?.querySelector("a")?.click();break;case"ArrowUp":Te(r,n,f,-1),l.preventDefault();break;case"ArrowDown":Te(r,n,f,1),l.preventDefault();break}});function c(){ke(n)}n.addEventListener("change",c),n.addEventListener("blur",c),n.addEventListener("click",c),document.body.addEventListener("keydown",l=>{if(l.altKey||l.metaKey||l.shiftKey)return;let d=l.ctrlKey&&l.key==="k",f=!l.ctrlKey&&!ut()&&l.key==="/";(d||f)&&(l.preventDefault(),a())})}function at(t,e,n,r){if(!r.index||!r.data)return;t.innerHTML="",n.innerHTML="",we+=1;let i=e.value.trim(),s;if(i){let a=i.split(" ").map(c=>c.length?`*${c}*`:"").join(" ");s=r.index.search(a).filter(({ref:c})=>{let l=r.data.rows[Number(c)].classes;return!l||!Le(l)})}else s=[];if(s.length===0&&i){let a=window.translations.search_no_results_found_for_0.replace("{0}",` "${te(i)}" `);Pe(n,a);return}for(let a=0;ac.score-a.score);let o=Math.min(10,s.length);for(let a=0;a`,f=Ce(c.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(f+=` (score: ${s[a].score.toFixed(2)})`),c.parent&&(f=` ${Ce(c.parent,i)}.${f}`);let p=document.createElement("li");p.id=`tsd-search:${we}-${a}`,p.role="option",p.ariaSelected="false",p.classList.value=c.classes??"";let v=document.createElement("a");v.tabIndex=-1,v.href=r.base+c.url,v.innerHTML=d+`${f}`,p.append(v),t.appendChild(p)}}function Te(t,e,n,r){let i;if(r===1?i=n?.nextElementSibling||t.firstElementChild:i=n?.previousElementSibling||t.lastElementChild,i!==n){if(!i||i.role!=="option"){console.error("Option missing");return}i.ariaSelected="true",i.scrollIntoView({behavior:"smooth",block:"nearest"}),e.setAttribute("aria-activedescendant",i.id),n?.setAttribute("aria-selected","false")}}function ke(t){let e=t.getAttribute("aria-activedescendant");(e?document.getElementById(e):null)?.setAttribute("aria-selected","false"),t.setAttribute("aria-activedescendant","")}function Ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(te(t.substring(s,o)),`${te(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(te(t.substring(s))),i.join("")}var lt={"&":"&","<":"<",">":">","'":"'",'"':"""};function te(t){return t.replace(/[&<>"'"]/g,e=>lt[e])}function Pe(t,e){t.innerHTML=e?`
${e}
`:""}var ct=["button","checkbox","file","hidden","image","radio","range","reset","submit"];function ut(){let t=document.activeElement;return t?t.isContentEditable||t.tagName==="TEXTAREA"||t.tagName==="SEARCH"?!0:t.tagName==="INPUT"&&!ct.includes(t.type):!1}var D="mousedown",Me="mousemove",$="mouseup",ne={x:0,y:0},Qe=!1,ce=!1,dt=!1,F=!1,Oe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Oe?"is-mobile":"not-mobile");Oe&&"ontouchstart"in document.documentElement&&(dt=!0,D="touchstart",Me="touchmove",$="touchend");document.addEventListener(D,t=>{ce=!0,F=!1;let e=D=="touchstart"?t.targetTouches[0]:t;ne.y=e.pageY||0,ne.x=e.pageX||0});document.addEventListener(Me,t=>{if(ce&&!F){let e=D=="touchstart"?t.targetTouches[0]:t,n=ne.x-(e.pageX||0),r=ne.y-(e.pageY||0);F=Math.sqrt(n*n+r*r)>10}});document.addEventListener($,()=>{ce=!1});document.addEventListener("click",t=>{Qe&&(t.preventDefault(),t.stopImmediatePropagation(),Qe=!1)});var re=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener($,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(D,n=>this.onDocumentPointerDown(n)),document.addEventListener($,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){F||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!F&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var ue=new Map,de=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;S.setItem(this.key,e.toString())}},ie=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(ue.has(i))s=ue.get(i);else{let o=S.getItem(i),a=o?o==="true":this.el.open;s=new de(i,a),ue.set(i,s)}s.add(this.el)}};function He(t){let e=S.getItem("tsd-theme")||"os";t.value=e,Ae(e),t.addEventListener("change",()=>{S.setItem("tsd-theme",t.value),Ae(t.value)})}function Ae(t){document.documentElement.dataset.theme=t}var se;function Ne(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Re),Re())}async function Re(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await R(window.navigationData);se=document.documentElement.dataset.base,se.endsWith("/")||(se+="/"),t.innerHTML="";for(let n of e)Ve(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Ve(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',De(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let c=a.appendChild(document.createElement("ul"));c.className="tsd-nested-navigation";for(let l of t.children)Ve(l,c,i)}else De(t,r,t.class)}function De(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=se+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&(r.classList.add("current"),r.ariaCurrent="page"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(Fe(t.text,document.createElement("span")))}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(Fe(t.text,document.createElement("span")))}}function Fe(t,e){let n=t.split(/(?<=[^A-Z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|(?<=[_-])(?=[^_-])/);for(let r=0;r{let i=r.target;for(;i.parentElement&&i.parentElement.tagName!="LI";)i=i.parentElement;i.dataset.dropdown&&(i.dataset.dropdown=String(i.dataset.dropdown!=="true"))});let t=new Map,e=new Set;for(let r of document.querySelectorAll(".tsd-full-hierarchy [data-refl]")){let i=r.querySelector("ul");t.has(r.dataset.refl)?e.add(r.dataset.refl):i&&t.set(r.dataset.refl,i)}for(let r of e)n(r);function n(r){let i=t.get(r).cloneNode(!0);i.querySelectorAll("[id]").forEach(s=>{s.removeAttribute("id")}),i.querySelectorAll("[data-dropdown]").forEach(s=>{s.dataset.dropdown="false"});for(let s of document.querySelectorAll(`[data-refl="${r}"]`)){let o=gt(),a=s.querySelector("ul");s.insertBefore(o,a),o.dataset.dropdown=String(!!a),a||s.appendChild(i.cloneNode(!0))}}}function pt(){let t=document.getElementById("tsd-hierarchy-script");t&&(t.addEventListener("load",Be),Be())}async function Be(){let t=document.querySelector(".tsd-panel.tsd-hierarchy:has(h4 a)");if(!t||!window.hierarchyData)return;let e=+t.dataset.refl,n=await R(window.hierarchyData),r=t.querySelector("ul"),i=document.createElement("ul");if(i.classList.add("tsd-hierarchy"),ft(i,n,e),r.querySelectorAll("li").length==i.querySelectorAll("li").length)return;let s=document.createElement("span");s.classList.add("tsd-hierarchy-toggle"),s.textContent=window.translations.hierarchy_expand,t.querySelector("h4 a")?.insertAdjacentElement("afterend",s),s.insertAdjacentText("beforebegin",", "),s.addEventListener("click",()=>{s.textContent===window.translations.hierarchy_expand?(r.insertAdjacentElement("afterend",i),r.remove(),s.textContent=window.translations.hierarchy_collapse):(i.insertAdjacentElement("afterend",r),i.remove(),s.textContent=window.translations.hierarchy_expand)})}function ft(t,e,n){let r=e.roots.filter(i=>mt(e,i,n));for(let i of r)t.appendChild(je(e,i,n))}function je(t,e,n,r=new Set){if(r.has(e))return;r.add(e);let i=t.reflections[e],s=document.createElement("li");if(s.classList.add("tsd-hierarchy-item"),e===n){let o=s.appendChild(document.createElement("span"));o.textContent=i.name,o.classList.add("tsd-hierarchy-target")}else{for(let a of i.uniqueNameParents||[]){let c=t.reflections[a],l=s.appendChild(document.createElement("a"));l.textContent=c.name,l.href=oe+c.url,l.className=c.class+" tsd-signature-type",s.append(document.createTextNode("."))}let o=s.appendChild(document.createElement("a"));o.textContent=t.reflections[e].name,o.href=oe+i.url,o.className=i.class+" tsd-signature-type"}if(i.children){let o=s.appendChild(document.createElement("ul"));o.classList.add("tsd-hierarchy");for(let a of i.children){let c=je(t,a,n,r);c&&o.appendChild(c)}}return r.delete(e),s}function mt(t,e,n){if(e===n)return!0;let r=new Set,i=[t.reflections[e]];for(;i.length;){let s=i.pop();if(!r.has(s)){r.add(s);for(let o of s.children||[]){if(o===n)return!0;i.push(t.reflections[o])}}}return!1}function gt(){let t=document.createElementNS("http://www.w3.org/2000/svg","svg");return t.setAttribute("width","20"),t.setAttribute("height","20"),t.innerHTML='',t}X(re,"a[data-toggle]");X(ie,".tsd-accordion");X(ee,".tsd-filter-item input[type=checkbox]");var qe=document.getElementById("tsd-theme");qe&&He(qe);var yt=new Z;Object.defineProperty(window,"app",{value:yt});_e();Ne();$e();"virtualKeyboard"in navigator&&(navigator.virtualKeyboard.overlaysContent=!0);})(); diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index 3d5ac05b..95fec569 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "eJytmdty2zYQht9F107jOE3a5s6jOqln7Noj2elFpxcouZIwJgEWANWonb57wZMIEAdKC1/a+/P/cMYu9Pu/CwXf1OLTYgWy4kzC06GCxcWiImqn/wusLuVbM/bdTpWFFrxQli8+/XixyAoipZYqmb+h8o12A8FIsfjv4uh9XasdMEUzoihnN0JwMSLa70G+9Yhs1rur02hLzhhkKoAxozj/L8BA0Czgb0Zx/rfsHkouDkuS7cAFWGEsYU8Kmuuh2NBtLWKzEpTiyHc8I8VacUG2EOifI8GR7jdkuSNFAWwLgb45EjTphgleFKVevmHURPMKrM8k08MkT0GaUjw5DEryvaNSGbs/2qWAFs1ewV81FZCHiZYCzfmqD4XNIUwx4kgGlZKy7Qo2AuTuib9AaEuHlEncdcYrCM6bo0GyDtdZxmumrisaQk0lONJDs8YCiDHmeBsOj1r8Aoe5M8grw7W5t4qD0v2/gIqtLp8qibeCrd7zIOI8S4Xk8aquloRloKcidCB4RAm0hyo8jlY8gfFES+B16GJyJDhSHJLu/yzh54pXv3I98AGII0GT/OZIv+tMLQtCy9GTMq3akKzJefugbX314ePJafWlzsyaP28HUz/Hp3Sg/ozdHOuJ5VGBbz8X9J82qXwkgpQyiJrocMDjKWs1PkKOfZDYhKGminMHFRJWUN1oK3f341wdDtglnDcloUVkVB1VCmzMbiOsUZSCelDVbK+OmhTQYy13s6RRlIJal3KWdNSkgL5ymsEsylDhYJGlkLIAhnRmTfW2VMXhoWo2ib8nAW0a+Deqdn1KME+einHo20mBboBuPYX5ybZ520a/bxfDGd/xrU4yYuNjKWLXXyd8FsW82yjCtVrXfrpU6U5gL8YUIBFGTRQDOTIcrs/I47CpCIlqs/H23orNlCtLwOlpp2yWZqpwsBXkVECm+gfLfm5i4OgXaY2Y7bRPGNthK9jrnW6+QcTdA2pcr56rnCiwH5zvQSeZefPYA9K/ZGe/wjWme/mJ3IymAIdo7oO2BHgUvPJDbEls5gblOAjDC1lsBme/ilYjVbVWeuxHZ3WomsKg///k28uffnj34WpaKOmO7WkOwmll7+XRnOXb9LA7y04hOOrzWf5jL8SKnH5e1nSN+whTjdcX8QtR52b/EhWmur9KnUNuMxnyZ+GgjoFE7+b3DLvyMvyHYALDOuyHY1jXjXWhHGREm9wCyHvfAPUYn1t9y1oqXnavh9+yHdFlcGCVh5X43owF47EID9DDyleluw8FQXzgtQDFn8e+Jq2742YH2pKlcqdXrgnz3rZnED6D0rtbdKfuFGEF8Yz2IU/XtHTfvXf+QlhemI+XHS0gw3N1QdKV0r4D2griGX154E87O5JHksxb0y3zlNgW0NLgiWYye89zZyCncTypOx9ZXnEa3tZeUdp9Pjw4j6g9EbS5Ue0HaZvy/uqkQRqt4gP1/oz2DvnSSNnULGvn2U6obMTH7w2jWrYVwqXPY4hFPv97SMN93x+DJxi4eXbM0VU7iD/+BxCNjOs=" \ No newline at end of file +window.navigationData = "eJytmcty2zYUht+Fa6dxnCZtvdOoTuoZq9ZIdrrodIGCRyLGIMACoGq103fv8CYCxIUS4KV9fvwfbgTOgX7/N1PwqrLbbAOy4kzC07GC7CqrkCqy2wxYXcr3euy7QpU0u8peCMuz2x+vMkyRlNltpmT+jsh38KpAMESz/65O3otaFcAUwUgRzu6E4GJEtO1BvneITNaHm/NoS84YYOXB6NE4/6/AQBDs8dejcf73bAUlF8clwgXYACMcSzggSvIlZzuyr0VoVbzSOPIDx4huFRdoD57xWZI40mqHlgWiFNgePGOzJNGkOyY4pSUw366zNW/A+oKw4kKeg9Sl8WQ/KMn3gUilff3BIXm00ewN/FUTAbmfaCiiOd9AkN3RT9HikQwiJWH7DewEyOKJv4Dvk/Ypk7hbzCvwrpuliWQdFxjzmqlFRXyoqSSO9NjsMQ9ijFnemsMaSfkCx7kzyCmL63NvFQal+38FFdpdLlUSbwN7IhWIMM9QRfJ4VVdLxDBQ6j0QHKIE2mPln0cjnsB4IiXw2ncxWZI4UhiS7v8s4eeKV79yhn1fkiWJJrnNI/0WWC0pIuXoSZgCsUO4yXn7oGl98+nz2Wn19ZKz5s/7wdTNcSktqDtj1+d6YnlSxPefC/JPm1SukUCl9KImujjg6ZQ1Oh8ghxokdmGoqcLcQRUJowSYMnJ3N87WxQG7hPOuRIQGZtVSpcDG7DbAGkUpqEdVzY7qpEkBrWtZzJJGUQpqW8pZ0kmTAvrGCYZZlKaKgwW2QsoGGNKZLaHAFD0+Vs1H4h6JR5sG/o2ook8J5slTcRz6flKga6B7R2F+tm3e9tHt28XijB/4ntcqND+GInT9dcJnQefdRlFcr1c7tKhIdwI7MbogEqHVRCGQJYvD9Rl5GDYVRaLabLy9t0IrZcsScA98T9gsTVfFwTaQEwFY9Q+W/dqEwMEWaZ2YHbRLGPrCNnDgL6C/QYTdPeq4UT1XOVJgPjivQBU8bx57QLq37GyruM50Lz+Bm1EXxCGa+6AtAdaCV26IKQmt3KAcJ2F4IQut4GyrYDVSVVuFlHYXqWPVFAb9/ydtr3/64cOnm2mhtBb8QHIQVi97L4fmIt9mhN1Zdg7BUl/Och97Plbg9HOypnvcRZhqnL4RvxB1buYvUX6q/avUJeQ2k0F/Ugt1CiR6N79nmJWX5j8EExjGYT8cwxuQNVUWMqBN7gHkva+HeorP7b5lLRUvu9fDV1wgtgfPLvcr40czFoynItxD9yvflG4/FHjxnteCKP489i1p3R03O9GGLJU7vXJ1mPO2vYDwBRQuQHSn7hRhBOMZ7UMewoocuvfOXxDLqf542dE8snjuaoe6Utp1QBvBeEZfHrjTzo7kkCTztmTPHCW2ATQ08UQ9mV3x3JrIaTye1J2PLK848X/WTlHafT48OI+oAxKkuVHNB2mT8vHmrEkarcIT9fGC/g750kjZ1Qy362wmVCbi8/eaUS3bCuHa5THEAs3/HtJwV/tT8AwDO88OOdpqC/HH/xCNjOs=" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index cddd5fd1..ccd2f28a 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "eJy1mttu2zgQht9FuXVTc0g5h7tstgsUKLZFW+xeBEGhSnQixJG0kpy2CPLuS1KnoTh2KFu9CSKL83M0/GZISnwOyvxHFVzePAcPaZYElwzOF0EWPcrgMvh4ta3v35VlXgaLYFtu1E/xJqoqWb0dbp3e148bdb+9o9oEL4tOLWTQq8V5VtXlNq5flzux2yLpRVBEpcxq27uhQ7YE0fcofVw/6Vod1cu3RFZxmRZ1mmd+PY4sJvQO4arvXN9fXudZLX/W79Xfch3Fsncg7X6p3pIN946d9ZBqQDIZ11dxnG+z+t+0vv8sk7RUP03r7KQVihqhH0qoHIToINDPuMvRUka1/EvW8b0sp/pmbNe97RzubKs6f/yaP8js3c/4PsruJo7OSaNQawU5KMzgmp0dfs64uVJXyZu0epNmKmRpLZPD3WkfzsRqqlutbd3azhCdOxXuUtHwZ5EXn8o8X090qbNPlH3R2s/ils5BWVUmTF/SjdLY/Jrsm84/JWLiVQ0iszuoC8WnvNgWR3moq0TRqszjomq6Tu+2aoBwvfb2LR6Zz+OURu3vPJtav7VDmrKsNZ3HmfeJGcDrTZQ+VtMdShMzcnFnPoNTKsOTjeymnetos/kexQ8TXWtEuiknHkRmcDCtdHNlmMZRUwmneJZW0cj6NxTZtPqQR0ma3U12btPb/Qa3NvldamrF9dHTpZHSBeO3zZu9s4cUtt69GetZ79CBS7Lep3lXYko23x7gS2M0gwOP62hi743FHF3/alfKUx34FfV2M7hRKIUHOXV5MFjN4EIpn1QKfpbrUlb3h6ztGoGyEZhxgVcdPuFWs0+422ryZqU1maca4y3lB5OCH83GlJz5rQZ7t5BYtitOH3S12aNOtfPuRFdB86xqyV6Q8nYL/w2wnpyXnoInXWOajJGT+5+kXRCoKHyW/21VZJI9sXvVaNKGX8NyeC8ng8L+MOx+wn3z3dFRaKa9vJeZ2ck8+0Ou81Laxke4m2ffjWA0Fpzd8S4DdywTvf0tLZ2Z3SxlvS2zr/kRHjYSdT6Lc7C8OGPh8Lbzqii+1Goh3/tX/yp0QW9/nvzmTSbjFQUheNI3fnUZ0bm3M7xVoR5QftO97O1y3PLQ/kbDSXf1yoARvTjj0hbepzSR5biItJ0STfbPQPv6MNuaTaoc9OjNaXxkv+Y9hW+/uPGkfq/3Izq+vVebjx7nejQPPUVlGn3fjNZGeyVXgo5Qr7neZrF5ajsovqJqJXZlrQ4Gve6Wr9SPbmlAaPX3poq55WuPutuY6u52oeptIn8Gl8/BkywrPRNdBnDKTy9Uy3UqN4n+qNR4okzzx0dpuEjyeGv+vW2b/SP1Rx7duGn9Vj36zXLBw9OVOL+9Xdx0xuaG+aHTGH4xhkxdMcqQOYbMMgR1BQu+PA2FZQeOHVh2XF1xqkPuGHLLUKgrQRkKx1BYhqG6CinD0DEMLcOVulpRhivHcGUZnqmrM8rwzDE8swzPdwT13LE7t+wUPzfnVIcXjuGFPfyahgty/F1y2Agdww5JHSPosfFhmgpGk+cixGyGmCaDAWnsYsRsjpimg5EIMhclZrPENCGMxJC5ODGbJ6YpYSSKzEWK2UwxTQojcWQuVszmimlcGIkkc9liNlxMI8NIvJjLF7MBA80MIwkDlzCwCQPNDJCEgUsYjAqUqVAkYUAUKZsw0MwASRi4hIFNGGhmgCQMXMLAJgw0M0ASBi5hYBMGmhkgCQOXMLAJA80MkISBSxjYhIEpXSRh4BIGNmGgmQGSMHAJA5swrpkBkjDuEsZtwrhmhpOEcZcwbhPGNTOcJIy7hPHRPGgmQpIwTkyFNmFcM8PpadQljNuEcc0MJwnjLmHcJoxrZjhJGHcJ4zZhXDPDScK4Sxi3CeOaGX5GzI7cBYzbgHGNDCcB4y5g3AZMaGT4BdGxcPkSNl9CEyNIvoTLl7D5ErDriYWLl7DxEhoYQbIpXLzEaKll1lokm4JYbdl4CQ2MINkULl7CxkusdsbapUvYdAnNi6CXiC5dwqZLaGAEybVw8RI2XkIDI0iuhYuXsPEKNTGCrJyhy1do8xUavkiwQ5ev9iezD1EbELW5fN/sR9Q2IiqKqnn18hx8a7cpvD/V9hyopLh8fnkZtiXqCu1M9D3dV/sSF2kwpAH+Gv2L0EFKiEFKDd9Uqf5dl6WJJP0Vi34zjJRCJHU+Xat/qYokUexUik6WNF90zYsRShyQ+AHPbsTN2w9KnCPx0Et83xm3QRgFeZIsermH2LxAXi4bAVVUPGWHs5aDIhow5qszxpyj2HG/gRmdwRu0VoOU53NRBwAGvbNBzy8B27NvgwKiDhobv1whjn+ikKGI+anZZ98GJVTx/AoecWRtUEN8saWnHH3KDCG2RKJ+kO08GIZUMbl+Zdo90oXk0DAzvyGxD2QhKTS4zC8d3KNUSA5VfOZXQnYdf0KiqCwxv0RzTi4hNZS1zC/N0FEjpIOylfllmf15DyUYihr3i9r+M0XIS5RyzC/nxueBkBjKOPDLOOIgD6pWKNnAL9m6wzhIBOUW+OVWI0IMBKBogV+0zPkcpIArsF9qogM2SAflJfjlZW6QH88IKMR+I7broy7CFeUj98vH0ZdXpIWykftlY38WCEULJRD4JVDnz66cBMQ694vc6LMjWq+hQRB+nA/fFVGsUMXh5+2Cyo946sQSelY0oOA3oNWO+QTQeILfeG4r6exrBJIRfonYHD5CnqBogV991nXKdQXphH4g9DpFc+QHDSEigfuR0IkNuVj2n8yQl6hyhccKU1MUqmvco66pXXCRFnKTZsrk5vbl5X+y1OyP"; \ No newline at end of file +window.searchData = "eJy1mttu2zgQht+FuVVT8yCf7rrZLlCg2BZtsXthBIUq0bEQR9RKctogyLsvSJ2G4tihbPXOsDj/jIbfDCmJz6RQP0uy3jyT+zRLyJqyZUCy6EGSNfn07lDt3heFKkhADsWerEm8j8pSlm/7S9e76mFPgvYKWRPyErRqIWWdWqyysioOcfW63JU9FkgHJI8KmVV2dL1DOmOi8yh9Qr9qR13k5Xsiy7hI8ypVmZ/HgcUI7yycd8719dmNyir5q/qQVbLYRrHsAkjbf8q36MCTc2fdZKyyTMbVuzhWh6z6N612X2SSFjKuxjm7aoSiWuhnWu2KXghPAn6PxwItZFTJv2QV72QxNjZju+1spwjnUFbq4Zu6l9n7X/Euyu5Gzs5VrVBpBdkrTBCaXR1+wbi1UpXJm7R8k2Y7WaSVTM4Pp7k5k6uxYTW2VWM7QXbuZCaLqJJ/5ir/XCi1HRlSa5/kKs8b+0nC0jUoy9Kk6Wu6l1m1fxodm64/WZYmX2UvMnmAulF8VvkhvyhC3SXyRmWaEG9Utk3vDkVk9Wvv2OKB+TRBadT+VtnY/q0D0pRljek0wXxIzATe7KP0oRwfUJqYmYtb8wmC2kVZspftsnMT7fc/ovh+ZGi1SLvkxL3IBAGmpR4usyqNo7oTjoksLaOB9W9osmn5UUVJmt2NDm7f2f2GsPbqLjW94ubi5dJI6Ybx29bNLthzGlsX3oT9rAvozC1ZF9O0O7G9ulOHM2KpjSYI4GEbjfReW0zh+qnZKY8N4Cnq7CYII4/K8l6O3R70VhOEUMhHdS+/yG0hy905e7taoKgFJtzglecvuOXkC+6hHP2w0phM043hI+VHU4KfzIMpuvJbA04+QkLZtjl91N3mhDo2ztuJ7oLmXj8XKkfl7RH+D8B6cZ55Cl61g3EyBkGevpNmQ5Cq7Iv875AWMjmRu1eNRj3wa1jO93LVK5xOw/E7PLXeXZyFetlTnczEQarsD7lVhbSNLwhXZT+MYDQUnDzwtgKPbBO94y0snYnDLGR1KLJv6oIIa4lKTRIcm60WNOzfdr7L869VVPVLS/WU64be/D36zZtMhjsKRPCqG/zqNqIN72h6y1xlpfyuvZx0ORx5rr/BdOKuXpkwxIszL03jfUwTWQybSOMUGXJ6BTrlwzzW7FOZOUsq4s0ZfKFf857C1y8cPMrvzWlEh5dPavPB7dwM1qHHqEijH/vB3uik5FzgGeo0t4csNndtJ8VX9FCaLj9D9NpLvlI/260BotVdGyvmtq8T6u5gzN1tQNIskb/I+pk8yqLUK9GasGt+vSIB2aZyn+iPSnUkAYnVw4M0XCQqPpift82wf6T+yKMH16PfzkiwmQU8vJ6L5e1tsGmNzQXzR6vR/2MMKQk2FDOkjiG1DBkJNizgs+tQWHbMsWOWHSfBhmMOuWPILUNBgo3ADIVjKCzDkASbEDMMHcPQMpyTYDPHDOeO4dwyXJBgs8AMF47hwjJcHknq0rFbWnYrEmyWmMOVY7iyp1/TsELn3yWHDtAx7KDUUYQeGx+qqaA4eS5C1GaIajIoQ41djKjNEdV0UBRB6qJEbZaoJoSiGFIXJ2rzRDUlFEWRukhRmymqSaEojtTFitpcUY0LRZGkLlvUhotqZCiKF3X5ojZgTDNDUcKYSxizCWOaGYYSxlzC2KBBmQ6FEsaQJmUTxjQzDCWMuYQxmzCmmWEoYcwljNmEMc0MQwljLmHMJoxpZhhKGHMJYzZhTDPDUMKYSxizCWOmdaGEMZcwZhPGNDMMJYy5hDGbMK6ZYShh3CWM24RxzQxHCeMuYdwmjGtmOEoYdwnjg3XQLIQoYRxZCm3CuGaG48uoSxi3CeOaGY4Sxl3CuE0Y18xwlDDuEsZtwrhmhqOEcZcwbhPGNTN8gayO3AWM24BxjQxHAeMuYNwGTGhk+ApxLFy+hM2X0MQIlC/h8iVsvgQ7dsfCxUvYeAkNjEDZFC5eYrDVMnstlE2B7LZsvIQGRqBsChcvYeMl5kdz7dIlbLqE5kXgW0SXLmHTJTQwAuVauHgJGy+hgREo18LFS9h4hZoYgXbO0OUrtPkKDV8o2KHLV/OXeQ55lEUlkw/188hmQ6I8L+tXL8/ke/OYwrtTbc+Er8j6+eWlfyxZP7+AJxN9TftqXuICDQo0mL9G9yK0lxKilxKL0VLduy5LE0j6K+bdwzBQCoHUcrxW91IVSILcCT5e0nzRNS9GMHEGxM+4dyNu3n5g4hyIh17ip8649cIgyaNkwcs9wOYKRDmrBcTcV7Y/a9krggmjvjpDzDnIHfebmMEZvF5r3kt53hd2AKDXW/R6fgXYnH3rFQB1rLbxqxXk+CdIGciYn5p99q1XAh3Pr+EhR9Z6NcAXnXnK4afMAGIzIOoH2dGDYUAVkuvXpt0jXUAOTDP1mxL7QBaQApNL/crBPUoF5EDHp34t5NjxJyAK2hL1KzTn5BJQA1VL/coMHDUCOqBaqV+V2Z/3QIGBrHG/rJ0+UwSiBCVH/WpueB4IiIGKY34VhxzkAd0KFBvzK7b2MA4QAbXF/GqrFkEmgoFsMb9smfM5QAF2YL/SBAdsgA6oS+ZXl8ogP1wRQIr9ZuzYR12AK6hH7lePgy+vQAtUI/erxu4sEMgWKCDmV0BtPMdqkgHWuV/mBp8dwX4NTILw47z/rghyBToOXzYbKj/isRNL4F7BhDK/CS2PrCcMzCfzm89DKZ3nGgFkhF8h1oePQCQgW8yvP+s+5YYCdEI/EDqdvD7yA6YQkMD9SGjF+losuk9mIErQucJLhbElCvQ17tHXbgOSp7ncp5kk683ty8v/stTsjw=="; \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css index 44328e99..ec257d51 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -504,8 +504,15 @@ body { background: var(--color-background); font-family: - -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", - Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; + -apple-system, + BlinkMacSystemFont, + "Segoe UI", + "Noto Sans", + Helvetica, + Arial, + sans-serif, + "Apple Color Emoji", + "Segoe UI Emoji"; font-size: 16px; color: var(--color-text); margin: 0; @@ -531,6 +538,14 @@ scroll-margin-block: calc(var(--dim-header-height) + 0.5rem); } + math[display="block"] { + position: relative; + padding: 10px; + border: 1px solid var(--color-accent); + border-radius: 0.8em; + margin-bottom: 8px; + } + code, pre { font-family: Menlo, Monaco, Consolas, "Courier New", monospace; @@ -1047,7 +1062,7 @@ cursor: pointer; } - .tsd-accordion-summary a { + .tsd-accordion-summary > a { width: calc(100% - 1.5rem); } .tsd-accordion-summary > * { diff --git a/docs/classes/AuthenticationError.html b/docs/classes/AuthenticationError.html index 5f609dd4..b31c5317 100644 --- a/docs/classes/AuthenticationError.html +++ b/docs/classes/AuthenticationError.html @@ -1,7 +1,39 @@ -AuthenticationError | @auth0/auth0-react
@auth0/auth0-react
    Preparing search index...

    Class AuthenticationError

    Thrown when handling the redirect callback fails, will be one of Auth0's +AuthenticationError | @auth0/auth0-react

    +
    @auth0/auth0-react + +
      +
      +
      Preparing search index...
      +
      +
      +
      + +

      Class AuthenticationError

      +
      +

      Thrown when handling the redirect callback fails, will be one of Auth0's Authentication API's Standard Error Responses: https://auth0.com/docs/api/authentication?javascript#standard-error-responses

      -

      Hierarchy (View Summary)

      Index

      Constructors

      constructor -

      Properties

      appState +
      +
      +

      Hierarchy (View Summary)

      +
      +
      +
      +
      +
      Index
       +
      +
      + +
      constructor +
      +
      + +
      appState error error_description message @@ -9,17 +41,100 @@ stack? state stackTraceLimit -

      Methods

      captureStackTrace +
      +
      + +
      captureStackTrace fromPayload prepareStackTrace -

      Constructors

      • Parameters

        • error: string
        • error_description: string
        • state: string
        • OptionalappState: any

        Returns AuthenticationError

      Properties

      appState: any
      error: string
      error_description: string
      message: string
      name: string
      stack?: string
      state: string
      stackTraceLimit: number

      The Error.stackTraceLimit property specifies the number of stack frames +

      +
      + +
      +
      + +
        +
      • + +
        +
        +

        Parameters

        +
          +
        • error: string
          • +
        • error_description: string
          • +
        • state: string
          • +
        • OptionalappState: any
        +

        Returns AuthenticationError

      +
      + +
      +
      + +
      appState: any
      +
      + +
      error: string
      +
      + +
      error_description: string
      +
      + +
      message: string
      +
      + +
      name: string
      +
      + +
      stack?: string
      +
      + +
      state: string
      +
      + +
      stackTraceLimit: number
      +

      The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

      The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

      If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

      -

      Methods

      • Creates a .stack property on targetObject, which when accessed returns +

      +
      + +
      +
      + +
        +
      • + +
        +

        Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

        const myObject = {};
        Error.captureStackTrace(myObject);
        myObject.stack;  // Similar to `new Error().stack`
@@ -35,5 +150,72 @@
 
        function a() {
          b();
        }

        function b() {
          c();
        }

        function c() {
          // Create an error without stack trace to avoid calculating the stack trace twice.
          const { stackTraceLimit } = Error;
          Error.stackTraceLimit = 0;
          const error = new Error();
          Error.stackTraceLimit = stackTraceLimit;

          // Capture the stack trace above function b
          Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
          throw error;
        }

        a();
 
        
 
-

        Parameters

        • targetObject: object
        • OptionalconstructorOpt: Function

        Returns void

      • Parameters

        • __namedParameters: { error: string; error_description: string }

        Returns GenericError

      Settings

      Member Visibility

      On This Page

      Constructors
      Properties
      Methods
      +
      +
      +

      Parameters

      +
        +
      • targetObject: object
        • +
      • OptionalconstructorOpt: Function
      +

      Returns void

      +
      + +
        +
      • + +
        +
        +

        Parameters

        +
          +
        • __namedParameters: { error: string; error_description: string }
        +

        Returns GenericError

      +
      + +
      +
      +
      +
      +
      +

      Settings

       +
      +
      Member Visibility +
        +
        • +
        • +
      +
      +
      +

      On This Page

       +
      +
      Constructors +
      +
      Properties +
      +
      Methods +
      +
      +
      +
      diff --git a/docs/classes/ConnectError.html b/docs/classes/ConnectError.html index b5b4c9e7..9c209ab7 100644 --- a/docs/classes/ConnectError.html +++ b/docs/classes/ConnectError.html @@ -1,7 +1,39 @@ -ConnectError | @auth0/auth0-react
      @auth0/auth0-react
        Preparing search index...

        Class ConnectError

        Thrown when handling the redirect callback for the connect flow fails, will be one of Auth0's +ConnectError | @auth0/auth0-react

        +
        @auth0/auth0-react + +
          +
          +
          Preparing search index...
          +
          +
          +
          + +

          Class ConnectError

          +
          +

          Thrown when handling the redirect callback for the connect flow fails, will be one of Auth0's Authentication API's Standard Error Responses: https://auth0.com/docs/api/authentication?javascript#standard-error-responses

          -

          Hierarchy (View Summary)

          Index

          Constructors

          constructor -

          Properties

          appState +
          +
          +

          Hierarchy (View Summary)

          +
          +
          +
          +
          +
          Index
           +
          +
          + +
          constructor +
          +
          + +
          appState connection error error_description @@ -10,17 +42,106 @@ stack? state stackTraceLimit -

          Methods

          captureStackTrace +
          +
          + +
          captureStackTrace fromPayload prepareStackTrace -

          Constructors

          • Parameters

            • error: string
            • error_description: string
            • connection: string
            • state: string
            • OptionalappState: any

            Returns ConnectError

          Properties

          appState: any
          connection: string
          error: string
          error_description: string
          message: string
          name: string
          stack?: string
          state: string
          stackTraceLimit: number

          The Error.stackTraceLimit property specifies the number of stack frames +

          +
          + +
          +
          + +
            +
          • + +
            +
            +

            Parameters

            +
              +
            • error: string
              • +
            • error_description: string
              • +
            • connection: string
              • +
            • state: string
              • +
            • OptionalappState: any
            +

            Returns ConnectError

          +
          + +
          +
          + +
          appState: any
          +
          + +
          connection: string
          +
          + +
          error: string
          +
          + +
          error_description: string
          +
          + +
          message: string
          +
          + +
          name: string
          +
          + +
          stack?: string
          +
          + +
          state: string
          +
          + +
          stackTraceLimit: number
          +

          The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

          The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

          If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

          -

          Methods

          • Creates a .stack property on targetObject, which when accessed returns +

          +
          + +
          +
          + +
            +
          • + +
            +

            Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

            const myObject = {};
            Error.captureStackTrace(myObject);
            myObject.stack;  // Similar to `new Error().stack`
@@ -36,5 +157,72 @@
 
            function a() {
              b();
            }

            function b() {
              c();
            }

            function c() {
              // Create an error without stack trace to avoid calculating the stack trace twice.
              const { stackTraceLimit } = Error;
              Error.stackTraceLimit = 0;
              const error = new Error();
              Error.stackTraceLimit = stackTraceLimit;

              // Capture the stack trace above function b
              Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
              throw error;
            }

            a();
 
            
 
-

            Parameters

            • targetObject: object
            • OptionalconstructorOpt: Function

            Returns void

          • Parameters

            • __namedParameters: { error: string; error_description: string }

            Returns GenericError

          Settings

          Member Visibility

          On This Page

          Constructors
          Properties
          Methods
          +
          +
          +

          Parameters

          +
            +
          • targetObject: object
            • +
          • OptionalconstructorOpt: Function
          +

          Returns void

          +
          + +
            +
          • + +
            +
            +

            Parameters

            +
              +
            • __namedParameters: { error: string; error_description: string }
            +

            Returns GenericError

          +
          + +
          +
          +
          +
          +
          +

          Settings

           +
          +
          Member Visibility +
            +
            • +
            • +
          +
          +
          +

          On This Page

           +
          +
          Constructors +
          +
          Properties +
          +
          Methods +
          +
          +
          +
          diff --git a/docs/classes/GenericError.html b/docs/classes/GenericError.html index 31270d30..1b300371 100644 --- a/docs/classes/GenericError.html +++ b/docs/classes/GenericError.html @@ -1,22 +1,135 @@ -GenericError | @auth0/auth0-react
          @auth0/auth0-react
            Preparing search index...

            Class GenericError

            Thrown when network requests to the Auth server fail.

            -

            Hierarchy (View Summary)

            Index

            Constructors

            constructor -

            Properties

            error +GenericError | @auth0/auth0-react
            +
            @auth0/auth0-react + +
              +
              +
              Preparing search index...
              +
              +
              +
              + +

              Class GenericError

              +
              +

              Thrown when network requests to the Auth server fail.

              +
              +
              +

              Hierarchy (View Summary)

              +
              +
              +
              +
              +
              Index
               +
              +
              + +
              constructor +
              +
              + +
              error error_description message name stack? stackTraceLimit -

              Methods

              captureStackTrace +
              +
              + +
              captureStackTrace fromPayload prepareStackTrace -

              Constructors

              • Parameters

                • error: string
                • error_description: string

                Returns GenericError

              Properties

              error: string
              error_description: string
              message: string
              name: string
              stack?: string
              stackTraceLimit: number

              The Error.stackTraceLimit property specifies the number of stack frames +

              +
              + +
              +
              + +
                +
              • + +
                +
                +

                Parameters

                +
                  +
                • error: string
                  • +
                • error_description: string
                +

                Returns GenericError

              +
              + +
              +
              + +
              error: string
              +
              + +
              error_description: string
              +
              + +
              message: string
              +
              + +
              name: string
              +
              + +
              stack?: string
              +
              + +
              stackTraceLimit: number
              +

              The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

              The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

              If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

              -

              Methods

              • Creates a .stack property on targetObject, which when accessed returns +

              +
              + +
              +
              + +
                +
              • + +
                +

                Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

                const myObject = {};
                Error.captureStackTrace(myObject);
                myObject.stack;  // Similar to `new Error().stack`
@@ -32,5 +145,71 @@
 
                function a() {
                  b();
                }

                function b() {
                  c();
                }

                function c() {
                  // Create an error without stack trace to avoid calculating the stack trace twice.
                  const { stackTraceLimit } = Error;
                  Error.stackTraceLimit = 0;
                  const error = new Error();
                  Error.stackTraceLimit = stackTraceLimit;

                  // Capture the stack trace above function b
                  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                  throw error;
                }

                a();
 
                
 
-

                Parameters

                • targetObject: object
                • OptionalconstructorOpt: Function

                Returns void

              • Parameters

                • __namedParameters: { error: string; error_description: string }

                Returns GenericError

              Settings

              Member Visibility

              On This Page

              Constructors
              Properties
              Methods
              + +
              +

              Parameters

              +
                +
              • targetObject: object
                • +
              • OptionalconstructorOpt: Function
              +

              Returns void

              +
              + +
                +
              • + +
                +
                +

                Parameters

                +
                  +
                • __namedParameters: { error: string; error_description: string }
                +

                Returns GenericError

              +
              + +
              +
              +
              +
              +
              +

              Settings

               +
              +
              Member Visibility +
                +
                • +
                • +
              +
              +
              +

              On This Page

               +
              +
              Constructors +
              +
              Properties +
              +
              Methods +
              +
              +
              +
              diff --git a/docs/classes/InMemoryCache.html b/docs/classes/InMemoryCache.html index 316235a7..11cdae48 100644 --- a/docs/classes/InMemoryCache.html +++ b/docs/classes/InMemoryCache.html @@ -1,3 +1,69 @@ -InMemoryCache | @auth0/auth0-react
              @auth0/auth0-react
                Preparing search index...

                Class InMemoryCache

                Index

                Constructors

                constructor -

                Properties

                enclosedCache -

                Constructors

                Properties

                enclosedCache: ICache

                Settings

                Member Visibility

                On This Page

                Constructors
                Properties
                +InMemoryCache | @auth0/auth0-react
                +
                @auth0/auth0-react + +
                  +
                  +
                  Preparing search index...
                  +
                  +
                  +
                  + +

                  Class InMemoryCache

                  +
                  +
                  +
                  +
                  Index
                   +
                  +
                  + +
                  constructor +
                  +
                  + +
                  enclosedCache +
                  +
                  + +
                  +
                  + +
                  +
                  + +
                  +
                  + +
                  enclosedCache: ICache
                  +
                  +
                  +
                  +
                  +

                  Settings

                   +
                  +
                  Member Visibility +
                    +
                    • +
                    • +
                  +
                  +
                  +

                  On This Page

                   +
                  +
                  Constructors +
                  +
                  Properties +
                  +
                  +
                  +
                  diff --git a/docs/classes/InvalidConfigurationError.html b/docs/classes/InvalidConfigurationError.html index 6c0064cf..3f535b6e 100644 --- a/docs/classes/InvalidConfigurationError.html +++ b/docs/classes/InvalidConfigurationError.html @@ -1,24 +1,132 @@ -InvalidConfigurationError | @auth0/auth0-react
                  @auth0/auth0-react
                    Preparing search index...

                    Class InvalidConfigurationError

                    Thrown at construction time for an invalid option combination (e.g. +InvalidConfigurationError | @auth0/auth0-react

                    +
                    @auth0/auth0-react + +
                      +
                      +
                      Preparing search index...
                      +
                      +
                      +
                      + +

                      Class InvalidConfigurationError

                      +
                      +

                      Thrown at construction time for an invalid option combination (e.g. refreshTokenMode: 'online' without useDpop: true). The suggestion names the fix.

                      -

                      Hierarchy (View Summary)

                      Index

                      Constructors

                      constructor -

                      Properties

                      error +
                      +
                      +

                      Hierarchy (View Summary)

                      +
                      +
                      +
                      +
                      +
                      Index
                       +
                      +
                      + +
                      constructor +
                      +
                      + +
                      error error_description message name stack? suggestion stackTraceLimit -

                      Methods

                      captureStackTrace +
                      +
                      + +
                      captureStackTrace fromPayload prepareStackTrace -

                      Constructors

                      Properties

                      error: string
                      error_description: string
                      message: string
                      name: string
                      stack?: string
                      suggestion: string
                      stackTraceLimit: number

                      The Error.stackTraceLimit property specifies the number of stack frames +

                      +
                      + +
                      +
                      + +
                      +
                      + +
                      +
                      + +
                      error: string
                      +
                      + +
                      error_description: string
                      +
                      + +
                      message: string
                      +
                      + +
                      name: string
                      +
                      + +
                      stack?: string
                      +
                      + +
                      suggestion: string
                      +
                      + +
                      stackTraceLimit: number
                      +

                      The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

                      The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

                      If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

                      -

                      Methods

                      • Creates a .stack property on targetObject, which when accessed returns +

                      +
                      + +
                      +
                      + +
                        +
                      • + +
                        +

                        Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

                        const myObject = {};
                        Error.captureStackTrace(myObject);
                        myObject.stack;  // Similar to `new Error().stack`
@@ -34,5 +142,72 @@
 
                        function a() {
                          b();
                        }

                        function b() {
                          c();
                        }

                        function c() {
                          // Create an error without stack trace to avoid calculating the stack trace twice.
                          const { stackTraceLimit } = Error;
                          Error.stackTraceLimit = 0;
                          const error = new Error();
                          Error.stackTraceLimit = stackTraceLimit;

                          // Capture the stack trace above function b
                          Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                          throw error;
                        }

                        a();
 
                        
 
-

                        Parameters

                        • targetObject: object
                        • OptionalconstructorOpt: Function

                        Returns void

                      • Parameters

                        • __namedParameters: { error: string; error_description: string }

                        Returns GenericError

                      Settings

                      Member Visibility

                      On This Page

                      Constructors
                      Properties
                      Methods
                      +
                      +
                      +

                      Parameters

                      +
                        +
                      • targetObject: object
                        • +
                      • OptionalconstructorOpt: Function
                      +

                      Returns void

                      +
                      + +
                        +
                      • + +
                        +
                        +

                        Parameters

                        +
                          +
                        • __namedParameters: { error: string; error_description: string }
                        +

                        Returns GenericError

                      +
                      + +
                      +
                      +
                      +
                      +
                      +

                      Settings

                       +
                      +
                      Member Visibility +
                        +
                        • +
                        • +
                      +
                      +
                      +

                      On This Page

                       +
                      +
                      Constructors +
                      +
                      Properties +
                      +
                      Methods +
                      +
                      +
                      +
                      diff --git a/docs/classes/LocalStorageCache.html b/docs/classes/LocalStorageCache.html index b7cbe717..56a5f99f 100644 --- a/docs/classes/LocalStorageCache.html +++ b/docs/classes/LocalStorageCache.html @@ -1,6 +1,132 @@ -LocalStorageCache | @auth0/auth0-react
                      @auth0/auth0-react
                        Preparing search index...

                        Class LocalStorageCache

                        Implements

                        Index

                        Constructors

                        constructor -

                        Methods

                        allKeys +LocalStorageCache | @auth0/auth0-react
                        +
                        @auth0/auth0-react + +
                          +
                          +
                          Preparing search index...
                          +
                          +
                          +
                          + +

                          Class LocalStorageCache

                          +
                          +

                          Implements

                          +
                          +
                          +
                          +
                          +
                          Index
                           +
                          +
                          + +
                          constructor +
                          +
                          + +
                          allKeys get remove set -

                          Constructors

                          Methods

                          • Returns string[]

                          • Type Parameters

                            Parameters

                            • key: string

                            Returns MaybePromise<T | undefined>

                          • Parameters

                            • key: string

                            Returns void

                          • Type Parameters

                            Parameters

                            • key: string
                            • entry: T

                            Returns void

                          Settings

                          Member Visibility

                          On This Page

                          Constructors
                          Methods
                          +
                          +
                          + +
                          +
                          + +
                          +
                          + +
                          +
                          + +
                            +
                          • + +
                            +

                            Returns string[]

                          +
                          + +
                            +
                          • + +
                            +
                            +

                            Type Parameters

                            +
                            +
                            +

                            Parameters

                            +
                              +
                            • key: string
                            +

                            Returns MaybePromise<T | undefined>

                          +
                          + +
                            +
                          • + +
                            +
                            +

                            Parameters

                            +
                              +
                            • key: string
                            +

                            Returns void

                          +
                          + +
                            +
                          • + +
                            +
                            +

                            Type Parameters

                            +
                            +
                            +

                            Parameters

                            +
                              +
                            • key: string
                              • +
                            • entry: T
                            +

                            Returns void

                          +
                          +
                          +
                          +
                          +

                          Settings

                           +
                          +
                          Member Visibility +
                            +
                            • +
                            • +
                          +
                          +
                          +

                          On This Page

                           +
                          +
                          Constructors +
                          +
                          Methods +
                          +
                          +
                          +
                          diff --git a/docs/classes/MfaChallengeError.html b/docs/classes/MfaChallengeError.html index 3336972e..bfc87450 100644 --- a/docs/classes/MfaChallengeError.html +++ b/docs/classes/MfaChallengeError.html @@ -1,25 +1,131 @@ -MfaChallengeError | @auth0/auth0-react
                          @auth0/auth0-react
                            Preparing search index...

                            Class MfaChallengeError

                            Error thrown when initiating an MFA challenge fails.

                            -
                            try {
                              const challenge = await mfa.challenge({
                                mfaToken: mfaToken,
                                challengeType: 'otp',
                                authenticatorId: 'otp|dev_123'
                              });
                            } catch (error) {
                              if (error instanceof MfaChallengeError) {
                                console.log(error.error); // 'too_many_attempts'
                                console.log(error.error_description); // 'Rate limit exceeded'
                              }
                            }
+MfaChallengeError | @auth0/auth0-react
                            
+
                            @auth0/auth0-react
+
+
                              
+
                              
+
                              Preparing search index...
                              
+
                              
+
                              
+
                              
+
+
                              Class MfaChallengeError
                              
+
                              
+
                              Error thrown when initiating an MFA challenge fails.
                              
+
                              
+
                              
+
                              
+
                              try {
                                const challenge = await mfa.challenge({
                                  mfaToken: mfaToken,
                                  challengeType: 'otp',
                                  authenticatorId: 'otp|dev_123'
                                });
                              } catch (error) {
                                if (error instanceof MfaChallengeError) {
                                  console.log(error.error); // 'too_many_attempts'
                                  console.log(error.error_description); // 'Rate limit exceeded'
                                }
                              }
 
                              
 
-
                              Hierarchy (View Summary)
                              Index
                              Constructors
                              constructor
-
                              Properties
                              error
+
                              
+
                              
+
                              Hierarchy (View Summary)
                              
+
                              
+
                              
+
                              
+
                              
+
                              Index
                              
+
                              
+
                              
+
+
                              constructor
+
                              
+
                              
+
+
                              error
 error_description
 message
 name
 stack?
 stackTraceLimit
-
                              Methods
                              captureStackTrace
+
                              
+
                              
+
+
                              captureStackTrace
 fromPayload
 prepareStackTrace
-
                              Constructors
                              • Parameters
                                • error: string
                                • error_description: string
                                Returns MfaChallengeError
                              Properties
                              error: string
                              error_description: string
                              message: string
                              name: string
                              stack?: string
                              stackTraceLimit: number
                              The Error.stackTraceLimit property specifies the number of stack frames
+
                              +
                              + +
                              +
                              + +
                                +
                              • + +
                                +
                                +

                                Parameters

                                +
                                  +
                                • error: string
                                  • +
                                • error_description: string
                                +

                                Returns MfaChallengeError

                              +
                              + +
                              +
                              + +
                              error: string
                              +
                              + +
                              error_description: string
                              +
                              + +
                              message: string
                              +
                              + +
                              name: string
                              +
                              + +
                              stack?: string
                              +
                              + +
                              stackTraceLimit: number
                              +

                              The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

                              The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

                              If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

                              -

                              Methods

                              • Creates a .stack property on targetObject, which when accessed returns +

                              +
                              + +
                              +
                              + +
                                +
                              • + +
                                +

                                Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

                                const myObject = {};
                                Error.captureStackTrace(myObject);
                                myObject.stack;  // Similar to `new Error().stack`
@@ -35,5 +141,72 @@
 
                                function a() {
                                  b();
                                }

                                function b() {
                                  c();
                                }

                                function c() {
                                  // Create an error without stack trace to avoid calculating the stack trace twice.
                                  const { stackTraceLimit } = Error;
                                  Error.stackTraceLimit = 0;
                                  const error = new Error();
                                  Error.stackTraceLimit = stackTraceLimit;

                                  // Capture the stack trace above function b
                                  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                  throw error;
                                }

                                a();
 
                                
 
-

                                Parameters

                                • targetObject: object
                                • OptionalconstructorOpt: Function

                                Returns void

                              • Parameters

                                • __namedParameters: { error: string; error_description: string }

                                Returns MfaError

                              Settings

                              Member Visibility

                              On This Page

                              Constructors
                              Properties
                              Methods
                              + +
                              +

                              Parameters

                              +
                                +
                              • targetObject: object
                                • +
                              • OptionalconstructorOpt: Function
                              +

                              Returns void

                              +
                              + +
                                +
                              • + +
                                +
                                +

                                Parameters

                                +
                                  +
                                • __namedParameters: { error: string; error_description: string }
                                +

                                Returns MfaError

                              +
                              + +
                              +
                              +
                              +
                              +
                              +

                              Settings

                               +
                              +
                              Member Visibility +
                                +
                                • +
                                • +
                              +
                              +
                              +

                              On This Page

                               +
                              +
                              Constructors +
                              +
                              Properties +
                              +
                              Methods +
                              +
                              +
                              +
                              diff --git a/docs/classes/MfaEnrollmentError.html b/docs/classes/MfaEnrollmentError.html index ceef2d41..a2bbe12f 100644 --- a/docs/classes/MfaEnrollmentError.html +++ b/docs/classes/MfaEnrollmentError.html @@ -1,25 +1,131 @@ -MfaEnrollmentError | @auth0/auth0-react
                              @auth0/auth0-react
                                Preparing search index...

                                Class MfaEnrollmentError

                                Error thrown when enrolling an MFA authenticator fails.

                                -
                                try {
                                  const enrollment = await mfa.enroll({
                                    authenticator_types: ['otp']
                                  });
                                } catch (error) {
                                  if (error instanceof MfaEnrollmentError) {
                                    console.log(error.error); // 'invalid_phone_number'
                                    console.log(error.error_description); // 'Invalid phone number format'
                                  }
                                }
+MfaEnrollmentError | @auth0/auth0-react
                                
+
                                @auth0/auth0-react
+
+
                                  
+
                                  
+
                                  Preparing search index...
                                  
+
                                  
+
                                  
+
                                  
+
+
                                  Class MfaEnrollmentError
                                  
+
                                  
+
                                  Error thrown when enrolling an MFA authenticator fails.
                                  
+
                                  
+
                                  
+
                                  
+
                                  try {
                                    const enrollment = await mfa.enroll({
                                      authenticator_types: ['otp']
                                    });
                                  } catch (error) {
                                    if (error instanceof MfaEnrollmentError) {
                                      console.log(error.error); // 'invalid_phone_number'
                                      console.log(error.error_description); // 'Invalid phone number format'
                                    }
                                  }
 
                                  
 
-
                                  Hierarchy (View Summary)
                                  Index
                                  Constructors
                                  constructor
-
                                  Properties
                                  error
+
                                  
+
                                  
+
                                  Hierarchy (View Summary)
                                  
+
                                  
+
                                  
+
                                  
+
                                  
+
                                  Index
                                  
+
                                  
+
                                  
+
+
                                  constructor
+
                                  
+
                                  
+
+
                                  error
 error_description
 message
 name
 stack?
 stackTraceLimit
-
                                  Methods
                                  captureStackTrace
+
                                  
+
                                  
+
+
                                  captureStackTrace
 fromPayload
 prepareStackTrace
-
                                  Constructors
                                  • Parameters
                                    • error: string
                                    • error_description: string
                                    Returns MfaEnrollmentError
                                  Properties
                                  error: string
                                  error_description: string
                                  message: string
                                  name: string
                                  stack?: string
                                  stackTraceLimit: number
                                  The Error.stackTraceLimit property specifies the number of stack frames
+
                                  +
                                  + +
                                  +
                                  + +
                                    +
                                  • + +
                                    +
                                    +

                                    Parameters

                                    +
                                      +
                                    • error: string
                                      • +
                                    • error_description: string
                                    +

                                    Returns MfaEnrollmentError

                                  +
                                  + +
                                  +
                                  + +
                                  error: string
                                  +
                                  + +
                                  error_description: string
                                  +
                                  + +
                                  message: string
                                  +
                                  + +
                                  name: string
                                  +
                                  + +
                                  stack?: string
                                  +
                                  + +
                                  stackTraceLimit: number
                                  +

                                  The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

                                  The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

                                  If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

                                  -

                                  Methods

                                  • Creates a .stack property on targetObject, which when accessed returns +

                                  +
                                  + +
                                  +
                                  + +
                                    +
                                  • + +
                                    +

                                    Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

                                    const myObject = {};
                                    Error.captureStackTrace(myObject);
                                    myObject.stack;  // Similar to `new Error().stack`
@@ -35,5 +141,72 @@
 
                                    function a() {
                                      b();
                                    }

                                    function b() {
                                      c();
                                    }

                                    function c() {
                                      // Create an error without stack trace to avoid calculating the stack trace twice.
                                      const { stackTraceLimit } = Error;
                                      Error.stackTraceLimit = 0;
                                      const error = new Error();
                                      Error.stackTraceLimit = stackTraceLimit;

                                      // Capture the stack trace above function b
                                      Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                      throw error;
                                    }

                                    a();
 
                                    
 
-

                                    Parameters

                                    • targetObject: object
                                    • OptionalconstructorOpt: Function

                                    Returns void

                                  • Parameters

                                    • __namedParameters: { error: string; error_description: string }

                                    Returns MfaError

                                  Settings

                                  Member Visibility

                                  On This Page

                                  Constructors
                                  Properties
                                  Methods
                                  + +
                                  +

                                  Parameters

                                  +
                                    +
                                  • targetObject: object
                                    • +
                                  • OptionalconstructorOpt: Function
                                  +

                                  Returns void

                                  +
                                  + +
                                    +
                                  • + +
                                    +
                                    +

                                    Parameters

                                    +
                                      +
                                    • __namedParameters: { error: string; error_description: string }
                                    +

                                    Returns MfaError

                                  +
                                  + +
                                  +
                                  +
                                  +
                                  +
                                  +

                                  Settings

                                   +
                                  +
                                  Member Visibility +
                                    +
                                    • +
                                    • +
                                  +
                                  +
                                  +

                                  On This Page

                                   +
                                  +
                                  Constructors +
                                  +
                                  Properties +
                                  +
                                  Methods +
                                  +
                                  +
                                  +
                                  diff --git a/docs/classes/MfaEnrollmentFactorsError.html b/docs/classes/MfaEnrollmentFactorsError.html index 9d2cf89c..de3404c1 100644 --- a/docs/classes/MfaEnrollmentFactorsError.html +++ b/docs/classes/MfaEnrollmentFactorsError.html @@ -1,25 +1,131 @@ -MfaEnrollmentFactorsError | @auth0/auth0-react
                                  @auth0/auth0-react
                                    Preparing search index...

                                    Class MfaEnrollmentFactorsError

                                    Error thrown when getting enrollment factors fails.

                                    -
                                    try {
                                      const factors = await mfa.getEnrollmentFactors(mfaToken);
                                    } catch (error) {
                                      if (error instanceof MfaEnrollmentFactorsError) {
                                        console.log(error.error); // 'mfa_context_not_found'
                                        console.log(error.error_description); // 'MFA context not found...'
                                      }
                                    }
+MfaEnrollmentFactorsError | @auth0/auth0-react
                                    
+
                                    @auth0/auth0-react
+
+
                                      
+
                                      
+
                                      Preparing search index...
                                      
+
                                      
+
                                      
+
                                      
+
+
                                      Class MfaEnrollmentFactorsError
                                      
+
                                      
+
                                      Error thrown when getting enrollment factors fails.
                                      
+
                                      
+
                                      
+
                                      
+
                                      try {
                                        const factors = await mfa.getEnrollmentFactors(mfaToken);
                                      } catch (error) {
                                        if (error instanceof MfaEnrollmentFactorsError) {
                                          console.log(error.error); // 'mfa_context_not_found'
                                          console.log(error.error_description); // 'MFA context not found...'
                                        }
                                      }
 
                                      
 
-
                                      Hierarchy (View Summary)
                                      Index
                                      Constructors
                                      constructor
-
                                      Properties
                                      error
+
                                      
+
                                      
+
                                      Hierarchy (View Summary)
                                      
+
                                      
+
                                      
+
                                      
+
                                      
+
                                      Index
                                      
+
                                      
+
                                      
+
+
                                      constructor
+
                                      
+
                                      
+
+
                                      error
 error_description
 message
 name
 stack?
 stackTraceLimit
-
                                      Methods
                                      captureStackTrace
+
                                      
+
                                      
+
+
                                      captureStackTrace
 fromPayload
 prepareStackTrace
-
                                      Constructors
                                      Properties
                                      error: string
                                      error_description: string
                                      message: string
                                      name: string
                                      stack?: string
                                      stackTraceLimit: number
                                      The Error.stackTraceLimit property specifies the number of stack frames
+
                                      +
                                      + +
                                      +
                                      + +
                                      +
                                      + +
                                      +
                                      + +
                                      error: string
                                      +
                                      + +
                                      error_description: string
                                      +
                                      + +
                                      message: string
                                      +
                                      + +
                                      name: string
                                      +
                                      + +
                                      stack?: string
                                      +
                                      + +
                                      stackTraceLimit: number
                                      +

                                      The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

                                      The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

                                      If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

                                      -

                                      Methods

                                      • Creates a .stack property on targetObject, which when accessed returns +

                                      +
                                      + +
                                      +
                                      + +
                                        +
                                      • + +
                                        +

                                        Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

                                        const myObject = {};
                                        Error.captureStackTrace(myObject);
                                        myObject.stack;  // Similar to `new Error().stack`
@@ -35,5 +141,72 @@
 
                                        function a() {
                                          b();
                                        }

                                        function b() {
                                          c();
                                        }

                                        function c() {
                                          // Create an error without stack trace to avoid calculating the stack trace twice.
                                          const { stackTraceLimit } = Error;
                                          Error.stackTraceLimit = 0;
                                          const error = new Error();
                                          Error.stackTraceLimit = stackTraceLimit;

                                          // Capture the stack trace above function b
                                          Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                          throw error;
                                        }

                                        a();
 
                                        
 
-

                                        Parameters

                                        • targetObject: object
                                        • OptionalconstructorOpt: Function

                                        Returns void

                                      • Parameters

                                        • __namedParameters: { error: string; error_description: string }

                                        Returns MfaError

                                      Settings

                                      Member Visibility

                                      On This Page

                                      Constructors
                                      Properties
                                      Methods
                                      + +
                                      +

                                      Parameters

                                      +
                                        +
                                      • targetObject: object
                                        • +
                                      • OptionalconstructorOpt: Function
                                      +

                                      Returns void

                                      +
                                      + +
                                        +
                                      • + +
                                        +
                                        +

                                        Parameters

                                        +
                                          +
                                        • __namedParameters: { error: string; error_description: string }
                                        +

                                        Returns MfaError

                                      +
                                      + +
                                      +
                                      +
                                      +
                                      +
                                      +

                                      Settings

                                       +
                                      +
                                      Member Visibility +
                                        +
                                        • +
                                        • +
                                      +
                                      +
                                      +

                                      On This Page

                                       +
                                      +
                                      Constructors +
                                      +
                                      Properties +
                                      +
                                      Methods +
                                      +
                                      +
                                      +
                                      diff --git a/docs/classes/MfaError.html b/docs/classes/MfaError.html index 3365bc94..828eafaa 100644 --- a/docs/classes/MfaError.html +++ b/docs/classes/MfaError.html @@ -1,23 +1,132 @@ -MfaError | @auth0/auth0-react
                                      @auth0/auth0-react
                                        Preparing search index...

                                        Class MfaError

                                        Base class for MFA-related errors in auth0-spa-js. +MfaError | @auth0/auth0-react

                                        +
                                        @auth0/auth0-react + +
                                          +
                                          +
                                          Preparing search index...
                                          +
                                          +
                                          +
                                          + +

                                          Class MfaError

                                          +
                                          +

                                          Base class for MFA-related errors in auth0-spa-js. Extends GenericError for unified error hierarchy across the SDK.

                                          -

                                          Hierarchy (View Summary)

                                          Index

                                          Constructors

                                          constructor -

                                          Properties

                                          error +
                                          +
                                          +

                                          Hierarchy (View Summary)

                                          +
                                          +
                                          +
                                          +
                                          +
                                          Index
                                           +
                                          +
                                          + +
                                          constructor +
                                          +
                                          + +
                                          error error_description message name stack? stackTraceLimit -

                                          Methods

                                          captureStackTrace +
                                          +
                                          + +
                                          captureStackTrace fromPayload prepareStackTrace -

                                          Constructors

                                          • Parameters

                                            • error: string
                                            • error_description: string

                                            Returns MfaError

                                          Properties

                                          error: string
                                          error_description: string
                                          message: string
                                          name: string
                                          stack?: string
                                          stackTraceLimit: number

                                          The Error.stackTraceLimit property specifies the number of stack frames +

                                          +
                                          + +
                                          +
                                          + +
                                            +
                                          • + +
                                            +
                                            +

                                            Parameters

                                            +
                                              +
                                            • error: string
                                              • +
                                            • error_description: string
                                            +

                                            Returns MfaError

                                          +
                                          + +
                                          +
                                          + +
                                          error: string
                                          +
                                          + +
                                          error_description: string
                                          +
                                          + +
                                          message: string
                                          +
                                          + +
                                          name: string
                                          +
                                          + +
                                          stack?: string
                                          +
                                          + +
                                          stackTraceLimit: number
                                          +

                                          The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

                                          The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

                                          If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

                                          -

                                          Methods

                                          • Creates a .stack property on targetObject, which when accessed returns +

                                          +
                                          + +
                                          +
                                          + +
                                            +
                                          • + +
                                            +

                                            Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

                                            const myObject = {};
                                            Error.captureStackTrace(myObject);
                                            myObject.stack;  // Similar to `new Error().stack`
@@ -33,5 +142,72 @@
 
                                            function a() {
                                              b();
                                            }

                                            function b() {
                                              c();
                                            }

                                            function c() {
                                              // Create an error without stack trace to avoid calculating the stack trace twice.
                                              const { stackTraceLimit } = Error;
                                              Error.stackTraceLimit = 0;
                                              const error = new Error();
                                              Error.stackTraceLimit = stackTraceLimit;

                                              // Capture the stack trace above function b
                                              Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                              throw error;
                                            }

                                            a();
 
                                            
 
-

                                            Parameters

                                            • targetObject: object
                                            • OptionalconstructorOpt: Function

                                            Returns void

                                          • Parameters

                                            • __namedParameters: { error: string; error_description: string }

                                            Returns MfaError

                                          Settings

                                          Member Visibility

                                          On This Page

                                          Constructors
                                          Properties
                                          Methods
                                          +
                                          +
                                          +

                                          Parameters

                                          +
                                            +
                                          • targetObject: object
                                            • +
                                          • OptionalconstructorOpt: Function
                                          +

                                          Returns void

                                          +
                                          + +
                                            +
                                          • + +
                                            +
                                            +

                                            Parameters

                                            +
                                              +
                                            • __namedParameters: { error: string; error_description: string }
                                            +

                                            Returns MfaError

                                          +
                                          + +
                                          +
                                          +
                                          +
                                          +
                                          +

                                          Settings

                                           +
                                          +
                                          Member Visibility +
                                            +
                                            • +
                                            • +
                                          +
                                          +
                                          +

                                          On This Page

                                           +
                                          +
                                          Constructors +
                                          +
                                          Properties +
                                          +
                                          Methods +
                                          +
                                          +
                                          +
                                          diff --git a/docs/classes/MfaListAuthenticatorsError.html b/docs/classes/MfaListAuthenticatorsError.html index cdc200e9..d6927230 100644 --- a/docs/classes/MfaListAuthenticatorsError.html +++ b/docs/classes/MfaListAuthenticatorsError.html @@ -1,25 +1,131 @@ -MfaListAuthenticatorsError | @auth0/auth0-react
                                          @auth0/auth0-react
                                            Preparing search index...

                                            Class MfaListAuthenticatorsError

                                            Error thrown when listing MFA authenticators fails.

                                            -
                                            try {
                                              const authenticators = await mfa.getAuthenticators();
                                            } catch (error) {
                                              if (error instanceof MfaListAuthenticatorsError) {
                                                console.log(error.error); // 'access_denied'
                                                console.log(error.error_description); // 'Unauthorized'
                                              }
                                            }
+MfaListAuthenticatorsError | @auth0/auth0-react
                                            
+
                                            @auth0/auth0-react
+
+
                                              
+
                                              
+
                                              Preparing search index...
                                              
+
                                              
+
                                              
+
                                              
+
+
                                              Class MfaListAuthenticatorsError
                                              
+
                                              
+
                                              Error thrown when listing MFA authenticators fails.
                                              
+
                                              
+
                                              
+
                                              
+
                                              try {
                                                const authenticators = await mfa.getAuthenticators();
                                              } catch (error) {
                                                if (error instanceof MfaListAuthenticatorsError) {
                                                  console.log(error.error); // 'access_denied'
                                                  console.log(error.error_description); // 'Unauthorized'
                                                }
                                              }
 
                                              
 
-
                                              Hierarchy (View Summary)
                                              Index
                                              Constructors
                                              constructor
-
                                              Properties
                                              error
+
                                              
+
                                              
+
                                              Hierarchy (View Summary)
                                              
+
                                                
+
                                              • MfaError
+
                                                  
+
                                                • MfaListAuthenticatorsError
                                              
+
                                              
+
                                              
+
                                              
+
                                              Index
                                              
+
                                              
+
                                              
+
+
                                              constructor
+
                                              
+
                                              
+
+
                                              error
 error_description
 message
 name
 stack?
 stackTraceLimit
-
                                              Methods
                                              captureStackTrace
+
                                              
+
                                              
+
+
                                              captureStackTrace
 fromPayload
 prepareStackTrace
-
                                              Constructors
                                              Properties
                                              error: string
                                              error_description: string
                                              message: string
                                              name: string
                                              stack?: string
                                              stackTraceLimit: number
                                              The Error.stackTraceLimit property specifies the number of stack frames
+
                                              +
                                              + +
                                              +
                                              + +
                                              +
                                              + +
                                              +
                                              + +
                                              error: string
                                              +
                                              + +
                                              error_description: string
                                              +
                                              + +
                                              message: string
                                              +
                                              + +
                                              name: string
                                              +
                                              + +
                                              stack?: string
                                              +
                                              + +
                                              stackTraceLimit: number
                                              +

                                              The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

                                              The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

                                              If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

                                              -

                                              Methods

                                              • Creates a .stack property on targetObject, which when accessed returns +

                                              +
                                              + +
                                              +
                                              + +
                                                +
                                              • + +
                                                +

                                                Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

                                                const myObject = {};
                                                Error.captureStackTrace(myObject);
                                                myObject.stack;  // Similar to `new Error().stack`
@@ -35,5 +141,72 @@
 
                                                function a() {
                                                  b();
                                                }

                                                function b() {
                                                  c();
                                                }

                                                function c() {
                                                  // Create an error without stack trace to avoid calculating the stack trace twice.
                                                  const { stackTraceLimit } = Error;
                                                  Error.stackTraceLimit = 0;
                                                  const error = new Error();
                                                  Error.stackTraceLimit = stackTraceLimit;

                                                  // Capture the stack trace above function b
                                                  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                  throw error;
                                                }

                                                a();
 
                                                
 
-

                                                Parameters

                                                • targetObject: object
                                                • OptionalconstructorOpt: Function

                                                Returns void

                                              • Parameters

                                                • __namedParameters: { error: string; error_description: string }

                                                Returns MfaError

                                              Settings

                                              Member Visibility

                                              On This Page

                                              Constructors
                                              Properties
                                              Methods
                                              + +
                                              +

                                              Parameters

                                              +
                                                +
                                              • targetObject: object
                                                • +
                                              • OptionalconstructorOpt: Function
                                              +

                                              Returns void

                                              +
                                              + +
                                                +
                                              • + +
                                                +
                                                +

                                                Parameters

                                                +
                                                  +
                                                • __namedParameters: { error: string; error_description: string }
                                                +

                                                Returns MfaError

                                              +
                                              + +
                                              +
                                              +
                                              +
                                              +
                                              +

                                              Settings

                                               +
                                              +
                                              Member Visibility +
                                                +
                                                • +
                                                • +
                                              +
                                              +
                                              +

                                              On This Page

                                               +
                                              +
                                              Constructors +
                                              +
                                              Properties +
                                              +
                                              Methods +
                                              +
                                              +
                                              +
                                              diff --git a/docs/classes/MfaRequiredError.html b/docs/classes/MfaRequiredError.html index a590f556..5146a9b5 100644 --- a/docs/classes/MfaRequiredError.html +++ b/docs/classes/MfaRequiredError.html @@ -1,6 +1,38 @@ -MfaRequiredError | @auth0/auth0-react
                                              @auth0/auth0-react
                                                Preparing search index...

                                                Class MfaRequiredError

                                                Error thrown when the token exchange results in a mfa_required error

                                                -

                                                Hierarchy (View Summary)

                                                Index

                                                Constructors

                                                constructor -

                                                Properties

                                                error +MfaRequiredError | @auth0/auth0-react
                                                +
                                                @auth0/auth0-react + +
                                                  +
                                                  +
                                                  Preparing search index...
                                                  +
                                                  +
                                                  +
                                                  + +

                                                  Class MfaRequiredError

                                                  +
                                                  +

                                                  Error thrown when the token exchange results in a mfa_required error

                                                  +
                                                  +
                                                  +

                                                  Hierarchy (View Summary)

                                                  +
                                                  +
                                                  +
                                                  +
                                                  +
                                                  Index
                                                   +
                                                  +
                                                  + +
                                                  constructor +
                                                  +
                                                  + +
                                                  error error_description message mfa_requirements @@ -8,17 +40,100 @@ name stack? stackTraceLimit -

                                                  Methods

                                                  captureStackTrace +
                                                  +
                                                  + +
                                                  captureStackTrace fromPayload prepareStackTrace -

                                                  Constructors

                                                  • Parameters

                                                    • error: string
                                                    • error_description: string
                                                    • mfa_token: string
                                                    • mfa_requirements: MfaRequirements

                                                    Returns MfaRequiredError

                                                  Properties

                                                  error: string
                                                  error_description: string
                                                  message: string
                                                  mfa_requirements: MfaRequirements
                                                  mfa_token: string
                                                  name: string
                                                  stack?: string
                                                  stackTraceLimit: number

                                                  The Error.stackTraceLimit property specifies the number of stack frames +

                                                  +
                                                  + +
                                                  +
                                                  + +
                                                    +
                                                  • + +
                                                    +
                                                    +

                                                    Parameters

                                                    +
                                                      +
                                                    • error: string
                                                      • +
                                                    • error_description: string
                                                      • +
                                                    • mfa_token: string
                                                      • +
                                                    • mfa_requirements: MfaRequirements
                                                    +

                                                    Returns MfaRequiredError

                                                  +
                                                  + +
                                                  +
                                                  + +
                                                  error: string
                                                  +
                                                  + +
                                                  error_description: string
                                                  +
                                                  + +
                                                  message: string
                                                  +
                                                  + +
                                                  mfa_requirements: MfaRequirements
                                                  +
                                                  + +
                                                  mfa_token: string
                                                  +
                                                  + +
                                                  name: string
                                                  +
                                                  + +
                                                  stack?: string
                                                  +
                                                  + +
                                                  stackTraceLimit: number
                                                  +

                                                  The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

                                                  The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

                                                  If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

                                                  -

                                                  Methods

                                                  • Creates a .stack property on targetObject, which when accessed returns +

                                                  +
                                                  + +
                                                  +
                                                  + +
                                                    +
                                                  • + +
                                                    +

                                                    Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

                                                    const myObject = {};
                                                    Error.captureStackTrace(myObject);
                                                    myObject.stack;  // Similar to `new Error().stack`
@@ -34,5 +149,72 @@
 
                                                    function a() {
                                                      b();
                                                    }

                                                    function b() {
                                                      c();
                                                    }

                                                    function c() {
                                                      // Create an error without stack trace to avoid calculating the stack trace twice.
                                                      const { stackTraceLimit } = Error;
                                                      Error.stackTraceLimit = 0;
                                                      const error = new Error();
                                                      Error.stackTraceLimit = stackTraceLimit;

                                                      // Capture the stack trace above function b
                                                      Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                      throw error;
                                                    }

                                                    a();
 
                                                    
 
-

                                                    Parameters

                                                    • targetObject: object
                                                    • OptionalconstructorOpt: Function

                                                    Returns void

                                                  • Parameters

                                                    • __namedParameters: { error: string; error_description: string }

                                                    Returns GenericError

                                                  Settings

                                                  Member Visibility

                                                  On This Page

                                                  Constructors
                                                  Properties
                                                  Methods
                                                  + +
                                                  +

                                                  Parameters

                                                  +
                                                    +
                                                  • targetObject: object
                                                    • +
                                                  • OptionalconstructorOpt: Function
                                                  +

                                                  Returns void

                                                  +
                                                  + +
                                                    +
                                                  • + +
                                                    +
                                                    +

                                                    Parameters

                                                    +
                                                      +
                                                    • __namedParameters: { error: string; error_description: string }
                                                    +

                                                    Returns GenericError

                                                  +
                                                  + +
                                                  +
                                                  +
                                                  +
                                                  +
                                                  +

                                                  Settings

                                                   +
                                                  +
                                                  Member Visibility +
                                                    +
                                                    • +
                                                    • +
                                                  +
                                                  +
                                                  +

                                                  On This Page

                                                   +
                                                  +
                                                  Constructors +
                                                  +
                                                  Properties +
                                                  +
                                                  Methods +
                                                  +
                                                  +
                                                  +
                                                  diff --git a/docs/classes/MfaVerifyError.html b/docs/classes/MfaVerifyError.html index df583252..603b7378 100644 --- a/docs/classes/MfaVerifyError.html +++ b/docs/classes/MfaVerifyError.html @@ -1,25 +1,131 @@ -MfaVerifyError | @auth0/auth0-react
                                                  @auth0/auth0-react
                                                    Preparing search index...

                                                    Class MfaVerifyError

                                                    Error thrown when verifying an MFA challenge fails.

                                                    -
                                                    try {
                                                      const tokens = await mfa.verify({
                                                        mfaToken: mfaToken,
                                                        grant_type: 'http://auth0.com/oauth/grant-type/mfa-otp',
                                                        otp: '123456'
                                                      });
                                                    } catch (error) {
                                                      if (error instanceof MfaVerifyError) {
                                                        console.log(error.error); // 'invalid_otp' or 'context_not_found'
                                                        console.log(error.error_description); // Error details
                                                      }
                                                    }
+MfaVerifyError | @auth0/auth0-react
                                                    
+
                                                    @auth0/auth0-react
+
+
                                                      
+
                                                      
+
                                                      Preparing search index...
                                                      
+
                                                      
+
                                                      
+
                                                      
+
+
                                                      Class MfaVerifyError
                                                      
+
                                                      
+
                                                      Error thrown when verifying an MFA challenge fails.
                                                      
+
                                                      
+
                                                      
+
                                                      
+
                                                      try {
                                                        const tokens = await mfa.verify({
                                                          mfaToken: mfaToken,
                                                          grant_type: 'http://auth0.com/oauth/grant-type/mfa-otp',
                                                          otp: '123456'
                                                        });
                                                      } catch (error) {
                                                        if (error instanceof MfaVerifyError) {
                                                          console.log(error.error); // 'invalid_otp' or 'context_not_found'
                                                          console.log(error.error_description); // Error details
                                                        }
                                                      }
 
                                                      
 
-
                                                      Hierarchy (View Summary)
                                                      Index
                                                      Constructors
                                                      constructor
-
                                                      Properties
                                                      error
+
                                                      
+
                                                      
+
                                                      Hierarchy (View Summary)
                                                      
+
                                                      
+
                                                      
+
                                                      
+
                                                      
+
                                                      Index
                                                      
+
                                                      
+
                                                      
+
+
                                                      constructor
+
                                                      
+
                                                      
+
+
                                                      error
 error_description
 message
 name
 stack?
 stackTraceLimit
-
                                                      Methods
                                                      captureStackTrace
+
                                                      
+
                                                      
+
+
                                                      captureStackTrace
 fromPayload
 prepareStackTrace
-
                                                      Constructors
                                                      • Parameters
                                                        • error: string
                                                        • error_description: string
                                                        Returns MfaVerifyError
                                                      Properties
                                                      error: string
                                                      error_description: string
                                                      message: string
                                                      name: string
                                                      stack?: string
                                                      stackTraceLimit: number
                                                      The Error.stackTraceLimit property specifies the number of stack frames
+
                                                      +
                                                      + +
                                                      +
                                                      + +
                                                        +
                                                      • + +
                                                        +
                                                        +

                                                        Parameters

                                                        +
                                                          +
                                                        • error: string
                                                          • +
                                                        • error_description: string
                                                        +

                                                        Returns MfaVerifyError

                                                      +
                                                      + +
                                                      +
                                                      + +
                                                      error: string
                                                      +
                                                      + +
                                                      error_description: string
                                                      +
                                                      + +
                                                      message: string
                                                      +
                                                      + +
                                                      name: string
                                                      +
                                                      + +
                                                      stack?: string
                                                      +
                                                      + +
                                                      stackTraceLimit: number
                                                      +

                                                      The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

                                                      The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

                                                      If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

                                                      -

                                                      Methods

                                                      • Creates a .stack property on targetObject, which when accessed returns +

                                                      +
                                                      + +
                                                      +
                                                      + +
                                                        +
                                                      • + +
                                                        +

                                                        Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

                                                        const myObject = {};
                                                        Error.captureStackTrace(myObject);
                                                        myObject.stack;  // Similar to `new Error().stack`
@@ -35,5 +141,72 @@
 
                                                        function a() {
                                                          b();
                                                        }

                                                        function b() {
                                                          c();
                                                        }

                                                        function c() {
                                                          // Create an error without stack trace to avoid calculating the stack trace twice.
                                                          const { stackTraceLimit } = Error;
                                                          Error.stackTraceLimit = 0;
                                                          const error = new Error();
                                                          Error.stackTraceLimit = stackTraceLimit;

                                                          // Capture the stack trace above function b
                                                          Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                          throw error;
                                                        }

                                                        a();
 
                                                        
 
-

                                                        Parameters

                                                        • targetObject: object
                                                        • OptionalconstructorOpt: Function

                                                        Returns void

                                                      • Parameters

                                                        • __namedParameters: { error: string; error_description: string }

                                                        Returns MfaError

                                                      Settings

                                                      Member Visibility

                                                      On This Page

                                                      Constructors
                                                      Properties
                                                      Methods
                                                      + +
                                                      +

                                                      Parameters

                                                      +
                                                        +
                                                      • targetObject: object
                                                        • +
                                                      • OptionalconstructorOpt: Function
                                                      +

                                                      Returns void

                                                      +
                                                      + +
                                                        +
                                                      • + +
                                                        +
                                                        +

                                                        Parameters

                                                        +
                                                          +
                                                        • __namedParameters: { error: string; error_description: string }
                                                        +

                                                        Returns MfaError

                                                      +
                                                      + +
                                                      +
                                                      +
                                                      +
                                                      +
                                                      +

                                                      Settings

                                                       +
                                                      +
                                                      Member Visibility +
                                                        +
                                                        • +
                                                        • +
                                                      +
                                                      +
                                                      +

                                                      On This Page

                                                       +
                                                      +
                                                      Constructors +
                                                      +
                                                      Properties +
                                                      +
                                                      Methods +
                                                      +
                                                      +
                                                      +
                                                      diff --git a/docs/classes/MissingRefreshTokenError.html b/docs/classes/MissingRefreshTokenError.html index df818d5f..9dd5b69f 100644 --- a/docs/classes/MissingRefreshTokenError.html +++ b/docs/classes/MissingRefreshTokenError.html @@ -1,6 +1,38 @@ -MissingRefreshTokenError | @auth0/auth0-react
                                                      @auth0/auth0-react
                                                        Preparing search index...

                                                        Class MissingRefreshTokenError

                                                        Error thrown when there is no refresh token to use

                                                        -

                                                        Hierarchy (View Summary)

                                                        Index

                                                        Constructors

                                                        constructor -

                                                        Properties

                                                        audience +MissingRefreshTokenError | @auth0/auth0-react
                                                        +
                                                        @auth0/auth0-react + +
                                                          +
                                                          +
                                                          Preparing search index...
                                                          +
                                                          +
                                                          +
                                                          + +

                                                          Class MissingRefreshTokenError

                                                          +
                                                          +

                                                          Error thrown when there is no refresh token to use

                                                          +
                                                          +
                                                          +

                                                          Hierarchy (View Summary)

                                                          +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          Index
                                                           +
                                                          +
                                                          + +
                                                          constructor +
                                                          +
                                                          + +
                                                          audience error error_description message @@ -8,17 +40,98 @@ scope stack? stackTraceLimit -

                                                          Methods

                                                          captureStackTrace +
                                                          +
                                                          + +
                                                          captureStackTrace fromPayload prepareStackTrace -

                                                          Constructors

                                                          Properties

                                                          audience: string
                                                          error: string
                                                          error_description: string
                                                          message: string
                                                          name: string
                                                          scope: string
                                                          stack?: string
                                                          stackTraceLimit: number

                                                          The Error.stackTraceLimit property specifies the number of stack frames +

                                                          +
                                                          + +
                                                          +
                                                          + +
                                                          +
                                                          + +
                                                          +
                                                          + +
                                                          audience: string
                                                          +
                                                          + +
                                                          error: string
                                                          +
                                                          + +
                                                          error_description: string
                                                          +
                                                          + +
                                                          message: string
                                                          +
                                                          + +
                                                          name: string
                                                          +
                                                          + +
                                                          scope: string
                                                          +
                                                          + +
                                                          stack?: string
                                                          +
                                                          + +
                                                          stackTraceLimit: number
                                                          +

                                                          The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

                                                          The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

                                                          If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

                                                          -

                                                          Methods

                                                          • Creates a .stack property on targetObject, which when accessed returns +

                                                          +
                                                          + +
                                                          +
                                                          + +
                                                            +
                                                          • + +
                                                            +

                                                            Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

                                                            const myObject = {};
                                                            Error.captureStackTrace(myObject);
                                                            myObject.stack;  // Similar to `new Error().stack`
@@ -34,5 +147,72 @@
 
                                                            function a() {
                                                              b();
                                                            }

                                                            function b() {
                                                              c();
                                                            }

                                                            function c() {
                                                              // Create an error without stack trace to avoid calculating the stack trace twice.
                                                              const { stackTraceLimit } = Error;
                                                              Error.stackTraceLimit = 0;
                                                              const error = new Error();
                                                              Error.stackTraceLimit = stackTraceLimit;

                                                              // Capture the stack trace above function b
                                                              Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                              throw error;
                                                            }

                                                            a();
 
                                                            
 
-

                                                            Parameters

                                                            • targetObject: object
                                                            • OptionalconstructorOpt: Function

                                                            Returns void

                                                          • Parameters

                                                            • __namedParameters: { error: string; error_description: string }

                                                            Returns GenericError

                                                          Settings

                                                          Member Visibility

                                                          On This Page

                                                          Constructors
                                                          Properties
                                                          Methods
                                                          + +
                                                          +

                                                          Parameters

                                                          +
                                                            +
                                                          • targetObject: object
                                                            • +
                                                          • OptionalconstructorOpt: Function
                                                          +

                                                          Returns void

                                                          +
                                                          + +
                                                            +
                                                          • + +
                                                            +
                                                            +

                                                            Parameters

                                                            +
                                                              +
                                                            • __namedParameters: { error: string; error_description: string }
                                                            +

                                                            Returns GenericError

                                                          +
                                                          + +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +

                                                          Settings

                                                           +
                                                          +
                                                          Member Visibility +
                                                            +
                                                            • +
                                                            • +
                                                          +
                                                          +
                                                          +

                                                          On This Page

                                                           +
                                                          +
                                                          Constructors +
                                                          +
                                                          Properties +
                                                          +
                                                          Methods +
                                                          +
                                                          +
                                                          +
                                                          diff --git a/docs/classes/MissingScopesError.html b/docs/classes/MissingScopesError.html index c2625d94..5dd7a4e0 100644 --- a/docs/classes/MissingScopesError.html +++ b/docs/classes/MissingScopesError.html @@ -1,6 +1,38 @@ -MissingScopesError | @auth0/auth0-react
                                                          @auth0/auth0-react
                                                            Preparing search index...

                                                            Class MissingScopesError

                                                            Error thrown when there are missing scopes after refreshing a token

                                                            -

                                                            Hierarchy (View Summary)

                                                            Index

                                                            Constructors

                                                            constructor -

                                                            Properties

                                                            audience +MissingScopesError | @auth0/auth0-react
                                                            +
                                                            @auth0/auth0-react + +
                                                              +
                                                              +
                                                              Preparing search index...
                                                              +
                                                              +
                                                              +
                                                              + +

                                                              Class MissingScopesError

                                                              +
                                                              +

                                                              Error thrown when there are missing scopes after refreshing a token

                                                              +
                                                              +
                                                              +

                                                              Hierarchy (View Summary)

                                                              +
                                                              +
                                                              +
                                                              +
                                                              +
                                                              Index
                                                               +
                                                              +
                                                              + +
                                                              constructor +
                                                              +
                                                              + +
                                                              audience error error_description message @@ -8,17 +40,98 @@ scope stack? stackTraceLimit -

                                                              Methods

                                                              captureStackTrace +
                                                              +
                                                              + +
                                                              captureStackTrace fromPayload prepareStackTrace -

                                                              Constructors

                                                              Properties

                                                              audience: string
                                                              error: string
                                                              error_description: string
                                                              message: string
                                                              name: string
                                                              scope: string
                                                              stack?: string
                                                              stackTraceLimit: number

                                                              The Error.stackTraceLimit property specifies the number of stack frames +

                                                              +
                                                              + +
                                                              +
                                                              + +
                                                              +
                                                              + +
                                                              +
                                                              + +
                                                              audience: string
                                                              +
                                                              + +
                                                              error: string
                                                              +
                                                              + +
                                                              error_description: string
                                                              +
                                                              + +
                                                              message: string
                                                              +
                                                              + +
                                                              name: string
                                                              +
                                                              + +
                                                              scope: string
                                                              +
                                                              + +
                                                              stack?: string
                                                              +
                                                              + +
                                                              stackTraceLimit: number
                                                              +

                                                              The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

                                                              The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

                                                              If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

                                                              -

                                                              Methods

                                                              • Creates a .stack property on targetObject, which when accessed returns +

                                                              +
                                                              + +
                                                              +
                                                              + +
                                                                +
                                                              • + +
                                                                +

                                                                Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

                                                                const myObject = {};
                                                                Error.captureStackTrace(myObject);
                                                                myObject.stack;  // Similar to `new Error().stack`
@@ -34,5 +147,72 @@
 
                                                                function a() {
                                                                  b();
                                                                }

                                                                function b() {
                                                                  c();
                                                                }

                                                                function c() {
                                                                  // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                  const { stackTraceLimit } = Error;
                                                                  Error.stackTraceLimit = 0;
                                                                  const error = new Error();
                                                                  Error.stackTraceLimit = stackTraceLimit;

                                                                  // Capture the stack trace above function b
                                                                  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                  throw error;
                                                                }

                                                                a();
 
                                                                
 
-

                                                                Parameters

                                                                • targetObject: object
                                                                • OptionalconstructorOpt: Function

                                                                Returns void

                                                              • Parameters

                                                                • __namedParameters: { error: string; error_description: string }

                                                                Returns GenericError

                                                              Settings

                                                              Member Visibility

                                                              On This Page

                                                              Constructors
                                                              Properties
                                                              Methods
                                                              + +
                                                              +

                                                              Parameters

                                                              +
                                                                +
                                                              • targetObject: object
                                                                • +
                                                              • OptionalconstructorOpt: Function
                                                              +

                                                              Returns void

                                                              +
                                                              + +
                                                                +
                                                              • + +
                                                                +
                                                                +

                                                                Parameters

                                                                +
                                                                  +
                                                                • __namedParameters: { error: string; error_description: string }
                                                                +

                                                                Returns GenericError

                                                              +
                                                              + +
                                                              +
                                                              +
                                                              +
                                                              +
                                                              +

                                                              Settings

                                                               +
                                                              +
                                                              Member Visibility +
                                                                +
                                                                • +
                                                                • +
                                                              +
                                                              +
                                                              +

                                                              On This Page

                                                               +
                                                              +
                                                              Constructors +
                                                              +
                                                              Properties +
                                                              +
                                                              Methods +
                                                              +
                                                              +
                                                              +
                                                              diff --git a/docs/classes/MyAccountApiError.html b/docs/classes/MyAccountApiError.html index d1d3309e..20f7eb59 100644 --- a/docs/classes/MyAccountApiError.html +++ b/docs/classes/MyAccountApiError.html @@ -1,9 +1,44 @@ -MyAccountApiError | @auth0/auth0-react
                                                              @auth0/auth0-react
                                                                Preparing search index...

                                                                Class MyAccountApiError

                                                                Error thrown when the MyAccount API returns a non-2xx response.

                                                                -
                                                                try {
                                                                  await myAccount.getAuthenticationMethods();
                                                                } catch (err) {
                                                                  if (err instanceof MyAccountApiError) {
                                                                    console.error(err.status, err.title, err.detail);
                                                                  }
                                                                }
+MyAccountApiError | @auth0/auth0-react
                                                                
+
                                                                @auth0/auth0-react
+
+
                                                                  
+
                                                                  
+
                                                                  Preparing search index...
                                                                  
+
                                                                  
+
                                                                  
+
                                                                  
+
+
                                                                  Class MyAccountApiError
                                                                  
+
                                                                  
+
                                                                  Error thrown when the MyAccount API returns a non-2xx response.
                                                                  
+
                                                                  
+
                                                                  
+
                                                                  
+
                                                                  try {
                                                                    await myAccount.getAuthenticationMethods();
                                                                  } catch (err) {
                                                                    if (err instanceof MyAccountApiError) {
                                                                      console.error(err.status, err.title, err.detail);
                                                                    }
                                                                  }
 
                                                                  
 
-
                                                                  Hierarchy
                                                                  • Error
                                                                    • MyAccountApiError
                                                                  Index
                                                                  Constructors
                                                                  constructor
-
                                                                  Properties
                                                                  detail
+
                                                                  
+
                                                                  
+
                                                                  Hierarchy
                                                                  
+
                                                                    
+
                                                                  • Error
+
                                                                      
+
                                                                    • MyAccountApiError
                                                                  
+
                                                                  
+
                                                                  
+
                                                                  
+
                                                                  Index
                                                                  
+
                                                                  
+
                                                                  
+
+
                                                                  constructor
+
                                                                  
+
                                                                  
+
+
                                                                  detail
 message
 name
 stack?
@@ -12,21 +47,109 @@
 type
 validation_errors?
 stackTraceLimit
-
                                                                  Methods
                                                                  captureStackTrace
+
                                                                  
+
                                                                  
+
+
                                                                  captureStackTrace
 prepareStackTrace
-
                                                                  Constructors
                                                                  • Parameters
                                                                    • __namedParameters: ErrorResponse
                                                                    Returns MyAccountApiError
                                                                  Properties
                                                                  detail: string
                                                                  Human-readable explanation specific to this occurrence
                                                                  
-
                                                                  message: string
                                                                  name: string
                                                                  stack?: string
                                                                  status: number
                                                                  HTTP status code
                                                                  
-
                                                                  title: string
                                                                  Short human-readable summary of the error
                                                                  
-
                                                                  type: string
                                                                  RFC 7807 error type identifier
                                                                  
-
                                                                  validation_errors?: {
                                                                      detail: string;
                                                                      field?: string;
                                                                      pointer?: string;
                                                                      source?: string;
                                                                  }[]
                                                                  Field-level validation errors, if present
                                                                  
-
                                                                  stackTraceLimit: number
                                                                  The Error.stackTraceLimit property specifies the number of stack frames
+
                                                                  +
                                                                  + +
                                                                  +
                                                                  + +
                                                                    +
                                                                  • + +
                                                                    +
                                                                    +

                                                                    Parameters

                                                                    +
                                                                      +
                                                                    • __namedParameters: ErrorResponse
                                                                    +

                                                                    Returns MyAccountApiError

                                                                  +
                                                                  + +
                                                                  +
                                                                  + +
                                                                  detail: string
                                                                  +

                                                                  Human-readable explanation specific to this occurrence

                                                                  +
                                                                  +
                                                                  + +
                                                                  message: string
                                                                  +
                                                                  + +
                                                                  name: string
                                                                  +
                                                                  + +
                                                                  stack?: string
                                                                  +
                                                                  + +
                                                                  status: number
                                                                  +

                                                                  HTTP status code

                                                                  +
                                                                  +
                                                                  + +
                                                                  title: string
                                                                  +

                                                                  Short human-readable summary of the error

                                                                  +
                                                                  +
                                                                  + +
                                                                  type: string
                                                                  +

                                                                  RFC 7807 error type identifier

                                                                  +
                                                                  +
                                                                  + +
                                                                  validation_errors?: {
                                                                      detail: string;
                                                                      field?: string;
                                                                      pointer?: string;
                                                                      source?: string;
                                                                  }[]
                                                                  +

                                                                  Field-level validation errors, if present

                                                                  +
                                                                  +
                                                                  + +
                                                                  stackTraceLimit: number
                                                                  +

                                                                  The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

                                                                  The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

                                                                  If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

                                                                  -

                                                                  Methods

                                                                  • Creates a .stack property on targetObject, which when accessed returns +

                                                                  +
                                                                  + +
                                                                  +
                                                                  + +
                                                                    +
                                                                  • + +
                                                                    +

                                                                    Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

                                                                    const myObject = {};
                                                                    Error.captureStackTrace(myObject);
                                                                    myObject.stack;  // Similar to `new Error().stack`
@@ -42,5 +165,58 @@
 
                                                                    function a() {
                                                                      b();
                                                                    }

                                                                    function b() {
                                                                      c();
                                                                    }

                                                                    function c() {
                                                                      // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                      const { stackTraceLimit } = Error;
                                                                      Error.stackTraceLimit = 0;
                                                                      const error = new Error();
                                                                      Error.stackTraceLimit = stackTraceLimit;

                                                                      // Capture the stack trace above function b
                                                                      Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                      throw error;
                                                                    }

                                                                    a();
 
                                                                    
 
-

                                                                    Parameters

                                                                    • targetObject: object
                                                                    • OptionalconstructorOpt: Function

                                                                    Returns void

                                                                  Settings

                                                                  Member Visibility

                                                                  On This Page

                                                                  Constructors
                                                                  Properties
                                                                  Methods
                                                                  + +
                                                                  +

                                                                  Parameters

                                                                  +
                                                                    +
                                                                  • targetObject: object
                                                                    • +
                                                                  • OptionalconstructorOpt: Function
                                                                  +

                                                                  Returns void

                                                                  +
                                                                  + +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +

                                                                  Settings

                                                                   +
                                                                  +
                                                                  Member Visibility +
                                                                    +
                                                                    • +
                                                                    • +
                                                                  +
                                                                  +
                                                                  +

                                                                  On This Page

                                                                   +
                                                                  +
                                                                  Constructors +
                                                                  +
                                                                  Properties +
                                                                  +
                                                                  Methods +
                                                                  +
                                                                  +
                                                                  +
                                                                  diff --git a/docs/classes/OAuthError.html b/docs/classes/OAuthError.html index b48f3ccc..da186b4f 100644 --- a/docs/classes/OAuthError.html +++ b/docs/classes/OAuthError.html @@ -1,23 +1,124 @@ -OAuthError | @auth0/auth0-react
                                                                  @auth0/auth0-react
                                                                    Preparing search index...

                                                                    Class OAuthError

                                                                    An OAuth2 error will come from the authorization server and will have at least an error property which will +OAuthError | @auth0/auth0-react

                                                                    +
                                                                    @auth0/auth0-react + +
                                                                      +
                                                                      +
                                                                      Preparing search index...
                                                                      +
                                                                      +
                                                                      +
                                                                      + +

                                                                      Class OAuthError

                                                                      +
                                                                      +

                                                                      An OAuth2 error will come from the authorization server and will have at least an error property which will be the error code. And possibly an error_description property

                                                                      See: https://openid.net/specs/openid-connect-core-1_0.html#rfc.section.3.1.2.6

                                                                      -

                                                                      Hierarchy

                                                                      • Error
                                                                        • OAuthError
                                                                      Index

                                                                      Constructors

                                                                      constructor -

                                                                      Properties

                                                                      error +
                                                                      +
                                                                      +

                                                                      Hierarchy

                                                                      +
                                                                        +
                                                                      • Error +
                                                                          +
                                                                        • OAuthError
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      Index
                                                                       +
                                                                      +
                                                                      + +
                                                                      constructor +
                                                                      +
                                                                      + +
                                                                      error error_description? message name stack? stackTraceLimit -

                                                                      Methods

                                                                      captureStackTrace +
                                                                      +
                                                                      + +
                                                                      captureStackTrace prepareStackTrace -

                                                                      Constructors

                                                                      • Parameters

                                                                        • error: string
                                                                        • Optionalerror_description: string

                                                                        Returns OAuthError

                                                                      Properties

                                                                      error: string
                                                                      error_description?: string
                                                                      message: string
                                                                      name: string
                                                                      stack?: string
                                                                      stackTraceLimit: number

                                                                      The Error.stackTraceLimit property specifies the number of stack frames +

                                                                      +
                                                                      + +
                                                                      +
                                                                      + +
                                                                        +
                                                                      • + +
                                                                        +
                                                                        +

                                                                        Parameters

                                                                        +
                                                                          +
                                                                        • error: string
                                                                          • +
                                                                        • Optionalerror_description: string
                                                                        +

                                                                        Returns OAuthError

                                                                      +
                                                                      + +
                                                                      +
                                                                      + +
                                                                      error: string
                                                                      +
                                                                      + +
                                                                      error_description?: string
                                                                      +
                                                                      + +
                                                                      message: string
                                                                      +
                                                                      + +
                                                                      name: string
                                                                      +
                                                                      + +
                                                                      stack?: string
                                                                      +
                                                                      + +
                                                                      stackTraceLimit: number
                                                                      +

                                                                      The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

                                                                      The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

                                                                      If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

                                                                      -

                                                                      Methods

                                                                      • Creates a .stack property on targetObject, which when accessed returns +

                                                                      +
                                                                      + +
                                                                      +
                                                                      + +
                                                                        +
                                                                      • + +
                                                                        +

                                                                        Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

                                                                        const myObject = {};
                                                                        Error.captureStackTrace(myObject);
                                                                        myObject.stack;  // Similar to `new Error().stack`
@@ -33,5 +134,58 @@
 
                                                                        function a() {
                                                                          b();
                                                                        }

                                                                        function b() {
                                                                          c();
                                                                        }

                                                                        function c() {
                                                                          // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                          const { stackTraceLimit } = Error;
                                                                          Error.stackTraceLimit = 0;
                                                                          const error = new Error();
                                                                          Error.stackTraceLimit = stackTraceLimit;

                                                                          // Capture the stack trace above function b
                                                                          Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                          throw error;
                                                                        }

                                                                        a();
 
                                                                        
 
-

                                                                        Parameters

                                                                        • targetObject: object
                                                                        • OptionalconstructorOpt: Function

                                                                        Returns void

                                                                      Settings

                                                                      Member Visibility

                                                                      On This Page

                                                                      Constructors
                                                                      Properties
                                                                      Methods
                                                                      +
                                                                      +
                                                                      +

                                                                      Parameters

                                                                      +
                                                                        +
                                                                      • targetObject: object
                                                                        • +
                                                                      • OptionalconstructorOpt: Function
                                                                      +

                                                                      Returns void

                                                                      +
                                                                      + +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      +

                                                                      Settings

                                                                       +
                                                                      +
                                                                      Member Visibility +
                                                                        +
                                                                        • +
                                                                        • +
                                                                      +
                                                                      +
                                                                      +

                                                                      On This Page

                                                                       +
                                                                      +
                                                                      Constructors +
                                                                      +
                                                                      Properties +
                                                                      +
                                                                      Methods +
                                                                      +
                                                                      +
                                                                      +
                                                                      diff --git a/docs/classes/PasskeyChallengeError.html b/docs/classes/PasskeyChallengeError.html index 448e6a1d..1830d29c 100644 --- a/docs/classes/PasskeyChallengeError.html +++ b/docs/classes/PasskeyChallengeError.html @@ -1,21 +1,124 @@ -PasskeyChallengeError | @auth0/auth0-react
                                                                      @auth0/auth0-react
                                                                        Preparing search index...

                                                                        Class PasskeyChallengeError

                                                                        Error thrown when requesting a passkey login challenge fails.

                                                                        -

                                                                        Hierarchy

                                                                        • PasskeyError
                                                                          • PasskeyChallengeError
                                                                        Index

                                                                        Constructors

                                                                        constructor -

                                                                        Properties

                                                                        cause? +PasskeyChallengeError | @auth0/auth0-react
                                                                        +
                                                                        @auth0/auth0-react + +
                                                                          +
                                                                          +
                                                                          Preparing search index...
                                                                          +
                                                                          +
                                                                          +
                                                                          + +

                                                                          Class PasskeyChallengeError

                                                                          +
                                                                          +

                                                                          Error thrown when requesting a passkey login challenge fails.

                                                                          +
                                                                          +
                                                                          +

                                                                          Hierarchy

                                                                          +
                                                                            +
                                                                          • PasskeyError +
                                                                              +
                                                                            • PasskeyChallengeError
                                                                          +
                                                                          +
                                                                          +
                                                                          +
                                                                          Index
                                                                           +
                                                                          +
                                                                          + +
                                                                          constructor +
                                                                          +
                                                                          + +
                                                                          cause? code message name stack? stackTraceLimit -

                                                                          Methods

                                                                          captureStackTrace +
                                                                          +
                                                                          + +
                                                                          captureStackTrace prepareStackTrace -

                                                                          Constructors

                                                                          • Parameters

                                                                            • message: string
                                                                            • Optionalcause: PasskeyApiErrorResponse

                                                                            Returns PasskeyChallengeError

                                                                          Properties

                                                                          cause?: PasskeyApiErrorResponse
                                                                          code: string
                                                                          message: string
                                                                          name: string
                                                                          stack?: string
                                                                          stackTraceLimit: number

                                                                          The Error.stackTraceLimit property specifies the number of stack frames +

                                                                          +
                                                                          + +
                                                                          +
                                                                          + +
                                                                            +
                                                                          • + +
                                                                            +
                                                                            +

                                                                            Parameters

                                                                            +
                                                                              +
                                                                            • message: string
                                                                              • +
                                                                            • Optionalcause: PasskeyApiErrorResponse
                                                                            +

                                                                            Returns PasskeyChallengeError

                                                                          +
                                                                          + +
                                                                          +
                                                                          + +
                                                                          cause?: PasskeyApiErrorResponse
                                                                          +
                                                                          + +
                                                                          code: string
                                                                          +
                                                                          + +
                                                                          message: string
                                                                          +
                                                                          + +
                                                                          name: string
                                                                          +
                                                                          + +
                                                                          stack?: string
                                                                          +
                                                                          + +
                                                                          stackTraceLimit: number
                                                                          +

                                                                          The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

                                                                          The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

                                                                          If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

                                                                          -

                                                                          Methods

                                                                          • Creates a .stack property on targetObject, which when accessed returns +

                                                                          +
                                                                          + +
                                                                          +
                                                                          + +
                                                                            +
                                                                          • + +
                                                                            +

                                                                            Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

                                                                            const myObject = {};
                                                                            Error.captureStackTrace(myObject);
                                                                            myObject.stack;  // Similar to `new Error().stack`
@@ -31,5 +134,58 @@
 
                                                                            function a() {
                                                                              b();
                                                                            }

                                                                            function b() {
                                                                              c();
                                                                            }

                                                                            function c() {
                                                                              // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                              const { stackTraceLimit } = Error;
                                                                              Error.stackTraceLimit = 0;
                                                                              const error = new Error();
                                                                              Error.stackTraceLimit = stackTraceLimit;

                                                                              // Capture the stack trace above function b
                                                                              Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                              throw error;
                                                                            }

                                                                            a();
 
                                                                            
 
-

                                                                            Parameters

                                                                            • targetObject: object
                                                                            • OptionalconstructorOpt: Function

                                                                            Returns void

                                                                          Settings

                                                                          Member Visibility

                                                                          On This Page

                                                                          Constructors
                                                                          Properties
                                                                          Methods
                                                                          + +
                                                                          +

                                                                          Parameters

                                                                          +
                                                                            +
                                                                          • targetObject: object
                                                                            • +
                                                                          • OptionalconstructorOpt: Function
                                                                          +

                                                                          Returns void

                                                                          +
                                                                          + +
                                                                            +
                                                                          • + +
                                                                            +
                                                                            +

                                                                            Parameters

                                                                            +
                                                                              +
                                                                            • err: Error
                                                                              • +
                                                                            • stackTraces: CallSite[]
                                                                            +

                                                                            Returns any

                                                                            +
                                                                            +
                                                                            +

                                                                            https://v8.dev/docs/stack-trace-api#customizing-stack-traces

                                                                            +
                                                                          +
                                                                          +
                                                                          +
                                                                          +
                                                                          +

                                                                          Settings

                                                                           +
                                                                          +
                                                                          Member Visibility +
                                                                            +
                                                                            • +
                                                                            • +
                                                                          +
                                                                          +
                                                                          +

                                                                          On This Page

                                                                           +
                                                                          +
                                                                          Constructors +
                                                                          +
                                                                          Properties +
                                                                          +
                                                                          Methods +
                                                                          +
                                                                          +
                                                                          +
                                                                          diff --git a/docs/classes/PasskeyError.html b/docs/classes/PasskeyError.html index 3be7ec00..7a6ca4d5 100644 --- a/docs/classes/PasskeyError.html +++ b/docs/classes/PasskeyError.html @@ -1,20 +1,120 @@ -PasskeyError | @auth0/auth0-react
                                                                          @auth0/auth0-react
                                                                            Preparing search index...

                                                                            Class PasskeyError

                                                                            Hierarchy

                                                                            • Error
                                                                              • PasskeyError
                                                                            Index

                                                                            Constructors

                                                                            constructor -

                                                                            Properties

                                                                            cause? +PasskeyError | @auth0/auth0-react
                                                                            +
                                                                            @auth0/auth0-react + +
                                                                              +
                                                                              +
                                                                              Preparing search index...
                                                                              +
                                                                              +
                                                                              +
                                                                              + +

                                                                              Class PasskeyError

                                                                              +
                                                                              +

                                                                              Hierarchy

                                                                              +
                                                                                +
                                                                              • Error +
                                                                                  +
                                                                                • PasskeyError
                                                                              +
                                                                              +
                                                                              +
                                                                              +
                                                                              Index
                                                                               +
                                                                              +
                                                                              + +
                                                                              constructor +
                                                                              +
                                                                              + +
                                                                              cause? code message name stack? stackTraceLimit -

                                                                              Methods

                                                                              captureStackTrace +
                                                                              +
                                                                              + +
                                                                              captureStackTrace prepareStackTrace -

                                                                              Constructors

                                                                              • Parameters

                                                                                • code: string
                                                                                • message: string
                                                                                • Optionalcause: PasskeyErrorResponse

                                                                                Returns PasskeyError

                                                                              Properties

                                                                              cause?: PasskeyErrorResponse
                                                                              code: string
                                                                              message: string
                                                                              name: string
                                                                              stack?: string
                                                                              stackTraceLimit: number

                                                                              The Error.stackTraceLimit property specifies the number of stack frames +

                                                                              +
                                                                              + +
                                                                              +
                                                                              + +
                                                                                +
                                                                              • + +
                                                                                +
                                                                                +

                                                                                Parameters

                                                                                +
                                                                                  +
                                                                                • code: string
                                                                                  • +
                                                                                • message: string
                                                                                  • +
                                                                                • Optionalcause: PasskeyErrorResponse
                                                                                +

                                                                                Returns PasskeyError

                                                                              +
                                                                              + +
                                                                              +
                                                                              + +
                                                                              cause?: PasskeyErrorResponse
                                                                              +
                                                                              + +
                                                                              code: string
                                                                              +
                                                                              + +
                                                                              message: string
                                                                              +
                                                                              + +
                                                                              name: string
                                                                              +
                                                                              + +
                                                                              stack?: string
                                                                              +
                                                                              + +
                                                                              stackTraceLimit: number
                                                                              +

                                                                              The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

                                                                              The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

                                                                              If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

                                                                              -

                                                                              Methods

                                                                              • Creates a .stack property on targetObject, which when accessed returns +

                                                                              +
                                                                              + +
                                                                              +
                                                                              + +
                                                                                +
                                                                              • + +
                                                                                +

                                                                                Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

                                                                                const myObject = {};
                                                                                Error.captureStackTrace(myObject);
                                                                                myObject.stack;  // Similar to `new Error().stack`
@@ -30,5 +130,58 @@
 
                                                                                function a() {
                                                                                  b();
                                                                                }

                                                                                function b() {
                                                                                  c();
                                                                                }

                                                                                function c() {
                                                                                  // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                  const { stackTraceLimit } = Error;
                                                                                  Error.stackTraceLimit = 0;
                                                                                  const error = new Error();
                                                                                  Error.stackTraceLimit = stackTraceLimit;

                                                                                  // Capture the stack trace above function b
                                                                                  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                  throw error;
                                                                                }

                                                                                a();
 
                                                                                
 
-

                                                                                Parameters

                                                                                • targetObject: object
                                                                                • OptionalconstructorOpt: Function

                                                                                Returns void

                                                                              Settings

                                                                              Member Visibility

                                                                              On This Page

                                                                              Constructors
                                                                              Properties
                                                                              Methods
                                                                              + +
                                                                              +

                                                                              Parameters

                                                                              +
                                                                                +
                                                                              • targetObject: object
                                                                                • +
                                                                              • OptionalconstructorOpt: Function
                                                                              +

                                                                              Returns void

                                                                              +
                                                                              + +
                                                                              +
                                                                              +
                                                                              +
                                                                              +
                                                                              +

                                                                              Settings

                                                                               +
                                                                              +
                                                                              Member Visibility +
                                                                                +
                                                                                • +
                                                                                • +
                                                                              +
                                                                              +
                                                                              +

                                                                              On This Page

                                                                               +
                                                                              +
                                                                              Constructors +
                                                                              +
                                                                              Properties +
                                                                              +
                                                                              Methods +
                                                                              +
                                                                              +
                                                                              +
                                                                              diff --git a/docs/classes/PasskeyGetTokenError.html b/docs/classes/PasskeyGetTokenError.html index d3cc0b36..34c95614 100644 --- a/docs/classes/PasskeyGetTokenError.html +++ b/docs/classes/PasskeyGetTokenError.html @@ -1,23 +1,126 @@ -PasskeyGetTokenError | @auth0/auth0-react
                                                                              @auth0/auth0-react
                                                                                Preparing search index...

                                                                                Class PasskeyGetTokenError

                                                                                Error thrown when exchanging a passkey credential for tokens fails.

                                                                                +PasskeyGetTokenError | @auth0/auth0-react
                                                                                +
                                                                                @auth0/auth0-react + +
                                                                                  +
                                                                                  +
                                                                                  Preparing search index...
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  + +

                                                                                  Class PasskeyGetTokenError

                                                                                  +
                                                                                  +

                                                                                  Error thrown when exchanging a passkey credential for tokens fails.

                                                                                  Unlike the challenge errors, this carries mfa_token / mfa_requirements on its cause when the server responds with mfa_required.

                                                                                  -

                                                                                  Hierarchy

                                                                                  • PasskeyError
                                                                                    • PasskeyGetTokenError
                                                                                  Index

                                                                                  Constructors

                                                                                  constructor -

                                                                                  Properties

                                                                                  cause? +
                                                                                  +
                                                                                  +

                                                                                  Hierarchy

                                                                                  +
                                                                                    +
                                                                                  • PasskeyError +
                                                                                      +
                                                                                    • PasskeyGetTokenError
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  Index
                                                                                   +
                                                                                  +
                                                                                  + +
                                                                                  constructor +
                                                                                  +
                                                                                  + +
                                                                                  cause? code message name stack? stackTraceLimit -

                                                                                  Methods

                                                                                  captureStackTrace +
                                                                                  +
                                                                                  + +
                                                                                  captureStackTrace prepareStackTrace -

                                                                                  Constructors

                                                                                  • Parameters

                                                                                    • message: string
                                                                                    • Optionalcause: PasskeyGetTokenApiErrorResponse

                                                                                    Returns PasskeyGetTokenError

                                                                                  Properties

                                                                                  cause?: PasskeyGetTokenApiErrorResponse
                                                                                  code: string
                                                                                  message: string
                                                                                  name: string
                                                                                  stack?: string
                                                                                  stackTraceLimit: number

                                                                                  The Error.stackTraceLimit property specifies the number of stack frames +

                                                                                  +
                                                                                  + +
                                                                                  +
                                                                                  + +
                                                                                    +
                                                                                  • + +
                                                                                    +
                                                                                    +

                                                                                    Parameters

                                                                                    +
                                                                                      +
                                                                                    • message: string
                                                                                      • +
                                                                                    • Optionalcause: PasskeyGetTokenApiErrorResponse
                                                                                    +

                                                                                    Returns PasskeyGetTokenError

                                                                                  +
                                                                                  + +
                                                                                  +
                                                                                  + +
                                                                                  cause?: PasskeyGetTokenApiErrorResponse
                                                                                  +
                                                                                  + +
                                                                                  code: string
                                                                                  +
                                                                                  + +
                                                                                  message: string
                                                                                  +
                                                                                  + +
                                                                                  name: string
                                                                                  +
                                                                                  + +
                                                                                  stack?: string
                                                                                  +
                                                                                  + +
                                                                                  stackTraceLimit: number
                                                                                  +

                                                                                  The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

                                                                                  The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

                                                                                  If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

                                                                                  -

                                                                                  Methods

                                                                                  • Creates a .stack property on targetObject, which when accessed returns +

                                                                                  +
                                                                                  + +
                                                                                  +
                                                                                  + +
                                                                                    +
                                                                                  • + +
                                                                                    +

                                                                                    Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

                                                                                    const myObject = {};
                                                                                    Error.captureStackTrace(myObject);
                                                                                    myObject.stack;  // Similar to `new Error().stack`
@@ -33,5 +136,58 @@
 
                                                                                    function a() {
                                                                                      b();
                                                                                    }

                                                                                    function b() {
                                                                                      c();
                                                                                    }

                                                                                    function c() {
                                                                                      // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                      const { stackTraceLimit } = Error;
                                                                                      Error.stackTraceLimit = 0;
                                                                                      const error = new Error();
                                                                                      Error.stackTraceLimit = stackTraceLimit;

                                                                                      // Capture the stack trace above function b
                                                                                      Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                      throw error;
                                                                                    }

                                                                                    a();
 
                                                                                    
 
-

                                                                                    Parameters

                                                                                    • targetObject: object
                                                                                    • OptionalconstructorOpt: Function

                                                                                    Returns void

                                                                                  Settings

                                                                                  Member Visibility

                                                                                  On This Page

                                                                                  Constructors
                                                                                  Properties
                                                                                  Methods
                                                                                  +
                                                                                  +
                                                                                  +

                                                                                  Parameters

                                                                                  +
                                                                                    +
                                                                                  • targetObject: object
                                                                                    • +
                                                                                  • OptionalconstructorOpt: Function
                                                                                  +

                                                                                  Returns void

                                                                                  +
                                                                                  + +
                                                                                    +
                                                                                  • + +
                                                                                    +
                                                                                    +

                                                                                    Parameters

                                                                                    +
                                                                                      +
                                                                                    • err: Error
                                                                                      • +
                                                                                    • stackTraces: CallSite[]
                                                                                    +

                                                                                    Returns any

                                                                                    +
                                                                                    +
                                                                                    +

                                                                                    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

                                                                                    +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +

                                                                                  Settings

                                                                                   +
                                                                                  +
                                                                                  Member Visibility +
                                                                                    +
                                                                                    • +
                                                                                    • +
                                                                                  +
                                                                                  +
                                                                                  +

                                                                                  On This Page

                                                                                   +
                                                                                  +
                                                                                  Constructors +
                                                                                  +
                                                                                  Properties +
                                                                                  +
                                                                                  Methods +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  diff --git a/docs/classes/PasskeyRegisterError.html b/docs/classes/PasskeyRegisterError.html index da2c04b4..4a70f75e 100644 --- a/docs/classes/PasskeyRegisterError.html +++ b/docs/classes/PasskeyRegisterError.html @@ -1,21 +1,124 @@ -PasskeyRegisterError | @auth0/auth0-react
                                                                                  @auth0/auth0-react
                                                                                    Preparing search index...

                                                                                    Class PasskeyRegisterError

                                                                                    Error thrown when requesting a passkey register challenge fails.

                                                                                    -

                                                                                    Hierarchy

                                                                                    • PasskeyError
                                                                                      • PasskeyRegisterError
                                                                                    Index

                                                                                    Constructors

                                                                                    constructor -

                                                                                    Properties

                                                                                    cause? +PasskeyRegisterError | @auth0/auth0-react
                                                                                    +
                                                                                    @auth0/auth0-react + +
                                                                                      +
                                                                                      +
                                                                                      Preparing search index...
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      + +

                                                                                      Class PasskeyRegisterError

                                                                                      +
                                                                                      +

                                                                                      Error thrown when requesting a passkey register challenge fails.

                                                                                      +
                                                                                      +
                                                                                      +

                                                                                      Hierarchy

                                                                                      +
                                                                                        +
                                                                                      • PasskeyError +
                                                                                          +
                                                                                        • PasskeyRegisterError
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      Index
                                                                                       +
                                                                                      +
                                                                                      + +
                                                                                      constructor +
                                                                                      +
                                                                                      + +
                                                                                      cause? code message name stack? stackTraceLimit -

                                                                                      Methods

                                                                                      captureStackTrace +
                                                                                      +
                                                                                      + +
                                                                                      captureStackTrace prepareStackTrace -

                                                                                      Constructors

                                                                                      • Parameters

                                                                                        • message: string
                                                                                        • Optionalcause: PasskeyApiErrorResponse

                                                                                        Returns PasskeyRegisterError

                                                                                      Properties

                                                                                      cause?: PasskeyApiErrorResponse
                                                                                      code: string
                                                                                      message: string
                                                                                      name: string
                                                                                      stack?: string
                                                                                      stackTraceLimit: number

                                                                                      The Error.stackTraceLimit property specifies the number of stack frames +

                                                                                      +
                                                                                      + +
                                                                                      +
                                                                                      + +
                                                                                        +
                                                                                      • + +
                                                                                        +
                                                                                        +

                                                                                        Parameters

                                                                                        +
                                                                                          +
                                                                                        • message: string
                                                                                          • +
                                                                                        • Optionalcause: PasskeyApiErrorResponse
                                                                                        +

                                                                                        Returns PasskeyRegisterError

                                                                                      +
                                                                                      + +
                                                                                      +
                                                                                      + +
                                                                                      cause?: PasskeyApiErrorResponse
                                                                                      +
                                                                                      + +
                                                                                      code: string
                                                                                      +
                                                                                      + +
                                                                                      message: string
                                                                                      +
                                                                                      + +
                                                                                      name: string
                                                                                      +
                                                                                      + +
                                                                                      stack?: string
                                                                                      +
                                                                                      + +
                                                                                      stackTraceLimit: number
                                                                                      +

                                                                                      The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

                                                                                      The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

                                                                                      If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

                                                                                      -

                                                                                      Methods

                                                                                      • Creates a .stack property on targetObject, which when accessed returns +

                                                                                      +
                                                                                      + +
                                                                                      +
                                                                                      + +
                                                                                        +
                                                                                      • + +
                                                                                        +

                                                                                        Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

                                                                                        const myObject = {};
                                                                                        Error.captureStackTrace(myObject);
                                                                                        myObject.stack;  // Similar to `new Error().stack`
@@ -31,5 +134,58 @@
 
                                                                                        function a() {
                                                                                          b();
                                                                                        }

                                                                                        function b() {
                                                                                          c();
                                                                                        }

                                                                                        function c() {
                                                                                          // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                          const { stackTraceLimit } = Error;
                                                                                          Error.stackTraceLimit = 0;
                                                                                          const error = new Error();
                                                                                          Error.stackTraceLimit = stackTraceLimit;

                                                                                          // Capture the stack trace above function b
                                                                                          Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                          throw error;
                                                                                        }

                                                                                        a();
 
                                                                                        
 
-

                                                                                        Parameters

                                                                                        • targetObject: object
                                                                                        • OptionalconstructorOpt: Function

                                                                                        Returns void

                                                                                      Settings

                                                                                      Member Visibility

                                                                                      On This Page

                                                                                      Constructors
                                                                                      Properties
                                                                                      Methods
                                                                                      + +
                                                                                      +

                                                                                      Parameters

                                                                                      +
                                                                                        +
                                                                                      • targetObject: object
                                                                                        • +
                                                                                      • OptionalconstructorOpt: Function
                                                                                      +

                                                                                      Returns void

                                                                                      +
                                                                                      + +
                                                                                        +
                                                                                      • + +
                                                                                        +
                                                                                        +

                                                                                        Parameters

                                                                                        +
                                                                                          +
                                                                                        • err: Error
                                                                                          • +
                                                                                        • stackTraces: CallSite[]
                                                                                        +

                                                                                        Returns any

                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        https://v8.dev/docs/stack-trace-api#customizing-stack-traces

                                                                                        +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +

                                                                                      Settings

                                                                                       +
                                                                                      +
                                                                                      Member Visibility +
                                                                                        +
                                                                                        • +
                                                                                        • +
                                                                                      +
                                                                                      +
                                                                                      +

                                                                                      On This Page

                                                                                       +
                                                                                      +
                                                                                      Constructors +
                                                                                      +
                                                                                      Properties +
                                                                                      +
                                                                                      Methods +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      diff --git a/docs/classes/PopupCancelledError.html b/docs/classes/PopupCancelledError.html index 890293a0..fd53c88f 100644 --- a/docs/classes/PopupCancelledError.html +++ b/docs/classes/PopupCancelledError.html @@ -1,23 +1,130 @@ -PopupCancelledError | @auth0/auth0-react
                                                                                      @auth0/auth0-react
                                                                                        Preparing search index...

                                                                                        Class PopupCancelledError

                                                                                        Thrown when network requests to the Auth server fail.

                                                                                        -

                                                                                        Hierarchy (View Summary)

                                                                                        Index

                                                                                        Constructors

                                                                                        constructor -

                                                                                        Properties

                                                                                        error +PopupCancelledError | @auth0/auth0-react
                                                                                        +
                                                                                        @auth0/auth0-react + +
                                                                                          +
                                                                                          +
                                                                                          Preparing search index...
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          + +

                                                                                          Class PopupCancelledError

                                                                                          +
                                                                                          +

                                                                                          Thrown when network requests to the Auth server fail.

                                                                                          +
                                                                                          +
                                                                                          +

                                                                                          Hierarchy (View Summary)

                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          Index
                                                                                           +
                                                                                          +
                                                                                          + +
                                                                                          constructor +
                                                                                          +
                                                                                          + +
                                                                                          error error_description message name popup stack? stackTraceLimit -

                                                                                          Methods

                                                                                          captureStackTrace +
                                                                                          +
                                                                                          + +
                                                                                          captureStackTrace fromPayload prepareStackTrace -

                                                                                          Constructors

                                                                                          Properties

                                                                                          error: string
                                                                                          error_description: string
                                                                                          message: string
                                                                                          name: string
                                                                                          popup: Window
                                                                                          stack?: string
                                                                                          stackTraceLimit: number

                                                                                          The Error.stackTraceLimit property specifies the number of stack frames +

                                                                                          +
                                                                                          + +
                                                                                          +
                                                                                          + +
                                                                                          +
                                                                                          + +
                                                                                          +
                                                                                          + +
                                                                                          error: string
                                                                                          +
                                                                                          + +
                                                                                          error_description: string
                                                                                          +
                                                                                          + +
                                                                                          message: string
                                                                                          +
                                                                                          + +
                                                                                          name: string
                                                                                          +
                                                                                          + +
                                                                                          popup: Window
                                                                                          +
                                                                                          + +
                                                                                          stack?: string
                                                                                          +
                                                                                          + +
                                                                                          stackTraceLimit: number
                                                                                          +

                                                                                          The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

                                                                                          The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

                                                                                          If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

                                                                                          -

                                                                                          Methods

                                                                                          • Creates a .stack property on targetObject, which when accessed returns +

                                                                                          +
                                                                                          + +
                                                                                          +
                                                                                          + +
                                                                                            +
                                                                                          • + +
                                                                                            +

                                                                                            Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

                                                                                            const myObject = {};
                                                                                            Error.captureStackTrace(myObject);
                                                                                            myObject.stack;  // Similar to `new Error().stack`
@@ -33,5 +140,72 @@
 
                                                                                            function a() {
                                                                                              b();
                                                                                            }

                                                                                            function b() {
                                                                                              c();
                                                                                            }

                                                                                            function c() {
                                                                                              // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                              const { stackTraceLimit } = Error;
                                                                                              Error.stackTraceLimit = 0;
                                                                                              const error = new Error();
                                                                                              Error.stackTraceLimit = stackTraceLimit;

                                                                                              // Capture the stack trace above function b
                                                                                              Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                              throw error;
                                                                                            }

                                                                                            a();
 
                                                                                            
 
-

                                                                                            Parameters

                                                                                            • targetObject: object
                                                                                            • OptionalconstructorOpt: Function

                                                                                            Returns void

                                                                                          • Parameters

                                                                                            • __namedParameters: { error: string; error_description: string }

                                                                                            Returns GenericError

                                                                                          Settings

                                                                                          Member Visibility

                                                                                          On This Page

                                                                                          Constructors
                                                                                          Properties
                                                                                          Methods
                                                                                          + +
                                                                                          +

                                                                                          Parameters

                                                                                          +
                                                                                            +
                                                                                          • targetObject: object
                                                                                            • +
                                                                                          • OptionalconstructorOpt: Function
                                                                                          +

                                                                                          Returns void

                                                                                          +
                                                                                          + +
                                                                                            +
                                                                                          • + +
                                                                                            +
                                                                                            +

                                                                                            Parameters

                                                                                            +
                                                                                              +
                                                                                            • __namedParameters: { error: string; error_description: string }
                                                                                            +

                                                                                            Returns GenericError

                                                                                          +
                                                                                          + +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +

                                                                                          Settings

                                                                                           +
                                                                                          +
                                                                                          Member Visibility +
                                                                                            +
                                                                                            • +
                                                                                            • +
                                                                                          +
                                                                                          +
                                                                                          +

                                                                                          On This Page

                                                                                           +
                                                                                          +
                                                                                          Constructors +
                                                                                          +
                                                                                          Properties +
                                                                                          +
                                                                                          Methods +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          diff --git a/docs/classes/PopupOpenError.html b/docs/classes/PopupOpenError.html index b893aa5a..6fbe38d5 100644 --- a/docs/classes/PopupOpenError.html +++ b/docs/classes/PopupOpenError.html @@ -1,22 +1,120 @@ -PopupOpenError | @auth0/auth0-react
                                                                                          @auth0/auth0-react
                                                                                            Preparing search index...

                                                                                            Class PopupOpenError

                                                                                            Thrown when network requests to the Auth server fail.

                                                                                            -

                                                                                            Hierarchy (View Summary)

                                                                                            Index

                                                                                            Constructors

                                                                                            constructor -

                                                                                            Properties

                                                                                            error +PopupOpenError | @auth0/auth0-react
                                                                                            +
                                                                                            @auth0/auth0-react + +
                                                                                              +
                                                                                              +
                                                                                              Preparing search index...
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              + +

                                                                                              Class PopupOpenError

                                                                                              +
                                                                                              +

                                                                                              Thrown when network requests to the Auth server fail.

                                                                                              +
                                                                                              +
                                                                                              +

                                                                                              Hierarchy (View Summary)

                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              Index
                                                                                               +
                                                                                              +
                                                                                              + +
                                                                                              constructor +
                                                                                              +
                                                                                              + +
                                                                                              error error_description message name stack? stackTraceLimit -

                                                                                              Methods

                                                                                              captureStackTrace +
                                                                                              +
                                                                                              + +
                                                                                              captureStackTrace fromPayload prepareStackTrace -

                                                                                              Constructors

                                                                                              Properties

                                                                                              error: string
                                                                                              error_description: string
                                                                                              message: string
                                                                                              name: string
                                                                                              stack?: string
                                                                                              stackTraceLimit: number

                                                                                              The Error.stackTraceLimit property specifies the number of stack frames +

                                                                                              +
                                                                                              + +
                                                                                              +
                                                                                              + +
                                                                                              +
                                                                                              + +
                                                                                              +
                                                                                              + +
                                                                                              error: string
                                                                                              +
                                                                                              + +
                                                                                              error_description: string
                                                                                              +
                                                                                              + +
                                                                                              message: string
                                                                                              +
                                                                                              + +
                                                                                              name: string
                                                                                              +
                                                                                              + +
                                                                                              stack?: string
                                                                                              +
                                                                                              + +
                                                                                              stackTraceLimit: number
                                                                                              +

                                                                                              The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

                                                                                              The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

                                                                                              If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

                                                                                              -

                                                                                              Methods

                                                                                              • Creates a .stack property on targetObject, which when accessed returns +

                                                                                              +
                                                                                              + +
                                                                                              +
                                                                                              + +
                                                                                                +
                                                                                              • + +
                                                                                                +

                                                                                                Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

                                                                                                const myObject = {};
                                                                                                Error.captureStackTrace(myObject);
                                                                                                myObject.stack;  // Similar to `new Error().stack`
@@ -32,5 +130,72 @@
 
                                                                                                function a() {
                                                                                                  b();
                                                                                                }

                                                                                                function b() {
                                                                                                  c();
                                                                                                }

                                                                                                function c() {
                                                                                                  // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                                  const { stackTraceLimit } = Error;
                                                                                                  Error.stackTraceLimit = 0;
                                                                                                  const error = new Error();
                                                                                                  Error.stackTraceLimit = stackTraceLimit;

                                                                                                  // Capture the stack trace above function b
                                                                                                  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                                  throw error;
                                                                                                }

                                                                                                a();
 
                                                                                                
 
-

                                                                                                Parameters

                                                                                                • targetObject: object
                                                                                                • OptionalconstructorOpt: Function

                                                                                                Returns void

                                                                                              • Parameters

                                                                                                • __namedParameters: { error: string; error_description: string }

                                                                                                Returns GenericError

                                                                                              Settings

                                                                                              Member Visibility

                                                                                              On This Page

                                                                                              Constructors
                                                                                              Properties
                                                                                              Methods
                                                                                              + +
                                                                                              +

                                                                                              Parameters

                                                                                              +
                                                                                                +
                                                                                              • targetObject: object
                                                                                                • +
                                                                                              • OptionalconstructorOpt: Function
                                                                                              +

                                                                                              Returns void

                                                                                              +
                                                                                              + +
                                                                                                +
                                                                                              • + +
                                                                                                +
                                                                                                +

                                                                                                Parameters

                                                                                                +
                                                                                                  +
                                                                                                • __namedParameters: { error: string; error_description: string }
                                                                                                +

                                                                                                Returns GenericError

                                                                                              +
                                                                                              + +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +

                                                                                              Settings

                                                                                               +
                                                                                              +
                                                                                              Member Visibility +
                                                                                                +
                                                                                                • +
                                                                                                • +
                                                                                              +
                                                                                              +
                                                                                              +

                                                                                              On This Page

                                                                                               +
                                                                                              +
                                                                                              Constructors +
                                                                                              +
                                                                                              Properties +
                                                                                              +
                                                                                              Methods +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              diff --git a/docs/classes/PopupTimeoutError.html b/docs/classes/PopupTimeoutError.html index c50f90d2..5dfcf89a 100644 --- a/docs/classes/PopupTimeoutError.html +++ b/docs/classes/PopupTimeoutError.html @@ -1,23 +1,130 @@ -PopupTimeoutError | @auth0/auth0-react
                                                                                              @auth0/auth0-react
                                                                                                Preparing search index...

                                                                                                Class PopupTimeoutError

                                                                                                Error thrown when the login popup times out (if the user does not complete auth)

                                                                                                -

                                                                                                Hierarchy (View Summary)

                                                                                                Index

                                                                                                Constructors

                                                                                                constructor -

                                                                                                Properties

                                                                                                error +PopupTimeoutError | @auth0/auth0-react
                                                                                                +
                                                                                                @auth0/auth0-react + +
                                                                                                  +
                                                                                                  +
                                                                                                  Preparing search index...
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  + +

                                                                                                  Class PopupTimeoutError

                                                                                                  +
                                                                                                  +

                                                                                                  Error thrown when the login popup times out (if the user does not complete auth)

                                                                                                  +
                                                                                                  +
                                                                                                  +

                                                                                                  Hierarchy (View Summary)

                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  Index
                                                                                                   +
                                                                                                  +
                                                                                                  + +
                                                                                                  constructor +
                                                                                                  +
                                                                                                  + +
                                                                                                  error error_description message name popup stack? stackTraceLimit -

                                                                                                  Methods

                                                                                                  captureStackTrace +
                                                                                                  +
                                                                                                  + +
                                                                                                  captureStackTrace fromPayload prepareStackTrace -

                                                                                                  Constructors

                                                                                                  Properties

                                                                                                  error: string
                                                                                                  error_description: string
                                                                                                  message: string
                                                                                                  name: string
                                                                                                  popup: Window
                                                                                                  stack?: string
                                                                                                  stackTraceLimit: number

                                                                                                  The Error.stackTraceLimit property specifies the number of stack frames +

                                                                                                  +
                                                                                                  + +
                                                                                                  +
                                                                                                  + +
                                                                                                  +
                                                                                                  + +
                                                                                                  +
                                                                                                  + +
                                                                                                  error: string
                                                                                                  +
                                                                                                  + +
                                                                                                  error_description: string
                                                                                                  +
                                                                                                  + +
                                                                                                  message: string
                                                                                                  +
                                                                                                  + +
                                                                                                  name: string
                                                                                                  +
                                                                                                  + +
                                                                                                  popup: Window
                                                                                                  +
                                                                                                  + +
                                                                                                  stack?: string
                                                                                                  +
                                                                                                  + +
                                                                                                  stackTraceLimit: number
                                                                                                  +

                                                                                                  The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

                                                                                                  The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

                                                                                                  If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

                                                                                                  -

                                                                                                  Methods

                                                                                                  • Creates a .stack property on targetObject, which when accessed returns +

                                                                                                  +
                                                                                                  + +
                                                                                                  +
                                                                                                  + +
                                                                                                    +
                                                                                                  • + +
                                                                                                    +

                                                                                                    Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

                                                                                                    const myObject = {};
                                                                                                    Error.captureStackTrace(myObject);
                                                                                                    myObject.stack;  // Similar to `new Error().stack`
@@ -33,5 +140,72 @@
 
                                                                                                    function a() {
                                                                                                      b();
                                                                                                    }

                                                                                                    function b() {
                                                                                                      c();
                                                                                                    }

                                                                                                    function c() {
                                                                                                      // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                                      const { stackTraceLimit } = Error;
                                                                                                      Error.stackTraceLimit = 0;
                                                                                                      const error = new Error();
                                                                                                      Error.stackTraceLimit = stackTraceLimit;

                                                                                                      // Capture the stack trace above function b
                                                                                                      Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                                      throw error;
                                                                                                    }

                                                                                                    a();
 
                                                                                                    
 
-

                                                                                                    Parameters

                                                                                                    • targetObject: object
                                                                                                    • OptionalconstructorOpt: Function

                                                                                                    Returns void

                                                                                                  • Parameters

                                                                                                    • __namedParameters: { error: string; error_description: string }

                                                                                                    Returns GenericError

                                                                                                  Settings

                                                                                                  Member Visibility

                                                                                                  On This Page

                                                                                                  Constructors
                                                                                                  Properties
                                                                                                  Methods
                                                                                                  + +
                                                                                                  +

                                                                                                  Parameters

                                                                                                  +
                                                                                                    +
                                                                                                  • targetObject: object
                                                                                                    • +
                                                                                                  • OptionalconstructorOpt: Function
                                                                                                  +

                                                                                                  Returns void

                                                                                                  +
                                                                                                  + +
                                                                                                    +
                                                                                                  • + +
                                                                                                    +
                                                                                                    +

                                                                                                    Parameters

                                                                                                    +
                                                                                                      +
                                                                                                    • __namedParameters: { error: string; error_description: string }
                                                                                                    +

                                                                                                    Returns GenericError

                                                                                                  +
                                                                                                  + +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  +

                                                                                                  Settings

                                                                                                   +
                                                                                                  +
                                                                                                  Member Visibility +
                                                                                                    +
                                                                                                    • +
                                                                                                    • +
                                                                                                  +
                                                                                                  +
                                                                                                  +

                                                                                                  On This Page

                                                                                                   +
                                                                                                  +
                                                                                                  Constructors +
                                                                                                  +
                                                                                                  Properties +
                                                                                                  +
                                                                                                  Methods +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  diff --git a/docs/classes/TimeoutError.html b/docs/classes/TimeoutError.html index 1b43d619..a0bfeb11 100644 --- a/docs/classes/TimeoutError.html +++ b/docs/classes/TimeoutError.html @@ -1,23 +1,123 @@ -TimeoutError | @auth0/auth0-react
                                                                                                  @auth0/auth0-react
                                                                                                    Preparing search index...

                                                                                                    Class TimeoutError

                                                                                                    Thrown when silent auth times out (usually due to a configuration issue) or +TimeoutError | @auth0/auth0-react

                                                                                                    +
                                                                                                    @auth0/auth0-react + +
                                                                                                      +
                                                                                                      +
                                                                                                      Preparing search index...
                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      + +

                                                                                                      Class TimeoutError

                                                                                                      +
                                                                                                      +

                                                                                                      Thrown when silent auth times out (usually due to a configuration issue) or when network requests to the Auth server timeout.

                                                                                                      -

                                                                                                      Hierarchy (View Summary)

                                                                                                      Index

                                                                                                      Constructors

                                                                                                      constructor -

                                                                                                      Properties

                                                                                                      error +
                                                                                                      +
                                                                                                      +

                                                                                                      Hierarchy (View Summary)

                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      Index
                                                                                                       +
                                                                                                      +
                                                                                                      + +
                                                                                                      constructor +
                                                                                                      +
                                                                                                      + +
                                                                                                      error error_description message name stack? stackTraceLimit -

                                                                                                      Methods

                                                                                                      captureStackTrace +
                                                                                                      +
                                                                                                      + +
                                                                                                      captureStackTrace fromPayload prepareStackTrace -

                                                                                                      Constructors

                                                                                                      Properties

                                                                                                      error: string
                                                                                                      error_description: string
                                                                                                      message: string
                                                                                                      name: string
                                                                                                      stack?: string
                                                                                                      stackTraceLimit: number

                                                                                                      The Error.stackTraceLimit property specifies the number of stack frames +

                                                                                                      +
                                                                                                      + +
                                                                                                      +
                                                                                                      + +
                                                                                                      +
                                                                                                      + +
                                                                                                      +
                                                                                                      + +
                                                                                                      error: string
                                                                                                      +
                                                                                                      + +
                                                                                                      error_description: string
                                                                                                      +
                                                                                                      + +
                                                                                                      message: string
                                                                                                      +
                                                                                                      + +
                                                                                                      name: string
                                                                                                      +
                                                                                                      + +
                                                                                                      stack?: string
                                                                                                      +
                                                                                                      + +
                                                                                                      stackTraceLimit: number
                                                                                                      +

                                                                                                      The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

                                                                                                      The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

                                                                                                      If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

                                                                                                      -

                                                                                                      Methods

                                                                                                      • Creates a .stack property on targetObject, which when accessed returns +

                                                                                                      +
                                                                                                      + +
                                                                                                      +
                                                                                                      + +
                                                                                                        +
                                                                                                      • + +
                                                                                                        +

                                                                                                        Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

                                                                                                        const myObject = {};
                                                                                                        Error.captureStackTrace(myObject);
                                                                                                        myObject.stack;  // Similar to `new Error().stack`
@@ -33,5 +133,72 @@
 
                                                                                                        function a() {
                                                                                                          b();
                                                                                                        }

                                                                                                        function b() {
                                                                                                          c();
                                                                                                        }

                                                                                                        function c() {
                                                                                                          // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                                          const { stackTraceLimit } = Error;
                                                                                                          Error.stackTraceLimit = 0;
                                                                                                          const error = new Error();
                                                                                                          Error.stackTraceLimit = stackTraceLimit;

                                                                                                          // Capture the stack trace above function b
                                                                                                          Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                                          throw error;
                                                                                                        }

                                                                                                        a();
 
                                                                                                        
 
-

                                                                                                        Parameters

                                                                                                        • targetObject: object
                                                                                                        • OptionalconstructorOpt: Function

                                                                                                        Returns void

                                                                                                      • Parameters

                                                                                                        • __namedParameters: { error: string; error_description: string }

                                                                                                        Returns GenericError

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      On This Page

                                                                                                      Constructors
                                                                                                      Properties
                                                                                                      Methods
                                                                                                      +
                                                                                                      +
                                                                                                      +

                                                                                                      Parameters

                                                                                                      +
                                                                                                        +
                                                                                                      • targetObject: object
                                                                                                        • +
                                                                                                      • OptionalconstructorOpt: Function
                                                                                                      +

                                                                                                      Returns void

                                                                                                      +
                                                                                                      + +
                                                                                                        +
                                                                                                      • + +
                                                                                                        +
                                                                                                        +

                                                                                                        Parameters

                                                                                                        +
                                                                                                          +
                                                                                                        • __namedParameters: { error: string; error_description: string }
                                                                                                        +

                                                                                                        Returns GenericError

                                                                                                      +
                                                                                                      + +
                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      +

                                                                                                      Settings

                                                                                                       +
                                                                                                      +
                                                                                                      Member Visibility +
                                                                                                        +
                                                                                                        • +
                                                                                                        • +
                                                                                                      +
                                                                                                      +
                                                                                                      +

                                                                                                      On This Page

                                                                                                       +
                                                                                                      +
                                                                                                      Constructors +
                                                                                                      +
                                                                                                      Properties +
                                                                                                      +
                                                                                                      Methods +
                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      diff --git a/docs/classes/UseDpopNonceError.html b/docs/classes/UseDpopNonceError.html index d73e4507..e16f95f2 100644 --- a/docs/classes/UseDpopNonceError.html +++ b/docs/classes/UseDpopNonceError.html @@ -1,23 +1,130 @@ -UseDpopNonceError | @auth0/auth0-react
                                                                                                      @auth0/auth0-react
                                                                                                        Preparing search index...

                                                                                                        Class UseDpopNonceError

                                                                                                        Error thrown when the wrong DPoP nonce is used and a potential subsequent retry wasn't able to fix it.

                                                                                                        -

                                                                                                        Hierarchy (View Summary)

                                                                                                        Index

                                                                                                        Constructors

                                                                                                        constructor -

                                                                                                        Properties

                                                                                                        error +UseDpopNonceError | @auth0/auth0-react
                                                                                                        +
                                                                                                        @auth0/auth0-react + +
                                                                                                          +
                                                                                                          +
                                                                                                          Preparing search index...
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          + +

                                                                                                          Class UseDpopNonceError

                                                                                                          +
                                                                                                          +

                                                                                                          Error thrown when the wrong DPoP nonce is used and a potential subsequent retry wasn't able to fix it.

                                                                                                          +
                                                                                                          +
                                                                                                          +

                                                                                                          Hierarchy (View Summary)

                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          Index
                                                                                                           +
                                                                                                          +
                                                                                                          + +
                                                                                                          constructor +
                                                                                                          +
                                                                                                          + +
                                                                                                          error error_description message name newDpopNonce stack? stackTraceLimit -

                                                                                                          Methods

                                                                                                          captureStackTrace +
                                                                                                          +
                                                                                                          + +
                                                                                                          captureStackTrace fromPayload prepareStackTrace -

                                                                                                          Constructors

                                                                                                          Properties

                                                                                                          error: string
                                                                                                          error_description: string
                                                                                                          message: string
                                                                                                          name: string
                                                                                                          newDpopNonce: string | undefined
                                                                                                          stack?: string
                                                                                                          stackTraceLimit: number

                                                                                                          The Error.stackTraceLimit property specifies the number of stack frames +

                                                                                                          +
                                                                                                          + +
                                                                                                          +
                                                                                                          + +
                                                                                                          +
                                                                                                          + +
                                                                                                          +
                                                                                                          + +
                                                                                                          error: string
                                                                                                          +
                                                                                                          + +
                                                                                                          error_description: string
                                                                                                          +
                                                                                                          + +
                                                                                                          message: string
                                                                                                          +
                                                                                                          + +
                                                                                                          name: string
                                                                                                          +
                                                                                                          + +
                                                                                                          newDpopNonce: string | undefined
                                                                                                          +
                                                                                                          + +
                                                                                                          stack?: string
                                                                                                          +
                                                                                                          + +
                                                                                                          stackTraceLimit: number
                                                                                                          +

                                                                                                          The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

                                                                                                          The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

                                                                                                          If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

                                                                                                          -

                                                                                                          Methods

                                                                                                          • Creates a .stack property on targetObject, which when accessed returns +

                                                                                                          +
                                                                                                          + +
                                                                                                          +
                                                                                                          + +
                                                                                                            +
                                                                                                          • + +
                                                                                                            +

                                                                                                            Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

                                                                                                            const myObject = {};
                                                                                                            Error.captureStackTrace(myObject);
                                                                                                            myObject.stack;  // Similar to `new Error().stack`
@@ -33,5 +140,72 @@
 
                                                                                                            function a() {
                                                                                                              b();
                                                                                                            }

                                                                                                            function b() {
                                                                                                              c();
                                                                                                            }

                                                                                                            function c() {
                                                                                                              // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                                              const { stackTraceLimit } = Error;
                                                                                                              Error.stackTraceLimit = 0;
                                                                                                              const error = new Error();
                                                                                                              Error.stackTraceLimit = stackTraceLimit;

                                                                                                              // Capture the stack trace above function b
                                                                                                              Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                                              throw error;
                                                                                                            }

                                                                                                            a();
 
                                                                                                            
 
-

                                                                                                            Parameters

                                                                                                            • targetObject: object
                                                                                                            • OptionalconstructorOpt: Function

                                                                                                            Returns void

                                                                                                          • Parameters

                                                                                                            • __namedParameters: { error: string; error_description: string }

                                                                                                            Returns GenericError

                                                                                                          Settings

                                                                                                          Member Visibility

                                                                                                          On This Page

                                                                                                          Constructors
                                                                                                          Properties
                                                                                                          Methods
                                                                                                          + +
                                                                                                          +

                                                                                                          Parameters

                                                                                                          +
                                                                                                            +
                                                                                                          • targetObject: object
                                                                                                            • +
                                                                                                          • OptionalconstructorOpt: Function
                                                                                                          +

                                                                                                          Returns void

                                                                                                          +
                                                                                                          + +
                                                                                                            +
                                                                                                          • + +
                                                                                                            +
                                                                                                            +

                                                                                                            Parameters

                                                                                                            +
                                                                                                              +
                                                                                                            • __namedParameters: { error: string; error_description: string }
                                                                                                            +

                                                                                                            Returns GenericError

                                                                                                          +
                                                                                                          + +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          +

                                                                                                          Settings

                                                                                                           +
                                                                                                          +
                                                                                                          Member Visibility +
                                                                                                            +
                                                                                                            • +
                                                                                                            • +
                                                                                                          +
                                                                                                          +
                                                                                                          +

                                                                                                          On This Page

                                                                                                           +
                                                                                                          +
                                                                                                          Constructors +
                                                                                                          +
                                                                                                          Properties +
                                                                                                          +
                                                                                                          Methods +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          diff --git a/docs/classes/User.html b/docs/classes/User.html index 848ab1f2..42ee1ecb 100644 --- a/docs/classes/User.html +++ b/docs/classes/User.html @@ -1,5 +1,34 @@ -User | @auth0/auth0-react
                                                                                                          @auth0/auth0-react
                                                                                                            Preparing search index...

                                                                                                            Class User

                                                                                                            Indexable

                                                                                                            • [key: string]: any
                                                                                                            Index

                                                                                                            Constructors

                                                                                                            constructor -

                                                                                                            Properties

                                                                                                            act? +User | @auth0/auth0-react
                                                                                                            +
                                                                                                            @auth0/auth0-react + +
                                                                                                              +
                                                                                                              +
                                                                                                              Preparing search index...
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              + +

                                                                                                              Class User

                                                                                                              +
                                                                                                              +

                                                                                                              Indexable

                                                                                                              +
                                                                                                                +
                                                                                                              • +
                                                                                                                [key: string]: any
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              Index
                                                                                                               +
                                                                                                              +
                                                                                                              + +
                                                                                                              constructor +
                                                                                                              +
                                                                                                              + +
                                                                                                              act? address? birthdate? email? @@ -20,4 +49,146 @@ updated_at? website? zoneinfo? -

                                                                                                              Constructors

                                                                                                              Properties

                                                                                                              act?: ActClaim
                                                                                                              address?: string
                                                                                                              birthdate?: string
                                                                                                              email?: string
                                                                                                              email_verified?: boolean
                                                                                                              family_name?: string
                                                                                                              gender?: string
                                                                                                              given_name?: string
                                                                                                              locale?: string
                                                                                                              middle_name?: string
                                                                                                              name?: string
                                                                                                              nickname?: string
                                                                                                              phone_number?: string
                                                                                                              phone_number_verified?: boolean
                                                                                                              picture?: string
                                                                                                              preferred_username?: string
                                                                                                              profile?: string
                                                                                                              sub?: string
                                                                                                              updated_at?: string
                                                                                                              website?: string
                                                                                                              zoneinfo?: string

                                                                                                              Settings

                                                                                                              Member Visibility

                                                                                                              On This Page

                                                                                                              Constructors
                                                                                                              Properties
                                                                                                              +
                                                                                                              +
                                                                                                              + +
                                                                                                              +
                                                                                                              + +
                                                                                                              +
                                                                                                              + +
                                                                                                              +
                                                                                                              + +
                                                                                                              act?: ActClaim
                                                                                                              +
                                                                                                              + +
                                                                                                              address?: string
                                                                                                              +
                                                                                                              + +
                                                                                                              birthdate?: string
                                                                                                              +
                                                                                                              + +
                                                                                                              email?: string
                                                                                                              +
                                                                                                              + +
                                                                                                              email_verified?: boolean
                                                                                                              +
                                                                                                              + +
                                                                                                              family_name?: string
                                                                                                              +
                                                                                                              + +
                                                                                                              gender?: string
                                                                                                              +
                                                                                                              + +
                                                                                                              given_name?: string
                                                                                                              +
                                                                                                              + +
                                                                                                              locale?: string
                                                                                                              +
                                                                                                              + +
                                                                                                              middle_name?: string
                                                                                                              +
                                                                                                              + +
                                                                                                              name?: string
                                                                                                              +
                                                                                                              + +
                                                                                                              nickname?: string
                                                                                                              +
                                                                                                              + +
                                                                                                              phone_number?: string
                                                                                                              +
                                                                                                              + +
                                                                                                              phone_number_verified?: boolean
                                                                                                              +
                                                                                                              + +
                                                                                                              picture?: string
                                                                                                              +
                                                                                                              + +
                                                                                                              preferred_username?: string
                                                                                                              +
                                                                                                              + +
                                                                                                              profile?: string
                                                                                                              +
                                                                                                              + +
                                                                                                              sub?: string
                                                                                                              +
                                                                                                              + +
                                                                                                              updated_at?: string
                                                                                                              +
                                                                                                              + +
                                                                                                              website?: string
                                                                                                              +
                                                                                                              + +
                                                                                                              zoneinfo?: string
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              +

                                                                                                              Settings

                                                                                                               +
                                                                                                              +
                                                                                                              Member Visibility +
                                                                                                                +
                                                                                                                • +
                                                                                                                • +
                                                                                                              +
                                                                                                              +
                                                                                                              +

                                                                                                              On This Page

                                                                                                               +
                                                                                                              +
                                                                                                              Constructors +
                                                                                                              +
                                                                                                              Properties +
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              diff --git a/docs/enums/ResponseType.html b/docs/enums/ResponseType.html index 4a9995fc..e50c24d7 100644 --- a/docs/enums/ResponseType.html +++ b/docs/enums/ResponseType.html @@ -1,8 +1,66 @@ -ResponseType | @auth0/auth0-react
                                                                                                              @auth0/auth0-react
                                                                                                                Preparing search index...

                                                                                                                Enumeration ResponseType

                                                                                                                The types of responses expected from the authorization server.

                                                                                                                +ResponseType | @auth0/auth0-react
                                                                                                                +
                                                                                                                @auth0/auth0-react + +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  Preparing search index...
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  + +

                                                                                                                  Enumeration ResponseType

                                                                                                                  +
                                                                                                                  +

                                                                                                                  The types of responses expected from the authorization server.

                                                                                                                  • code: used for the standard login flow.
                                                                                                                  • connect_code: used for the connect account flow.
                                                                                                                  -
                                                                                                                  Index

                                                                                                                  Enumeration Members

                                                                                                                  Code +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  Index
                                                                                                                   +
                                                                                                                  +
                                                                                                                  + +
                                                                                                                  Code ConnectCode -

                                                                                                                  Enumeration Members

                                                                                                                  Code: "code"
                                                                                                                  ConnectCode: "connect_code"

                                                                                                                  Settings

                                                                                                                  Member Visibility

                                                                                                                  On This Page

                                                                                                                  Enumeration Members
                                                                                                                  +
                                                                                                                  +
                                                                                                                  + +
                                                                                                                  +
                                                                                                                  + +
                                                                                                                  Code: "code"
                                                                                                                  +
                                                                                                                  + +
                                                                                                                  ConnectCode: "connect_code"
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +

                                                                                                                  Settings

                                                                                                                   +
                                                                                                                  +
                                                                                                                  Member Visibility +
                                                                                                                    +
                                                                                                                    • +
                                                                                                                    • +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +

                                                                                                                  On This Page

                                                                                                                   +
                                                                                                                  +
                                                                                                                  Enumeration Members +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  diff --git a/docs/functions/Auth0Provider.html b/docs/functions/Auth0Provider.html index 4b2ab94d..3b1f7495 100644 --- a/docs/functions/Auth0Provider.html +++ b/docs/functions/Auth0Provider.html @@ -1,5 +1,50 @@ -Auth0Provider | @auth0/auth0-react
                                                                                                                  @auth0/auth0-react
                                                                                                                    Preparing search index...

                                                                                                                    Function Auth0Provider

                                                                                                                    • <Auth0Provider
                                                                                                                        domain={domain}
                                                                                                                        clientId={clientId}
                                                                                                                        authorizationParams={{ redirect_uri: window.location.origin }}>
                                                                                                                        <MyApp />
                                                                                                                      </Auth0Provider>
+Auth0Provider | @auth0/auth0-react
                                                                                                                      
+
                                                                                                                      @auth0/auth0-react
+
+
                                                                                                                        
+
                                                                                                                        
+
                                                                                                                        Preparing search index...
                                                                                                                        
+
                                                                                                                        
+
                                                                                                                        
+
                                                                                                                        
+
+
                                                                                                                        Function Auth0Provider
                                                                                                                        
+
                                                                                                                        
+
                                                                                                                        Settings
                                                                                                                        Member Visibility
                                                                                                                        
+
                                                                                                                        +
                                                                                                                        +

                                                                                                                        Type Parameters

                                                                                                                        +
                                                                                                                        +
                                                                                                                        +

                                                                                                                        Parameters

                                                                                                                        +
                                                                                                                        +

                                                                                                                        Returns Element

                                                                                                                      +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      +

                                                                                                                      Settings

                                                                                                                       +
                                                                                                                      +
                                                                                                                      Member Visibility +
                                                                                                                        +
                                                                                                                        • +
                                                                                                                        • +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      diff --git a/docs/functions/useAuth0.html b/docs/functions/useAuth0.html index 7e14477f..ada7bea7 100644 --- a/docs/functions/useAuth0.html +++ b/docs/functions/useAuth0.html @@ -1,6 +1,51 @@ -useAuth0 | @auth0/auth0-react
                                                                                                                      @auth0/auth0-react
                                                                                                                        Preparing search index...

                                                                                                                        Function useAuth0

                                                                                                                        • const {
                                                                                                                            // Auth state:
                                                                                                                            error,
                                                                                                                            isAuthenticated,
                                                                                                                            isLoading,
                                                                                                                            user,
                                                                                                                            // Auth methods:
                                                                                                                            getAccessTokenSilently,
                                                                                                                            getAccessTokenWithPopup,
                                                                                                                            getIdTokenClaims,
                                                                                                                            loginWithCustomTokenExchange,
                                                                                                                            exchangeToken, // deprecated - use loginWithCustomTokenExchange
                                                                                                                            loginWithRedirect,
                                                                                                                            loginWithPopup,
                                                                                                                            logout,
                                                                                                                          } = useAuth0<TUser>();
+useAuth0 | @auth0/auth0-react
                                                                                                                          
+
                                                                                                                          @auth0/auth0-react
+
+
                                                                                                                            
+
                                                                                                                            
+
                                                                                                                            Preparing search index...
                                                                                                                            
+
                                                                                                                            
+
                                                                                                                            
+
                                                                                                                            
+
+
                                                                                                                            Function useAuth0
                                                                                                                            
+
                                                                                                                            
+
                                                                                                                              
+
                                                                                                                            • 
+
+
                                                                                                                              
+
                                                                                                                              const {
                                                                                                                                // Auth state:
                                                                                                                                error,
                                                                                                                                isAuthenticated,
                                                                                                                                isLoading,
                                                                                                                                user,
                                                                                                                                // Auth methods:
                                                                                                                                getAccessTokenSilently,
                                                                                                                                getAccessTokenWithPopup,
                                                                                                                                getIdTokenClaims,
                                                                                                                                loginWithCustomTokenExchange,
                                                                                                                                exchangeToken, // deprecated - use loginWithCustomTokenExchange
                                                                                                                                loginWithRedirect,
                                                                                                                                loginWithPopup,
                                                                                                                                logout,
                                                                                                                              } = useAuth0<TUser>();
 
                                                                                                                              
 
 
                                                                                                                              Use the useAuth0 hook in your components to access the auth state and methods.
                                                                                                                              
 
                                                                                                                              TUser is an optional type param to provide a type to the user field.
                                                                                                                              
-
                                                                                                                              Type Parameters
                                                                                                                              Parameters
                                                                                                                              Returns Auth0ContextInterface<TUser>
                                                                                                                            Settings
                                                                                                                            Member Visibility
                                                                                                                            
+
                                                                                                                            +
                                                                                                                            +

                                                                                                                            Type Parameters

                                                                                                                            +
                                                                                                                            +
                                                                                                                            +

                                                                                                                            Parameters

                                                                                                                            +
                                                                                                                            +

                                                                                                                            Returns Auth0ContextInterface<TUser>

                                                                                                                          +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          +

                                                                                                                          Settings

                                                                                                                           +
                                                                                                                          +
                                                                                                                          Member Visibility +
                                                                                                                            +
                                                                                                                            • +
                                                                                                                            • +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          diff --git a/docs/functions/withAuth0.html b/docs/functions/withAuth0.html index c452c239..1a7a23c7 100644 --- a/docs/functions/withAuth0.html +++ b/docs/functions/withAuth0.html @@ -1,7 +1,53 @@ -withAuth0 | @auth0/auth0-react
                                                                                                                          @auth0/auth0-react
                                                                                                                            Preparing search index...

                                                                                                                            Function withAuth0

                                                                                                                            • class MyComponent extends Component {
                                                                                                                                render() {
                                                                                                                                  // Access the auth context from the `auth0` prop
                                                                                                                                  const { user } = this.props.auth0;
                                                                                                                                  return <div>Hello {user.name}!</div>
                                                                                                                                }
                                                                                                                              }
                                                                                                                              // Wrap your class component in withAuth0
                                                                                                                              export default withAuth0(MyComponent);
+withAuth0 | @auth0/auth0-react
                                                                                                                              
+
                                                                                                                              @auth0/auth0-react
+
+
                                                                                                                                
+
                                                                                                                                
+
                                                                                                                                Preparing search index...
                                                                                                                                
+
                                                                                                                                
+
                                                                                                                                
+
                                                                                                                                
+
+
                                                                                                                                Function withAuth0
                                                                                                                                
+
                                                                                                                                
+
                                                                                                                                  
+
                                                                                                                                • 
+
+
                                                                                                                                  
+
                                                                                                                                  class MyComponent extends Component {
                                                                                                                                    render() {
                                                                                                                                      // Access the auth context from the `auth0` prop
                                                                                                                                      const { user } = this.props.auth0;
                                                                                                                                      return <div>Hello {user.name}!</div>
                                                                                                                                    }
                                                                                                                                  }
                                                                                                                                  // Wrap your class component in withAuth0
                                                                                                                                  export default withAuth0(MyComponent);
 
                                                                                                                                  
 
 
                                                                                                                                  Wrap your class components in this Higher Order Component to give them access to the Auth0Context.
                                                                                                                                  
 
                                                                                                                                  Providing a context as the second argument allows you to configure the Auth0Provider the Auth0Context
 should come from f you have multiple within your application.
                                                                                                                                  
-
                                                                                                                                  Type Parameters
                                                                                                                                  Parameters
                                                                                                                                  Returns ComponentType<Omit<P, "auth0">>
                                                                                                                                Settings
                                                                                                                                Member Visibility
                                                                                                                                
+
                                                                                                                                +
                                                                                                                                +

                                                                                                                                Type Parameters

                                                                                                                                +
                                                                                                                                +
                                                                                                                                +

                                                                                                                                Parameters

                                                                                                                                +
                                                                                                                                +

                                                                                                                                Returns ComponentType<Omit<P, "auth0">>

                                                                                                                              +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              +

                                                                                                                              Settings

                                                                                                                               +
                                                                                                                              +
                                                                                                                              Member Visibility +
                                                                                                                                +
                                                                                                                                • +
                                                                                                                                • +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              diff --git a/docs/functions/withAuthenticationRequired.html b/docs/functions/withAuthenticationRequired.html index 787ed8da..cf377c35 100644 --- a/docs/functions/withAuthenticationRequired.html +++ b/docs/functions/withAuthenticationRequired.html @@ -1,6 +1,52 @@ -withAuthenticationRequired | @auth0/auth0-react
                                                                                                                              @auth0/auth0-react
                                                                                                                                Preparing search index...

                                                                                                                                Function withAuthenticationRequired

                                                                                                                                • const MyProtectedComponent = withAuthenticationRequired(MyComponent);
+withAuthenticationRequired | @auth0/auth0-react
                                                                                                                                  
+
                                                                                                                                  @auth0/auth0-react
+
+
                                                                                                                                    
+
                                                                                                                                    
+
                                                                                                                                    Preparing search index...
                                                                                                                                    
+
                                                                                                                                    
+
                                                                                                                                    
+
                                                                                                                                    
+
+
                                                                                                                                    Function withAuthenticationRequired
                                                                                                                                    
+
                                                                                                                                    
+
                                                                                                                                      
+
                                                                                                                                    • 
+
+
                                                                                                                                      
+
                                                                                                                                      const MyProtectedComponent = withAuthenticationRequired(MyComponent);
 
                                                                                                                                      
 
 
                                                                                                                                      When you wrap your components in this Higher Order Component and an anonymous user visits your component
 they will be redirected to the login page; after login they will be returned to the page they were redirected from.
                                                                                                                                      
-
                                                                                                                                      Type Parameters
                                                                                                                                      • P extends object
                                                                                                                                      Parameters
                                                                                                                                      Returns FC<P>
                                                                                                                                    Settings
                                                                                                                                    Member Visibility
                                                                                                                                    
+
                                                                                                                                    +
                                                                                                                                    +

                                                                                                                                    Type Parameters

                                                                                                                                    +
                                                                                                                                      +
                                                                                                                                    • P extends object
                                                                                                                                    +
                                                                                                                                    +

                                                                                                                                    Parameters

                                                                                                                                    +
                                                                                                                                    +

                                                                                                                                    Returns FC<P>

                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +

                                                                                                                                  Settings

                                                                                                                                   +
                                                                                                                                  +
                                                                                                                                  Member Visibility +
                                                                                                                                    +
                                                                                                                                    • +
                                                                                                                                    • +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  diff --git a/docs/hierarchy.html b/docs/hierarchy.html index 20224537..ca44160c 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1 +1,58 @@ -@auth0/auth0-react
                                                                                                                                  @auth0/auth0-react
                                                                                                                                    Preparing search index...

                                                                                                                                    @auth0/auth0-react

                                                                                                                                    Hierarchy Summary

                                                                                                                                    Settings

                                                                                                                                    Member Visibility
                                                                                                                                    +@auth0/auth0-react
                                                                                                                                    +
                                                                                                                                    @auth0/auth0-react + +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Preparing search index...
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +

                                                                                                                                      @auth0/auth0-react

                                                                                                                                      +

                                                                                                                                      Hierarchy Summary

                                                                                                                                      + + +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +

                                                                                                                                      Settings

                                                                                                                                       +
                                                                                                                                      +
                                                                                                                                      Member Visibility +
                                                                                                                                        +
                                                                                                                                        • +
                                                                                                                                        • +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      diff --git a/docs/index.html b/docs/index.html index 742931d2..665c3ec2 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,14 @@ -@auth0/auth0-react
                                                                                                                                      @auth0/auth0-react
                                                                                                                                        Preparing search index...

                                                                                                                                        @auth0/auth0-react

                                                                                                                                        Auth0 SDK for React Single Page Applications

                                                                                                                                        +@auth0/auth0-react
                                                                                                                                        +
                                                                                                                                        @auth0/auth0-react + +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          Preparing search index...
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +

                                                                                                                                          @auth0/auth0-react

                                                                                                                                          +

                                                                                                                                          Auth0 SDK for React Single Page Applications

                                                                                                                                          npm codecov Ask DeepWiki @@ -93,4 +103,32 @@

                                                                                                                                          Settings

                                                                                                                                          Member Visibility

                                                                                                                                          On This Page

                                                                                                                                          DocumentationGetting startedAPI referenceFeedback
                                                                                                                                          +This project is licensed under the MIT license. See the LICENSE file for more info.

                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +

                                                                                                                                          Settings

                                                                                                                                           +
                                                                                                                                          +
                                                                                                                                          Member Visibility +
                                                                                                                                            +
                                                                                                                                            • +
                                                                                                                                            • +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +

                                                                                                                                          On This Page

                                                                                                                                           +
                                                                                                                                          DocumentationGetting started +API referenceFeedback +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          diff --git a/docs/interfaces/ActClaim.html b/docs/interfaces/ActClaim.html index 7a4c3226..e568beab 100644 --- a/docs/interfaces/ActClaim.html +++ b/docs/interfaces/ActClaim.html @@ -1,7 +1,70 @@ -ActClaim | @auth0/auth0-react
                                                                                                                                          @auth0/auth0-react
                                                                                                                                            Preparing search index...

                                                                                                                                            Interface ActClaim

                                                                                                                                            Represents the actor claim (act) in an ID token returned via a token exchange response.

                                                                                                                                            +ActClaim | @auth0/auth0-react
                                                                                                                                            +
                                                                                                                                            @auth0/auth0-react + +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              Preparing search index...
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              + +

                                                                                                                                              Interface ActClaim

                                                                                                                                              +
                                                                                                                                              +

                                                                                                                                              Represents the actor claim (act) in an ID token returned via a token exchange response.

                                                                                                                                              The act claim identifies the acting party — the entity that has been delegated authority to act on behalf of the subject. It is set via Auth0 Actions using the setActor command.

                                                                                                                                              -

                                                                                                                                              RFC 8693 Section 4.1

                                                                                                                                              -
                                                                                                                                              interface ActClaim {
                                                                                                                                                  sub?: string;
                                                                                                                                                  [key: string]: any;
                                                                                                                                              }

                                                                                                                                              Indexable

                                                                                                                                              • [key: string]: any
                                                                                                                                              Index

                                                                                                                                              Properties

                                                                                                                                              sub? -

                                                                                                                                              Properties

                                                                                                                                              sub?: string

                                                                                                                                              The identifier of the acting party.

                                                                                                                                              -

                                                                                                                                              Settings

                                                                                                                                              Member Visibility

                                                                                                                                              On This Page

                                                                                                                                              Properties
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +

                                                                                                                                              RFC 8693 Section 4.1

                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              interface ActClaim {
                                                                                                                                                  sub?: string;
                                                                                                                                                  [key: string]: any;
                                                                                                                                              }
                                                                                                                                              +
                                                                                                                                              +

                                                                                                                                              Indexable

                                                                                                                                              +
                                                                                                                                                +
                                                                                                                                              • +
                                                                                                                                                [key: string]: any
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              Index
                                                                                                                                               +
                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                              sub? +
                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                              sub?: string
                                                                                                                                              +

                                                                                                                                              The identifier of the acting party.

                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +

                                                                                                                                              Settings

                                                                                                                                               +
                                                                                                                                              +
                                                                                                                                              Member Visibility +
                                                                                                                                                +
                                                                                                                                                • +
                                                                                                                                                • +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +

                                                                                                                                              On This Page

                                                                                                                                               +
                                                                                                                                              +
                                                                                                                                              Properties +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              diff --git a/docs/interfaces/Auth0ContextInterface.html b/docs/interfaces/Auth0ContextInterface.html index 464fd3b2..6caaf667 100644 --- a/docs/interfaces/Auth0ContextInterface.html +++ b/docs/interfaces/Auth0ContextInterface.html @@ -1,5 +1,39 @@ -Auth0ContextInterface | @auth0/auth0-react
                                                                                                                                              @auth0/auth0-react
                                                                                                                                                Preparing search index...

                                                                                                                                                Interface Auth0ContextInterface<TUser>

                                                                                                                                                Contains the authenticated state and authentication methods provided by the useAuth0 hook.

                                                                                                                                                -
                                                                                                                                                interface Auth0ContextInterface<TUser extends User = User> {
                                                                                                                                                    connectAccountWithRedirect: (
                                                                                                                                                        options: RedirectConnectAccountOptions,
                                                                                                                                                    ) => Promise<void>;
                                                                                                                                                    createFetcher: <TOutput extends CustomFetchMinimalOutput = Response>(
                                                                                                                                                        config?: FetcherConfig<TOutput>,
                                                                                                                                                    ) => Fetcher<TOutput>;
                                                                                                                                                    customTokenExchange: (
                                                                                                                                                        options: CustomTokenExchangeOptions,
                                                                                                                                                    ) => Promise<TokenEndpointResponse>;
                                                                                                                                                    error: Error | undefined;
                                                                                                                                                    exchangeToken: (
                                                                                                                                                        options: CustomTokenExchangeOptions,
                                                                                                                                                    ) => Promise<TokenEndpointResponse>;
                                                                                                                                                    generateDpopProof: (
                                                                                                                                                        params: {
                                                                                                                                                            accessToken: string;
                                                                                                                                                            method: string;
                                                                                                                                                            nonce?: string;
                                                                                                                                                            url: string;
                                                                                                                                                        },
                                                                                                                                                    ) => Promise<string>;
                                                                                                                                                    getAccessTokenSilently: {
                                                                                                                                                        (
                                                                                                                                                            options: GetTokenSilentlyOptions & { detailedResponse: true },
                                                                                                                                                        ): Promise<GetTokenSilentlyVerboseResponse>;
                                                                                                                                                        (options?: GetTokenSilentlyOptions): Promise<string>;
                                                                                                                                                        (
                                                                                                                                                            options: GetTokenSilentlyOptions,
                                                                                                                                                        ): Promise<string | GetTokenSilentlyVerboseResponse>;
                                                                                                                                                    };
                                                                                                                                                    getAccessTokenWithPopup: (
                                                                                                                                                        options?: GetTokenWithPopupOptions,
                                                                                                                                                        config?: PopupConfigOptions,
                                                                                                                                                    ) => Promise<string | undefined>;
                                                                                                                                                    getConfiguration: () => Readonly<ClientConfiguration>;
                                                                                                                                                    getDpopNonce: (id?: string) => Promise<string | undefined>;
                                                                                                                                                    getIdTokenClaims: () => Promise<IdToken | undefined>;
                                                                                                                                                    handleRedirectCallback: (
                                                                                                                                                        url?: string,
                                                                                                                                                    ) => Promise<ConnectAccountRedirectResult | RedirectLoginResult<any>>;
                                                                                                                                                    isAuthenticated: boolean;
                                                                                                                                                    isLoading: boolean;
                                                                                                                                                    loginWithCustomTokenExchange: (
                                                                                                                                                        options: CustomTokenExchangeOptions,
                                                                                                                                                    ) => Promise<TokenEndpointResponse>;
                                                                                                                                                    loginWithPopup: (
                                                                                                                                                        options?: PopupLoginOptions,
                                                                                                                                                        config?: PopupConfigOptions,
                                                                                                                                                    ) => Promise<void>;
                                                                                                                                                    loginWithRedirect: (
                                                                                                                                                        options?: RedirectLoginOptions<AppState>,
                                                                                                                                                    ) => Promise<void>;
                                                                                                                                                    logout: (options?: LogoutOptions) => Promise<void>;
                                                                                                                                                    mfa: MfaApiClient;
                                                                                                                                                    myAccount: MyAccountApiClient;
                                                                                                                                                    passkey: PasskeyApiClient;
                                                                                                                                                    revokeRefreshToken: (options?: RevokeRefreshTokenOptions) => Promise<void>;
                                                                                                                                                    setDpopNonce: (nonce: string, id?: string) => Promise<void>;
                                                                                                                                                    user: TUser | undefined;
                                                                                                                                                }

                                                                                                                                                Type Parameters

                                                                                                                                                Hierarchy

                                                                                                                                                • AuthState<TUser>
                                                                                                                                                  • Auth0ContextInterface
                                                                                                                                                Index

                                                                                                                                                Properties

                                                                                                                                                connectAccountWithRedirect +Auth0ContextInterface | @auth0/auth0-react
                                                                                                                                                +
                                                                                                                                                @auth0/auth0-react + +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Preparing search index...
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +

                                                                                                                                                  Interface Auth0ContextInterface<TUser>

                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Contains the authenticated state and authentication methods provided by the useAuth0 hook.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  interface Auth0ContextInterface<TUser extends User = User> {
                                                                                                                                                      connectAccountWithRedirect: (
                                                                                                                                                          options: RedirectConnectAccountOptions,
                                                                                                                                                      ) => Promise<void>;
                                                                                                                                                      createFetcher: <TOutput extends CustomFetchMinimalOutput = Response>(
                                                                                                                                                          config?: FetcherConfig<TOutput>,
                                                                                                                                                      ) => Fetcher<TOutput>;
                                                                                                                                                      customTokenExchange: (
                                                                                                                                                          options: CustomTokenExchangeOptions,
                                                                                                                                                      ) => Promise<TokenEndpointResponse>;
                                                                                                                                                      error: Error | undefined;
                                                                                                                                                      exchangeToken: (
                                                                                                                                                          options: CustomTokenExchangeOptions,
                                                                                                                                                      ) => Promise<TokenEndpointResponse>;
                                                                                                                                                      generateDpopProof: (
                                                                                                                                                          params: {
                                                                                                                                                              accessToken: string;
                                                                                                                                                              method: string;
                                                                                                                                                              nonce?: string;
                                                                                                                                                              url: string;
                                                                                                                                                          },
                                                                                                                                                      ) => Promise<string>;
                                                                                                                                                      getAccessTokenSilently: {
                                                                                                                                                          (
                                                                                                                                                              options: GetTokenSilentlyOptions & { detailedResponse: true },
                                                                                                                                                          ): Promise<GetTokenSilentlyVerboseResponse>;
                                                                                                                                                          (options?: GetTokenSilentlyOptions): Promise<string>;
                                                                                                                                                          (
                                                                                                                                                              options: GetTokenSilentlyOptions,
                                                                                                                                                          ): Promise<string | GetTokenSilentlyVerboseResponse>;
                                                                                                                                                      };
                                                                                                                                                      getAccessTokenWithPopup: (
                                                                                                                                                          options?: GetTokenWithPopupOptions,
                                                                                                                                                          config?: PopupConfigOptions,
                                                                                                                                                      ) => Promise<string | undefined>;
                                                                                                                                                      getConfiguration: () => Readonly<ClientConfiguration>;
                                                                                                                                                      getDpopNonce: (id?: string) => Promise<string | undefined>;
                                                                                                                                                      getIdTokenClaims: () => Promise<IdToken | undefined>;
                                                                                                                                                      handleRedirectCallback: (
                                                                                                                                                          url?: string,
                                                                                                                                                      ) => Promise<ConnectAccountRedirectResult | RedirectLoginResult<any>>;
                                                                                                                                                      isAuthenticated: boolean;
                                                                                                                                                      isLoading: boolean;
                                                                                                                                                      loginWithCustomTokenExchange: (
                                                                                                                                                          options: CustomTokenExchangeOptions,
                                                                                                                                                      ) => Promise<TokenEndpointResponse>;
                                                                                                                                                      loginWithPopup: (
                                                                                                                                                          options?: PopupLoginOptions,
                                                                                                                                                          config?: PopupConfigOptions,
                                                                                                                                                      ) => Promise<void>;
                                                                                                                                                      loginWithRedirect: (
                                                                                                                                                          options?: RedirectLoginOptions<AppState>,
                                                                                                                                                      ) => Promise<void>;
                                                                                                                                                      logout: (options?: LogoutOptions) => Promise<void>;
                                                                                                                                                      mfa: MfaApiClient;
                                                                                                                                                      myAccount: MyAccountApiClient;
                                                                                                                                                      passkey: PasskeyApiClient;
                                                                                                                                                      revokeRefreshToken: (options?: RevokeRefreshTokenOptions) => Promise<void>;
                                                                                                                                                      setDpopNonce: (nonce: string, id?: string) => Promise<void>;
                                                                                                                                                      user: TUser | undefined;
                                                                                                                                                  }
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Type Parameters

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Hierarchy

                                                                                                                                                  +
                                                                                                                                                    +
                                                                                                                                                  • AuthState<TUser> +
                                                                                                                                                      +
                                                                                                                                                    • Auth0ContextInterface
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Index
                                                                                                                                                   +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  connectAccountWithRedirect createFetcher customTokenExchange error @@ -23,7 +57,14 @@ revokeRefreshToken setDpopNonce user -

                                                                                                                                                  Properties

                                                                                                                                                  connectAccountWithRedirect: (
                                                                                                                                                      options: RedirectConnectAccountOptions,
                                                                                                                                                  ) => Promise<void>
                                                                                                                                                  await connectAccountWithRedirect({
                                                                                                                                                    connection: 'google-oauth2',
                                                                                                                                                    scopes: ['openid', 'profile', 'email', 'https://www.googleapis.com/auth/drive.readonly'],
                                                                                                                                                    authorization_params: {
                                                                                                                                                      // additional authorization params to forward to the authorization server
                                                                                                                                                    }
                                                                                                                                                  });
+
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  connectAccountWithRedirect: (
                                                                                                                                                      options: RedirectConnectAccountOptions,
                                                                                                                                                  ) => Promise<void>
                                                                                                                                                  +
                                                                                                                                                  await connectAccountWithRedirect({
                                                                                                                                                    connection: 'google-oauth2',
                                                                                                                                                    scopes: ['openid', 'profile', 'email', 'https://www.googleapis.com/auth/drive.readonly'],
                                                                                                                                                    authorization_params: {
                                                                                                                                                      // additional authorization params to forward to the authorization server
                                                                                                                                                    }
                                                                                                                                                  });

                                                                                                                                                  Redirects to the /connect URL using the parameters @@ -31,17 +72,46 @@ where the user can authenticate and authorize the account to be connected.

                                                                                                                                                  If connecting the account is successful onRedirectCallback will be called with the details of the connected account.

                                                                                                                                                  -
                                                                                                                                                  createFetcher: <TOutput extends CustomFetchMinimalOutput = Response>(
                                                                                                                                                      config?: FetcherConfig<TOutput>,
                                                                                                                                                  ) => Fetcher<TOutput>

                                                                                                                                                  Returns a new Fetcher class that will contain a fetchWithAuth() method. +

                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  createFetcher: <TOutput extends CustomFetchMinimalOutput = Response>(
                                                                                                                                                      config?: FetcherConfig<TOutput>,
                                                                                                                                                  ) => Fetcher<TOutput>
                                                                                                                                                  +

                                                                                                                                                  Returns a new Fetcher class that will contain a fetchWithAuth() method. This is a drop-in replacement for the Fetch API's fetch() method, but will handle certain authentication logic for you, like building the proper auth headers or managing DPoP nonces and retries automatically.

                                                                                                                                                  Check the EXAMPLES.md file for a deeper look into this method.

                                                                                                                                                  -

                                                                                                                                                  Type Declaration

                                                                                                                                                    • <TOutput extends CustomFetchMinimalOutput = Response>(
                                                                                                                                                          config?: FetcherConfig<TOutput>,
                                                                                                                                                      ): Fetcher<TOutput>

                                                                                                                                                    • Returns a new Fetcher class that will contain a fetchWithAuth() method. +

                                                                                                                                                      +
                                                                                                                                                      +

                                                                                                                                                      Type Declaration

                                                                                                                                                      +
                                                                                                                                                        +
                                                                                                                                                      • +
                                                                                                                                                          +
                                                                                                                                                        • <TOutput extends CustomFetchMinimalOutput = Response>(
                                                                                                                                                              config?: FetcherConfig<TOutput>,
                                                                                                                                                          ): Fetcher<TOutput>
                                                                                                                                                          • +
                                                                                                                                                        • +

                                                                                                                                                          Returns a new Fetcher class that will contain a fetchWithAuth() method. This is a drop-in replacement for the Fetch API's fetch() method, but will handle certain authentication logic for you, like building the proper auth headers or managing DPoP nonces and retries automatically.

                                                                                                                                                          Check the EXAMPLES.md file for a deeper look into this method.

                                                                                                                                                          -

                                                                                                                                                          Type Parameters

                                                                                                                                                          • TOutput extends CustomFetchMinimalOutput = Response

                                                                                                                                                          Parameters

                                                                                                                                                          Returns Fetcher<TOutput>

                                                                                                                                                  customTokenExchange: (
                                                                                                                                                      options: CustomTokenExchangeOptions,
                                                                                                                                                  ) => Promise<TokenEndpointResponse>
                                                                                                                                                  const tokenResponse = await customTokenExchange({
                                                                                                                                                    subject_token: 'ey...',
                                                                                                                                                    subject_token_type: 'urn:acme:legacy-system-token',
                                                                                                                                                    actor_token: 'ey...',
                                                                                                                                                    actor_token_type: 'https://idp.example.com/token-type/agent',
                                                                                                                                                  });
+
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Type Parameters

                                                                                                                                                  +
                                                                                                                                                    +
                                                                                                                                                  • TOutput extends CustomFetchMinimalOutput = Response
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Parameters

                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Returns Fetcher<TOutput>

                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  customTokenExchange: (
                                                                                                                                                      options: CustomTokenExchangeOptions,
                                                                                                                                                  ) => Promise<TokenEndpointResponse>
                                                                                                                                                  +
                                                                                                                                                  const tokenResponse = await customTokenExchange({
                                                                                                                                                    subject_token: 'ey...',
                                                                                                                                                    subject_token_type: 'urn:acme:legacy-system-token',
                                                                                                                                                    actor_token: 'ey...',
                                                                                                                                                    actor_token_type: 'https://idp.example.com/token-type/agent',
                                                                                                                                                  });

                                                                                                                                                  Exchanges an external subject token for Auth0 tokens without affecting the current session.

                                                                                                                                                  @@ -51,11 +121,51 @@ API token without changing who the current user is.

                                                                                                                                                  When actor_token is present Auth0 suppresses refresh token issuance; a missing refresh_token in the response is expected and will not cause an error.

                                                                                                                                                  -

                                                                                                                                                  Type Declaration

                                                                                                                                                  error: Error | undefined
                                                                                                                                                  exchangeToken: (
                                                                                                                                                      options: CustomTokenExchangeOptions,
                                                                                                                                                  ) => Promise<TokenEndpointResponse>

                                                                                                                                                  Type Declaration

                                                                                                                                                  Use loginWithCustomTokenExchange() instead. This method will be removed in the next major version.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Type Declaration

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  error: Error | undefined
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  exchangeToken: (
                                                                                                                                                      options: CustomTokenExchangeOptions,
                                                                                                                                                  ) => Promise<TokenEndpointResponse>
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Type Declaration

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Use loginWithCustomTokenExchange() instead. This method will be removed in the next major version.

                                                                                                                                                  const tokenResponse = await exchangeToken({
                                                                                                                                                    subject_token: 'external_token_value',
                                                                                                                                                    subject_token_type: 'urn:acme:legacy-system-token',
                                                                                                                                                    scope: 'openid profile email'
                                                                                                                                                  });
                                                                                                                                                  @@ -67,13 +177,38 @@ 
                                                                                                                                                  // Instead of:
                                                                                                                                                  const tokens = await exchangeToken(options);

                                                                                                                                                  // Use:
                                                                                                                                                  const tokens = await loginWithCustomTokenExchange(options);
                                                                                                                                                  -
                                                                                                                                                  generateDpopProof: (
                                                                                                                                                      params: {
                                                                                                                                                          accessToken: string;
                                                                                                                                                          method: string;
                                                                                                                                                          nonce?: string;
                                                                                                                                                          url: string;
                                                                                                                                                      },
                                                                                                                                                  ) => Promise<string>

                                                                                                                                                  Returns a string to be used to demonstrate possession of the private +

                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  generateDpopProof: (
                                                                                                                                                      params: {
                                                                                                                                                          accessToken: string;
                                                                                                                                                          method: string;
                                                                                                                                                          nonce?: string;
                                                                                                                                                          url: string;
                                                                                                                                                      },
                                                                                                                                                  ) => Promise<string>
                                                                                                                                                  +

                                                                                                                                                  Returns a string to be used to demonstrate possession of the private key used to cryptographically bind access tokens with DPoP.

                                                                                                                                                  It requires enabling the Auth0ClientOptions.useDpop option.

                                                                                                                                                  -

                                                                                                                                                  Type Declaration

                                                                                                                                                    • (
                                                                                                                                                          params: {
                                                                                                                                                              accessToken: string;
                                                                                                                                                              method: string;
                                                                                                                                                              nonce?: string;
                                                                                                                                                              url: string;
                                                                                                                                                          },
                                                                                                                                                      ): Promise<string>

                                                                                                                                                    • Returns a string to be used to demonstrate possession of the private +

                                                                                                                                                      +
                                                                                                                                                      +

                                                                                                                                                      Type Declaration

                                                                                                                                                      +
                                                                                                                                                        +
                                                                                                                                                      • +
                                                                                                                                                          +
                                                                                                                                                        • (
                                                                                                                                                              params: {
                                                                                                                                                                  accessToken: string;
                                                                                                                                                                  method: string;
                                                                                                                                                                  nonce?: string;
                                                                                                                                                                  url: string;
                                                                                                                                                              },
                                                                                                                                                          ): Promise<string>
                                                                                                                                                          • +
                                                                                                                                                        • +

                                                                                                                                                          Returns a string to be used to demonstrate possession of the private key used to cryptographically bind access tokens with DPoP.

                                                                                                                                                          It requires enabling the Auth0ClientOptions.useDpop option.

                                                                                                                                                          -

                                                                                                                                                          Parameters

                                                                                                                                                          • params: { accessToken: string; method: string; nonce?: string; url: string }

                                                                                                                                                          Returns Promise<string>

                                                                                                                                                  getAccessTokenSilently: {
                                                                                                                                                      (
                                                                                                                                                          options: GetTokenSilentlyOptions & { detailedResponse: true },
                                                                                                                                                      ): Promise<GetTokenSilentlyVerboseResponse>;
                                                                                                                                                      (options?: GetTokenSilentlyOptions): Promise<string>;
                                                                                                                                                      (
                                                                                                                                                          options: GetTokenSilentlyOptions,
                                                                                                                                                      ): Promise<string | GetTokenSilentlyVerboseResponse>;
                                                                                                                                                  }
                                                                                                                                                  const token = await getAccessTokenSilently(options);
+
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Parameters

                                                                                                                                                  +
                                                                                                                                                    +
                                                                                                                                                  • params: { accessToken: string; method: string; nonce?: string; url: string }
                                                                                                                                                  +

                                                                                                                                                  Returns Promise<string>

                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  getAccessTokenSilently: {
                                                                                                                                                      (
                                                                                                                                                          options: GetTokenSilentlyOptions & { detailedResponse: true },
                                                                                                                                                      ): Promise<GetTokenSilentlyVerboseResponse>;
                                                                                                                                                      (options?: GetTokenSilentlyOptions): Promise<string>;
                                                                                                                                                      (
                                                                                                                                                          options: GetTokenSilentlyOptions,
                                                                                                                                                      ): Promise<string | GetTokenSilentlyVerboseResponse>;
                                                                                                                                                  }
                                                                                                                                                  +
                                                                                                                                                  const token = await getAccessTokenSilently(options);

                                                                                                                                                  If there's a valid token stored, return it. Otherwise, opens an @@ -92,7 +227,13 @@ back to using an iframe to make the token exchange.

                                                                                                                                                  Note that in all cases, falling back to an iframe requires access to the auth0 cookie.

                                                                                                                                                  -
                                                                                                                                                  getAccessTokenWithPopup: (
                                                                                                                                                      options?: GetTokenWithPopupOptions,
                                                                                                                                                      config?: PopupConfigOptions,
                                                                                                                                                  ) => Promise<string | undefined>
                                                                                                                                                  const token = await getTokenWithPopup(options, config);
+
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  getAccessTokenWithPopup: (
                                                                                                                                                      options?: GetTokenWithPopupOptions,
                                                                                                                                                      config?: PopupConfigOptions,
                                                                                                                                                  ) => Promise<string | undefined>
                                                                                                                                                  +
                                                                                                                                                  const token = await getTokenWithPopup(options, config);

                                                                                                                                                  Get an access token interactively.

                                                                                                                                                  @@ -100,41 +241,127 @@ provided as arguments. Random and secure state and nonce parameters will be auto-generated. If the response is successful, results will be valid according to their expiration times.

                                                                                                                                                  -
                                                                                                                                                  getConfiguration: () => Readonly<ClientConfiguration>
                                                                                                                                                  const config = getConfiguration();
                                                                                                                                                  // { domain: 'tenant.auth0.com', clientId: 'abc123' }
+
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  getConfiguration: () => Readonly<ClientConfiguration>
                                                                                                                                                  +
                                                                                                                                                  const config = getConfiguration();
                                                                                                                                                  // { domain: 'tenant.auth0.com', clientId: 'abc123' }

                                                                                                                                                  Returns a readonly copy of the initialization configuration containing the domain and clientId.

                                                                                                                                                  -

                                                                                                                                                  Type Declaration

                                                                                                                                                    • (): Readonly<ClientConfiguration>

                                                                                                                                                    • Returns a readonly copy of the initialization configuration.

                                                                                                                                                      -

                                                                                                                                                      Returns Readonly<ClientConfiguration>

                                                                                                                                                      An object containing domain and clientId

                                                                                                                                                      -
                                                                                                                                                      const auth0 = new Auth0Client({
                                                                                                                                                        domain: 'tenant.auth0.com',
                                                                                                                                                        clientId: 'abc123'
                                                                                                                                                      });

                                                                                                                                                      const config = auth0.getConfiguration();
                                                                                                                                                      // { domain: 'tenant.auth0.com', clientId: 'abc123' }
+
                                                                                                                                                      +
                                                                                                                                                      +

                                                                                                                                                      Type Declaration

                                                                                                                                                      +
                                                                                                                                                        +
                                                                                                                                                      • +
                                                                                                                                                          +
                                                                                                                                                        • (): Readonly<ClientConfiguration>
                                                                                                                                                          • +
                                                                                                                                                        • +

                                                                                                                                                          Returns a readonly copy of the initialization configuration.

                                                                                                                                                          +
                                                                                                                                                          +

                                                                                                                                                          Returns Readonly<ClientConfiguration>

                                                                                                                                                          An object containing domain and clientId

                                                                                                                                                          + +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          const auth0 = new Auth0Client({
                                                                                                                                                            domain: 'tenant.auth0.com',
                                                                                                                                                            clientId: 'abc123'
                                                                                                                                                          });

                                                                                                                                                          const config = auth0.getConfiguration();
                                                                                                                                                          // { domain: 'tenant.auth0.com', clientId: 'abc123' }
                                                                                                                                                          -
                                                                                                                                                  getDpopNonce: (id?: string) => Promise<string | undefined>

                                                                                                                                                  Returns the current DPoP nonce used for making requests to Auth0.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  getDpopNonce: (id?: string) => Promise<string | undefined>
                                                                                                                                                  +

                                                                                                                                                  Returns the current DPoP nonce used for making requests to Auth0.

                                                                                                                                                  It can return undefined because when starting fresh it will not be populated until after the first response from the server.

                                                                                                                                                  It requires enabling the Auth0ClientOptions.useDpop option.

                                                                                                                                                  -

                                                                                                                                                  Type Declaration

                                                                                                                                                    • (id?: string): Promise<string | undefined>

                                                                                                                                                    • Returns the current DPoP nonce used for making requests to Auth0.

                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +

                                                                                                                                                      Type Declaration

                                                                                                                                                      +
                                                                                                                                                        +
                                                                                                                                                      • +
                                                                                                                                                          +
                                                                                                                                                        • (id?: string): Promise<string | undefined>
                                                                                                                                                          • +
                                                                                                                                                        • +

                                                                                                                                                          Returns the current DPoP nonce used for making requests to Auth0.

                                                                                                                                                          It can return undefined because when starting fresh it will not be populated until after the first response from the server.

                                                                                                                                                          It requires enabling the Auth0ClientOptions.useDpop option.

                                                                                                                                                          -

                                                                                                                                                          Parameters

                                                                                                                                                          • Optionalid: string

                                                                                                                                                            The identifier of a nonce: if absent, it will get the nonce +

                                                                                                                                                            +
                                                                                                                                                            +

                                                                                                                                                            Parameters

                                                                                                                                                            +
                                                                                                                                                              +
                                                                                                                                                            • Optionalid: string +

                                                                                                                                                              The identifier of a nonce: if absent, it will get the nonce used for requests to Auth0. Otherwise, it will be used to select a specific non-Auth0 nonce.

                                                                                                                                                              -

                                                                                                                                                            Returns Promise<string | undefined>

                                                                                                                                                      The nonce value.

                                                                                                                                                      -

                                                                                                                                                      The identifier of a nonce: if absent, it will get the nonce +

                                                                                                                                                  +

                                                                                                                                                  Returns Promise<string | undefined>

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  The nonce value.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  The identifier of a nonce: if absent, it will get the nonce used for requests to Auth0. Otherwise, it will be used to select a specific non-Auth0 nonce.

                                                                                                                                                  -
                                                                                                                                                  getIdTokenClaims: () => Promise<IdToken | undefined>
                                                                                                                                                  const claims = await getIdTokenClaims();
+
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  getIdTokenClaims: () => Promise<IdToken | undefined>
                                                                                                                                                  +
                                                                                                                                                  const claims = await getIdTokenClaims();

                                                                                                                                                  Returns all claims from the id_token if available.

                                                                                                                                                  -
                                                                                                                                                  handleRedirectCallback: (
                                                                                                                                                      url?: string,
                                                                                                                                                  ) => Promise<ConnectAccountRedirectResult | RedirectLoginResult<any>>

                                                                                                                                                  After the browser redirects back to the callback page, +

                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  handleRedirectCallback: (
                                                                                                                                                      url?: string,
                                                                                                                                                  ) => Promise<ConnectAccountRedirectResult | RedirectLoginResult<any>>
                                                                                                                                                  +

                                                                                                                                                  After the browser redirects back to the callback page, call handleRedirectCallback to handle success and error responses from Auth0. If the response is successful, results will be valid according to their expiration times.

                                                                                                                                                  -

                                                                                                                                                  Type Declaration

                                                                                                                                                    • (url?: string): Promise<ConnectAccountRedirectResult | RedirectLoginResult<any>>

                                                                                                                                                    • Parameters

                                                                                                                                                      • Optionalurl: string

                                                                                                                                                        The URL to that should be used to retrieve the state and code values. Defaults to window.location.href if not given.

                                                                                                                                                        -

                                                                                                                                                      Returns Promise<ConnectAccountRedirectResult | RedirectLoginResult<any>>

                                                                                                                                                  isAuthenticated: boolean
                                                                                                                                                  isLoading: boolean
                                                                                                                                                  loginWithCustomTokenExchange: (
                                                                                                                                                      options: CustomTokenExchangeOptions,
                                                                                                                                                  ) => Promise<TokenEndpointResponse>
                                                                                                                                                  await loginWithCustomTokenExchange(options);
+
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Type Declaration

                                                                                                                                                  +
                                                                                                                                                    +
                                                                                                                                                  • +
                                                                                                                                                      +
                                                                                                                                                    • (url?: string): Promise<ConnectAccountRedirectResult | RedirectLoginResult<any>>
                                                                                                                                                      • +
                                                                                                                                                    • +
                                                                                                                                                      +

                                                                                                                                                      Parameters

                                                                                                                                                      +
                                                                                                                                                        +
                                                                                                                                                      • Optionalurl: string +

                                                                                                                                                        The URL to that should be used to retrieve the state and code values. Defaults to window.location.href if not given.

                                                                                                                                                        +
                                                                                                                                                      +

                                                                                                                                                      Returns Promise<ConnectAccountRedirectResult | RedirectLoginResult<any>>

                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  isAuthenticated: boolean
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  isLoading: boolean
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  loginWithCustomTokenExchange: (
                                                                                                                                                      options: CustomTokenExchangeOptions,
                                                                                                                                                  ) => Promise<TokenEndpointResponse>
                                                                                                                                                  +
                                                                                                                                                  await loginWithCustomTokenExchange(options);

                                                                                                                                                  Exchanges an external subject token for Auth0 tokens and logs the user in. @@ -142,8 +369,21 @@

                                                                                                                                                  The exchanged tokens are automatically cached, establishing an authenticated session. After calling this method, you can use getUser(), getIdTokenClaims(), and getTokenSilently() to access the user's information and tokens.

                                                                                                                                                  -

                                                                                                                                                  Type Declaration

                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Type Declaration

                                                                                                                                                  +
                                                                                                                                                    +
                                                                                                                                                  • +
                                                                                                                                                      +
                                                                                                                                                    • (options: CustomTokenExchangeOptions): Promise<TokenEndpointResponse>
                                                                                                                                                      • +
                                                                                                                                                    • +
                                                                                                                                                      +

                                                                                                                                                      Parameters

                                                                                                                                                      +
                                                                                                                                                      +

                                                                                                                                                      Returns Promise<TokenEndpointResponse>

                                                                                                                                                      A promise that resolves to the token endpoint response, which contains the issued Auth0 tokens (access_token, id_token, etc.).

                                                                                                                                                      The request includes the following parameters:

                                                                                                                                                        @@ -158,7 +398,13 @@ 
                                                                                                                                                        const options = {
                                                                                                                                                          subject_token: 'eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp...',
                                                                                                                                                          subject_token_type: 'urn:acme:legacy-system-token',
                                                                                                                                                          scope: 'openid profile email',
                                                                                                                                                          audience: 'https://api.example.com',
                                                                                                                                                          organization: 'org_12345'
                                                                                                                                                        };

                                                                                                                                                        try {
                                                                                                                                                          const tokenResponse = await loginWithCustomTokenExchange(options);
                                                                                                                                                          console.log('Access token:', tokenResponse.access_token);

                                                                                                                                                          // User is now logged in - access user info
                                                                                                                                                          const user = await getUser();
                                                                                                                                                          console.log('Logged in user:', user);
                                                                                                                                                        } catch (error) {
                                                                                                                                                          console.error('Token exchange failed:', error);
                                                                                                                                                        }
                                                                                                                                                        -
                                                                                                                                                  loginWithPopup: (
                                                                                                                                                      options?: PopupLoginOptions,
                                                                                                                                                      config?: PopupConfigOptions,
                                                                                                                                                  ) => Promise<void>
                                                                                                                                                  await loginWithPopup(options, config);
+
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  loginWithPopup: (
                                                                                                                                                      options?: PopupLoginOptions,
                                                                                                                                                      config?: PopupConfigOptions,
                                                                                                                                                  ) => Promise<void>
                                                                                                                                                  +
                                                                                                                                                  await loginWithPopup(options, config);

                                                                                                                                                  Opens a popup with the /authorize URL using the parameters @@ -168,20 +414,38 @@

                                                                                                                                                  IMPORTANT: This method has to be called from an event handler that was started by the user like a button click, for example, otherwise the popup will be blocked in most browsers.

                                                                                                                                                  -
                                                                                                                                                  loginWithRedirect: (options?: RedirectLoginOptions<AppState>) => Promise<void>
                                                                                                                                                  await loginWithRedirect(options);
+
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  loginWithRedirect: (options?: RedirectLoginOptions<AppState>) => Promise<void>
                                                                                                                                                  +
                                                                                                                                                  await loginWithRedirect(options);

                                                                                                                                                  Performs a redirect to /authorize using the parameters provided as arguments. Random and secure state and nonce parameters will be auto-generated.

                                                                                                                                                  -
                                                                                                                                                  logout: (options?: LogoutOptions) => Promise<void>
                                                                                                                                                  auth0.logout({ logoutParams: { returnTo: window.location.origin } });
+
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  logout: (options?: LogoutOptions) => Promise<void>
                                                                                                                                                  +
                                                                                                                                                  auth0.logout({ logoutParams: { returnTo: window.location.origin } });

                                                                                                                                                  Clears the application session and performs a redirect to /v2/logout, using the parameters provided as arguments, to clear the Auth0 session. If the logoutParams.federated option is specified, it also clears the Identity Provider session. Read more about how Logout works at Auth0.

                                                                                                                                                  -
                                                                                                                                                  mfa: MfaApiClient
                                                                                                                                                  const { mfa } = useAuth0();
                                                                                                                                                  const authenticators = await mfa.getAuthenticators(mfaToken);
+
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  mfa: MfaApiClient
                                                                                                                                                  +
                                                                                                                                                  const { mfa } = useAuth0();
                                                                                                                                                  const authenticators = await mfa.getAuthenticators(mfaToken);

                                                                                                                                                  MFA API client for Multi-Factor Authentication operations.

                                                                                                                                                  @@ -193,10 +457,19 @@
                                                                                                                                                • verify(params) - Verify MFA challenges and complete authentication
                                                                                                                                                • getEnrollmentFactors(mfaToken) - Get available enrollment factors
                                                                                                                                                  • -
                                                                                                                                                  const { mfa, getAccessTokenSilently } = useAuth0();

                                                                                                                                                  try {
                                                                                                                                                    await getAccessTokenSilently();
                                                                                                                                                  } catch (error) {
                                                                                                                                                    if (error.error === 'mfa_required') {
                                                                                                                                                      // Check if enrollment is needed
                                                                                                                                                      const factors = await mfa.getEnrollmentFactors(error.mfa_token);

                                                                                                                                                      if (factors.length > 0) {
                                                                                                                                                        // Enroll in OTP
                                                                                                                                                        const enrollment = await mfa.enroll({
                                                                                                                                                          mfaToken: error.mfa_token,
                                                                                                                                                          factorType: 'otp'
                                                                                                                                                        });
                                                                                                                                                        console.log('QR Code:', enrollment.barcodeUri);
                                                                                                                                                      }

                                                                                                                                                      // Get authenticators and challenge
                                                                                                                                                      const authenticators = await mfa.getAuthenticators(error.mfa_token);
                                                                                                                                                      await mfa.challenge({
                                                                                                                                                        mfaToken: error.mfa_token,
                                                                                                                                                        challengeType: 'otp',
                                                                                                                                                        authenticatorId: authenticators[0].id
                                                                                                                                                      });

                                                                                                                                                      // Verify with user's code
                                                                                                                                                      const tokens = await mfa.verify({
                                                                                                                                                        mfaToken: error.mfa_token,
                                                                                                                                                        otp: userCode
                                                                                                                                                      });
                                                                                                                                                    }
                                                                                                                                                  }
+
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  const { mfa, getAccessTokenSilently } = useAuth0();

                                                                                                                                                  try {
                                                                                                                                                    await getAccessTokenSilently();
                                                                                                                                                  } catch (error) {
                                                                                                                                                    if (error.error === 'mfa_required') {
                                                                                                                                                      // Check if enrollment is needed
                                                                                                                                                      const factors = await mfa.getEnrollmentFactors(error.mfa_token);

                                                                                                                                                      if (factors.length > 0) {
                                                                                                                                                        // Enroll in OTP
                                                                                                                                                        const enrollment = await mfa.enroll({
                                                                                                                                                          mfaToken: error.mfa_token,
                                                                                                                                                          factorType: 'otp'
                                                                                                                                                        });
                                                                                                                                                        console.log('QR Code:', enrollment.barcodeUri);
                                                                                                                                                      }

                                                                                                                                                      // Get authenticators and challenge
                                                                                                                                                      const authenticators = await mfa.getAuthenticators(error.mfa_token);
                                                                                                                                                      await mfa.challenge({
                                                                                                                                                        mfaToken: error.mfa_token,
                                                                                                                                                        challengeType: 'otp',
                                                                                                                                                        authenticatorId: authenticators[0].id
                                                                                                                                                      });

                                                                                                                                                      // Verify with user's code
                                                                                                                                                      const tokens = await mfa.verify({
                                                                                                                                                        mfaToken: error.mfa_token,
                                                                                                                                                        otp: userCode
                                                                                                                                                      });
                                                                                                                                                    }
                                                                                                                                                  }
                                                                                                                                                  -
                                                                                                                                                  myAccount: MyAccountApiClient
                                                                                                                                                  const { myAccount } = useAuth0();
                                                                                                                                                  const factors = await myAccount.getFactors();
+
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  myAccount: MyAccountApiClient
                                                                                                                                                  +
                                                                                                                                                  const { myAccount } = useAuth0();
                                                                                                                                                  const factors = await myAccount.getFactors();

                                                                                                                                                  MyAccount API client for self-service account management operations.

                                                                                                                                                  @@ -211,10 +484,19 @@
                                                                                                                                                • enrollmentChallenge(options) - Initiate a two-step enrollment challenge
                                                                                                                                                • enrollmentVerify(options) - Complete a two-step enrollment by verifying the challenge
                                                                                                                                                  • -
                                                                                                                                                  const { myAccount } = useAuth0();

                                                                                                                                                  // List all enrolled authentication methods
                                                                                                                                                  const methods = await myAccount.getAuthenticationMethods();

                                                                                                                                                  // Enroll a new passkey
                                                                                                                                                  const challenge = await myAccount.enrollmentChallenge({ type: 'passkey' });
                                                                                                                                                  const credential = await navigator.credentials.create({ publicKey: challenge.authn_params_public_key });
                                                                                                                                                  await myAccount.enrollmentVerify({ type: 'passkey', auth_session: challenge.auth_session, location: challenge.location, authn_response: credential });

                                                                                                                                                  // Remove an authentication method
                                                                                                                                                  await myAccount.deleteAuthenticationMethod('method-id');
+
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  const { myAccount } = useAuth0();

                                                                                                                                                  // List all enrolled authentication methods
                                                                                                                                                  const methods = await myAccount.getAuthenticationMethods();

                                                                                                                                                  // Enroll a new passkey
                                                                                                                                                  const challenge = await myAccount.enrollmentChallenge({ type: 'passkey' });
                                                                                                                                                  const credential = await navigator.credentials.create({ publicKey: challenge.authn_params_public_key });
                                                                                                                                                  await myAccount.enrollmentVerify({ type: 'passkey', auth_session: challenge.auth_session, location: challenge.location, authn_response: credential });

                                                                                                                                                  // Remove an authentication method
                                                                                                                                                  await myAccount.deleteAuthenticationMethod('method-id');
                                                                                                                                                  -
                                                                                                                                                  passkey: PasskeyApiClient
                                                                                                                                                  const { passkey } = useAuth0();
                                                                                                                                                  const tokens = await passkey.signup({ email: 'user@example.com' });
+
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  passkey: PasskeyApiClient
                                                                                                                                                  +
                                                                                                                                                  const { passkey } = useAuth0();
                                                                                                                                                  const tokens = await passkey.signup({ email: 'user@example.com' });

                                                                                                                                                  Passkey API client for WebAuthn-based passwordless authentication.

                                                                                                                                                  @@ -224,7 +506,13 @@

                                                                                                                                                  Both methods exchange the WebAuthn credential for Auth0 tokens and update isAuthenticated / user in the same way as loginWithPopup.

                                                                                                                                                  -
                                                                                                                                                  revokeRefreshToken: (options?: RevokeRefreshTokenOptions) => Promise<void>
                                                                                                                                                  await revokeRefreshToken();
                                                                                                                                                  // or for a specific audience:
                                                                                                                                                  await revokeRefreshToken({ audience: 'https://api.example.com' });
+
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  revokeRefreshToken: (options?: RevokeRefreshTokenOptions) => Promise<void>
                                                                                                                                                  +
                                                                                                                                                  await revokeRefreshToken();
                                                                                                                                                  // or for a specific audience:
                                                                                                                                                  await revokeRefreshToken({ audience: 'https://api.example.com' });

                                                                                                                                                  Revokes the refresh token via the /oauth/revoke endpoint. This invalidates the @@ -240,18 +528,88 @@

                                                                                                                                                  Offline mode: only the refresh token is invalidated; the cached access token and user profile remain valid until the access token expires. isAuthenticated and user are unaffected until then.

                                                                                                                                                  -

                                                                                                                                                  Type Declaration

                                                                                                                                                  setDpopNonce: (nonce: string, id?: string) => Promise<void>

                                                                                                                                                  Sets the current DPoP nonce used for making requests to Auth0.

                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Returns Promise<void>

                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  setDpopNonce: (nonce: string, id?: string) => Promise<void>
                                                                                                                                                  +

                                                                                                                                                  Sets the current DPoP nonce used for making requests to Auth0.

                                                                                                                                                  It requires enabling the Auth0ClientOptions.useDpop option.

                                                                                                                                                  -

                                                                                                                                                  Type Declaration

                                                                                                                                                    • (nonce: string, id?: string): Promise<void>

                                                                                                                                                    • Sets the current DPoP nonce used for making requests to Auth0.

                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +

                                                                                                                                                      Type Declaration

                                                                                                                                                      +
                                                                                                                                                        +
                                                                                                                                                      • +
                                                                                                                                                          +
                                                                                                                                                        • (nonce: string, id?: string): Promise<void>
                                                                                                                                                          • +
                                                                                                                                                        • +

                                                                                                                                                          Sets the current DPoP nonce used for making requests to Auth0.

                                                                                                                                                          It requires enabling the Auth0ClientOptions.useDpop option.

                                                                                                                                                          -

                                                                                                                                                          Parameters

                                                                                                                                                          • nonce: string

                                                                                                                                                            The nonce value.

                                                                                                                                                            -
                                                                                                                                                          • Optionalid: string

                                                                                                                                                            The identifier of a nonce: if absent, it will set the nonce +

                                                                                                                                                            +
                                                                                                                                                            +

                                                                                                                                                            Parameters

                                                                                                                                                            +
                                                                                                                                                              +
                                                                                                                                                            • nonce: string +

                                                                                                                                                              The nonce value.

                                                                                                                                                              +
                                                                                                                                                              • +
                                                                                                                                                            • Optionalid: string +

                                                                                                                                                              The identifier of a nonce: if absent, it will set the nonce used for requests to Auth0. Otherwise, it will be used to select a specific non-Auth0 nonce.

                                                                                                                                                              -

                                                                                                                                                            Returns Promise<void>

                                                                                                                                                      The nonce value.

                                                                                                                                                      -

                                                                                                                                                      The identifier of a nonce: if absent, it will set the nonce +

                                                                                                                                                  +

                                                                                                                                                  Returns Promise<void>

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  The nonce value.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  The identifier of a nonce: if absent, it will set the nonce used for requests to Auth0. Otherwise, it will be used to select a specific non-Auth0 nonce.

                                                                                                                                                  -
                                                                                                                                                  user: TUser | undefined

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  On This Page

                                                                                                                                                  Properties
                                                                                                                                                  + +
                                                                                                                                                  + +
                                                                                                                                                  user: TUser | undefined
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Settings

                                                                                                                                                   +
                                                                                                                                                  +
                                                                                                                                                  Member Visibility +
                                                                                                                                                    +
                                                                                                                                                    • +
                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  On This Page

                                                                                                                                                   +
                                                                                                                                                  +
                                                                                                                                                  Properties +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  diff --git a/docs/interfaces/Authenticator.html b/docs/interfaces/Authenticator.html index bc49bbbf..d93acb16 100644 --- a/docs/interfaces/Authenticator.html +++ b/docs/interfaces/Authenticator.html @@ -1,16 +1,107 @@ -Authenticator | @auth0/auth0-react
                                                                                                                                                  @auth0/auth0-react
                                                                                                                                                    Preparing search index...

                                                                                                                                                    Interface Authenticator

                                                                                                                                                    Represents an MFA authenticator enrolled by a user

                                                                                                                                                    -
                                                                                                                                                    interface Authenticator {
                                                                                                                                                        active: boolean;
                                                                                                                                                        authenticatorType: AuthenticatorType;
                                                                                                                                                        createdAt?: string;
                                                                                                                                                        id: string;
                                                                                                                                                        lastAuth?: string;
                                                                                                                                                        name?: string;
                                                                                                                                                        type?: string;
                                                                                                                                                    }
                                                                                                                                                    Index

                                                                                                                                                    Properties

                                                                                                                                                    active +Authenticator | @auth0/auth0-react
                                                                                                                                                    +
                                                                                                                                                    @auth0/auth0-react + +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      Preparing search index...
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      + +

                                                                                                                                                      Interface Authenticator

                                                                                                                                                      +
                                                                                                                                                      +

                                                                                                                                                      Represents an MFA authenticator enrolled by a user

                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      interface Authenticator {
                                                                                                                                                          active: boolean;
                                                                                                                                                          authenticatorType: AuthenticatorType;
                                                                                                                                                          createdAt?: string;
                                                                                                                                                          id: string;
                                                                                                                                                          lastAuth?: string;
                                                                                                                                                          name?: string;
                                                                                                                                                          type?: string;
                                                                                                                                                      }
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      Index
                                                                                                                                                       +
                                                                                                                                                      +
                                                                                                                                                      + +
                                                                                                                                                      active authenticatorType createdAt? id lastAuth? name? type? -

                                                                                                                                                      Properties

                                                                                                                                                      active: boolean

                                                                                                                                                      Whether the authenticator is active

                                                                                                                                                      -
                                                                                                                                                      authenticatorType: AuthenticatorType

                                                                                                                                                      Type of authenticator

                                                                                                                                                      -
                                                                                                                                                      createdAt?: string

                                                                                                                                                      ISO 8601 timestamp when created

                                                                                                                                                      -
                                                                                                                                                      id: string

                                                                                                                                                      Unique identifier for the authenticator

                                                                                                                                                      -
                                                                                                                                                      lastAuth?: string

                                                                                                                                                      ISO 8601 timestamp of last authentication

                                                                                                                                                      -
                                                                                                                                                      name?: string

                                                                                                                                                      Optional friendly name

                                                                                                                                                      -
                                                                                                                                                      type?: string

                                                                                                                                                      Types of MFA challenges

                                                                                                                                                      -

                                                                                                                                                      Settings

                                                                                                                                                      Member Visibility

                                                                                                                                                      On This Page

                                                                                                                                                      Properties
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      + +
                                                                                                                                                      +
                                                                                                                                                      + +
                                                                                                                                                      active: boolean
                                                                                                                                                      +

                                                                                                                                                      Whether the authenticator is active

                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      + +
                                                                                                                                                      authenticatorType: AuthenticatorType
                                                                                                                                                      +

                                                                                                                                                      Type of authenticator

                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      + +
                                                                                                                                                      createdAt?: string
                                                                                                                                                      +

                                                                                                                                                      ISO 8601 timestamp when created

                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      + +
                                                                                                                                                      id: string
                                                                                                                                                      +

                                                                                                                                                      Unique identifier for the authenticator

                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      + +
                                                                                                                                                      lastAuth?: string
                                                                                                                                                      +

                                                                                                                                                      ISO 8601 timestamp of last authentication

                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      + +
                                                                                                                                                      name?: string
                                                                                                                                                      +

                                                                                                                                                      Optional friendly name

                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      + +
                                                                                                                                                      type?: string
                                                                                                                                                      +

                                                                                                                                                      Types of MFA challenges

                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +

                                                                                                                                                      Settings

                                                                                                                                                       +
                                                                                                                                                      +
                                                                                                                                                      Member Visibility +
                                                                                                                                                        +
                                                                                                                                                        • +
                                                                                                                                                        • +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +

                                                                                                                                                      On This Page

                                                                                                                                                       +
                                                                                                                                                      +
                                                                                                                                                      Properties +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      diff --git a/docs/interfaces/AuthorizationParams.html b/docs/interfaces/AuthorizationParams.html index 6a0d37d1..fee8d2e0 100644 --- a/docs/interfaces/AuthorizationParams.html +++ b/docs/interfaces/AuthorizationParams.html @@ -1,6 +1,34 @@ -AuthorizationParams | @auth0/auth0-react
                                                                                                                                                      @auth0/auth0-react
                                                                                                                                                        Preparing search index...

                                                                                                                                                        Interface AuthorizationParams

                                                                                                                                                        interface AuthorizationParams {
                                                                                                                                                            acr_values?: string;
                                                                                                                                                            audience?: string;
                                                                                                                                                            connection?: string;
                                                                                                                                                            display?: "page" | "popup" | "touch" | "wap";
                                                                                                                                                            id_token_hint?: string;
                                                                                                                                                            invitation?: string;
                                                                                                                                                            login_hint?: string;
                                                                                                                                                            max_age?: string | number;
                                                                                                                                                            organization?: string;
                                                                                                                                                            prompt?: "none" | "login" | "consent" | "select_account";
                                                                                                                                                            redirect_uri?: string;
                                                                                                                                                            scope?: string;
                                                                                                                                                            screen_hint?: string;
                                                                                                                                                            session_transfer_token?: string;
                                                                                                                                                            ui_locales?: string;
                                                                                                                                                            [key: string]: any;
                                                                                                                                                        }

                                                                                                                                                        Indexable

                                                                                                                                                        • [key: string]: any

                                                                                                                                                          If you need to send custom parameters to the Authorization Server, +AuthorizationParams | @auth0/auth0-react

                                                                                                                                                          +
                                                                                                                                                          @auth0/auth0-react + +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            Preparing search index...
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            Interface AuthorizationParams

                                                                                                                                                            +
                                                                                                                                                            interface AuthorizationParams {
                                                                                                                                                                acr_values?: string;
                                                                                                                                                                audience?: string;
                                                                                                                                                                connection?: string;
                                                                                                                                                                display?: "page" | "popup" | "touch" | "wap";
                                                                                                                                                                id_token_hint?: string;
                                                                                                                                                                invitation?: string;
                                                                                                                                                                login_hint?: string;
                                                                                                                                                                max_age?: string | number;
                                                                                                                                                                organization?: string;
                                                                                                                                                                prompt?: "none" | "login" | "consent" | "select_account";
                                                                                                                                                                redirect_uri?: string;
                                                                                                                                                                scope?: string;
                                                                                                                                                                screen_hint?: string;
                                                                                                                                                                session_transfer_token?: string;
                                                                                                                                                                ui_locales?: string;
                                                                                                                                                                [key: string]: any;
                                                                                                                                                            }
                                                                                                                                                            +
                                                                                                                                                            +

                                                                                                                                                            Indexable

                                                                                                                                                            +
                                                                                                                                                              +
                                                                                                                                                            • +
                                                                                                                                                              [key: string]: any
                                                                                                                                                              +

                                                                                                                                                              If you need to send custom parameters to the Authorization Server, make sure to use the original parameter name.

                                                                                                                                                              -
                                                                                                                                                            Index

                                                                                                                                                            Properties

                                                                                                                                                            acr_values? +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          Index
                                                                                                                                                           +
                                                                                                                                                          +
                                                                                                                                                          + +
                                                                                                                                                          acr_values? audience? connection? display? @@ -15,26 +43,80 @@ screen_hint? session_transfer_token? ui_locales? -

                                                                                                                                                          Properties

                                                                                                                                                          acr_values?: string
                                                                                                                                                          audience?: string

                                                                                                                                                          The default audience to be used for requesting API access.

                                                                                                                                                          -
                                                                                                                                                          connection?: string

                                                                                                                                                          The name of the connection configured for your application. +

                                                                                                                                                          +
                                                                                                                                                          + +
                                                                                                                                                          +
                                                                                                                                                          + +
                                                                                                                                                          acr_values?: string
                                                                                                                                                          +
                                                                                                                                                          + +
                                                                                                                                                          audience?: string
                                                                                                                                                          +

                                                                                                                                                          The default audience to be used for requesting API access.

                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          + +
                                                                                                                                                          connection?: string
                                                                                                                                                          +

                                                                                                                                                          The name of the connection configured for your application. If null, it will redirect to the Auth0 Login Page and show the Login Widget.

                                                                                                                                                          -
                                                                                                                                                          display?: "page" | "popup" | "touch" | "wap"
                                                                                                                                                            +
                                                                                                                                                          +
                                                                                                                                                          + +
                                                                                                                                                          display?: "page" | "popup" | "touch" | "wap"
                                                                                                                                                          +
                                                                                                                                                          • 'page': displays the UI with a full page view
                                                                                                                                                          • 'popup': displays the UI with a popup window
                                                                                                                                                          • 'touch': displays the UI in a way that leverages a touch interface
                                                                                                                                                          • 'wap': displays the UI with a "feature phone" type interface
                                                                                                                                                          -
                                                                                                                                                          id_token_hint?: string

                                                                                                                                                          Previously issued ID Token.

                                                                                                                                                          -
                                                                                                                                                          invitation?: string

                                                                                                                                                          The Id of an invitation to accept. This is available from the user invitation URL that is given when participating in a user invitation flow.

                                                                                                                                                          -
                                                                                                                                                          login_hint?: string

                                                                                                                                                          The user's email address or other identifier. When your app knows +

                                                                                                                                                          +
                                                                                                                                                          + +
                                                                                                                                                          id_token_hint?: string
                                                                                                                                                          +

                                                                                                                                                          Previously issued ID Token.

                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          + +
                                                                                                                                                          invitation?: string
                                                                                                                                                          +

                                                                                                                                                          The Id of an invitation to accept. This is available from the user invitation URL that is given when participating in a user invitation flow.

                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          + +
                                                                                                                                                          login_hint?: string
                                                                                                                                                          +

                                                                                                                                                          The user's email address or other identifier. When your app knows which user is trying to authenticate, you can provide this parameter to pre-fill the email box or select the right session for sign-in.

                                                                                                                                                          This currently only affects the classic Lock experience.

                                                                                                                                                          -
                                                                                                                                                          max_age?: string | number

                                                                                                                                                          Maximum allowable elapsed time (in seconds) since authentication. +

                                                                                                                                                          +
                                                                                                                                                          + +
                                                                                                                                                          max_age?: string | number
                                                                                                                                                          +

                                                                                                                                                          Maximum allowable elapsed time (in seconds) since authentication. If the last time the user authenticated is greater than this value, the user must be reauthenticated.

                                                                                                                                                          -
                                                                                                                                                          organization?: string

                                                                                                                                                          The organization to log in to.

                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          + +
                                                                                                                                                          organization?: string
                                                                                                                                                          +

                                                                                                                                                          The organization to log in to.

                                                                                                                                                          This will specify an organization parameter in your user's login request.

                                                                                                                                                          • If you provide an Organization ID (a string with the prefix org_), it will be validated against the org_id claim of your user's ID Token. The validation is case-sensitive.
                                                                                                                                                            • @@ -42,29 +124,92 @@ To use an Organization Name you must have "Allow Organization Names in Authentication API" switched on in your Auth0 settings dashboard. More information is available on the Auth0 documentation portal
                                                                                                                                                          -
                                                                                                                                                          prompt?: "none" | "login" | "consent" | "select_account"
                                                                                                                                                            +
                                                                                                                                                          +
                                                                                                                                                          + +
                                                                                                                                                          prompt?: "none" | "login" | "consent" | "select_account"
                                                                                                                                                          +
                                                                                                                                                          • 'none': do not prompt user for login or consent on reauthentication
                                                                                                                                                          • 'login': prompt user for reauthentication
                                                                                                                                                          • 'consent': prompt user for consent before processing request
                                                                                                                                                          • 'select_account': prompt user to select an account
                                                                                                                                                          -
                                                                                                                                                          redirect_uri?: string

                                                                                                                                                          The default URL where Auth0 will redirect your browser to with +

                                                                                                                                                          +
                                                                                                                                                          + +
                                                                                                                                                          redirect_uri?: string
                                                                                                                                                          +

                                                                                                                                                          The default URL where Auth0 will redirect your browser to with the authentication result. It must be whitelisted in the "Allowed Callback URLs" field in your Auth0 Application's settings. If not provided here, it should be provided in the other methods that provide authentication.

                                                                                                                                                          -
                                                                                                                                                          scope?: string

                                                                                                                                                          The default scope to be used on authentication requests.

                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          + +
                                                                                                                                                          scope?: string
                                                                                                                                                          +

                                                                                                                                                          The default scope to be used on authentication requests.

                                                                                                                                                          This defaults to profile email if not set. If you are setting extra scopes and require profile and email to be included then you must include them in the provided scope.

                                                                                                                                                          Note: The openid scope is always applied regardless of this setting.

                                                                                                                                                          -
                                                                                                                                                          screen_hint?: string

                                                                                                                                                          Provides a hint to Auth0 as to what flow should be displayed. +

                                                                                                                                                          +
                                                                                                                                                          + +
                                                                                                                                                          screen_hint?: string
                                                                                                                                                          +

                                                                                                                                                          Provides a hint to Auth0 as to what flow should be displayed. The default behavior is to show a login page but you can override this by passing 'signup' to show the signup page instead.

                                                                                                                                                          This only affects the New Universal Login Experience.

                                                                                                                                                          -
                                                                                                                                                          session_transfer_token?: string

                                                                                                                                                          Session transfer token from a native application for Native to Web SSO. +

                                                                                                                                                          +
                                                                                                                                                          + +
                                                                                                                                                          session_transfer_token?: string
                                                                                                                                                          +

                                                                                                                                                          Session transfer token from a native application for Native to Web SSO. When sessionTransferTokenQueryParamName is set, this is automatically extracted from the specified URL query parameter if present.

                                                                                                                                                          -

                                                                                                                                                          https://auth0.com/docs/authenticate/single-sign-on/native-to-web

                                                                                                                                                          -
                                                                                                                                                          ui_locales?: string

                                                                                                                                                          The space-separated list of language tags, ordered by preference. +

                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          +

                                                                                                                                                          https://auth0.com/docs/authenticate/single-sign-on/native-to-web

                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          + +
                                                                                                                                                          ui_locales?: string
                                                                                                                                                          +

                                                                                                                                                          The space-separated list of language tags, ordered by preference. For example: 'fr-CA fr en'.

                                                                                                                                                          -

                                                                                                                                                          Settings

                                                                                                                                                          Member Visibility

                                                                                                                                                          On This Page

                                                                                                                                                          Properties
                                                                                                                                                          + +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          +

                                                                                                                                                          Settings

                                                                                                                                                           +
                                                                                                                                                          +
                                                                                                                                                          Member Visibility +
                                                                                                                                                            +
                                                                                                                                                            • +
                                                                                                                                                            • +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          +

                                                                                                                                                          On This Page

                                                                                                                                                           +
                                                                                                                                                          +
                                                                                                                                                          Properties +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          diff --git a/docs/interfaces/ChallengeAuthenticatorParams.html b/docs/interfaces/ChallengeAuthenticatorParams.html index e5881740..f146a255 100644 --- a/docs/interfaces/ChallengeAuthenticatorParams.html +++ b/docs/interfaces/ChallengeAuthenticatorParams.html @@ -1,8 +1,75 @@ -ChallengeAuthenticatorParams | @auth0/auth0-react
                                                                                                                                                          @auth0/auth0-react
                                                                                                                                                            Preparing search index...

                                                                                                                                                            Interface ChallengeAuthenticatorParams

                                                                                                                                                            Parameters for initiating an MFA challenge

                                                                                                                                                            -
                                                                                                                                                            interface ChallengeAuthenticatorParams {
                                                                                                                                                                authenticatorId?: string;
                                                                                                                                                                challengeType: "otp" | "oob";
                                                                                                                                                                mfaToken: string;
                                                                                                                                                            }
                                                                                                                                                            Index

                                                                                                                                                            Properties

                                                                                                                                                            authenticatorId? +ChallengeAuthenticatorParams | @auth0/auth0-react
                                                                                                                                                            +
                                                                                                                                                            @auth0/auth0-react + +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Preparing search index...
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              + +

                                                                                                                                                              Interface ChallengeAuthenticatorParams

                                                                                                                                                              +
                                                                                                                                                              +

                                                                                                                                                              Parameters for initiating an MFA challenge

                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              interface ChallengeAuthenticatorParams {
                                                                                                                                                                  authenticatorId?: string;
                                                                                                                                                                  challengeType: "otp" | "oob";
                                                                                                                                                                  mfaToken: string;
                                                                                                                                                              }
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Index
                                                                                                                                                               +
                                                                                                                                                              +
                                                                                                                                                              + +
                                                                                                                                                              authenticatorId? challengeType mfaToken -

                                                                                                                                                              Properties

                                                                                                                                                              authenticatorId?: string

                                                                                                                                                              Specific authenticator to challenge (optional)

                                                                                                                                                              -
                                                                                                                                                              challengeType: "otp" | "oob"

                                                                                                                                                              Type of challenge to initiate

                                                                                                                                                              -
                                                                                                                                                              mfaToken: string

                                                                                                                                                              MFA token from mfa_required error or MFA-scoped access token

                                                                                                                                                              -

                                                                                                                                                              Settings

                                                                                                                                                              Member Visibility

                                                                                                                                                              On This Page

                                                                                                                                                              Properties
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              + +
                                                                                                                                                              +
                                                                                                                                                              + +
                                                                                                                                                              authenticatorId?: string
                                                                                                                                                              +

                                                                                                                                                              Specific authenticator to challenge (optional)

                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              + +
                                                                                                                                                              challengeType: "otp" | "oob"
                                                                                                                                                              +

                                                                                                                                                              Type of challenge to initiate

                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              + +
                                                                                                                                                              mfaToken: string
                                                                                                                                                              +

                                                                                                                                                              MFA token from mfa_required error or MFA-scoped access token

                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +

                                                                                                                                                              Settings

                                                                                                                                                               +
                                                                                                                                                              +
                                                                                                                                                              Member Visibility +
                                                                                                                                                                +
                                                                                                                                                                • +
                                                                                                                                                                • +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +

                                                                                                                                                              On This Page

                                                                                                                                                               +
                                                                                                                                                              +
                                                                                                                                                              Properties +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              diff --git a/docs/interfaces/ChallengeResponse.html b/docs/interfaces/ChallengeResponse.html index 8d4a0b85..3fabdacd 100644 --- a/docs/interfaces/ChallengeResponse.html +++ b/docs/interfaces/ChallengeResponse.html @@ -1,8 +1,75 @@ -ChallengeResponse | @auth0/auth0-react
                                                                                                                                                              @auth0/auth0-react
                                                                                                                                                                Preparing search index...

                                                                                                                                                                Interface ChallengeResponse

                                                                                                                                                                Response from initiating an MFA challenge

                                                                                                                                                                -
                                                                                                                                                                interface ChallengeResponse {
                                                                                                                                                                    bindingMethod?: string;
                                                                                                                                                                    challengeType: "otp" | "oob";
                                                                                                                                                                    oobCode?: string;
                                                                                                                                                                }
                                                                                                                                                                Index

                                                                                                                                                                Properties

                                                                                                                                                                bindingMethod? +ChallengeResponse | @auth0/auth0-react
                                                                                                                                                                +
                                                                                                                                                                @auth0/auth0-react + +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  Preparing search index...
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  + +

                                                                                                                                                                  Interface ChallengeResponse

                                                                                                                                                                  +
                                                                                                                                                                  +

                                                                                                                                                                  Response from initiating an MFA challenge

                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  interface ChallengeResponse {
                                                                                                                                                                      bindingMethod?: string;
                                                                                                                                                                      challengeType: "otp" | "oob";
                                                                                                                                                                      oobCode?: string;
                                                                                                                                                                  }
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  Index
                                                                                                                                                                   +
                                                                                                                                                                  +
                                                                                                                                                                  + +
                                                                                                                                                                  bindingMethod? challengeType oobCode? -

                                                                                                                                                                  Properties

                                                                                                                                                                  bindingMethod?: string

                                                                                                                                                                  Binding method for OOB (e.g., 'prompt')

                                                                                                                                                                  -
                                                                                                                                                                  challengeType: "otp" | "oob"

                                                                                                                                                                  Type of challenge created

                                                                                                                                                                  -
                                                                                                                                                                  oobCode?: string

                                                                                                                                                                  Out-of-band code (for OOB challenges)

                                                                                                                                                                  -

                                                                                                                                                                  Settings

                                                                                                                                                                  Member Visibility

                                                                                                                                                                  On This Page

                                                                                                                                                                  Properties
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  + +
                                                                                                                                                                  +
                                                                                                                                                                  + +
                                                                                                                                                                  bindingMethod?: string
                                                                                                                                                                  +

                                                                                                                                                                  Binding method for OOB (e.g., 'prompt')

                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  + +
                                                                                                                                                                  challengeType: "otp" | "oob"
                                                                                                                                                                  +

                                                                                                                                                                  Type of challenge created

                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  + +
                                                                                                                                                                  oobCode?: string
                                                                                                                                                                  +

                                                                                                                                                                  Out-of-band code (for OOB challenges)

                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  +

                                                                                                                                                                  Settings

                                                                                                                                                                   +
                                                                                                                                                                  +
                                                                                                                                                                  Member Visibility +
                                                                                                                                                                    +
                                                                                                                                                                    • +
                                                                                                                                                                    • +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  +

                                                                                                                                                                  On This Page

                                                                                                                                                                   +
                                                                                                                                                                  +
                                                                                                                                                                  Properties +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  diff --git a/docs/interfaces/ClientConfiguration.html b/docs/interfaces/ClientConfiguration.html index 4645785d..5807a65b 100644 --- a/docs/interfaces/ClientConfiguration.html +++ b/docs/interfaces/ClientConfiguration.html @@ -1,6 +1,67 @@ -ClientConfiguration | @auth0/auth0-react
                                                                                                                                                                  @auth0/auth0-react
                                                                                                                                                                    Preparing search index...

                                                                                                                                                                    Interface ClientConfiguration

                                                                                                                                                                    Configuration details exposed by the Auth0Client after initialization.

                                                                                                                                                                    -
                                                                                                                                                                    interface ClientConfiguration {
                                                                                                                                                                        clientId: string;
                                                                                                                                                                        domain: string;
                                                                                                                                                                    }
                                                                                                                                                                    Index

                                                                                                                                                                    Properties

                                                                                                                                                                    clientId +ClientConfiguration | @auth0/auth0-react
                                                                                                                                                                    +
                                                                                                                                                                    @auth0/auth0-react + +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      Preparing search index...
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      + +

                                                                                                                                                                      Interface ClientConfiguration

                                                                                                                                                                      +
                                                                                                                                                                      +

                                                                                                                                                                      Configuration details exposed by the Auth0Client after initialization.

                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      interface ClientConfiguration {
                                                                                                                                                                          clientId: string;
                                                                                                                                                                          domain: string;
                                                                                                                                                                      }
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      Index
                                                                                                                                                                       +
                                                                                                                                                                      +
                                                                                                                                                                      + +
                                                                                                                                                                      clientId domain -

                                                                                                                                                                      Properties

                                                                                                                                                                      clientId: string

                                                                                                                                                                      The Auth0 client ID that was configured

                                                                                                                                                                      -
                                                                                                                                                                      domain: string

                                                                                                                                                                      The Auth0 domain that was configured

                                                                                                                                                                      -

                                                                                                                                                                      Settings

                                                                                                                                                                      Member Visibility

                                                                                                                                                                      On This Page

                                                                                                                                                                      Properties
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      + +
                                                                                                                                                                      +
                                                                                                                                                                      + +
                                                                                                                                                                      clientId: string
                                                                                                                                                                      +

                                                                                                                                                                      The Auth0 client ID that was configured

                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      + +
                                                                                                                                                                      domain: string
                                                                                                                                                                      +

                                                                                                                                                                      The Auth0 domain that was configured

                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      +

                                                                                                                                                                      Settings

                                                                                                                                                                       +
                                                                                                                                                                      +
                                                                                                                                                                      Member Visibility +
                                                                                                                                                                        +
                                                                                                                                                                        • +
                                                                                                                                                                        • +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      +

                                                                                                                                                                      On This Page

                                                                                                                                                                       +
                                                                                                                                                                      +
                                                                                                                                                                      Properties +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      diff --git a/docs/interfaces/EnrollEmailParams.html b/docs/interfaces/EnrollEmailParams.html index 58c7dc38..4b098f55 100644 --- a/docs/interfaces/EnrollEmailParams.html +++ b/docs/interfaces/EnrollEmailParams.html @@ -1,8 +1,82 @@ -EnrollEmailParams | @auth0/auth0-react
                                                                                                                                                                      @auth0/auth0-react
                                                                                                                                                                        Preparing search index...

                                                                                                                                                                        Interface EnrollEmailParams

                                                                                                                                                                        Email enrollment parameters

                                                                                                                                                                        -
                                                                                                                                                                        interface EnrollEmailParams {
                                                                                                                                                                            email?: string;
                                                                                                                                                                            factorType: "email";
                                                                                                                                                                            mfaToken: string;
                                                                                                                                                                        }

                                                                                                                                                                        Hierarchy

                                                                                                                                                                        • EnrollBaseParams
                                                                                                                                                                          • EnrollEmailParams
                                                                                                                                                                        Index

                                                                                                                                                                        Properties

                                                                                                                                                                        email? +EnrollEmailParams | @auth0/auth0-react
                                                                                                                                                                        +
                                                                                                                                                                        @auth0/auth0-react + +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Preparing search index...
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          + +

                                                                                                                                                                          Interface EnrollEmailParams

                                                                                                                                                                          +
                                                                                                                                                                          +

                                                                                                                                                                          Email enrollment parameters

                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          interface EnrollEmailParams {
                                                                                                                                                                              email?: string;
                                                                                                                                                                              factorType: "email";
                                                                                                                                                                              mfaToken: string;
                                                                                                                                                                          }
                                                                                                                                                                          +
                                                                                                                                                                          +

                                                                                                                                                                          Hierarchy

                                                                                                                                                                          +
                                                                                                                                                                            +
                                                                                                                                                                          • EnrollBaseParams +
                                                                                                                                                                              +
                                                                                                                                                                            • EnrollEmailParams
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Index
                                                                                                                                                                           +
                                                                                                                                                                          +
                                                                                                                                                                          + +
                                                                                                                                                                          email? factorType mfaToken -

                                                                                                                                                                          Properties

                                                                                                                                                                          email?: string

                                                                                                                                                                          Email address (optional, uses user's email if not provided)

                                                                                                                                                                          -
                                                                                                                                                                          factorType: "email"

                                                                                                                                                                          The factor type for enrollment

                                                                                                                                                                          -
                                                                                                                                                                          mfaToken: string

                                                                                                                                                                          MFA token from mfa_required error

                                                                                                                                                                          -

                                                                                                                                                                          Settings

                                                                                                                                                                          Member Visibility

                                                                                                                                                                          On This Page

                                                                                                                                                                          Properties
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          + +
                                                                                                                                                                          +
                                                                                                                                                                          + +
                                                                                                                                                                          email?: string
                                                                                                                                                                          +

                                                                                                                                                                          Email address (optional, uses user's email if not provided)

                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          + +
                                                                                                                                                                          factorType: "email"
                                                                                                                                                                          +

                                                                                                                                                                          The factor type for enrollment

                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          + +
                                                                                                                                                                          mfaToken: string
                                                                                                                                                                          +

                                                                                                                                                                          MFA token from mfa_required error

                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          +

                                                                                                                                                                          Settings

                                                                                                                                                                           +
                                                                                                                                                                          +
                                                                                                                                                                          Member Visibility +
                                                                                                                                                                            +
                                                                                                                                                                            • +
                                                                                                                                                                            • +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          +

                                                                                                                                                                          On This Page

                                                                                                                                                                           +
                                                                                                                                                                          +
                                                                                                                                                                          Properties +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          diff --git a/docs/interfaces/EnrollOtpParams.html b/docs/interfaces/EnrollOtpParams.html index 2c9c236c..41f4779c 100644 --- a/docs/interfaces/EnrollOtpParams.html +++ b/docs/interfaces/EnrollOtpParams.html @@ -1,6 +1,74 @@ -EnrollOtpParams | @auth0/auth0-react
                                                                                                                                                                          @auth0/auth0-react
                                                                                                                                                                            Preparing search index...

                                                                                                                                                                            Interface EnrollOtpParams

                                                                                                                                                                            OTP (Time-based One-Time Password) enrollment parameters

                                                                                                                                                                            -
                                                                                                                                                                            interface EnrollOtpParams {
                                                                                                                                                                                factorType: "otp";
                                                                                                                                                                                mfaToken: string;
                                                                                                                                                                            }

                                                                                                                                                                            Hierarchy

                                                                                                                                                                            • EnrollBaseParams
                                                                                                                                                                              • EnrollOtpParams
                                                                                                                                                                            Index

                                                                                                                                                                            Properties

                                                                                                                                                                            factorType +EnrollOtpParams | @auth0/auth0-react
                                                                                                                                                                            +
                                                                                                                                                                            @auth0/auth0-react + +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Preparing search index...
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              + +

                                                                                                                                                                              Interface EnrollOtpParams

                                                                                                                                                                              +
                                                                                                                                                                              +

                                                                                                                                                                              OTP (Time-based One-Time Password) enrollment parameters

                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              interface EnrollOtpParams {
                                                                                                                                                                                  factorType: "otp";
                                                                                                                                                                                  mfaToken: string;
                                                                                                                                                                              }
                                                                                                                                                                              +
                                                                                                                                                                              +

                                                                                                                                                                              Hierarchy

                                                                                                                                                                              +
                                                                                                                                                                                +
                                                                                                                                                                              • EnrollBaseParams +
                                                                                                                                                                                  +
                                                                                                                                                                                • EnrollOtpParams
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Index
                                                                                                                                                                               +
                                                                                                                                                                              +
                                                                                                                                                                              + +
                                                                                                                                                                              factorType mfaToken -

                                                                                                                                                                              Properties

                                                                                                                                                                              factorType: "otp"

                                                                                                                                                                              The factor type for enrollment

                                                                                                                                                                              -
                                                                                                                                                                              mfaToken: string

                                                                                                                                                                              MFA token from mfa_required error

                                                                                                                                                                              -

                                                                                                                                                                              Settings

                                                                                                                                                                              Member Visibility

                                                                                                                                                                              On This Page

                                                                                                                                                                              Properties
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              + +
                                                                                                                                                                              +
                                                                                                                                                                              + +
                                                                                                                                                                              factorType: "otp"
                                                                                                                                                                              +

                                                                                                                                                                              The factor type for enrollment

                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              + +
                                                                                                                                                                              mfaToken: string
                                                                                                                                                                              +

                                                                                                                                                                              MFA token from mfa_required error

                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +

                                                                                                                                                                              Settings

                                                                                                                                                                               +
                                                                                                                                                                              +
                                                                                                                                                                              Member Visibility +
                                                                                                                                                                                +
                                                                                                                                                                                • +
                                                                                                                                                                                • +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +

                                                                                                                                                                              On This Page

                                                                                                                                                                               +
                                                                                                                                                                              +
                                                                                                                                                                              Properties +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              diff --git a/docs/interfaces/EnrollPushParams.html b/docs/interfaces/EnrollPushParams.html index 2275fbd1..ec1e9223 100644 --- a/docs/interfaces/EnrollPushParams.html +++ b/docs/interfaces/EnrollPushParams.html @@ -1,6 +1,74 @@ -EnrollPushParams | @auth0/auth0-react
                                                                                                                                                                              @auth0/auth0-react
                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                Interface EnrollPushParams

                                                                                                                                                                                Push notification enrollment parameters

                                                                                                                                                                                -
                                                                                                                                                                                interface EnrollPushParams {
                                                                                                                                                                                    factorType: "push";
                                                                                                                                                                                    mfaToken: string;
                                                                                                                                                                                }

                                                                                                                                                                                Hierarchy

                                                                                                                                                                                • EnrollBaseParams
                                                                                                                                                                                  • EnrollPushParams
                                                                                                                                                                                Index

                                                                                                                                                                                Properties

                                                                                                                                                                                factorType +EnrollPushParams | @auth0/auth0-react
                                                                                                                                                                                +
                                                                                                                                                                                @auth0/auth0-react + +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +

                                                                                                                                                                                  Interface EnrollPushParams

                                                                                                                                                                                  +
                                                                                                                                                                                  +

                                                                                                                                                                                  Push notification enrollment parameters

                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  interface EnrollPushParams {
                                                                                                                                                                                      factorType: "push";
                                                                                                                                                                                      mfaToken: string;
                                                                                                                                                                                  }
                                                                                                                                                                                  +
                                                                                                                                                                                  +

                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                  +
                                                                                                                                                                                    +
                                                                                                                                                                                  • EnrollBaseParams +
                                                                                                                                                                                      +
                                                                                                                                                                                    • EnrollPushParams
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  Index
                                                                                                                                                                                   +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  factorType mfaToken -

                                                                                                                                                                                  Properties

                                                                                                                                                                                  factorType: "push"

                                                                                                                                                                                  The factor type for enrollment

                                                                                                                                                                                  -
                                                                                                                                                                                  mfaToken: string

                                                                                                                                                                                  MFA token from mfa_required error

                                                                                                                                                                                  -

                                                                                                                                                                                  Settings

                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                  On This Page

                                                                                                                                                                                  Properties
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  factorType: "push"
                                                                                                                                                                                  +

                                                                                                                                                                                  The factor type for enrollment

                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  mfaToken: string
                                                                                                                                                                                  +

                                                                                                                                                                                  MFA token from mfa_required error

                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +

                                                                                                                                                                                  Settings

                                                                                                                                                                                   +
                                                                                                                                                                                  +
                                                                                                                                                                                  Member Visibility +
                                                                                                                                                                                    +
                                                                                                                                                                                    • +
                                                                                                                                                                                    • +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +

                                                                                                                                                                                  On This Page

                                                                                                                                                                                   +
                                                                                                                                                                                  +
                                                                                                                                                                                  Properties +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  diff --git a/docs/interfaces/EnrollSmsParams.html b/docs/interfaces/EnrollSmsParams.html index fa68daab..6ed5a0f4 100644 --- a/docs/interfaces/EnrollSmsParams.html +++ b/docs/interfaces/EnrollSmsParams.html @@ -1,8 +1,82 @@ -EnrollSmsParams | @auth0/auth0-react
                                                                                                                                                                                  @auth0/auth0-react
                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                    Interface EnrollSmsParams

                                                                                                                                                                                    SMS enrollment parameters

                                                                                                                                                                                    -
                                                                                                                                                                                    interface EnrollSmsParams {
                                                                                                                                                                                        factorType: "sms";
                                                                                                                                                                                        mfaToken: string;
                                                                                                                                                                                        phoneNumber: string;
                                                                                                                                                                                    }

                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                    • EnrollBaseParams
                                                                                                                                                                                      • EnrollSmsParams
                                                                                                                                                                                    Index

                                                                                                                                                                                    Properties

                                                                                                                                                                                    factorType +EnrollSmsParams | @auth0/auth0-react
                                                                                                                                                                                    +
                                                                                                                                                                                    @auth0/auth0-react + +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      + +

                                                                                                                                                                                      Interface EnrollSmsParams

                                                                                                                                                                                      +
                                                                                                                                                                                      +

                                                                                                                                                                                      SMS enrollment parameters

                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      interface EnrollSmsParams {
                                                                                                                                                                                          factorType: "sms";
                                                                                                                                                                                          mfaToken: string;
                                                                                                                                                                                          phoneNumber: string;
                                                                                                                                                                                      }
                                                                                                                                                                                      +
                                                                                                                                                                                      +

                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                      +
                                                                                                                                                                                        +
                                                                                                                                                                                      • EnrollBaseParams +
                                                                                                                                                                                          +
                                                                                                                                                                                        • EnrollSmsParams
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Index
                                                                                                                                                                                       +
                                                                                                                                                                                      +
                                                                                                                                                                                      + +
                                                                                                                                                                                      factorType mfaToken phoneNumber -

                                                                                                                                                                                      Properties

                                                                                                                                                                                      factorType: "sms"

                                                                                                                                                                                      The factor type for enrollment

                                                                                                                                                                                      -
                                                                                                                                                                                      mfaToken: string

                                                                                                                                                                                      MFA token from mfa_required error

                                                                                                                                                                                      -
                                                                                                                                                                                      phoneNumber: string

                                                                                                                                                                                      Phone number in E.164 format (required for SMS)

                                                                                                                                                                                      -

                                                                                                                                                                                      Settings

                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                      On This Page

                                                                                                                                                                                      Properties
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      + +
                                                                                                                                                                                      +
                                                                                                                                                                                      + +
                                                                                                                                                                                      factorType: "sms"
                                                                                                                                                                                      +

                                                                                                                                                                                      The factor type for enrollment

                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      + +
                                                                                                                                                                                      mfaToken: string
                                                                                                                                                                                      +

                                                                                                                                                                                      MFA token from mfa_required error

                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      + +
                                                                                                                                                                                      phoneNumber: string
                                                                                                                                                                                      +

                                                                                                                                                                                      Phone number in E.164 format (required for SMS)

                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +

                                                                                                                                                                                      Settings

                                                                                                                                                                                       +
                                                                                                                                                                                      +
                                                                                                                                                                                      Member Visibility +
                                                                                                                                                                                        +
                                                                                                                                                                                        • +
                                                                                                                                                                                        • +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +

                                                                                                                                                                                      On This Page

                                                                                                                                                                                       +
                                                                                                                                                                                      +
                                                                                                                                                                                      Properties +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      diff --git a/docs/interfaces/EnrollVoiceParams.html b/docs/interfaces/EnrollVoiceParams.html index 97c1d26c..f2a6182d 100644 --- a/docs/interfaces/EnrollVoiceParams.html +++ b/docs/interfaces/EnrollVoiceParams.html @@ -1,8 +1,82 @@ -EnrollVoiceParams | @auth0/auth0-react
                                                                                                                                                                                      @auth0/auth0-react
                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                        Interface EnrollVoiceParams

                                                                                                                                                                                        Voice enrollment parameters

                                                                                                                                                                                        -
                                                                                                                                                                                        interface EnrollVoiceParams {
                                                                                                                                                                                            factorType: "voice";
                                                                                                                                                                                            mfaToken: string;
                                                                                                                                                                                            phoneNumber: string;
                                                                                                                                                                                        }

                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                        • EnrollBaseParams
                                                                                                                                                                                          • EnrollVoiceParams
                                                                                                                                                                                        Index

                                                                                                                                                                                        Properties

                                                                                                                                                                                        factorType +EnrollVoiceParams | @auth0/auth0-react
                                                                                                                                                                                        +
                                                                                                                                                                                        @auth0/auth0-react + +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          + +

                                                                                                                                                                                          Interface EnrollVoiceParams

                                                                                                                                                                                          +
                                                                                                                                                                                          +

                                                                                                                                                                                          Voice enrollment parameters

                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          interface EnrollVoiceParams {
                                                                                                                                                                                              factorType: "voice";
                                                                                                                                                                                              mfaToken: string;
                                                                                                                                                                                              phoneNumber: string;
                                                                                                                                                                                          }
                                                                                                                                                                                          +
                                                                                                                                                                                          +

                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                          +
                                                                                                                                                                                            +
                                                                                                                                                                                          • EnrollBaseParams +
                                                                                                                                                                                              +
                                                                                                                                                                                            • EnrollVoiceParams
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Index
                                                                                                                                                                                           +
                                                                                                                                                                                          +
                                                                                                                                                                                          + +
                                                                                                                                                                                          factorType mfaToken phoneNumber -

                                                                                                                                                                                          Properties

                                                                                                                                                                                          factorType: "voice"

                                                                                                                                                                                          The factor type for enrollment

                                                                                                                                                                                          -
                                                                                                                                                                                          mfaToken: string

                                                                                                                                                                                          MFA token from mfa_required error

                                                                                                                                                                                          -
                                                                                                                                                                                          phoneNumber: string

                                                                                                                                                                                          Phone number in E.164 format (required for voice)

                                                                                                                                                                                          -

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          Properties
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          + +
                                                                                                                                                                                          +
                                                                                                                                                                                          + +
                                                                                                                                                                                          factorType: "voice"
                                                                                                                                                                                          +

                                                                                                                                                                                          The factor type for enrollment

                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          + +
                                                                                                                                                                                          mfaToken: string
                                                                                                                                                                                          +

                                                                                                                                                                                          MFA token from mfa_required error

                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          + +
                                                                                                                                                                                          phoneNumber: string
                                                                                                                                                                                          +

                                                                                                                                                                                          Phone number in E.164 format (required for voice)

                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          +

                                                                                                                                                                                          Settings

                                                                                                                                                                                           +
                                                                                                                                                                                          +
                                                                                                                                                                                          Member Visibility +
                                                                                                                                                                                            +
                                                                                                                                                                                            • +
                                                                                                                                                                                            • +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          +

                                                                                                                                                                                          On This Page

                                                                                                                                                                                           +
                                                                                                                                                                                          +
                                                                                                                                                                                          Properties +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          diff --git a/docs/interfaces/EnrollmentFactor.html b/docs/interfaces/EnrollmentFactor.html index 26ffde1e..d5a7b854 100644 --- a/docs/interfaces/EnrollmentFactor.html +++ b/docs/interfaces/EnrollmentFactor.html @@ -1,4 +1,59 @@ -EnrollmentFactor | @auth0/auth0-react
                                                                                                                                                                                          @auth0/auth0-react
                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                            Interface EnrollmentFactor

                                                                                                                                                                                            Enrollment factor returned by getEnrollmentFactors

                                                                                                                                                                                            -
                                                                                                                                                                                            interface EnrollmentFactor {
                                                                                                                                                                                                type: string;
                                                                                                                                                                                            }
                                                                                                                                                                                            Index

                                                                                                                                                                                            Properties

                                                                                                                                                                                            type -

                                                                                                                                                                                            Properties

                                                                                                                                                                                            type: string

                                                                                                                                                                                            Type of enrollment factor available

                                                                                                                                                                                            -

                                                                                                                                                                                            Settings

                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                            On This Page

                                                                                                                                                                                            Properties
                                                                                                                                                                                            +EnrollmentFactor | @auth0/auth0-react
                                                                                                                                                                                            +
                                                                                                                                                                                            @auth0/auth0-react + +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              + +

                                                                                                                                                                                              Interface EnrollmentFactor

                                                                                                                                                                                              +
                                                                                                                                                                                              +

                                                                                                                                                                                              Enrollment factor returned by getEnrollmentFactors

                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              interface EnrollmentFactor {
                                                                                                                                                                                                  type: string;
                                                                                                                                                                                              }
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              Index
                                                                                                                                                                                               +
                                                                                                                                                                                              +
                                                                                                                                                                                              + +
                                                                                                                                                                                              type +
                                                                                                                                                                                              +
                                                                                                                                                                                              + +
                                                                                                                                                                                              +
                                                                                                                                                                                              + +
                                                                                                                                                                                              type: string
                                                                                                                                                                                              +

                                                                                                                                                                                              Type of enrollment factor available

                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              +

                                                                                                                                                                                              Settings

                                                                                                                                                                                               +
                                                                                                                                                                                              +
                                                                                                                                                                                              Member Visibility +
                                                                                                                                                                                                +
                                                                                                                                                                                                • +
                                                                                                                                                                                                • +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              +

                                                                                                                                                                                              On This Page

                                                                                                                                                                                               +
                                                                                                                                                                                              +
                                                                                                                                                                                              Properties +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              diff --git a/docs/interfaces/Factor.html b/docs/interfaces/Factor.html index 9a0fd836..76a40aa4 100644 --- a/docs/interfaces/Factor.html +++ b/docs/interfaces/Factor.html @@ -1,3 +1,60 @@ -Factor | @auth0/auth0-react
                                                                                                                                                                                              @auth0/auth0-react
                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                Interface Factor

                                                                                                                                                                                                interface Factor {
                                                                                                                                                                                                    type: AuthenticationMethodType;
                                                                                                                                                                                                    usage?: ("primary" | "secondary")[];
                                                                                                                                                                                                }
                                                                                                                                                                                                Index

                                                                                                                                                                                                Properties

                                                                                                                                                                                                type +Factor | @auth0/auth0-react
                                                                                                                                                                                                +
                                                                                                                                                                                                @auth0/auth0-react + +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + +

                                                                                                                                                                                                  Interface Factor

                                                                                                                                                                                                  +
                                                                                                                                                                                                  interface Factor {
                                                                                                                                                                                                      type: AuthenticationMethodType;
                                                                                                                                                                                                      usage?: ("primary" | "secondary")[];
                                                                                                                                                                                                  }
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Index
                                                                                                                                                                                                   +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + +
                                                                                                                                                                                                  type usage? -

                                                                                                                                                                                                  Properties

                                                                                                                                                                                                  type: AuthenticationMethodType
                                                                                                                                                                                                  usage?: ("primary" | "secondary")[]

                                                                                                                                                                                                  Settings

                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                  Properties
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + +
                                                                                                                                                                                                  type: AuthenticationMethodType
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + +
                                                                                                                                                                                                  usage?: ("primary" | "secondary")[]
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +

                                                                                                                                                                                                  Settings

                                                                                                                                                                                                   +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Member Visibility +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    • +
                                                                                                                                                                                                    • +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +

                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                   +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Properties +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  diff --git a/docs/interfaces/GetTokenSilentlyOptions.html b/docs/interfaces/GetTokenSilentlyOptions.html index 0894587f..a75c5c6f 100644 --- a/docs/interfaces/GetTokenSilentlyOptions.html +++ b/docs/interfaces/GetTokenSilentlyOptions.html @@ -1,25 +1,111 @@ -GetTokenSilentlyOptions | @auth0/auth0-react
                                                                                                                                                                                                  @auth0/auth0-react
                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                    Interface GetTokenSilentlyOptions

                                                                                                                                                                                                    interface GetTokenSilentlyOptions {
                                                                                                                                                                                                        authorizationParams?: {
                                                                                                                                                                                                            audience?: string;
                                                                                                                                                                                                            redirect_uri?: string;
                                                                                                                                                                                                            scope?: string;
                                                                                                                                                                                                            [key: string]: any;
                                                                                                                                                                                                        };
                                                                                                                                                                                                        cacheMode?: "on"
                                                                                                                                                                                                        | "off"
                                                                                                                                                                                                        | "cache-only";
                                                                                                                                                                                                        detailedResponse?: boolean;
                                                                                                                                                                                                        timeoutInSeconds?: number;
                                                                                                                                                                                                    }
                                                                                                                                                                                                    Index

                                                                                                                                                                                                    Properties

                                                                                                                                                                                                    authorizationParams? +GetTokenSilentlyOptions | @auth0/auth0-react
                                                                                                                                                                                                    +
                                                                                                                                                                                                    @auth0/auth0-react + +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + +

                                                                                                                                                                                                      Interface GetTokenSilentlyOptions

                                                                                                                                                                                                      +
                                                                                                                                                                                                      interface GetTokenSilentlyOptions {
                                                                                                                                                                                                          authorizationParams?: {
                                                                                                                                                                                                              audience?: string;
                                                                                                                                                                                                              redirect_uri?: string;
                                                                                                                                                                                                              scope?: string;
                                                                                                                                                                                                              [key: string]: any;
                                                                                                                                                                                                          };
                                                                                                                                                                                                          cacheMode?: "on"
                                                                                                                                                                                                          | "off"
                                                                                                                                                                                                          | "cache-only";
                                                                                                                                                                                                          detailedResponse?: boolean;
                                                                                                                                                                                                          timeoutInSeconds?: number;
                                                                                                                                                                                                      }
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Index
                                                                                                                                                                                                       +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + +
                                                                                                                                                                                                      authorizationParams? cacheMode? detailedResponse? timeoutInSeconds? -

                                                                                                                                                                                                      Properties

                                                                                                                                                                                                      authorizationParams?: {
                                                                                                                                                                                                          audience?: string;
                                                                                                                                                                                                          redirect_uri?: string;
                                                                                                                                                                                                          scope?: string;
                                                                                                                                                                                                          [key: string]: any;
                                                                                                                                                                                                      }

                                                                                                                                                                                                      Parameters that will be sent back to Auth0 as part of a request.

                                                                                                                                                                                                      -

                                                                                                                                                                                                      Type Declaration

                                                                                                                                                                                                      • [key: string]: any

                                                                                                                                                                                                        If you need to send custom parameters to the Authorization Server, +

                                                                                                                                                                                                      +
                                                                                                                                                                                                      + +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + +
                                                                                                                                                                                                      authorizationParams?: {
                                                                                                                                                                                                          audience?: string;
                                                                                                                                                                                                          redirect_uri?: string;
                                                                                                                                                                                                          scope?: string;
                                                                                                                                                                                                          [key: string]: any;
                                                                                                                                                                                                      }
                                                                                                                                                                                                      +

                                                                                                                                                                                                      Parameters that will be sent back to Auth0 as part of a request.

                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +

                                                                                                                                                                                                      Type Declaration

                                                                                                                                                                                                      +
                                                                                                                                                                                                        +
                                                                                                                                                                                                      • +
                                                                                                                                                                                                        [key: string]: any
                                                                                                                                                                                                        +

                                                                                                                                                                                                        If you need to send custom parameters to the Authorization Server, make sure to use the original parameter name.

                                                                                                                                                                                                        -
                                                                                                                                                                                                      • Optionalaudience?: string

                                                                                                                                                                                                        The audience that was used in the authentication request

                                                                                                                                                                                                        -
                                                                                                                                                                                                      • Optionalredirect_uri?: string

                                                                                                                                                                                                        There's no actual redirect when getting a token silently, +

                                                                                                                                                                                                        • +
                                                                                                                                                                                                      • +
                                                                                                                                                                                                        Optionalaudience?: string
                                                                                                                                                                                                        +

                                                                                                                                                                                                        The audience that was used in the authentication request

                                                                                                                                                                                                        +
                                                                                                                                                                                                        • +
                                                                                                                                                                                                      • +
                                                                                                                                                                                                        Optionalredirect_uri?: string
                                                                                                                                                                                                        +

                                                                                                                                                                                                        There's no actual redirect when getting a token silently, but, according to the spec, a redirect_uri param is required. Auth0 uses this parameter to validate that the current origin matches the redirect_uri origin when sending the response. It must be whitelisted in the "Allowed Web Origins" in your Auth0 Application's settings.

                                                                                                                                                                                                        -
                                                                                                                                                                                                      • Optionalscope?: string

                                                                                                                                                                                                        The scope that was used in the authentication request

                                                                                                                                                                                                        -
                                                                                                                                                                                                      cacheMode?: "on" | "off" | "cache-only"

                                                                                                                                                                                                      When off, ignores the cache and always sends a -request to Auth0. +

                                                                                                                                                                                                      +
                                                                                                                                                                                                    • +
                                                                                                                                                                                                      Optionalscope?: string
                                                                                                                                                                                                      +

                                                                                                                                                                                                      The scope that was used in the authentication request

                                                                                                                                                                                                      +
                                                                                                                                                                                                      • +
                                                                                                                                                                                                      + +
                                                                                                                                                                                                      cacheMode?: "on" | "off" | "cache-only"
                                                                                                                                                                                                      +

                                                                                                                                                                                                      When off, ignores the cache and always sends a +request to Auth0. Concurrent off calls are not deduplicated — each makes its own request. When cache-only, only reads from the cache and never sends a request to Auth0. Defaults to on, where it both reads from the cache and sends a request to Auth0 as needed.

                                                                                                                                                                                                      -
                                                                                                                                                                                                      detailedResponse?: boolean

                                                                                                                                                                                                      If true, the full response from the /oauth/token endpoint (or the cache, if the cache was used) is returned +

                                                                                                                                                                                                      +
                                                                                                                                                                                                      + +
                                                                                                                                                                                                      detailedResponse?: boolean
                                                                                                                                                                                                      +

                                                                                                                                                                                                      If true, the full response from the /oauth/token endpoint (or the cache, if the cache was used) is returned (minus refresh_token if one was issued). Otherwise, just the access token is returned.

                                                                                                                                                                                                      The default is false.

                                                                                                                                                                                                      -
                                                                                                                                                                                                      timeoutInSeconds?: number

                                                                                                                                                                                                      A maximum number of seconds to wait before declaring the background /authorize call as failed for timeout +

                                                                                                                                                                                                      +
                                                                                                                                                                                                      + +
                                                                                                                                                                                                      timeoutInSeconds?: number
                                                                                                                                                                                                      +

                                                                                                                                                                                                      A maximum number of seconds to wait before declaring the background /authorize call as failed for timeout Defaults to 60s.

                                                                                                                                                                                                      -

                                                                                                                                                                                                      Settings

                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                      Properties
                                                                                                                                                                                                      + +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +

                                                                                                                                                                                                      Settings

                                                                                                                                                                                                       +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Member Visibility +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        • +
                                                                                                                                                                                                        • +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +

                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                       +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Properties +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      diff --git a/docs/interfaces/GetTokenWithPopupOptions.html b/docs/interfaces/GetTokenWithPopupOptions.html index 1f6a68cf..5f0ba507 100644 --- a/docs/interfaces/GetTokenWithPopupOptions.html +++ b/docs/interfaces/GetTokenWithPopupOptions.html @@ -1,8 +1,74 @@ -GetTokenWithPopupOptions | @auth0/auth0-react
                                                                                                                                                                                                      @auth0/auth0-react
                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                        Interface GetTokenWithPopupOptions

                                                                                                                                                                                                        interface GetTokenWithPopupOptions {
                                                                                                                                                                                                            authorizationParams?: AuthorizationParams;
                                                                                                                                                                                                            cacheMode?: "on" | "off" | "cache-only";
                                                                                                                                                                                                        }

                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                        Index

                                                                                                                                                                                                        Properties

                                                                                                                                                                                                        authorizationParams? +GetTokenWithPopupOptions | @auth0/auth0-react
                                                                                                                                                                                                        +
                                                                                                                                                                                                        @auth0/auth0-react + +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + +

                                                                                                                                                                                                          Interface GetTokenWithPopupOptions

                                                                                                                                                                                                          +
                                                                                                                                                                                                          interface GetTokenWithPopupOptions {
                                                                                                                                                                                                              authorizationParams?: AuthorizationParams;
                                                                                                                                                                                                              cacheMode?: "on" | "off" | "cache-only";
                                                                                                                                                                                                          }
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +

                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Index
                                                                                                                                                                                                           +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + +
                                                                                                                                                                                                          authorizationParams? cacheMode? -

                                                                                                                                                                                                          Properties

                                                                                                                                                                                                          authorizationParams?: AuthorizationParams

                                                                                                                                                                                                          URL parameters that will be sent back to the Authorization Server. This can be known parameters +

                                                                                                                                                                                                          +
                                                                                                                                                                                                          + +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + +
                                                                                                                                                                                                          authorizationParams?: AuthorizationParams
                                                                                                                                                                                                          +

                                                                                                                                                                                                          URL parameters that will be sent back to the Authorization Server. This can be known parameters defined by Auth0 or custom parameters that you define.

                                                                                                                                                                                                          -
                                                                                                                                                                                                          cacheMode?: "on" | "off" | "cache-only"

                                                                                                                                                                                                          When off, ignores the cache and always sends a request to Auth0. +

                                                                                                                                                                                                          +
                                                                                                                                                                                                          + +
                                                                                                                                                                                                          cacheMode?: "on" | "off" | "cache-only"
                                                                                                                                                                                                          +

                                                                                                                                                                                                          When off, ignores the cache and always sends a request to Auth0. When cache-only, only reads from the cache and never sends a request to Auth0. Defaults to on, where it both reads from the cache and sends a request to Auth0 as needed.

                                                                                                                                                                                                          -

                                                                                                                                                                                                          Settings

                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                          Properties
                                                                                                                                                                                                          + +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +

                                                                                                                                                                                                          Settings

                                                                                                                                                                                                           +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Member Visibility +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            • +
                                                                                                                                                                                                            • +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +

                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                           +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Properties +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          diff --git a/docs/interfaces/ICache.html b/docs/interfaces/ICache.html index f905521b..3c8d4cb0 100644 --- a/docs/interfaces/ICache.html +++ b/docs/interfaces/ICache.html @@ -1,5 +1,113 @@ -ICache | @auth0/auth0-react
                                                                                                                                                                                                          @auth0/auth0-react
                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                            Interface ICache

                                                                                                                                                                                                            interface ICache {
                                                                                                                                                                                                                allKeys?(): MaybePromise<string[]>;
                                                                                                                                                                                                                get<T = Cacheable>(key: string): MaybePromise<T | undefined>;
                                                                                                                                                                                                                remove(key: string): MaybePromise<void>;
                                                                                                                                                                                                                set<T = Cacheable>(key: string, entry: T): MaybePromise<void>;
                                                                                                                                                                                                            }

                                                                                                                                                                                                            Implemented by

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Methods

                                                                                                                                                                                                            allKeys? +ICache | @auth0/auth0-react
                                                                                                                                                                                                            +
                                                                                                                                                                                                            @auth0/auth0-react + +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + +

                                                                                                                                                                                                              Interface ICache

                                                                                                                                                                                                              +
                                                                                                                                                                                                              interface ICache {
                                                                                                                                                                                                                  allKeys?(): MaybePromise<string[]>;
                                                                                                                                                                                                                  get<T = Cacheable>(key: string): MaybePromise<T | undefined>;
                                                                                                                                                                                                                  remove(key: string): MaybePromise<void>;
                                                                                                                                                                                                                  set<T = Cacheable>(key: string, entry: T): MaybePromise<void>;
                                                                                                                                                                                                              }
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +

                                                                                                                                                                                                              Implemented by

                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Index
                                                                                                                                                                                                               +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + +
                                                                                                                                                                                                              allKeys? get remove set -

                                                                                                                                                                                                              Methods

                                                                                                                                                                                                              • Returns MaybePromise<string[]>

                                                                                                                                                                                                              • Type Parameters

                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                • key: string

                                                                                                                                                                                                                Returns MaybePromise<T | undefined>

                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                • key: string

                                                                                                                                                                                                                Returns MaybePromise<void>

                                                                                                                                                                                                              • Type Parameters

                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                • key: string
                                                                                                                                                                                                                • entry: T

                                                                                                                                                                                                                Returns MaybePromise<void>

                                                                                                                                                                                                              Settings

                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                              Methods
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + +
                                                                                                                                                                                                                +
                                                                                                                                                                                                              • + +
                                                                                                                                                                                                                +

                                                                                                                                                                                                                Returns MaybePromise<string[]>

                                                                                                                                                                                                              +
                                                                                                                                                                                                              + +
                                                                                                                                                                                                                +
                                                                                                                                                                                                              • + +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +

                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +

                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                • key: string
                                                                                                                                                                                                                +

                                                                                                                                                                                                                Returns MaybePromise<T | undefined>

                                                                                                                                                                                                              +
                                                                                                                                                                                                              + +
                                                                                                                                                                                                                +
                                                                                                                                                                                                              • + +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +

                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                • key: string
                                                                                                                                                                                                                +

                                                                                                                                                                                                                Returns MaybePromise<void>

                                                                                                                                                                                                              +
                                                                                                                                                                                                              + +
                                                                                                                                                                                                                +
                                                                                                                                                                                                              • + +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +

                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +

                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                • key: string
                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                • entry: T
                                                                                                                                                                                                                +

                                                                                                                                                                                                                Returns MaybePromise<void>

                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +

                                                                                                                                                                                                              Settings

                                                                                                                                                                                                               +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Member Visibility +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                • +
                                                                                                                                                                                                                • +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +

                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                               +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Methods +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              diff --git a/docs/interfaces/IdToken.html b/docs/interfaces/IdToken.html index 503413af..c8570243 100644 --- a/docs/interfaces/IdToken.html +++ b/docs/interfaces/IdToken.html @@ -1,4 +1,31 @@ -IdToken | @auth0/auth0-react
                                                                                                                                                                                                              @auth0/auth0-react
                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                Interface IdToken

                                                                                                                                                                                                                interface IdToken {
                                                                                                                                                                                                                    __raw: string;
                                                                                                                                                                                                                    acr?: string;
                                                                                                                                                                                                                    act?: ActClaim;
                                                                                                                                                                                                                    address?: string;
                                                                                                                                                                                                                    amr?: string[];
                                                                                                                                                                                                                    at_hash?: string;
                                                                                                                                                                                                                    aud?: string;
                                                                                                                                                                                                                    auth_time?: string;
                                                                                                                                                                                                                    azp?: string;
                                                                                                                                                                                                                    birthdate?: string;
                                                                                                                                                                                                                    c_hash?: string;
                                                                                                                                                                                                                    cnf?: string;
                                                                                                                                                                                                                    email?: string;
                                                                                                                                                                                                                    email_verified?: boolean;
                                                                                                                                                                                                                    exp?: number;
                                                                                                                                                                                                                    family_name?: string;
                                                                                                                                                                                                                    gender?: string;
                                                                                                                                                                                                                    given_name?: string;
                                                                                                                                                                                                                    iat?: number;
                                                                                                                                                                                                                    iss?: string;
                                                                                                                                                                                                                    jti?: string;
                                                                                                                                                                                                                    locale?: string;
                                                                                                                                                                                                                    middle_name?: string;
                                                                                                                                                                                                                    name?: string;
                                                                                                                                                                                                                    nbf?: number;
                                                                                                                                                                                                                    nickname?: string;
                                                                                                                                                                                                                    nonce?: string;
                                                                                                                                                                                                                    org_id?: string;
                                                                                                                                                                                                                    org_name?: string;
                                                                                                                                                                                                                    phone_number?: string;
                                                                                                                                                                                                                    phone_number_verified?: boolean;
                                                                                                                                                                                                                    picture?: string;
                                                                                                                                                                                                                    preferred_username?: string;
                                                                                                                                                                                                                    profile?: string;
                                                                                                                                                                                                                    session_expiry?: number;
                                                                                                                                                                                                                    sid?: string;
                                                                                                                                                                                                                    sub_jwk?: string;
                                                                                                                                                                                                                    updated_at?: string;
                                                                                                                                                                                                                    website?: string;
                                                                                                                                                                                                                    zoneinfo?: string;
                                                                                                                                                                                                                    [key: string]: any;
                                                                                                                                                                                                                }

                                                                                                                                                                                                                Indexable

                                                                                                                                                                                                                • [key: string]: any
                                                                                                                                                                                                                Index

                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                __raw +IdToken | @auth0/auth0-react
                                                                                                                                                                                                                +
                                                                                                                                                                                                                @auth0/auth0-react + +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                  Interface IdToken

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  interface IdToken {
                                                                                                                                                                                                                      __raw: string;
                                                                                                                                                                                                                      acr?: string;
                                                                                                                                                                                                                      act?: ActClaim;
                                                                                                                                                                                                                      address?: string;
                                                                                                                                                                                                                      amr?: string[];
                                                                                                                                                                                                                      at_hash?: string;
                                                                                                                                                                                                                      aud?: string;
                                                                                                                                                                                                                      auth_time?: string;
                                                                                                                                                                                                                      azp?: string;
                                                                                                                                                                                                                      birthdate?: string;
                                                                                                                                                                                                                      c_hash?: string;
                                                                                                                                                                                                                      cnf?: string;
                                                                                                                                                                                                                      email?: string;
                                                                                                                                                                                                                      email_verified?: boolean;
                                                                                                                                                                                                                      exp?: number;
                                                                                                                                                                                                                      family_name?: string;
                                                                                                                                                                                                                      gender?: string;
                                                                                                                                                                                                                      given_name?: string;
                                                                                                                                                                                                                      iat?: number;
                                                                                                                                                                                                                      iss?: string;
                                                                                                                                                                                                                      jti?: string;
                                                                                                                                                                                                                      locale?: string;
                                                                                                                                                                                                                      middle_name?: string;
                                                                                                                                                                                                                      name?: string;
                                                                                                                                                                                                                      nbf?: number;
                                                                                                                                                                                                                      nickname?: string;
                                                                                                                                                                                                                      nonce?: string;
                                                                                                                                                                                                                      org_id?: string;
                                                                                                                                                                                                                      org_name?: string;
                                                                                                                                                                                                                      phone_number?: string;
                                                                                                                                                                                                                      phone_number_verified?: boolean;
                                                                                                                                                                                                                      picture?: string;
                                                                                                                                                                                                                      preferred_username?: string;
                                                                                                                                                                                                                      profile?: string;
                                                                                                                                                                                                                      session_expiry?: number;
                                                                                                                                                                                                                      sid?: string;
                                                                                                                                                                                                                      sub_jwk?: string;
                                                                                                                                                                                                                      updated_at?: string;
                                                                                                                                                                                                                      website?: string;
                                                                                                                                                                                                                      zoneinfo?: string;
                                                                                                                                                                                                                      [key: string]: any;
                                                                                                                                                                                                                  }
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  Indexable

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                    [key: string]: any
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  Index
                                                                                                                                                                                                                   +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  __raw acr? act? address? @@ -38,9 +65,236 @@ updated_at? website? zoneinfo? -

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  __raw

                                                                                                                                                                                                                  __raw: string
                                                                                                                                                                                                                  acr?: string
                                                                                                                                                                                                                  act?: ActClaim

                                                                                                                                                                                                                  The actor claim, present in ID tokens returned via token exchange responses. +

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  __raw

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  __raw: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  acr?: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  act?: ActClaim
                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  The actor claim, present in ID tokens returned via token exchange responses. Identifies the acting party that has been delegated authority to act on behalf of the subject. Set via Auth0 Actions using the setActor command.

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  address?: string
                                                                                                                                                                                                                  amr?: string[]
                                                                                                                                                                                                                  at_hash?: string
                                                                                                                                                                                                                  aud?: string
                                                                                                                                                                                                                  auth_time?: string
                                                                                                                                                                                                                  azp?: string
                                                                                                                                                                                                                  birthdate?: string
                                                                                                                                                                                                                  c_hash?: string
                                                                                                                                                                                                                  cnf?: string
                                                                                                                                                                                                                  email?: string
                                                                                                                                                                                                                  email_verified?: boolean
                                                                                                                                                                                                                  exp?: number
                                                                                                                                                                                                                  family_name?: string
                                                                                                                                                                                                                  gender?: string
                                                                                                                                                                                                                  given_name?: string
                                                                                                                                                                                                                  iat?: number
                                                                                                                                                                                                                  iss?: string
                                                                                                                                                                                                                  jti?: string
                                                                                                                                                                                                                  locale?: string
                                                                                                                                                                                                                  middle_name?: string
                                                                                                                                                                                                                  name?: string
                                                                                                                                                                                                                  nbf?: number
                                                                                                                                                                                                                  nickname?: string
                                                                                                                                                                                                                  nonce?: string
                                                                                                                                                                                                                  org_id?: string
                                                                                                                                                                                                                  org_name?: string
                                                                                                                                                                                                                  phone_number?: string
                                                                                                                                                                                                                  phone_number_verified?: boolean
                                                                                                                                                                                                                  picture?: string
                                                                                                                                                                                                                  preferred_username?: string
                                                                                                                                                                                                                  profile?: string
                                                                                                                                                                                                                  session_expiry?: number

                                                                                                                                                                                                                  IPSIE session expiry ceiling (Unix timestamp in seconds). +

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  address?: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  amr?: string[]
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  at_hash?: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  aud?: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  auth_time?: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  azp?: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  birthdate?: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  c_hash?: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  cnf?: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  email?: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  email_verified?: boolean
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  exp?: number
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  family_name?: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  gender?: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  given_name?: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  iat?: number
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  iss?: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  jti?: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  locale?: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  middle_name?: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  name?: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  nbf?: number
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  nickname?: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  nonce?: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  org_id?: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  org_name?: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  phone_number?: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  phone_number_verified?: boolean
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  picture?: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  preferred_username?: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  profile?: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  session_expiry?: number
                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  IPSIE session expiry ceiling (Unix timestamp in seconds). When present, the SDK will not return tokens after this point in time.

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  sid?: string
                                                                                                                                                                                                                  sub_jwk?: string
                                                                                                                                                                                                                  updated_at?: string
                                                                                                                                                                                                                  website?: string
                                                                                                                                                                                                                  zoneinfo?: string

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  sid?: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  sub_jwk?: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  updated_at?: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  website?: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  zoneinfo?: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                   +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  Member Visibility +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                   +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  Properties +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  diff --git a/docs/interfaces/LogoutOptions.html b/docs/interfaces/LogoutOptions.html index 4d3f1f81..c9acf6c0 100644 --- a/docs/interfaces/LogoutOptions.html +++ b/docs/interfaces/LogoutOptions.html @@ -1,18 +1,72 @@ -LogoutOptions | @auth0/auth0-react
                                                                                                                                                                                                                  @auth0/auth0-react
                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                    Interface LogoutOptions

                                                                                                                                                                                                                    interface LogoutOptions {
                                                                                                                                                                                                                        clientId?: string | null;
                                                                                                                                                                                                                        logoutParams?: {
                                                                                                                                                                                                                            federated?: boolean;
                                                                                                                                                                                                                            returnTo?: string;
                                                                                                                                                                                                                            [key: string]: any;
                                                                                                                                                                                                                        };
                                                                                                                                                                                                                        openUrl?: false
                                                                                                                                                                                                                        | ((url: string) => void | Promise<void>);
                                                                                                                                                                                                                    }

                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                    • Omit<SPALogoutOptions, "onRedirect">
                                                                                                                                                                                                                      • LogoutOptions
                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                    clientId? +LogoutOptions | @auth0/auth0-react
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    @auth0/auth0-react + +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                      Interface LogoutOptions

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      interface LogoutOptions {
                                                                                                                                                                                                                          clientId?: string | null;
                                                                                                                                                                                                                          logoutParams?: {
                                                                                                                                                                                                                              federated?: boolean;
                                                                                                                                                                                                                              returnTo?: string;
                                                                                                                                                                                                                              [key: string]: any;
                                                                                                                                                                                                                          };
                                                                                                                                                                                                                          openUrl?: false
                                                                                                                                                                                                                          | ((url: string) => void | Promise<void>);
                                                                                                                                                                                                                      }
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +

                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                      • Omit<SPALogoutOptions, "onRedirect"> +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                        • LogoutOptions
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      Index
                                                                                                                                                                                                                       +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                      clientId? logoutParams? openUrl? -

                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                      clientId?: string | null

                                                                                                                                                                                                                      The clientId of your application.

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                      clientId?: string | null
                                                                                                                                                                                                                      +

                                                                                                                                                                                                                      The clientId of your application.

                                                                                                                                                                                                                      If this property is not set, then the clientId that was used during initialization of the SDK is sent to the logout endpoint.

                                                                                                                                                                                                                      If this property is set to null, then no client ID value is sent to the logout endpoint.

                                                                                                                                                                                                                      Read more about how redirecting after logout works

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      logoutParams?: { federated?: boolean; returnTo?: string; [key: string]: any }

                                                                                                                                                                                                                      Parameters to pass to the logout endpoint. This can be known parameters defined by Auth0 or custom parameters +

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                      logoutParams?: { federated?: boolean; returnTo?: string; [key: string]: any }
                                                                                                                                                                                                                      +

                                                                                                                                                                                                                      Parameters to pass to the logout endpoint. This can be known parameters defined by Auth0 or custom parameters you wish to provide.

                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Type Declaration

                                                                                                                                                                                                                      • [key: string]: any

                                                                                                                                                                                                                        If you need to send custom parameters to the logout endpoint, make sure to use the original parameter name.

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                      • Optionalfederated?: boolean

                                                                                                                                                                                                                        When supported by the upstream identity provider, +

                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +

                                                                                                                                                                                                                        Type Declaration

                                                                                                                                                                                                                        +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                          [key: string]: any
                                                                                                                                                                                                                          +

                                                                                                                                                                                                                          If you need to send custom parameters to the logout endpoint, make sure to use the original parameter name.

                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                          Optionalfederated?: boolean
                                                                                                                                                                                                                          +

                                                                                                                                                                                                                          When supported by the upstream identity provider, forces the user to logout of their identity provider and from Auth0. Read more about how federated logout works at Auth0

                                                                                                                                                                                                                          -
                                                                                                                                                                                                                        • OptionalreturnTo?: string

                                                                                                                                                                                                                          The URL where Auth0 will redirect your browser to after the logout.

                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                          OptionalreturnTo?: string
                                                                                                                                                                                                                          +

                                                                                                                                                                                                                          The URL where Auth0 will redirect your browser to after the logout.

                                                                                                                                                                                                                          Note: If the client_id parameter is included, the returnTo URL that is provided must be listed in the Application's "Allowed Logout URLs" in the Auth0 dashboard. @@ -20,12 +74,49 @@ returnTo URL must be listed in the "Allowed Logout URLs" at the account level in the Auth0 dashboard.

                                                                                                                                                                                                                          Read more about how redirecting after logout works

                                                                                                                                                                                                                          -
                                                                                                                                                                                                                      openUrl?: false | ((url: string) => void | Promise<void>)

                                                                                                                                                                                                                      Used to control the redirect and not rely on the SDK to do the actual redirect.

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                      openUrl?: false | ((url: string) => void | Promise<void>)
                                                                                                                                                                                                                      +

                                                                                                                                                                                                                      Used to control the redirect and not rely on the SDK to do the actual redirect.

                                                                                                                                                                                                                      Set to false to disable the redirect, or provide a function to handle the actual redirect yourself.

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      await auth0.logout({
                                                                                                                                                                                                                        openUrl(url) {
                                                                                                                                                                                                                          window.location.replace(url);
                                                                                                                                                                                                                        }
                                                                                                                                                                                                                      });
+
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      await auth0.logout({
                                                                                                                                                                                                                        openUrl(url) {
                                                                                                                                                                                                                          window.location.replace(url);
                                                                                                                                                                                                                        }
                                                                                                                                                                                                                      });
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      import { Browser } from '@capacitor/browser';

                                                                                                                                                                                                                      await auth0.logout({
                                                                                                                                                                                                                        async openUrl(url) {
                                                                                                                                                                                                                          await Browser.open({ url });
                                                                                                                                                                                                                        }
                                                                                                                                                                                                                      });
+
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      import { Browser } from '@capacitor/browser';

                                                                                                                                                                                                                      await auth0.logout({
                                                                                                                                                                                                                        async openUrl(url) {
                                                                                                                                                                                                                          await Browser.open({ url });
                                                                                                                                                                                                                        }
                                                                                                                                                                                                                      });
                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +

                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                       +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      Member Visibility +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +

                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                       +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      Properties +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      diff --git a/docs/interfaces/LogoutUrlOptions.html b/docs/interfaces/LogoutUrlOptions.html index 7566a653..32e914ee 100644 --- a/docs/interfaces/LogoutUrlOptions.html +++ b/docs/interfaces/LogoutUrlOptions.html @@ -1,17 +1,64 @@ -LogoutUrlOptions | @auth0/auth0-react
                                                                                                                                                                                                                      @auth0/auth0-react
                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                        Interface LogoutUrlOptions

                                                                                                                                                                                                                        interface LogoutUrlOptions {
                                                                                                                                                                                                                            clientId?: string | null;
                                                                                                                                                                                                                            logoutParams?: {
                                                                                                                                                                                                                                federated?: boolean;
                                                                                                                                                                                                                                returnTo?: string;
                                                                                                                                                                                                                                [key: string]: any;
                                                                                                                                                                                                                            };
                                                                                                                                                                                                                        }
                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                        clientId? +LogoutUrlOptions | @auth0/auth0-react
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        @auth0/auth0-react + +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                          Interface LogoutUrlOptions

                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          interface LogoutUrlOptions {
                                                                                                                                                                                                                              clientId?: string | null;
                                                                                                                                                                                                                              logoutParams?: {
                                                                                                                                                                                                                                  federated?: boolean;
                                                                                                                                                                                                                                  returnTo?: string;
                                                                                                                                                                                                                                  [key: string]: any;
                                                                                                                                                                                                                              };
                                                                                                                                                                                                                          }
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          Index
                                                                                                                                                                                                                           +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                          clientId? logoutParams? -

                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                          clientId?: string | null

                                                                                                                                                                                                                          The clientId of your application.

                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                          clientId?: string | null
                                                                                                                                                                                                                          +

                                                                                                                                                                                                                          The clientId of your application.

                                                                                                                                                                                                                          If this property is not set, then the clientId that was used during initialization of the SDK is sent to the logout endpoint.

                                                                                                                                                                                                                          If this property is set to null, then no client ID value is sent to the logout endpoint.

                                                                                                                                                                                                                          Read more about how redirecting after logout works

                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          logoutParams?: { federated?: boolean; returnTo?: string; [key: string]: any }

                                                                                                                                                                                                                          Parameters to pass to the logout endpoint. This can be known parameters defined by Auth0 or custom parameters +

                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                          logoutParams?: { federated?: boolean; returnTo?: string; [key: string]: any }
                                                                                                                                                                                                                          +

                                                                                                                                                                                                                          Parameters to pass to the logout endpoint. This can be known parameters defined by Auth0 or custom parameters you wish to provide.

                                                                                                                                                                                                                          -

                                                                                                                                                                                                                          Type Declaration

                                                                                                                                                                                                                          • [key: string]: any

                                                                                                                                                                                                                            If you need to send custom parameters to the logout endpoint, make sure to use the original parameter name.

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                          • Optionalfederated?: boolean

                                                                                                                                                                                                                            When supported by the upstream identity provider, +

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +

                                                                                                                                                                                                                            Type Declaration

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                              [key: string]: any
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              If you need to send custom parameters to the logout endpoint, make sure to use the original parameter name.

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                              Optionalfederated?: boolean
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              When supported by the upstream identity provider, forces the user to logout of their identity provider and from Auth0. Read more about how federated logout works at Auth0

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                            • OptionalreturnTo?: string

                                                                                                                                                                                                                              The URL where Auth0 will redirect your browser to after the logout.

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                              OptionalreturnTo?: string
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              The URL where Auth0 will redirect your browser to after the logout.

                                                                                                                                                                                                                              Note: If the client_id parameter is included, the returnTo URL that is provided must be listed in the Application's "Allowed Logout URLs" in the Auth0 dashboard. @@ -19,4 +66,28 @@ returnTo URL must be listed in the "Allowed Logout URLs" at the account level in the Auth0 dashboard.

                                                                                                                                                                                                                              Read more about how redirecting after logout works

                                                                                                                                                                                                                              -

                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +

                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                           +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          Member Visibility +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +

                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                           +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          Properties +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          diff --git a/docs/interfaces/MfaApiClient.html b/docs/interfaces/MfaApiClient.html index 4afe94ba..4fa0460d 100644 --- a/docs/interfaces/MfaApiClient.html +++ b/docs/interfaces/MfaApiClient.html @@ -1,4 +1,17 @@ -MfaApiClient | @auth0/auth0-react
                                                                                                                                                                                                                          @auth0/auth0-react
                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                            Interface MfaApiClient

                                                                                                                                                                                                                            Client for Auth0 MFA API operations

                                                                                                                                                                                                                            +MfaApiClient | @auth0/auth0-react
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            @auth0/auth0-react + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                              Interface MfaApiClient

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              Client for Auth0 MFA API operations

                                                                                                                                                                                                                              Manages multi-factor authentication including:

                                                                                                                                                                                                                              • Listing enrolled authenticators
                                                                                                                                                                                                                                • @@ -10,86 +23,260 @@ backward compatibility with the existing spa-js API.

                                                                                                                                                                                                                                MFA context (scope, audience) is stored internally keyed by mfaToken, enabling concurrent MFA flows without state conflicts.

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                              try {
                                                                                                                                                                                                                                await auth0.getTokenSilently({ authorizationParams: { audience: 'https://api.example.com' } });
                                                                                                                                                                                                                              } catch (e) {
                                                                                                                                                                                                                                if (e instanceof MfaRequiredError) {
                                                                                                                                                                                                                                  // SDK automatically stores context for this mfaToken
                                                                                                                                                                                                                                  const authenticators = await auth0.mfa.getAuthenticators({ mfaToken: e.mfa_token });
                                                                                                                                                                                                                                  // ... complete MFA flow
                                                                                                                                                                                                                                }
                                                                                                                                                                                                                              }
+
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              try {
                                                                                                                                                                                                                                await auth0.getTokenSilently({ authorizationParams: { audience: 'https://api.example.com' } });
                                                                                                                                                                                                                              } catch (e) {
                                                                                                                                                                                                                                if (e instanceof MfaRequiredError) {
                                                                                                                                                                                                                                  // SDK automatically stores context for this mfaToken
                                                                                                                                                                                                                                  const authenticators = await auth0.mfa.getAuthenticators({ mfaToken: e.mfa_token });
                                                                                                                                                                                                                                  // ... complete MFA flow
                                                                                                                                                                                                                                }
                                                                                                                                                                                                                              }
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              interface MfaApiClient {
                                                                                                                                                                                                                                  challenge(
                                                                                                                                                                                                                                      params: ChallengeAuthenticatorParams,
                                                                                                                                                                                                                                  ): Promise<ChallengeResponse>;
                                                                                                                                                                                                                                  enroll(params: EnrollParams): Promise<EnrollmentResponse>;
                                                                                                                                                                                                                                  getAuthenticators(mfaToken: string): Promise<Authenticator[]>;
                                                                                                                                                                                                                                  getEnrollmentFactors(mfaToken: string): Promise<EnrollmentFactor[]>;
                                                                                                                                                                                                                                  setMFAAuthDetails(
                                                                                                                                                                                                                                      mfaToken: string,
                                                                                                                                                                                                                                      scope?: string,
                                                                                                                                                                                                                                      audience?: string,
                                                                                                                                                                                                                                      mfaRequirements?: MfaRequirements,
                                                                                                                                                                                                                                  ): void;
                                                                                                                                                                                                                                  verify(params: VerifyParams): Promise<TokenEndpointResponse>;
                                                                                                                                                                                                                              }
                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                              challenge +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              interface MfaApiClient {
                                                                                                                                                                                                                                  challenge(
                                                                                                                                                                                                                                      params: ChallengeAuthenticatorParams,
                                                                                                                                                                                                                                  ): Promise<ChallengeResponse>;
                                                                                                                                                                                                                                  enroll(params: EnrollParams): Promise<EnrollmentResponse>;
                                                                                                                                                                                                                                  getAuthenticators(mfaToken: string): Promise<Authenticator[]>;
                                                                                                                                                                                                                                  getEnrollmentFactors(mfaToken: string): Promise<EnrollmentFactor[]>;
                                                                                                                                                                                                                                  setMFAAuthDetails(
                                                                                                                                                                                                                                      mfaToken: string,
                                                                                                                                                                                                                                      scope?: string,
                                                                                                                                                                                                                                      audience?: string,
                                                                                                                                                                                                                                      mfaRequirements?: MfaRequirements,
                                                                                                                                                                                                                                  ): void;
                                                                                                                                                                                                                                  verify(params: VerifyParams): Promise<TokenEndpointResponse>;
                                                                                                                                                                                                                              }
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              Index
                                                                                                                                                                                                                               +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              challenge enroll getAuthenticators getEnrollmentFactors setMFAAuthDetails verify -

                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                              • + +
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                Initiates an MFA challenge

                                                                                                                                                                                                                                Sends OTP via SMS, initiates push notification, or prepares for OTP entry

                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                Returns Promise<ChallengeResponse>

                                                                                                                                                                                                                                Challenge response with oobCode if applicable

                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                If challenge initiation fails

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                const challenge = await mfa.challenge({
                                                                                                                                                                                                                                  mfaToken: mfaTokenFromLogin,
                                                                                                                                                                                                                                  challengeType: 'otp',
                                                                                                                                                                                                                                  authenticatorId: 'otp|dev_xxx'
                                                                                                                                                                                                                                });
                                                                                                                                                                                                                                // User enters OTP from their authenticator app
+
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                Returns Promise<ChallengeResponse>

                                                                                                                                                                                                                                Challenge response with oobCode if applicable

                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                If challenge initiation fails

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                const challenge = await mfa.challenge({
                                                                                                                                                                                                                                  mfaToken: mfaTokenFromLogin,
                                                                                                                                                                                                                                  challengeType: 'otp',
                                                                                                                                                                                                                                  authenticatorId: 'otp|dev_xxx'
                                                                                                                                                                                                                                });
                                                                                                                                                                                                                                // User enters OTP from their authenticator app
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                const challenge = await mfa.challenge({
                                                                                                                                                                                                                                  mfaToken: mfaTokenFromLogin,
                                                                                                                                                                                                                                  challengeType: 'oob',
                                                                                                                                                                                                                                  authenticatorId: 'sms|dev_xxx'
                                                                                                                                                                                                                                });
                                                                                                                                                                                                                                console.log(challenge.oobCode); // Use for verification
+
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                const challenge = await mfa.challenge({
                                                                                                                                                                                                                                  mfaToken: mfaTokenFromLogin,
                                                                                                                                                                                                                                  challengeType: 'oob',
                                                                                                                                                                                                                                  authenticatorId: 'sms|dev_xxx'
                                                                                                                                                                                                                                });
                                                                                                                                                                                                                                console.log(challenge.oobCode); // Use for verification
                                                                                                                                                                                                                                -

                                                                                                                                                                                                                              • Enrolls a new MFA authenticator

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                              • + +
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                Enrolls a new MFA authenticator

                                                                                                                                                                                                                                Requires MFA access token with 'enroll' scope

                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                • params: EnrollParams

                                                                                                                                                                                                                                  Enrollment parameters including mfaToken and factorType

                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                Returns Promise<EnrollmentResponse>

                                                                                                                                                                                                                                Enrollment response with authenticator details

                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                If enrollment fails

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                const enrollment = await mfa.enroll({
                                                                                                                                                                                                                                  mfaToken: mfaToken,
                                                                                                                                                                                                                                  factorType: 'otp'
                                                                                                                                                                                                                                });
                                                                                                                                                                                                                                console.log(enrollment.secret); // Base32 secret
                                                                                                                                                                                                                                console.log(enrollment.barcodeUri); // QR code URI
+
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                • params: EnrollParams +

                                                                                                                                                                                                                                  Enrollment parameters including mfaToken and factorType

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                Returns Promise<EnrollmentResponse>

                                                                                                                                                                                                                                Enrollment response with authenticator details

                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                If enrollment fails

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                const enrollment = await mfa.enroll({
                                                                                                                                                                                                                                  mfaToken: mfaToken,
                                                                                                                                                                                                                                  factorType: 'otp'
                                                                                                                                                                                                                                });
                                                                                                                                                                                                                                console.log(enrollment.secret); // Base32 secret
                                                                                                                                                                                                                                console.log(enrollment.barcodeUri); // QR code URI
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                const enrollment = await mfa.enroll({
                                                                                                                                                                                                                                  mfaToken: mfaToken,
                                                                                                                                                                                                                                  factorType: 'sms',
                                                                                                                                                                                                                                  phoneNumber: '+12025551234'
                                                                                                                                                                                                                                });
+
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                const enrollment = await mfa.enroll({
                                                                                                                                                                                                                                  mfaToken: mfaToken,
                                                                                                                                                                                                                                  factorType: 'sms',
                                                                                                                                                                                                                                  phoneNumber: '+12025551234'
                                                                                                                                                                                                                                });
                                                                                                                                                                                                                                -

                                                                                                                                                                                                                              • Gets enrolled MFA authenticators filtered by challenge types from context.

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                              • + +
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                Gets enrolled MFA authenticators filtered by challenge types from context.

                                                                                                                                                                                                                                Challenge types are automatically resolved from the stored MFA context (set when mfa_required error occurred).

                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                • mfaToken: string

                                                                                                                                                                                                                                  MFA token from mfa_required error

                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                Returns Promise<Authenticator[]>

                                                                                                                                                                                                                                Array of enrolled authenticators matching the challenge types

                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                If the request fails or context not found

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                try {
                                                                                                                                                                                                                                  await auth0.getTokenSilently();
                                                                                                                                                                                                                                } catch (e) {
                                                                                                                                                                                                                                  if (e instanceof MfaRequiredError) {
                                                                                                                                                                                                                                    // SDK automatically uses challenge types from error context
                                                                                                                                                                                                                                    const authenticators = await auth0.mfa.getAuthenticators(e.mfa_token);
                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                }
+
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                • mfaToken: string +

                                                                                                                                                                                                                                  MFA token from mfa_required error

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                Returns Promise<Authenticator[]>

                                                                                                                                                                                                                                Array of enrolled authenticators matching the challenge types

                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                If the request fails or context not found

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                try {
                                                                                                                                                                                                                                  await auth0.getTokenSilently();
                                                                                                                                                                                                                                } catch (e) {
                                                                                                                                                                                                                                  if (e instanceof MfaRequiredError) {
                                                                                                                                                                                                                                    // SDK automatically uses challenge types from error context
                                                                                                                                                                                                                                    const authenticators = await auth0.mfa.getAuthenticators(e.mfa_token);
                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                -

                                                                                                                                                                                                                              • Gets available MFA enrollment factors from the stored context.

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                              • + +
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                Gets available MFA enrollment factors from the stored context.

                                                                                                                                                                                                                                This method exposes the enrollment options from the mfa_required error's mfaRequirements.enroll array, eliminating the need for manual parsing.

                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                • mfaToken: string

                                                                                                                                                                                                                                  MFA token from mfa_required error

                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                Returns Promise<EnrollmentFactor[]>

                                                                                                                                                                                                                                Array of enrollment factors available for the user (empty array if no enrollment required)

                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                If MFA context not found

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                try {
                                                                                                                                                                                                                                  await auth0.getTokenSilently();
                                                                                                                                                                                                                                } catch (error) {
                                                                                                                                                                                                                                  if (error.error === 'mfa_required') {
                                                                                                                                                                                                                                    // Get enrollment options from SDK
                                                                                                                                                                                                                                    const enrollOptions = await auth0.mfa.getEnrollmentFactors(error.mfa_token);
                                                                                                                                                                                                                                    // [{ type: 'otp' }, { type: 'phone' }, { type: 'push-notification' }]

                                                                                                                                                                                                                                    showEnrollmentOptions(enrollOptions);
                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                }
+
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                • mfaToken: string +

                                                                                                                                                                                                                                  MFA token from mfa_required error

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                Returns Promise<EnrollmentFactor[]>

                                                                                                                                                                                                                                Array of enrollment factors available for the user (empty array if no enrollment required)

                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                If MFA context not found

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                try {
                                                                                                                                                                                                                                  await auth0.getTokenSilently();
                                                                                                                                                                                                                                } catch (error) {
                                                                                                                                                                                                                                  if (error.error === 'mfa_required') {
                                                                                                                                                                                                                                    // Get enrollment options from SDK
                                                                                                                                                                                                                                    const enrollOptions = await auth0.mfa.getEnrollmentFactors(error.mfa_token);
                                                                                                                                                                                                                                    // [{ type: 'otp' }, { type: 'phone' }, { type: 'push-notification' }]

                                                                                                                                                                                                                                    showEnrollmentOptions(enrollOptions);
                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                try {
                                                                                                                                                                                                                                  const factors = await auth0.mfa.getEnrollmentFactors(mfaToken);
                                                                                                                                                                                                                                  if (factors.length > 0) {
                                                                                                                                                                                                                                    // User needs to enroll in MFA
                                                                                                                                                                                                                                    renderEnrollmentUI(factors);
                                                                                                                                                                                                                                  } else {
                                                                                                                                                                                                                                    // No enrollment required, proceed with challenge
                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                } catch (error) {
                                                                                                                                                                                                                                  if (error instanceof MfaEnrollmentFactorsError) {
                                                                                                                                                                                                                                    console.error('Context not found:', error.error_description);
                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                }
+
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                try {
                                                                                                                                                                                                                                  const factors = await auth0.mfa.getEnrollmentFactors(mfaToken);
                                                                                                                                                                                                                                  if (factors.length > 0) {
                                                                                                                                                                                                                                    // User needs to enroll in MFA
                                                                                                                                                                                                                                    renderEnrollmentUI(factors);
                                                                                                                                                                                                                                  } else {
                                                                                                                                                                                                                                    // No enrollment required, proceed with challenge
                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                } catch (error) {
                                                                                                                                                                                                                                  if (error instanceof MfaEnrollmentFactorsError) {
                                                                                                                                                                                                                                    console.error('Context not found:', error.error_description);
                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                              • Internal

                                                                                                                                                                                                                                Stores authentication details (scope, audience, and MFA requirements) for MFA token verification. +

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                              • + +
                                                                                                                                                                                                                                Internal +

                                                                                                                                                                                                                                Stores authentication details (scope, audience, and MFA requirements) for MFA token verification. This is automatically called by Auth0Client when an mfa_required error occurs.

                                                                                                                                                                                                                                The context is stored keyed by the MFA token, enabling concurrent MFA flows.

                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                • mfaToken: string

                                                                                                                                                                                                                                  The MFA token from the mfa_required error response

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                • Optionalscope: string

                                                                                                                                                                                                                                  The OAuth scope from the original request (optional)

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                • Optionalaudience: string

                                                                                                                                                                                                                                  The API audience from the original request (optional)

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                • OptionalmfaRequirements: MfaRequirements

                                                                                                                                                                                                                                  The MFA requirements from the mfa_required error (optional)

                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                              • Verifies an MFA challenge and completes authentication

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                • mfaToken: string +

                                                                                                                                                                                                                                  The MFA token from the mfa_required error response

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                • Optionalscope: string +

                                                                                                                                                                                                                                  The OAuth scope from the original request (optional)

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                • Optionalaudience: string +

                                                                                                                                                                                                                                  The API audience from the original request (optional)

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                • OptionalmfaRequirements: MfaRequirements +

                                                                                                                                                                                                                                  The MFA requirements from the mfa_required error (optional)

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                              • + +
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                Verifies an MFA challenge and completes authentication

                                                                                                                                                                                                                                The scope and audience are retrieved from the stored context (set when the mfa_required error occurred). The grant_type is automatically inferred from which verification field is provided (otp, oobCode, or recoveryCode).

                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                • params: VerifyParams

                                                                                                                                                                                                                                  Verification parameters with OTP, OOB code, or recovery code

                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                Returns Promise<TokenEndpointResponse>

                                                                                                                                                                                                                                Token response with access_token, id_token, refresh_token

                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                If verification fails (invalid code, expired, rate limited)

                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                If MFA context not found

                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                If grant_type cannot be inferred

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                • params: VerifyParams +

                                                                                                                                                                                                                                  Verification parameters with OTP, OOB code, or recovery code

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                Returns Promise<TokenEndpointResponse>

                                                                                                                                                                                                                                Token response with access_token, id_token, refresh_token

                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                If verification fails (invalid code, expired, rate limited)

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                If MFA context not found

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                If grant_type cannot be inferred

                                                                                                                                                                                                                                Rate limits:

                                                                                                                                                                                                                                • 10 verification attempts allowed
                                                                                                                                                                                                                                • Refreshes at 1 attempt per 6 minutes
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                const tokens = await mfa.verify({
                                                                                                                                                                                                                                  mfaToken: mfaTokenFromLogin,
                                                                                                                                                                                                                                  otp: '123456'
                                                                                                                                                                                                                                });
                                                                                                                                                                                                                                console.log(tokens.access_token);
+
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                const tokens = await mfa.verify({
                                                                                                                                                                                                                                  mfaToken: mfaTokenFromLogin,
                                                                                                                                                                                                                                  otp: '123456'
                                                                                                                                                                                                                                });
                                                                                                                                                                                                                                console.log(tokens.access_token);
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                const tokens = await mfa.verify({
                                                                                                                                                                                                                                  mfaToken: mfaTokenFromLogin,
                                                                                                                                                                                                                                  oobCode: challenge.oobCode,
                                                                                                                                                                                                                                  bindingCode: '123456' // Code user received via SMS
                                                                                                                                                                                                                                });
+
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                const tokens = await mfa.verify({
                                                                                                                                                                                                                                  mfaToken: mfaTokenFromLogin,
                                                                                                                                                                                                                                  oobCode: challenge.oobCode,
                                                                                                                                                                                                                                  bindingCode: '123456' // Code user received via SMS
                                                                                                                                                                                                                                });
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                const tokens = await mfa.verify({
                                                                                                                                                                                                                                  mfaToken: mfaTokenFromLogin,
                                                                                                                                                                                                                                  recoveryCode: 'XXXX-XXXX-XXXX'
                                                                                                                                                                                                                                });
+
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                const tokens = await mfa.verify({
                                                                                                                                                                                                                                  mfaToken: mfaTokenFromLogin,
                                                                                                                                                                                                                                  recoveryCode: 'XXXX-XXXX-XXXX'
                                                                                                                                                                                                                                });
                                                                                                                                                                                                                                -

                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                               +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              Member Visibility +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                               +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              Methods +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              diff --git a/docs/interfaces/MyAccountApiClient.html b/docs/interfaces/MyAccountApiClient.html index defdfda6..178bbc88 100644 --- a/docs/interfaces/MyAccountApiClient.html +++ b/docs/interfaces/MyAccountApiClient.html @@ -1,4 +1,17 @@ -MyAccountApiClient | @auth0/auth0-react
                                                                                                                                                                                                                              @auth0/auth0-react
                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                Interface MyAccountApiClient

                                                                                                                                                                                                                                Client for Auth0 MyAccount API operations.

                                                                                                                                                                                                                                +MyAccountApiClient | @auth0/auth0-react
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                @auth0/auth0-react + +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                  Interface MyAccountApiClient

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                  Client for Auth0 MyAccount API operations.

                                                                                                                                                                                                                                  Provides methods for managing the current user's account:

                                                                                                                                                                                                                                  • Connected accounts (link/unlink external identity providers)
                                                                                                                                                                                                                                    • @@ -6,7 +19,18 @@
                                                                                                                                                                                                                                  • Authentication methods (passkeys, phone, email, TOTP) - list, get, update, delete
                                                                                                                                                                                                                                  • Authentication method enrollment (challenge and verify)
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  interface MyAccountApiClient {
                                                                                                                                                                                                                                      completeAccount(params: CompleteRequest): Promise<CompleteResponse>;
                                                                                                                                                                                                                                      connectAccount(params: ConnectRequest): Promise<ConnectResponse>;
                                                                                                                                                                                                                                      deleteAuthenticationMethod(id: string): Promise<void>;
                                                                                                                                                                                                                                      enrollmentChallenge(
                                                                                                                                                                                                                                          options: EnrollmentChallengeOptions,
                                                                                                                                                                                                                                      ): Promise<EnrollmentChallengeResponse>;
                                                                                                                                                                                                                                      enrollmentVerify(
                                                                                                                                                                                                                                          options: EnrollmentVerifyOptions,
                                                                                                                                                                                                                                      ): Promise<AuthenticationMethod>;
                                                                                                                                                                                                                                      getAuthenticationMethod(id: string): Promise<AuthenticationMethod>;
                                                                                                                                                                                                                                      getAuthenticationMethods(
                                                                                                                                                                                                                                          type?: AuthenticationMethodType,
                                                                                                                                                                                                                                      ): Promise<AuthenticationMethod[]>;
                                                                                                                                                                                                                                      getFactors(): Promise<Factor[]>;
                                                                                                                                                                                                                                      updateAuthenticationMethod(
                                                                                                                                                                                                                                          id: string,
                                                                                                                                                                                                                                          data: UpdateAuthenticationMethodRequest,
                                                                                                                                                                                                                                      ): Promise<AuthenticationMethod>;
                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                  completeAccount +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  interface MyAccountApiClient {
                                                                                                                                                                                                                                      completeAccount(params: CompleteRequest): Promise<CompleteResponse>;
                                                                                                                                                                                                                                      connectAccount(params: ConnectRequest): Promise<ConnectResponse>;
                                                                                                                                                                                                                                      deleteAuthenticationMethod(id: string): Promise<void>;
                                                                                                                                                                                                                                      enrollmentChallenge(
                                                                                                                                                                                                                                          options: EnrollmentChallengeOptions,
                                                                                                                                                                                                                                      ): Promise<EnrollmentChallengeResponse>;
                                                                                                                                                                                                                                      enrollmentVerify(
                                                                                                                                                                                                                                          options: EnrollmentVerifyOptions,
                                                                                                                                                                                                                                      ): Promise<AuthenticationMethod>;
                                                                                                                                                                                                                                      getAuthenticationMethod(id: string): Promise<AuthenticationMethod>;
                                                                                                                                                                                                                                      getAuthenticationMethods(
                                                                                                                                                                                                                                          type?: AuthenticationMethodType,
                                                                                                                                                                                                                                      ): Promise<AuthenticationMethod[]>;
                                                                                                                                                                                                                                      getFactors(): Promise<Factor[]>;
                                                                                                                                                                                                                                      updateAuthenticationMethod(
                                                                                                                                                                                                                                          id: string,
                                                                                                                                                                                                                                          data: UpdateAuthenticationMethodRequest,
                                                                                                                                                                                                                                      ): Promise<AuthenticationMethod>;
                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  Index
                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                  completeAccount connectAccount deleteAuthenticationMethod enrollmentChallenge @@ -15,32 +39,189 @@ getAuthenticationMethods getFactors updateAuthenticationMethod -

                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                  • Verify the redirect from the connect account flow and complete the connecting of the account.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    • params: CompleteRequest

                                                                                                                                                                                                                                      Completion parameters including auth session, connect code, and redirect URI

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                    Returns Promise<CompleteResponse>

                                                                                                                                                                                                                                    A promise that resolves to the completed connected account details

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                  • Get a ticket for the connect account flow.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    • params: ConnectRequest

                                                                                                                                                                                                                                      Connection parameters including connection name and redirect URI

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                    Returns Promise<ConnectResponse>

                                                                                                                                                                                                                                    A promise that resolves to a connect response with the redirect URI and auth session

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                  • Delete an authentication method by ID.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    • id: string

                                                                                                                                                                                                                                      The ID of the authentication method to delete

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                    Returns Promise<void>

                                                                                                                                                                                                                                    A promise that resolves when the authentication method has been deleted

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Verify the redirect from the connect account flow and complete the connecting of the account.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                    • params: CompleteRequest +

                                                                                                                                                                                                                                      Completion parameters including auth session, connect code, and redirect URI

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Returns Promise<CompleteResponse>

                                                                                                                                                                                                                                    A promise that resolves to the completed connected account details

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Get a ticket for the connect account flow.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                    • params: ConnectRequest +

                                                                                                                                                                                                                                      Connection parameters including connection name and redirect URI

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Returns Promise<ConnectResponse>

                                                                                                                                                                                                                                    A promise that resolves to a connect response with the redirect URI and auth session

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Delete an authentication method by ID.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                    • id: string +

                                                                                                                                                                                                                                      The ID of the authentication method to delete

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Returns Promise<void>

                                                                                                                                                                                                                                    A promise that resolves when the authentication method has been deleted

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Start the enrollment of an authentication method for the current user. The response shape varies by type.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    Returns Promise<EnrollmentChallengeResponse>

                                                                                                                                                                                                                                    A promise that resolves to the enrollment challenge response (shape varies by type)

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                  • Confirm the enrollment of an authentication method to complete registration.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    • options: EnrollmentVerifyOptions

                                                                                                                                                                                                                                      Enrollment verify options including the auth session and type-specific verification data

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                    Returns Promise<AuthenticationMethod>

                                                                                                                                                                                                                                    A promise that resolves to the confirmed authentication method

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                  • Get an authentication method by ID.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    • id: string

                                                                                                                                                                                                                                      The ID of the authentication method to retrieve

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                    Returns Promise<AuthenticationMethod>

                                                                                                                                                                                                                                    A promise that resolves to the authentication method

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                  • Get a list of all authentication methods for the current user.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    Returns Promise<AuthenticationMethod[]>

                                                                                                                                                                                                                                    A promise that resolves to an array of authentication methods

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                  • Get the status of all factors for the current user.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Returns Promise<Factor[]>

                                                                                                                                                                                                                                    A promise that resolves to an array of factors with their enabled/disabled status

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                  • Update details of an authentication method by ID.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    • id: string

                                                                                                                                                                                                                                      The ID of the authentication method to update

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • data: UpdateAuthenticationMethodRequest

                                                                                                                                                                                                                                      The fields to update (e.g. name, preferred_authentication_method for phone)

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                    Returns Promise<AuthenticationMethod>

                                                                                                                                                                                                                                    A promise that resolves to the updated authentication method

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                  Returns Promise<EnrollmentChallengeResponse>

                                                                                                                                                                                                                                  A promise that resolves to the enrollment challenge response (shape varies by type)

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Confirm the enrollment of an authentication method to complete registration.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                    • options: EnrollmentVerifyOptions +

                                                                                                                                                                                                                                      Enrollment verify options including the auth session and type-specific verification data

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Returns Promise<AuthenticationMethod>

                                                                                                                                                                                                                                    A promise that resolves to the confirmed authentication method

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Get an authentication method by ID.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                    • id: string +

                                                                                                                                                                                                                                      The ID of the authentication method to retrieve

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Returns Promise<AuthenticationMethod>

                                                                                                                                                                                                                                    A promise that resolves to the authentication method

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Get a list of all authentication methods for the current user.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Returns Promise<AuthenticationMethod[]>

                                                                                                                                                                                                                                    A promise that resolves to an array of authentication methods

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Get the status of all factors for the current user.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Returns Promise<Factor[]>

                                                                                                                                                                                                                                    A promise that resolves to an array of factors with their enabled/disabled status

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Update details of an authentication method by ID.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                    • id: string +

                                                                                                                                                                                                                                      The ID of the authentication method to update

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                    • data: UpdateAuthenticationMethodRequest +

                                                                                                                                                                                                                                      The fields to update (e.g. name, preferred_authentication_method for phone)

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Returns Promise<AuthenticationMethod>

                                                                                                                                                                                                                                    A promise that resolves to the updated authentication method

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  Member Visibility +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  Methods +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  diff --git a/docs/interfaces/PasskeyApiClient.html b/docs/interfaces/PasskeyApiClient.html index 4a19160d..3f45d079 100644 --- a/docs/interfaces/PasskeyApiClient.html +++ b/docs/interfaces/PasskeyApiClient.html @@ -1,32 +1,225 @@ -PasskeyApiClient | @auth0/auth0-react
                                                                                                                                                                                                                                  @auth0/auth0-react
                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                    Interface PasskeyApiClient

                                                                                                                                                                                                                                    Client for Auth0 Passkey operations.

                                                                                                                                                                                                                                    +PasskeyApiClient | @auth0/auth0-react
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    @auth0/auth0-react + +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                      Interface PasskeyApiClient

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      Client for Auth0 Passkey operations.

                                                                                                                                                                                                                                      Provides 2 public methods:

                                                                                                                                                                                                                                      • signup — Register a new user with a passkey (full flow: challenge → WebAuthn → token exchange)
                                                                                                                                                                                                                                      • login — Sign in with a passkey (full flow: challenge → WebAuthn → token exchange)
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      // Signup — single call handles everything
                                                                                                                                                                                                                                      const tokens = await auth0.passkey.signup({ email: 'user@example.com' });

                                                                                                                                                                                                                                      // Login — single call handles everything
                                                                                                                                                                                                                                      const tokens = await auth0.passkey.login();
+
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      // Signup — single call handles everything
                                                                                                                                                                                                                                      const tokens = await auth0.passkey.signup({ email: 'user@example.com' });

                                                                                                                                                                                                                                      // Login — single call handles everything
                                                                                                                                                                                                                                      const tokens = await auth0.passkey.login();
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      interface PasskeyApiClient {
                                                                                                                                                                                                                                          login(options?: PasskeyLoginOptions): Promise<TokenEndpointResponse>;
                                                                                                                                                                                                                                          signup(options: PasskeySignupOptions): Promise<TokenEndpointResponse>;
                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                      login +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      interface PasskeyApiClient {
                                                                                                                                                                                                                                          getLoginChallenge(
                                                                                                                                                                                                                                              options?: PasskeyLoginChallengeOptions,
                                                                                                                                                                                                                                          ): Promise<PasskeyLoginChallenge>;
                                                                                                                                                                                                                                          getSignupChallenge(
                                                                                                                                                                                                                                              options: PasskeySignupChallengeOptions,
                                                                                                                                                                                                                                          ): Promise<PasskeySignupChallenge>;
                                                                                                                                                                                                                                          getTokenWithPasskey(
                                                                                                                                                                                                                                              options: PasskeyGetTokenOptions,
                                                                                                                                                                                                                                          ): Promise<TokenEndpointResponse>;
                                                                                                                                                                                                                                          login(options?: PasskeyLoginOptions): Promise<TokenEndpointResponse>;
                                                                                                                                                                                                                                          signup(options: PasskeySignupOptions): Promise<TokenEndpointResponse>;
                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      Index
                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                      getLoginChallenge +getSignupChallenge +getTokenWithPasskey +login signup -

                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                      • + +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Request a passkey login challenge.

                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Step 1 of the granular login flow. Returns the auth session and a +decoded PublicKeyCredentialRequestOptions. Run the WebAuthn assertion +ceremony with publicKey, then hand the resulting credential and authSession to +getTokenWithPasskey().

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                        • Optionaloptions: PasskeyLoginChallengeOptions +

                                                                                                                                                                                                                                          Optional login challenge options (realm/organization)

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Returns Promise<PasskeyLoginChallenge>

                                                                                                                                                                                                                                        A promise resolving to { authSession, publicKey }

                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        If WebAuthn is not supported in the browser

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        If the challenge request fails

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                      • + +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Request a passkey signup challenge.

                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Step 1 of the granular signup flow. Returns the auth session and a +decoded PublicKeyCredentialCreationOptions. Run the WebAuthn credential +creation ceremony with publicKey, then hand the resulting credential and authSession to +getTokenWithPasskey().

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                        • options: PasskeySignupChallengeOptions +

                                                                                                                                                                                                                                          Signup challenge options (user identifier, optional realm/organization/metadata)

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Returns Promise<PasskeySignupChallenge>

                                                                                                                                                                                                                                        A promise resolving to { authSession, publicKey }

                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        If WebAuthn is not supported in the browser

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        If the challenge request fails

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                      • + +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Exchange a signed passkey credential for tokens.

                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Step 2 of the granular flow. Serializes the raw PublicKeyCredential +produced by the WebAuthn ceremony — either a creation (signup) or an +assertion (login) credential — and exchanges it for tokens. The credential +type (attestation vs assertion) is detected automatically.

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                        • options: PasskeyGetTokenOptions +

                                                                                                                                                                                                                                          The auth session, raw credential, and optional realm/organization/scope/audience

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Returns Promise<TokenEndpointResponse>

                                                                                                                                                                                                                                        A promise resolving to the token endpoint response

                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        If WebAuthn is not supported in the browser

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        If the credential is not a valid attestation or assertion response

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        If the token exchange fails

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                      • + +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Sign in with an existing passkey.

                                                                                                                                                                                                                                        Handles the full flow: requests a login challenge, triggers the browser WebAuthn assertion ceremony, serializes the result, and exchanges it for tokens.

                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                        • Optionaloptions: PasskeyLoginOptions

                                                                                                                                                                                                                                          Optional passkey login options (optional scope/audience/realm/organization)

                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                        Returns Promise<TokenEndpointResponse>

                                                                                                                                                                                                                                        A promise that resolves to the token endpoint response containing access/ID tokens

                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                        If WebAuthn is not supported in the browser

                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                        If the challenge request fails

                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                        If the token exchange fails

                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                        If the user cancels the WebAuthn prompt

                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                      • Register a new user with a passkey.

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                        • Optionaloptions: PasskeyLoginOptions +

                                                                                                                                                                                                                                          Optional passkey login options (optional scope/audience/realm/organization)

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Returns Promise<TokenEndpointResponse>

                                                                                                                                                                                                                                        A promise that resolves to the token endpoint response containing access/ID tokens

                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        If WebAuthn is not supported in the browser

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        If the challenge request fails

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        If the token exchange fails

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        If the user cancels the WebAuthn prompt

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                      • + +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Register a new user with a passkey.

                                                                                                                                                                                                                                        Handles the full flow: requests a signup challenge, triggers the browser WebAuthn credential creation ceremony, serializes the result, and exchanges it for tokens.

                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                        Returns Promise<TokenEndpointResponse>

                                                                                                                                                                                                                                        A promise that resolves to the token endpoint response containing access/ID tokens

                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                        If WebAuthn is not supported in the browser

                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                        If the challenge request fails

                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                        If the token exchange fails

                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                        If the user cancels the WebAuthn prompt

                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                      • options: PasskeySignupOptions +

                                                                                                                                                                                                                                        Passkey signup options (user identifier, optional scope/audience)

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      Returns Promise<TokenEndpointResponse>

                                                                                                                                                                                                                                      A promise that resolves to the token endpoint response containing access/ID tokens

                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      If WebAuthn is not supported in the browser

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      If the challenge request fails

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      If the token exchange fails

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      If the user cancels the WebAuthn prompt

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      Member Visibility +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      Methods +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      diff --git a/docs/interfaces/PopupConfigOptions.html b/docs/interfaces/PopupConfigOptions.html index 2b34f4e9..c8d1e087 100644 --- a/docs/interfaces/PopupConfigOptions.html +++ b/docs/interfaces/PopupConfigOptions.html @@ -1,7 +1,36 @@ -PopupConfigOptions | @auth0/auth0-react
                                                                                                                                                                                                                                      @auth0/auth0-react
                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                        Interface PopupConfigOptions

                                                                                                                                                                                                                                        interface PopupConfigOptions {
                                                                                                                                                                                                                                            closePopup?: boolean;
                                                                                                                                                                                                                                            popup?: any;
                                                                                                                                                                                                                                            timeoutInSeconds?: number;
                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                        closePopup? +PopupConfigOptions | @auth0/auth0-react
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        @auth0/auth0-react + +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                          Interface PopupConfigOptions

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          interface PopupConfigOptions {
                                                                                                                                                                                                                                              closePopup?: boolean;
                                                                                                                                                                                                                                              popup?: any;
                                                                                                                                                                                                                                              timeoutInSeconds?: number;
                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Index
                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                          closePopup? popup? timeoutInSeconds? -

                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                          closePopup?: boolean

                                                                                                                                                                                                                                          Controls whether the SDK automatically closes the popup window.

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                          closePopup?: boolean
                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          Controls whether the SDK automatically closes the popup window.

                                                                                                                                                                                                                                          • true (default): SDK closes the popup automatically after receiving the authorization response
                                                                                                                                                                                                                                          • false: SDK does not close the popup. The caller is responsible for closing it, including on errors.
                                                                                                                                                                                                                                            • @@ -13,12 +42,51 @@ 
                                                                                                                                                                                                                                            const popup = window.open('', '_blank');
                                                                                                                                                                                                                                            try {
                                                                                                                                                                                                                                              await auth0.loginWithPopup({}, { popup, closePopup: false });
                                                                                                                                                                                                                                            } finally {
                                                                                                                                                                                                                                              popup.close();
                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                          true
+
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          true
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          popup?: any

                                                                                                                                                                                                                                          Accepts an already-created popup window to use. If not specified, the SDK +

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                          popup?: any
                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          Accepts an already-created popup window to use. If not specified, the SDK will create its own. This may be useful for platforms like iOS that have security restrictions around when popups can be invoked (e.g. from a user click event)

                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          timeoutInSeconds?: number

                                                                                                                                                                                                                                          The number of seconds to wait for a popup response before +

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                          timeoutInSeconds?: number
                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          The number of seconds to wait for a popup response before throwing a timeout error. Defaults to 60s

                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Member Visibility +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Properties +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          diff --git a/docs/interfaces/PopupLoginOptions.html b/docs/interfaces/PopupLoginOptions.html index c08bf7e7..918d8aba 100644 --- a/docs/interfaces/PopupLoginOptions.html +++ b/docs/interfaces/PopupLoginOptions.html @@ -1,4 +1,66 @@ -PopupLoginOptions | @auth0/auth0-react
                                                                                                                                                                                                                                          @auth0/auth0-react
                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                            Interface PopupLoginOptions

                                                                                                                                                                                                                                            interface PopupLoginOptions {
                                                                                                                                                                                                                                                authorizationParams?: AuthorizationParams;
                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                            authorizationParams? -

                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                            authorizationParams?: AuthorizationParams

                                                                                                                                                                                                                                            URL parameters that will be sent back to the Authorization Server. This can be known parameters +PopupLoginOptions | @auth0/auth0-react

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            @auth0/auth0-react + +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                              Interface PopupLoginOptions

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              interface PopupLoginOptions {
                                                                                                                                                                                                                                                  authorizationParams?: AuthorizationParams;
                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              Index
                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                              authorizationParams? +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                              authorizationParams?: AuthorizationParams
                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              URL parameters that will be sent back to the Authorization Server. This can be known parameters defined by Auth0 or custom parameters that you define.

                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              Member Visibility +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              Properties +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              diff --git a/docs/interfaces/RedirectConnectAccountOptions.html b/docs/interfaces/RedirectConnectAccountOptions.html index b60bda09..a89ee42c 100644 --- a/docs/interfaces/RedirectConnectAccountOptions.html +++ b/docs/interfaces/RedirectConnectAccountOptions.html @@ -1,25 +1,124 @@ -RedirectConnectAccountOptions | @auth0/auth0-react
                                                                                                                                                                                                                                              @auth0/auth0-react
                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                Interface RedirectConnectAccountOptions<TAppState>

                                                                                                                                                                                                                                                interface RedirectConnectAccountOptions<TAppState = any> {
                                                                                                                                                                                                                                                    appState?: TAppState;
                                                                                                                                                                                                                                                    authorization_params?: AuthorizationParams;
                                                                                                                                                                                                                                                    connection: string;
                                                                                                                                                                                                                                                    openUrl?: (url: string) => Promise<void>;
                                                                                                                                                                                                                                                    redirectUri?: string;
                                                                                                                                                                                                                                                    scopes?: string[];
                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                • TAppState = any
                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                appState? +RedirectConnectAccountOptions | @auth0/auth0-react
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                @auth0/auth0-react + +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                  Interface RedirectConnectAccountOptions<TAppState>

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  interface RedirectConnectAccountOptions<TAppState = any> {
                                                                                                                                                                                                                                                      appState?: TAppState;
                                                                                                                                                                                                                                                      authorization_params?: AuthorizationParams;
                                                                                                                                                                                                                                                      connection: string;
                                                                                                                                                                                                                                                      openUrl?: (url: string) => Promise<void>;
                                                                                                                                                                                                                                                      redirectUri?: string;
                                                                                                                                                                                                                                                      scopes?: string[];
                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                  • TAppState = any
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  Index
                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                  appState? authorization_params? connection openUrl? redirectUri? scopes? -

                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                  appState?: TAppState

                                                                                                                                                                                                                                                  Optional application state to persist through the transaction.

                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                  await auth0.connectAccountWithRedirect({
                                                                                                                                                                                                                                                    connection: 'google-oauth2',
                                                                                                                                                                                                                                                    appState: { returnTo: '/settings' }
                                                                                                                                                                                                                                                  });
+
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                  appState?: TAppState
                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  Optional application state to persist through the transaction.

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  await auth0.connectAccountWithRedirect({
                                                                                                                                                                                                                                                    connection: 'google-oauth2',
                                                                                                                                                                                                                                                    appState: { returnTo: '/settings' }
                                                                                                                                                                                                                                                  });
                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                  authorization_params?: AuthorizationParams

                                                                                                                                                                                                                                                  Additional authorization parameters for the request.

                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                  await auth0.connectAccountWithRedirect({
                                                                                                                                                                                                                                                    connection: 'github',
                                                                                                                                                                                                                                                    authorization_params: {
                                                                                                                                                                                                                                                      audience: 'https://api.github.com'
                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                  });
+
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                  authorization_params?: AuthorizationParams
                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  Additional authorization parameters for the request.

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  await auth0.connectAccountWithRedirect({
                                                                                                                                                                                                                                                    connection: 'github',
                                                                                                                                                                                                                                                    authorization_params: {
                                                                                                                                                                                                                                                      audience: 'https://api.github.com'
                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                  });
                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                  connection: string

                                                                                                                                                                                                                                                  The name of the connection to link (e.g. 'google-oauth2').

                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                  openUrl?: (url: string) => Promise<void>

                                                                                                                                                                                                                                                  Optional function to handle the redirect URL.

                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                  await auth0.connectAccountWithRedirect({
                                                                                                                                                                                                                                                    connection: 'google-oauth2',
                                                                                                                                                                                                                                                    openUrl: async (url) => { myBrowserApi.open(url); }
                                                                                                                                                                                                                                                  });
+
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                  connection: string
                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  The name of the connection to link (e.g. 'google-oauth2').

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                  openUrl?: (url: string) => Promise<void>
                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  Optional function to handle the redirect URL.

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  await auth0.connectAccountWithRedirect({
                                                                                                                                                                                                                                                    connection: 'google-oauth2',
                                                                                                                                                                                                                                                    openUrl: async (url) => { myBrowserApi.open(url); }
                                                                                                                                                                                                                                                  });
                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                  redirectUri?: string

                                                                                                                                                                                                                                                  The URI to redirect back to after connecting the account.

                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                  scopes?: string[]

                                                                                                                                                                                                                                                  Array of scopes to request from the Identity Provider during the connect account flow.

                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                  await auth0.connectAccountWithRedirect({
                                                                                                                                                                                                                                                    connection: 'google-oauth2',
                                                                                                                                                                                                                                                    scopes: ['https://www.googleapis.com/auth/calendar']
                                                                                                                                                                                                                                                  });
+
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                  redirectUri?: string
                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  The URI to redirect back to after connecting the account.

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                  scopes?: string[]
                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  Array of scopes to request from the Identity Provider during the connect account flow.

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  await auth0.connectAccountWithRedirect({
                                                                                                                                                                                                                                                    connection: 'google-oauth2',
                                                                                                                                                                                                                                                    scopes: ['https://www.googleapis.com/auth/calendar']
                                                                                                                                                                                                                                                  });
                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  Member Visibility +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  Properties +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/RedirectLoginOptions.html b/docs/interfaces/RedirectLoginOptions.html index 117dc5ec..eaba9a12 100644 --- a/docs/interfaces/RedirectLoginOptions.html +++ b/docs/interfaces/RedirectLoginOptions.html @@ -1,16 +1,106 @@ -RedirectLoginOptions | @auth0/auth0-react
                                                                                                                                                                                                                                                  @auth0/auth0-react
                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                    Interface RedirectLoginOptions<TAppState>

                                                                                                                                                                                                                                                    interface RedirectLoginOptions<TAppState = AppState> {
                                                                                                                                                                                                                                                        appState?: TAppState;
                                                                                                                                                                                                                                                        authorizationParams?: AuthorizationParams;
                                                                                                                                                                                                                                                        fragment?: string;
                                                                                                                                                                                                                                                        openUrl?: (url: string) => void | Promise<void>;
                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                    • Omit<SPARedirectLoginOptions<TAppState>, "onRedirect">
                                                                                                                                                                                                                                                      • RedirectLoginOptions
                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                    appState? +RedirectLoginOptions | @auth0/auth0-react
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    @auth0/auth0-react + +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                      Interface RedirectLoginOptions<TAppState>

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      interface RedirectLoginOptions<TAppState = AppState> {
                                                                                                                                                                                                                                                          appState?: TAppState;
                                                                                                                                                                                                                                                          authorizationParams?: AuthorizationParams;
                                                                                                                                                                                                                                                          fragment?: string;
                                                                                                                                                                                                                                                          openUrl?: (url: string) => void | Promise<void>;
                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                      • Omit<SPARedirectLoginOptions<TAppState>, "onRedirect"> +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                        • RedirectLoginOptions
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      Index
                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      appState? authorizationParams? fragment? openUrl? -

                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                      appState?: TAppState

                                                                                                                                                                                                                                                      Used to store state before doing the redirect

                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      authorizationParams?: AuthorizationParams

                                                                                                                                                                                                                                                      URL parameters that will be sent back to the Authorization Server. This can be known parameters +

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      appState?: TAppState
                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      Used to store state before doing the redirect

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      authorizationParams?: AuthorizationParams
                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      URL parameters that will be sent back to the Authorization Server. This can be known parameters defined by Auth0 or custom parameters that you define.

                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      fragment?: string

                                                                                                                                                                                                                                                      Used to add to the URL fragment before redirecting

                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      openUrl?: (url: string) => void | Promise<void>

                                                                                                                                                                                                                                                      Used to control the redirect and not rely on the SDK to do the actual redirect.

                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      const client = new Auth0Client({
                                                                                                                                                                                                                                                        openUrl(url) {
                                                                                                                                                                                                                                                          window.location.replace(url);
                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                      });
+
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      fragment?: string
                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      Used to add to the URL fragment before redirecting

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      openUrl?: (url: string) => void | Promise<void>
                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      Used to control the redirect and not rely on the SDK to do the actual redirect.

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      const client = new Auth0Client({
                                                                                                                                                                                                                                                        openUrl(url) {
                                                                                                                                                                                                                                                          window.location.replace(url);
                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                      });
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      import { Browser } from '@capacitor/browser';

                                                                                                                                                                                                                                                      const client = new Auth0Client({
                                                                                                                                                                                                                                                        async openUrl(url) {
                                                                                                                                                                                                                                                          await Browser.open({ url });
                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                      });
+
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      import { Browser } from '@capacitor/browser';

                                                                                                                                                                                                                                                      const client = new Auth0Client({
                                                                                                                                                                                                                                                        async openUrl(url) {
                                                                                                                                                                                                                                                          await Browser.open({ url });
                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                      });
                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      Member Visibility +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      Properties +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/RevokeRefreshTokenOptions.html b/docs/interfaces/RevokeRefreshTokenOptions.html index a49d2c3e..04bd03ff 100644 --- a/docs/interfaces/RevokeRefreshTokenOptions.html +++ b/docs/interfaces/RevokeRefreshTokenOptions.html @@ -1,4 +1,59 @@ -RevokeRefreshTokenOptions | @auth0/auth0-react
                                                                                                                                                                                                                                                      @auth0/auth0-react
                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                        Interface RevokeRefreshTokenOptions

                                                                                                                                                                                                                                                        Options for revoking a refresh token

                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        interface RevokeRefreshTokenOptions {
                                                                                                                                                                                                                                                            audience?: string;
                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                        audience? -

                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                        audience?: string

                                                                                                                                                                                                                                                        Audience to identify which refresh token to revoke. Omit for default audience.

                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                        +RevokeRefreshTokenOptions | @auth0/auth0-react
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        @auth0/auth0-react + +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                          Interface RevokeRefreshTokenOptions

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          Options for revoking a refresh token

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          interface RevokeRefreshTokenOptions {
                                                                                                                                                                                                                                                              audience?: string;
                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Index
                                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                          audience? +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                          audience?: string
                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          Audience to identify which refresh token to revoke. Omit for default audience.

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Member Visibility +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Properties +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/UpdateAuthenticationMethodRequest.html b/docs/interfaces/UpdateAuthenticationMethodRequest.html index 3945c949..d6626ad3 100644 --- a/docs/interfaces/UpdateAuthenticationMethodRequest.html +++ b/docs/interfaces/UpdateAuthenticationMethodRequest.html @@ -1,4 +1,62 @@ -UpdateAuthenticationMethodRequest | @auth0/auth0-react
                                                                                                                                                                                                                                                          @auth0/auth0-react
                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                            Interface UpdateAuthenticationMethodRequest

                                                                                                                                                                                                                                                            interface UpdateAuthenticationMethodRequest {
                                                                                                                                                                                                                                                                name?: string;
                                                                                                                                                                                                                                                                preferred_authentication_method?: "sms" | "voice";
                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                            name? +UpdateAuthenticationMethodRequest | @auth0/auth0-react
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            @auth0/auth0-react + +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                              Interface UpdateAuthenticationMethodRequest

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              interface UpdateAuthenticationMethodRequest {
                                                                                                                                                                                                                                                                  name?: string;
                                                                                                                                                                                                                                                                  preferred_authentication_method?: "sms" | "voice";
                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Index
                                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                              name? preferred_authentication_method? -

                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                              name?: string
                                                                                                                                                                                                                                                              preferred_authentication_method?: "sms" | "voice"

                                                                                                                                                                                                                                                              Only valid when updating a phone authentication method.

                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                              name?: string
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                              preferred_authentication_method?: "sms" | "voice"
                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              Only valid when updating a phone authentication method.

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Member Visibility +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Properties +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/VerifyParams.html b/docs/interfaces/VerifyParams.html index 42d0cb9f..4f9b1f61 100644 --- a/docs/interfaces/VerifyParams.html +++ b/docs/interfaces/VerifyParams.html @@ -1,18 +1,97 @@ -VerifyParams | @auth0/auth0-react
                                                                                                                                                                                                                                                              @auth0/auth0-react
                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                Interface VerifyParams

                                                                                                                                                                                                                                                                Parameters for verifying an MFA challenge.

                                                                                                                                                                                                                                                                +VerifyParams | @auth0/auth0-react
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                @auth0/auth0-react + +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                  Interface VerifyParams

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Parameters for verifying an MFA challenge.

                                                                                                                                                                                                                                                                  The grant_type is automatically inferred from which verification field is provided:

                                                                                                                                                                                                                                                                  • otp field → MFA-OTP grant type
                                                                                                                                                                                                                                                                  • oobCode field → MFA-OOB grant type
                                                                                                                                                                                                                                                                  • recoveryCode field → MFA-RECOVERY-CODE grant type
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  interface VerifyParams {
                                                                                                                                                                                                                                                                      bindingCode?: string;
                                                                                                                                                                                                                                                                      mfaToken: string;
                                                                                                                                                                                                                                                                      oobCode?: string;
                                                                                                                                                                                                                                                                      otp?: string;
                                                                                                                                                                                                                                                                      recoveryCode?: string;
                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                  bindingCode? +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  interface VerifyParams {
                                                                                                                                                                                                                                                                      bindingCode?: string;
                                                                                                                                                                                                                                                                      mfaToken: string;
                                                                                                                                                                                                                                                                      oobCode?: string;
                                                                                                                                                                                                                                                                      otp?: string;
                                                                                                                                                                                                                                                                      recoveryCode?: string;
                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  Index
                                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  bindingCode? mfaToken oobCode? otp? recoveryCode? -

                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                  bindingCode?: string

                                                                                                                                                                                                                                                                  Binding code (for OOB challenges with binding)

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  mfaToken: string

                                                                                                                                                                                                                                                                  MFA token from challenge flow

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  oobCode?: string

                                                                                                                                                                                                                                                                  Out-of-band code (for OOB challenges)

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  otp?: string

                                                                                                                                                                                                                                                                  One-time password (for OTP challenges)

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  recoveryCode?: string

                                                                                                                                                                                                                                                                  Recovery code (for recovery code verification)

                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  bindingCode?: string
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Binding code (for OOB challenges with binding)

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  mfaToken: string
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  MFA token from challenge flow

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  oobCode?: string
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Out-of-band code (for OOB challenges)

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  otp?: string
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  One-time password (for OTP challenges)

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  recoveryCode?: string
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Recovery code (for recovery code verification)

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  Member Visibility +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  Properties +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/WithAuth0Props.html b/docs/interfaces/WithAuth0Props.html index 1f139f86..80dcb20f 100644 --- a/docs/interfaces/WithAuth0Props.html +++ b/docs/interfaces/WithAuth0Props.html @@ -1,3 +1,57 @@ -WithAuth0Props | @auth0/auth0-react
                                                                                                                                                                                                                                                                  @auth0/auth0-react
                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                    Interface WithAuth0Props

                                                                                                                                                                                                                                                                    Components wrapped in withAuth0 will have an additional auth0 prop

                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    interface WithAuth0Props {
                                                                                                                                                                                                                                                                        auth0: Auth0ContextInterface;
                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                    auth0 -

                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                    auth0: Auth0ContextInterface

                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                    +WithAuth0Props | @auth0/auth0-react
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    @auth0/auth0-react + +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                      Interface WithAuth0Props

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      Components wrapped in withAuth0 will have an additional auth0 prop

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      interface WithAuth0Props {
                                                                                                                                                                                                                                                                          auth0: Auth0ContextInterface;
                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      Index
                                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                      auth0 +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                      auth0: Auth0ContextInterface
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      Member Visibility +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      Properties +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/WithAuthenticationRequiredOptions.html b/docs/interfaces/WithAuthenticationRequiredOptions.html index 78a4deeb..4425805b 100644 --- a/docs/interfaces/WithAuthenticationRequiredOptions.html +++ b/docs/interfaces/WithAuthenticationRequiredOptions.html @@ -1,26 +1,81 @@ -WithAuthenticationRequiredOptions | @auth0/auth0-react
                                                                                                                                                                                                                                                                      @auth0/auth0-react
                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                        Interface WithAuthenticationRequiredOptions

                                                                                                                                                                                                                                                                        Options for the withAuthenticationRequired Higher Order Component

                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        interface WithAuthenticationRequiredOptions {
                                                                                                                                                                                                                                                                            context?: Context<Auth0ContextInterface<User>>;
                                                                                                                                                                                                                                                                            loginOptions?: RedirectLoginOptions<AppState>;
                                                                                                                                                                                                                                                                            onBeforeAuthentication?: () => Promise<void>;
                                                                                                                                                                                                                                                                            onRedirecting?: () => Element;
                                                                                                                                                                                                                                                                            returnTo?: string | (() => string);
                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                        context? +WithAuthenticationRequiredOptions | @auth0/auth0-react
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        @auth0/auth0-react + +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                          Interface WithAuthenticationRequiredOptions

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          Options for the withAuthenticationRequired Higher Order Component

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          interface WithAuthenticationRequiredOptions {
                                                                                                                                                                                                                                                                              context?: Context<Auth0ContextInterface<User>>;
                                                                                                                                                                                                                                                                              loginOptions?: RedirectLoginOptions<AppState>;
                                                                                                                                                                                                                                                                              onBeforeAuthentication?: () => Promise<void>;
                                                                                                                                                                                                                                                                              onRedirecting?: () => Element;
                                                                                                                                                                                                                                                                              returnTo?: string | (() => string);
                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Index
                                                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                          context? loginOptions? onBeforeAuthentication? onRedirecting? returnTo? -

                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                          context?: Context<Auth0ContextInterface<User>>

                                                                                                                                                                                                                                                                          The context to be used when calling useAuth0, this should only be provided if you are using multiple Auth0Providers +

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                          context?: Context<Auth0ContextInterface<User>>
                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          The context to be used when calling useAuth0, this should only be provided if you are using multiple Auth0Providers within your application and you wish to tie a specific component to a Auth0Provider other than the Auth0Provider associated with the default Auth0Context.

                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          loginOptions?: RedirectLoginOptions<AppState>
                                                                                                                                                                                                                                                                          withAuthenticationRequired(Profile, {
                                                                                                                                                                                                                                                                            loginOptions: {
                                                                                                                                                                                                                                                                              appState: {
                                                                                                                                                                                                                                                                                customProp: 'foo'
                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                          })
+
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                          loginOptions?: RedirectLoginOptions<AppState>
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          withAuthenticationRequired(Profile, {
                                                                                                                                                                                                                                                                            loginOptions: {
                                                                                                                                                                                                                                                                              appState: {
                                                                                                                                                                                                                                                                                customProp: 'foo'
                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                          })

                                                                                                                                                                                                                                                                          Pass additional login options, like extra appState to the login page. This will be merged with the returnTo option used by the onRedirectCallback handler.

                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          onBeforeAuthentication?: () => Promise<void>
                                                                                                                                                                                                                                                                          withAuthenticationRequired(Profile, {
                                                                                                                                                                                                                                                                            onBeforeAuthentication: () => { analyticsLibrary.track('login_triggered'); }
                                                                                                                                                                                                                                                                          })
+
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                          onBeforeAuthentication?: () => Promise<void>
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          withAuthenticationRequired(Profile, {
                                                                                                                                                                                                                                                                            onBeforeAuthentication: () => { analyticsLibrary.track('login_triggered'); }
                                                                                                                                                                                                                                                                          })

                                                                                                                                                                                                                                                                          Allows executing logic before the user is redirected to the login page.

                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          onRedirecting?: () => Element
                                                                                                                                                                                                                                                                          withAuthenticationRequired(Profile, {
                                                                                                                                                                                                                                                                            onRedirecting: () => <div>Redirecting you to the login...</div>
                                                                                                                                                                                                                                                                          })
+
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                          onRedirecting?: () => Element
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          withAuthenticationRequired(Profile, {
                                                                                                                                                                                                                                                                            onRedirecting: () => <div>Redirecting you to the login...</div>
                                                                                                                                                                                                                                                                          })

                                                                                                                                                                                                                                                                          Render a message to show that the user is being redirected to the login.

                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          returnTo?: string | (() => string)
                                                                                                                                                                                                                                                                          withAuthenticationRequired(Profile, {
                                                                                                                                                                                                                                                                            returnTo: '/profile'
                                                                                                                                                                                                                                                                          })
+
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                          returnTo?: string | (() => string)
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          withAuthenticationRequired(Profile, {
                                                                                                                                                                                                                                                                            returnTo: '/profile'
                                                                                                                                                                                                                                                                          })

                                                                                                                                                                                                                                                                          or

                                                                                                                                                                                                                                                                          @@ -28,4 +83,28 @@

                                                                                                                                                                                                                                                                          Add a path for the onRedirectCallback handler to return the user to after login.

                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Member Visibility +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Properties +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          diff --git a/docs/modules.html b/docs/modules.html index 8b42d57c..bc2f802d 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1 +1,39 @@ -@auth0/auth0-react
                                                                                                                                                                                                                                                                          @auth0/auth0-react
                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                              @auth0/auth0-react

                                                                                                                                                                                                                                                                              Main

                                                                                                                                                                                                                                                                              ClientConfiguration

                                                                                                                                                                                                                                                                              Other

                                                                                                                                                                                                                                                                              ResponseType
                                                                                                                                                                                                                                                                              AuthenticationError
                                                                                                                                                                                                                                                                              ConnectError
                                                                                                                                                                                                                                                                              GenericError
                                                                                                                                                                                                                                                                              InMemoryCache
                                                                                                                                                                                                                                                                              InvalidConfigurationError
                                                                                                                                                                                                                                                                              LocalStorageCache
                                                                                                                                                                                                                                                                              MfaChallengeError
                                                                                                                                                                                                                                                                              MfaEnrollmentError
                                                                                                                                                                                                                                                                              MfaEnrollmentFactorsError
                                                                                                                                                                                                                                                                              MfaError
                                                                                                                                                                                                                                                                              MfaListAuthenticatorsError
                                                                                                                                                                                                                                                                              MfaRequiredError
                                                                                                                                                                                                                                                                              MfaVerifyError
                                                                                                                                                                                                                                                                              MissingRefreshTokenError
                                                                                                                                                                                                                                                                              MissingScopesError
                                                                                                                                                                                                                                                                              MyAccountApiError
                                                                                                                                                                                                                                                                              OAuthError
                                                                                                                                                                                                                                                                              PasskeyChallengeError
                                                                                                                                                                                                                                                                              PasskeyError
                                                                                                                                                                                                                                                                              PasskeyGetTokenError
                                                                                                                                                                                                                                                                              PasskeyRegisterError
                                                                                                                                                                                                                                                                              PopupCancelledError
                                                                                                                                                                                                                                                                              PopupOpenError
                                                                                                                                                                                                                                                                              PopupTimeoutError
                                                                                                                                                                                                                                                                              TimeoutError
                                                                                                                                                                                                                                                                              UseDpopNonceError
                                                                                                                                                                                                                                                                              User
                                                                                                                                                                                                                                                                              ActClaim
                                                                                                                                                                                                                                                                              Auth0ContextInterface
                                                                                                                                                                                                                                                                              Authenticator
                                                                                                                                                                                                                                                                              AuthorizationParams
                                                                                                                                                                                                                                                                              ChallengeAuthenticatorParams
                                                                                                                                                                                                                                                                              ChallengeResponse
                                                                                                                                                                                                                                                                              EnrollEmailParams
                                                                                                                                                                                                                                                                              EnrollmentFactor
                                                                                                                                                                                                                                                                              EnrollOtpParams
                                                                                                                                                                                                                                                                              EnrollPushParams
                                                                                                                                                                                                                                                                              EnrollSmsParams
                                                                                                                                                                                                                                                                              EnrollVoiceParams
                                                                                                                                                                                                                                                                              Factor
                                                                                                                                                                                                                                                                              GetTokenSilentlyOptions
                                                                                                                                                                                                                                                                              GetTokenWithPopupOptions
                                                                                                                                                                                                                                                                              ICache
                                                                                                                                                                                                                                                                              IdToken
                                                                                                                                                                                                                                                                              LogoutOptions
                                                                                                                                                                                                                                                                              LogoutUrlOptions
                                                                                                                                                                                                                                                                              MfaApiClient
                                                                                                                                                                                                                                                                              MyAccountApiClient
                                                                                                                                                                                                                                                                              PasskeyApiClient
                                                                                                                                                                                                                                                                              PopupConfigOptions
                                                                                                                                                                                                                                                                              PopupLoginOptions
                                                                                                                                                                                                                                                                              RedirectConnectAccountOptions
                                                                                                                                                                                                                                                                              RedirectLoginOptions
                                                                                                                                                                                                                                                                              RevokeRefreshTokenOptions
                                                                                                                                                                                                                                                                              UpdateAuthenticationMethodRequest
                                                                                                                                                                                                                                                                              VerifyParams
                                                                                                                                                                                                                                                                              WithAuth0Props
                                                                                                                                                                                                                                                                              WithAuthenticationRequiredOptions
                                                                                                                                                                                                                                                                              AppState
                                                                                                                                                                                                                                                                              Auth0ProviderOptions
                                                                                                                                                                                                                                                                              Auth0ProviderWithClientOptions
                                                                                                                                                                                                                                                                              Auth0ProviderWithConfigOptions
                                                                                                                                                                                                                                                                              AuthenticationMethod
                                                                                                                                                                                                                                                                              AuthenticationMethodType
                                                                                                                                                                                                                                                                              Cacheable
                                                                                                                                                                                                                                                                              CacheLocation
                                                                                                                                                                                                                                                                              ConnectAccountRedirectResult
                                                                                                                                                                                                                                                                              ConnectedAccount
                                                                                                                                                                                                                                                                              CustomTokenExchangeOptions
                                                                                                                                                                                                                                                                              EnrollmentChallengeOptions
                                                                                                                                                                                                                                                                              EnrollmentChallengeResponse
                                                                                                                                                                                                                                                                              EnrollmentResponse
                                                                                                                                                                                                                                                                              EnrollmentVerifyOptions
                                                                                                                                                                                                                                                                              EnrollParams
                                                                                                                                                                                                                                                                              FetcherConfig
                                                                                                                                                                                                                                                                              InteractiveErrorHandler
                                                                                                                                                                                                                                                                              MfaFactorType
                                                                                                                                                                                                                                                                              PasskeyLoginOptions
                                                                                                                                                                                                                                                                              PasskeySignupOptions
                                                                                                                                                                                                                                                                              RefreshTokenMode
                                                                                                                                                                                                                                                                              TokenEndpointResponse
                                                                                                                                                                                                                                                                              Auth0Context
                                                                                                                                                                                                                                                                              RefreshTokenMode
                                                                                                                                                                                                                                                                              Auth0Provider
                                                                                                                                                                                                                                                                              useAuth0
                                                                                                                                                                                                                                                                              withAuth0
                                                                                                                                                                                                                                                                              withAuthenticationRequired

                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                              Main
                                                                                                                                                                                                                                                                              Other
                                                                                                                                                                                                                                                                              ResponseTypeAuthenticationErrorConnectErrorGenericErrorInMemoryCacheInvalidConfigurationErrorLocalStorageCacheMfaChallengeErrorMfaEnrollmentErrorMfaEnrollmentFactorsErrorMfaErrorMfaListAuthenticatorsErrorMfaRequiredErrorMfaVerifyErrorMissingRefreshTokenErrorMissingScopesErrorMyAccountApiErrorOAuthErrorPasskeyChallengeErrorPasskeyErrorPasskeyGetTokenErrorPasskeyRegisterErrorPopupCancelledErrorPopupOpenErrorPopupTimeoutErrorTimeoutErrorUseDpopNonceErrorUserActClaimAuth0ContextInterfaceAuthenticatorAuthorizationParamsChallengeAuthenticatorParamsChallengeResponseEnrollEmailParamsEnrollmentFactorEnrollOtpParamsEnrollPushParamsEnrollSmsParamsEnrollVoiceParamsFactorGetTokenSilentlyOptionsGetTokenWithPopupOptionsICacheIdTokenLogoutOptionsLogoutUrlOptionsMfaApiClientMyAccountApiClientPasskeyApiClientPopupConfigOptionsPopupLoginOptionsRedirectConnectAccountOptionsRedirectLoginOptionsRevokeRefreshTokenOptionsUpdateAuthenticationMethodRequestVerifyParamsWithAuth0PropsWithAuthenticationRequiredOptionsAppStateAuth0ProviderOptionsAuth0ProviderWithClientOptionsAuth0ProviderWithConfigOptionsAuthenticationMethodAuthenticationMethodTypeCacheableCacheLocationConnectAccountRedirectResultConnectedAccountCustomTokenExchangeOptionsEnrollmentChallengeOptionsEnrollmentChallengeResponseEnrollmentResponseEnrollmentVerifyOptionsEnrollParamsFetcherConfigInteractiveErrorHandlerMfaFactorTypePasskeyLoginOptionsPasskeySignupOptionsRefreshTokenModeTokenEndpointResponseAuth0ContextRefreshTokenModeAuth0ProvideruseAuth0withAuth0withAuthenticationRequired
                                                                                                                                                                                                                                                                              +@auth0/auth0-react
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              @auth0/auth0-react + +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  @auth0/auth0-react

                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  ClientConfiguration
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  ResponseType
                                                                                                                                                                                                                                                                                  AuthenticationError
                                                                                                                                                                                                                                                                                  ConnectError
                                                                                                                                                                                                                                                                                  GenericError
                                                                                                                                                                                                                                                                                  InMemoryCache
                                                                                                                                                                                                                                                                                  InvalidConfigurationError
                                                                                                                                                                                                                                                                                  LocalStorageCache
                                                                                                                                                                                                                                                                                  MfaChallengeError
                                                                                                                                                                                                                                                                                  MfaEnrollmentError
                                                                                                                                                                                                                                                                                  MfaEnrollmentFactorsError
                                                                                                                                                                                                                                                                                  MfaError
                                                                                                                                                                                                                                                                                  MfaListAuthenticatorsError
                                                                                                                                                                                                                                                                                  MfaRequiredError
                                                                                                                                                                                                                                                                                  MfaVerifyError
                                                                                                                                                                                                                                                                                  MissingRefreshTokenError
                                                                                                                                                                                                                                                                                  MissingScopesError
                                                                                                                                                                                                                                                                                  MyAccountApiError
                                                                                                                                                                                                                                                                                  OAuthError
                                                                                                                                                                                                                                                                                  PasskeyChallengeError
                                                                                                                                                                                                                                                                                  PasskeyError
                                                                                                                                                                                                                                                                                  PasskeyGetTokenError
                                                                                                                                                                                                                                                                                  PasskeyRegisterError
                                                                                                                                                                                                                                                                                  PopupCancelledError
                                                                                                                                                                                                                                                                                  PopupOpenError
                                                                                                                                                                                                                                                                                  PopupTimeoutError
                                                                                                                                                                                                                                                                                  TimeoutError
                                                                                                                                                                                                                                                                                  UseDpopNonceError
                                                                                                                                                                                                                                                                                  User
                                                                                                                                                                                                                                                                                  ActClaim
                                                                                                                                                                                                                                                                                  Auth0ContextInterface
                                                                                                                                                                                                                                                                                  Authenticator
                                                                                                                                                                                                                                                                                  AuthorizationParams
                                                                                                                                                                                                                                                                                  ChallengeAuthenticatorParams
                                                                                                                                                                                                                                                                                  ChallengeResponse
                                                                                                                                                                                                                                                                                  EnrollEmailParams
                                                                                                                                                                                                                                                                                  EnrollmentFactor
                                                                                                                                                                                                                                                                                  EnrollOtpParams
                                                                                                                                                                                                                                                                                  EnrollPushParams
                                                                                                                                                                                                                                                                                  EnrollSmsParams
                                                                                                                                                                                                                                                                                  EnrollVoiceParams
                                                                                                                                                                                                                                                                                  Factor
                                                                                                                                                                                                                                                                                  GetTokenSilentlyOptions
                                                                                                                                                                                                                                                                                  GetTokenWithPopupOptions
                                                                                                                                                                                                                                                                                  ICache
                                                                                                                                                                                                                                                                                  IdToken
                                                                                                                                                                                                                                                                                  LogoutOptions
                                                                                                                                                                                                                                                                                  LogoutUrlOptions
                                                                                                                                                                                                                                                                                  MfaApiClient
                                                                                                                                                                                                                                                                                  MyAccountApiClient
                                                                                                                                                                                                                                                                                  PasskeyApiClient
                                                                                                                                                                                                                                                                                  PopupConfigOptions
                                                                                                                                                                                                                                                                                  PopupLoginOptions
                                                                                                                                                                                                                                                                                  RedirectConnectAccountOptions
                                                                                                                                                                                                                                                                                  RedirectLoginOptions
                                                                                                                                                                                                                                                                                  RevokeRefreshTokenOptions
                                                                                                                                                                                                                                                                                  UpdateAuthenticationMethodRequest
                                                                                                                                                                                                                                                                                  VerifyParams
                                                                                                                                                                                                                                                                                  WithAuth0Props
                                                                                                                                                                                                                                                                                  WithAuthenticationRequiredOptions
                                                                                                                                                                                                                                                                                  AppState
                                                                                                                                                                                                                                                                                  Auth0ProviderOptions
                                                                                                                                                                                                                                                                                  Auth0ProviderWithClientOptions
                                                                                                                                                                                                                                                                                  Auth0ProviderWithConfigOptions
                                                                                                                                                                                                                                                                                  AuthenticationMethod
                                                                                                                                                                                                                                                                                  AuthenticationMethodType
                                                                                                                                                                                                                                                                                  Cacheable
                                                                                                                                                                                                                                                                                  CacheLocation
                                                                                                                                                                                                                                                                                  ConnectAccountRedirectResult
                                                                                                                                                                                                                                                                                  ConnectedAccount
                                                                                                                                                                                                                                                                                  CustomTokenExchangeOptions
                                                                                                                                                                                                                                                                                  EnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                  EnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                  EnrollmentResponse
                                                                                                                                                                                                                                                                                  EnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                  EnrollParams
                                                                                                                                                                                                                                                                                  FetcherConfig
                                                                                                                                                                                                                                                                                  InteractiveErrorHandler
                                                                                                                                                                                                                                                                                  MfaFactorType
                                                                                                                                                                                                                                                                                  PasskeyLoginOptions
                                                                                                                                                                                                                                                                                  PasskeySignupOptions
                                                                                                                                                                                                                                                                                  RefreshTokenMode
                                                                                                                                                                                                                                                                                  TokenEndpointResponse
                                                                                                                                                                                                                                                                                  Auth0Context
                                                                                                                                                                                                                                                                                  RefreshTokenMode
                                                                                                                                                                                                                                                                                  Auth0Provider
                                                                                                                                                                                                                                                                                  useAuth0
                                                                                                                                                                                                                                                                                  withAuth0
                                                                                                                                                                                                                                                                                  withAuthenticationRequired
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  Member Visibility +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  Main +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  Other +
                                                                                                                                                                                                                                                                                  ResponseTypeAuthenticationErrorConnectErrorGenericErrorInMemoryCacheInvalidConfigurationErrorLocalStorageCacheMfaChallengeErrorMfaEnrollmentErrorMfaEnrollmentFactorsErrorMfaErrorMfaListAuthenticatorsErrorMfaRequiredErrorMfaVerifyErrorMissingRefreshTokenErrorMissingScopesErrorMyAccountApiErrorOAuthErrorPasskeyChallengeErrorPasskeyErrorPasskeyGetTokenErrorPasskeyRegisterErrorPopupCancelledErrorPopupOpenErrorPopupTimeoutErrorTimeoutErrorUseDpopNonceErrorUserActClaimAuth0ContextInterfaceAuthenticatorAuthorizationParamsChallengeAuthenticatorParamsChallengeResponseEnrollEmailParamsEnrollmentFactorEnrollOtpParamsEnrollPushParamsEnrollSmsParamsEnrollVoiceParamsFactorGetTokenSilentlyOptionsGetTokenWithPopupOptionsICacheIdTokenLogoutOptionsLogoutUrlOptionsMfaApiClientMyAccountApiClientPasskeyApiClientPopupConfigOptionsPopupLoginOptionsRedirectConnectAccountOptionsRedirectLoginOptionsRevokeRefreshTokenOptionsUpdateAuthenticationMethodRequestVerifyParamsWithAuth0PropsWithAuthenticationRequiredOptionsAppStateAuth0ProviderOptionsAuth0ProviderWithClientOptionsAuth0ProviderWithConfigOptionsAuthenticationMethodAuthenticationMethodTypeCacheableCacheLocationConnectAccountRedirectResultConnectedAccountCustomTokenExchangeOptionsEnrollmentChallengeOptionsEnrollmentChallengeResponseEnrollmentResponseEnrollmentVerifyOptionsEnrollParamsFetcherConfigInteractiveErrorHandlerMfaFactorTypePasskeyLoginOptionsPasskeySignupOptionsRefreshTokenModeTokenEndpointResponseAuth0ContextRefreshTokenModeAuth0ProvideruseAuth0withAuth0withAuthenticationRequired
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  diff --git a/docs/types/AppState.html b/docs/types/AppState.html index f8c1583b..e1a69d9f 100644 --- a/docs/types/AppState.html +++ b/docs/types/AppState.html @@ -1,6 +1,75 @@ -AppState | @auth0/auth0-react
                                                                                                                                                                                                                                                                                  @auth0/auth0-react
                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                    Type Alias AppState

                                                                                                                                                                                                                                                                                    The state of the application before the user was redirected to the login page +AppState | @auth0/auth0-react

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    @auth0/auth0-react + +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                      Type Alias AppState

                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      The state of the application before the user was redirected to the login page and any account that the user may have connected to.

                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                      type AppState = {
                                                                                                                                                                                                                                                                                          connectedAccount?: ConnectedAccount;
                                                                                                                                                                                                                                                                                          response_type?: ResponseType;
                                                                                                                                                                                                                                                                                          returnTo?: string;
                                                                                                                                                                                                                                                                                          [key: string]: any;
                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                      Indexable

                                                                                                                                                                                                                                                                                      • [key: string]: any
                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                      connectedAccount? +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      type AppState = {
                                                                                                                                                                                                                                                                                          connectedAccount?: ConnectedAccount;
                                                                                                                                                                                                                                                                                          response_type?: ResponseType;
                                                                                                                                                                                                                                                                                          returnTo?: string;
                                                                                                                                                                                                                                                                                          [key: string]: any;
                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Indexable

                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                        [key: string]: any
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      Index
                                                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                      connectedAccount? response_type? returnTo? -

                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                      connectedAccount?: ConnectedAccount
                                                                                                                                                                                                                                                                                      response_type?: ResponseType
                                                                                                                                                                                                                                                                                      returnTo?: string

                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                      connectedAccount?: ConnectedAccount
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                      response_type?: ResponseType
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                      returnTo?: string
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      Member Visibility +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      Properties +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      diff --git a/docs/types/Auth0ProviderOptions.html b/docs/types/Auth0ProviderOptions.html index f0fb11da..3bf75734 100644 --- a/docs/types/Auth0ProviderOptions.html +++ b/docs/types/Auth0ProviderOptions.html @@ -1,4 +1,40 @@ -Auth0ProviderOptions | @auth0/auth0-react
                                                                                                                                                                                                                                                                                      @auth0/auth0-react
                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                        Type Alias Auth0ProviderOptions<TUser>

                                                                                                                                                                                                                                                                                        Auth0ProviderOptions:
                                                                                                                                                                                                                                                                                            | Auth0ProviderWithConfigOptions<TUser>
                                                                                                                                                                                                                                                                                            | Auth0ProviderWithClientOptions<TUser>

                                                                                                                                                                                                                                                                                        The main configuration to instantiate the Auth0Provider.

                                                                                                                                                                                                                                                                                        +Auth0ProviderOptions | @auth0/auth0-react
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        @auth0/auth0-react + +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                          Type Alias Auth0ProviderOptions<TUser>

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Auth0ProviderOptions:
                                                                                                                                                                                                                                                                                              | Auth0ProviderWithConfigOptions<TUser>
                                                                                                                                                                                                                                                                                              | Auth0ProviderWithClientOptions<TUser>
                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          The main configuration to instantiate the Auth0Provider.

                                                                                                                                                                                                                                                                                          Either provide domain and clientId (Auth0ProviderWithConfigOptions) or a pre-configured client instance (Auth0ProviderWithClientOptions).

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Member Visibility +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          diff --git a/docs/types/Auth0ProviderWithClientOptions.html b/docs/types/Auth0ProviderWithClientOptions.html index 47db36e5..ef49d463 100644 --- a/docs/types/Auth0ProviderWithClientOptions.html +++ b/docs/types/Auth0ProviderWithClientOptions.html @@ -1,2 +1,38 @@ -Auth0ProviderWithClientOptions | @auth0/auth0-react
                                                                                                                                                                                                                                                                                          @auth0/auth0-react
                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                            Type Alias Auth0ProviderWithClientOptions<TUser>

                                                                                                                                                                                                                                                                                            Auth0ProviderWithClientOptions: Auth0ProviderBaseOptions<TUser> & {
                                                                                                                                                                                                                                                                                                client: Auth0Client;
                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                            Options for Auth0Provider when supplying a pre-configured Auth0Client instance.

                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                            +Auth0ProviderWithClientOptions | @auth0/auth0-react
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            @auth0/auth0-react + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                              Type Alias Auth0ProviderWithClientOptions<TUser>

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              Auth0ProviderWithClientOptions: Auth0ProviderBaseOptions<TUser> & {
                                                                                                                                                                                                                                                                                                  client: Auth0Client;
                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Options for Auth0Provider when supplying a pre-configured Auth0Client instance.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              Member Visibility +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              diff --git a/docs/types/Auth0ProviderWithConfigOptions.html b/docs/types/Auth0ProviderWithConfigOptions.html index 8c5b38eb..f50e5484 100644 --- a/docs/types/Auth0ProviderWithConfigOptions.html +++ b/docs/types/Auth0ProviderWithConfigOptions.html @@ -1,3 +1,39 @@ -Auth0ProviderWithConfigOptions | @auth0/auth0-react
                                                                                                                                                                                                                                                                                              @auth0/auth0-react
                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                Type Alias Auth0ProviderWithConfigOptions<TUser>

                                                                                                                                                                                                                                                                                                Auth0ProviderWithConfigOptions: Auth0ProviderBaseOptions<TUser> & Auth0ClientOptions & {
                                                                                                                                                                                                                                                                                                    client?: never;
                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                Options for Auth0Provider when configuring Auth0 via domain and clientId. +Auth0ProviderWithConfigOptions | @auth0/auth0-react

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                @auth0/auth0-react + +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                  Type Alias Auth0ProviderWithConfigOptions<TUser>

                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  Auth0ProviderWithConfigOptions: Auth0ProviderBaseOptions<TUser> & Auth0ClientOptions & {
                                                                                                                                                                                                                                                                                                      client?: never;
                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                  Options for Auth0Provider when configuring Auth0 via domain and clientId. Use this type when building wrapper components around Auth0Provider.

                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  Member Visibility +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/AuthenticationMethod.html b/docs/types/AuthenticationMethod.html index 98457196..af84d98b 100644 --- a/docs/types/AuthenticationMethod.html +++ b/docs/types/AuthenticationMethod.html @@ -1 +1,32 @@ -AuthenticationMethod | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                  @auth0/auth0-react
                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                    Type Alias AuthenticationMethod

                                                                                                                                                                                                                                                                                                    AuthenticationMethod:
                                                                                                                                                                                                                                                                                                        | PasskeyAuthenticationMethod
                                                                                                                                                                                                                                                                                                        | WebAuthnPlatformAuthenticationMethod
                                                                                                                                                                                                                                                                                                        | WebAuthnRoamingAuthenticationMethod
                                                                                                                                                                                                                                                                                                        | PhoneAuthenticationMethod
                                                                                                                                                                                                                                                                                                        | EmailAuthenticationMethod
                                                                                                                                                                                                                                                                                                        | PasswordAuthenticationMethod
                                                                                                                                                                                                                                                                                                        | TotpAuthenticationMethod
                                                                                                                                                                                                                                                                                                        | PushNotificationAuthenticationMethod
                                                                                                                                                                                                                                                                                                        | RecoveryCodeAuthenticationMethod

                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                    +AuthenticationMethod | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    @auth0/auth0-react + +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                      Type Alias AuthenticationMethod

                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      AuthenticationMethod:
                                                                                                                                                                                                                                                                                                          | PasskeyAuthenticationMethod
                                                                                                                                                                                                                                                                                                          | WebAuthnPlatformAuthenticationMethod
                                                                                                                                                                                                                                                                                                          | WebAuthnRoamingAuthenticationMethod
                                                                                                                                                                                                                                                                                                          | PhoneAuthenticationMethod
                                                                                                                                                                                                                                                                                                          | EmailAuthenticationMethod
                                                                                                                                                                                                                                                                                                          | PasswordAuthenticationMethod
                                                                                                                                                                                                                                                                                                          | TotpAuthenticationMethod
                                                                                                                                                                                                                                                                                                          | PushNotificationAuthenticationMethod
                                                                                                                                                                                                                                                                                                          | RecoveryCodeAuthenticationMethod
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      Member Visibility +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/AuthenticationMethodType.html b/docs/types/AuthenticationMethodType.html index 8cc0823f..fd843162 100644 --- a/docs/types/AuthenticationMethodType.html +++ b/docs/types/AuthenticationMethodType.html @@ -1 +1,32 @@ -AuthenticationMethodType | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                      @auth0/auth0-react
                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                        Type Alias AuthenticationMethodType

                                                                                                                                                                                                                                                                                                        AuthenticationMethodType:
                                                                                                                                                                                                                                                                                                            | "passkey"
                                                                                                                                                                                                                                                                                                            | "password"
                                                                                                                                                                                                                                                                                                            | "phone"
                                                                                                                                                                                                                                                                                                            | "totp"
                                                                                                                                                                                                                                                                                                            | "email"
                                                                                                                                                                                                                                                                                                            | "push-notification"
                                                                                                                                                                                                                                                                                                            | "recovery-code"
                                                                                                                                                                                                                                                                                                            | "webauthn-platform"
                                                                                                                                                                                                                                                                                                            | "webauthn-roaming"

                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                        +AuthenticationMethodType | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        @auth0/auth0-react + +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                          Type Alias AuthenticationMethodType

                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          AuthenticationMethodType:
                                                                                                                                                                                                                                                                                                              | "passkey"
                                                                                                                                                                                                                                                                                                              | "password"
                                                                                                                                                                                                                                                                                                              | "phone"
                                                                                                                                                                                                                                                                                                              | "totp"
                                                                                                                                                                                                                                                                                                              | "email"
                                                                                                                                                                                                                                                                                                              | "push-notification"
                                                                                                                                                                                                                                                                                                              | "recovery-code"
                                                                                                                                                                                                                                                                                                              | "webauthn-platform"
                                                                                                                                                                                                                                                                                                              | "webauthn-roaming"
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          Member Visibility +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/CacheLocation.html b/docs/types/CacheLocation.html index 5986b3c2..ffa3e804 100644 --- a/docs/types/CacheLocation.html +++ b/docs/types/CacheLocation.html @@ -1,2 +1,34 @@ -CacheLocation | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                          @auth0/auth0-react
                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                            Type Alias CacheLocation

                                                                                                                                                                                                                                                                                                            CacheLocation: "memory" | "localstorage"

                                                                                                                                                                                                                                                                                                            The possible locations where tokens can be stored

                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                            +CacheLocation | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            @auth0/auth0-react + +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                              Type Alias CacheLocation

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              CacheLocation: "memory" | "localstorage"
                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                              The possible locations where tokens can be stored

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              Member Visibility +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/Cacheable.html b/docs/types/Cacheable.html index 4378e1b3..bc7de9fb 100644 --- a/docs/types/Cacheable.html +++ b/docs/types/Cacheable.html @@ -1 +1,32 @@ -Cacheable | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                              @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                Type Alias Cacheable

                                                                                                                                                                                                                                                                                                                Cacheable: WrappedCacheEntry | KeyManifestEntry

                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                +Cacheable | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                @auth0/auth0-react + +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                  Type Alias Cacheable

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  Cacheable: WrappedCacheEntry | KeyManifestEntry
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  Member Visibility +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/ConnectAccountRedirectResult.html b/docs/types/ConnectAccountRedirectResult.html index 0fcae662..ab600cee 100644 --- a/docs/types/ConnectAccountRedirectResult.html +++ b/docs/types/ConnectAccountRedirectResult.html @@ -1,10 +1,59 @@ -ConnectAccountRedirectResult | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                  @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                    Type Alias ConnectAccountRedirectResult<TAppState>

                                                                                                                                                                                                                                                                                                                    ConnectAccountRedirectResult: CompleteResponse & {
                                                                                                                                                                                                                                                                                                                        appState?: TAppState;
                                                                                                                                                                                                                                                                                                                        response_type: ConnectCode;
                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                    The result returned after a successful account connection redirect.

                                                                                                                                                                                                                                                                                                                    +ConnectAccountRedirectResult | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    @auth0/auth0-react + +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                      Type Alias ConnectAccountRedirectResult<TAppState>

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      ConnectAccountRedirectResult: CompleteResponse & {
                                                                                                                                                                                                                                                                                                                          appState?: TAppState;
                                                                                                                                                                                                                                                                                                                          response_type: ConnectCode;
                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      The result returned after a successful account connection redirect.

                                                                                                                                                                                                                                                                                                                      Combines the redirect login result (including any persisted app state) with the complete response from the My Account API.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                      • TAppState = any

                                                                                                                                                                                                                                                                                                                        The type of application state persisted through the transaction.

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                      Type Declaration

                                                                                                                                                                                                                                                                                                                      • OptionalappState?: TAppState

                                                                                                                                                                                                                                                                                                                        State stored when the redirect request was made

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • response_type: ConnectCode

                                                                                                                                                                                                                                                                                                                        The type of response, for connect account it will be connect_code

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      const result = await auth0.connectAccountWithRedirect(options);
                                                                                                                                                                                                                                                                                                                      console.log(result.appState); // Access persisted app state
                                                                                                                                                                                                                                                                                                                      console.log(result.connection);   // The connection of the account you connected to.
                                                                                                                                                                                                                                                                                                                      console.log(result.response_type === 'connect_code');   // The response type will be 'connect_code'
+
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • TAppState = any +

                                                                                                                                                                                                                                                                                                                        The type of application state persisted through the transaction.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Declaration

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                        OptionalappState?: TAppState
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        State stored when the redirect request was made

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                        response_type: ConnectCode
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        The type of response, for connect account it will be connect_code

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      const result = await auth0.connectAccountWithRedirect(options);
                                                                                                                                                                                                                                                                                                                      console.log(result.appState); // Access persisted app state
                                                                                                                                                                                                                                                                                                                      console.log(result.connection);   // The connection of the account you connected to.
                                                                                                                                                                                                                                                                                                                      console.log(result.response_type === 'connect_code');   // The response type will be 'connect_code'
                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      Member Visibility +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/ConnectedAccount.html b/docs/types/ConnectedAccount.html index c591a7de..21267913 100644 --- a/docs/types/ConnectedAccount.html +++ b/docs/types/ConnectedAccount.html @@ -1,2 +1,34 @@ -ConnectedAccount | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                      @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                        Type Alias ConnectedAccount

                                                                                                                                                                                                                                                                                                                        ConnectedAccount: Omit<
                                                                                                                                                                                                                                                                                                                            ConnectAccountRedirectResult,
                                                                                                                                                                                                                                                                                                                            "appState"
                                                                                                                                                                                                                                                                                                                            | "response_type",
                                                                                                                                                                                                                                                                                                                        >

                                                                                                                                                                                                                                                                                                                        The account that has been connected during the connect flow.

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                        +ConnectedAccount | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        @auth0/auth0-react + +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                          Type Alias ConnectedAccount

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          ConnectedAccount: Omit<
                                                                                                                                                                                                                                                                                                                              ConnectAccountRedirectResult,
                                                                                                                                                                                                                                                                                                                              "appState"
                                                                                                                                                                                                                                                                                                                              | "response_type",
                                                                                                                                                                                                                                                                                                                          >
                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          The account that has been connected during the connect flow.

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          Member Visibility +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/CustomTokenExchangeOptions.html b/docs/types/CustomTokenExchangeOptions.html index 27fb6ef8..ba4cdabf 100644 --- a/docs/types/CustomTokenExchangeOptions.html +++ b/docs/types/CustomTokenExchangeOptions.html @@ -1,55 +1,164 @@ -CustomTokenExchangeOptions | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                          @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                            Type Alias CustomTokenExchangeOptions

                                                                                                                                                                                                                                                                                                                            Represents the configuration options required for initiating a Custom Token Exchange request +CustomTokenExchangeOptions | @auth0/auth0-react

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            @auth0/auth0-react + +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                              Type Alias CustomTokenExchangeOptions

                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              Represents the configuration options required for initiating a Custom Token Exchange request following RFC 8693 specifications.

                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                              RFC 8693: OAuth 2.0 Token Exchange

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                              type CustomTokenExchangeOptions = {
                                                                                                                                                                                                                                                                                                                                  actor_token?: string;
                                                                                                                                                                                                                                                                                                                                  actor_token_type?: string;
                                                                                                                                                                                                                                                                                                                                  audience?: string;
                                                                                                                                                                                                                                                                                                                                  organization?: string;
                                                                                                                                                                                                                                                                                                                                  scope?: string;
                                                                                                                                                                                                                                                                                                                                  subject_token: string;
                                                                                                                                                                                                                                                                                                                                  subject_token_type: string;
                                                                                                                                                                                                                                                                                                                                  [key: string]: unknown;
                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                              Indexable

                                                                                                                                                                                                                                                                                                                              • [key: string]: unknown

                                                                                                                                                                                                                                                                                                                                Additional custom parameters for Auth0 Action processing

                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                Accessible in Action code via event.request.body

                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                {
                                                                                                                                                                                                                                                                                                                                  custom_parameter: "session_context",
                                                                                                                                                                                                                                                                                                                                  device_fingerprint: "a3d8f7...",
                                                                                                                                                                                                                                                                                                                                }
+
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                RFC 8693: OAuth 2.0 Token Exchange

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              type CustomTokenExchangeOptions = {
                                                                                                                                                                                                                                                                                                                                  actor_token?: string;
                                                                                                                                                                                                                                                                                                                                  actor_token_type?: string;
                                                                                                                                                                                                                                                                                                                                  audience?: string;
                                                                                                                                                                                                                                                                                                                                  organization?: string;
                                                                                                                                                                                                                                                                                                                                  scope?: string;
                                                                                                                                                                                                                                                                                                                                  subject_token: string;
                                                                                                                                                                                                                                                                                                                                  subject_token_type: string;
                                                                                                                                                                                                                                                                                                                                  [key: string]: unknown;
                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              Indexable

                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                [key: string]: unknown
                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Additional custom parameters for Auth0 Action processing

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Accessible in Action code via event.request.body

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                {
                                                                                                                                                                                                                                                                                                                                  custom_parameter: "session_context",
                                                                                                                                                                                                                                                                                                                                  device_fingerprint: "a3d8f7...",
                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                              actor_token? +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              Index
                                                                                                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                              actor_token? actor_token_type? audience? organization? scope? subject_token subject_token_type -

                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                              actor_token?: string

                                                                                                                                                                                                                                                                                                                              A token representing the acting party for delegation or impersonation scenarios.

                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                              Used when one principal needs to act on behalf of another. +

                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                              actor_token?: string
                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              A token representing the acting party for delegation or impersonation scenarios.

                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              Used when one principal needs to act on behalf of another. For example, an AI agent acting on behalf of a user.

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                              "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
+
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                              actor_token_type?: string

                                                                                                                                                                                                                                                                                                                              The type identifier for the actor token.

                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                              Must be a URI under your organization's control, following the same +

                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                              actor_token_type?: string
                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              The type identifier for the actor token.

                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              Must be a URI under your organization's control, following the same rules as subject_token_type.

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                              "https://idp.example.com/token-type/agent"
+
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              "https://idp.example.com/token-type/agent"
                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                              audience?: string

                                                                                                                                                                                                                                                                                                                              The target audience for the requested Auth0 token

                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                              Must match exactly with an API identifier configured in your Auth0 tenant. +

                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                              audience?: string
                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              The target audience for the requested Auth0 token

                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              Must match exactly with an API identifier configured in your Auth0 tenant. If not provided, falls back to the client's default audience.

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                              "https://api.your-service.com/v1"
+
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              "https://api.your-service.com/v1"
                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                              organization?: string

                                                                                                                                                                                                                                                                                                                              ID or name of the organization to use when authenticating a user. +

                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                              organization?: string
                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              ID or name of the organization to use when authenticating a user. When provided, the user will be authenticated using the organization context. The organization ID will be present in the access token payload.

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                              scope?: string

                                                                                                                                                                                                                                                                                                                              Space-separated list of OAuth 2.0 scopes being requested

                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                              Subject to API authorization policies configured in Auth0

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                              "openid profile email read:data write:data"
+
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                              scope?: string
                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              Space-separated list of OAuth 2.0 scopes being requested

                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              Subject to API authorization policies configured in Auth0

                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              "openid profile email read:data write:data"
                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                              subject_token: string

                                                                                                                                                                                                                                                                                                                              The opaque token value being exchanged for Auth0 tokens

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                              subject_token: string
                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              The opaque token value being exchanged for Auth0 tokens

                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              • Must be validated in Auth0 Actions using strong cryptographic verification
                                                                                                                                                                                                                                                                                                                              • Implement replay attack protection
                                                                                                                                                                                                                                                                                                                              • Recommended validation libraries: jose, jsonwebtoken
                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                              "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
+
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                              subject_token_type: string

                                                                                                                                                                                                                                                                                                                              The type identifier for the subject token being exchanged

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                              subject_token_type: string
                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              The type identifier for the subject token being exchanged

                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              • Must be a namespaced URI under your organization's control
                                                                                                                                                                                                                                                                                                                              • Forbidden patterns:
                                                                                                                                                                                                                                                                                                                                  @@ -59,7 +168,33 @@
                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                              "urn:acme:legacy-system-token"
                                                                                                                                                                                                                                                                                                                              "https://api.yourcompany.com/token-type/v1"
+
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              "urn:acme:legacy-system-token"
                                                                                                                                                                                                                                                                                                                              "https://api.yourcompany.com/token-type/v1"
                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              Member Visibility +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              Properties +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/EnrollParams.html b/docs/types/EnrollParams.html index bdc536a2..8932c4fc 100644 --- a/docs/types/EnrollParams.html +++ b/docs/types/EnrollParams.html @@ -1,2 +1,34 @@ -EnrollParams | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                              @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                Type Alias EnrollParams

                                                                                                                                                                                                                                                                                                                                EnrollParams:
                                                                                                                                                                                                                                                                                                                                    | EnrollOtpParams
                                                                                                                                                                                                                                                                                                                                    | EnrollSmsParams
                                                                                                                                                                                                                                                                                                                                    | EnrollVoiceParams
                                                                                                                                                                                                                                                                                                                                    | EnrollEmailParams
                                                                                                                                                                                                                                                                                                                                    | EnrollPushParams

                                                                                                                                                                                                                                                                                                                                Union type for all enrollment parameter types

                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                +EnrollParams | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                @auth0/auth0-react + +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                  Type Alias EnrollParams

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  EnrollParams:
                                                                                                                                                                                                                                                                                                                                      | EnrollOtpParams
                                                                                                                                                                                                                                                                                                                                      | EnrollSmsParams
                                                                                                                                                                                                                                                                                                                                      | EnrollVoiceParams
                                                                                                                                                                                                                                                                                                                                      | EnrollEmailParams
                                                                                                                                                                                                                                                                                                                                      | EnrollPushParams
                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                  Union type for all enrollment parameter types

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  Member Visibility +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/EnrollmentChallengeOptions.html b/docs/types/EnrollmentChallengeOptions.html index 5f9bdf8f..9cc1b56d 100644 --- a/docs/types/EnrollmentChallengeOptions.html +++ b/docs/types/EnrollmentChallengeOptions.html @@ -1 +1,32 @@ -EnrollmentChallengeOptions | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                  @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                    Type Alias EnrollmentChallengeOptions

                                                                                                                                                                                                                                                                                                                                    EnrollmentChallengeOptions:
                                                                                                                                                                                                                                                                                                                                        | PasskeyEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                        | PhoneEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                        | EmailEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                        | TotpEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                        | PushNotificationEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                        | RecoveryCodeEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                        | PasswordEnrollmentChallengeOptions

                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                    +EnrollmentChallengeOptions | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    @auth0/auth0-react + +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                      Type Alias EnrollmentChallengeOptions

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      EnrollmentChallengeOptions:
                                                                                                                                                                                                                                                                                                                                          | PasskeyEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                          | PhoneEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                          | EmailEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                          | TotpEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                          | PushNotificationEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                          | RecoveryCodeEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                          | PasswordEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Member Visibility +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/EnrollmentChallengeResponse.html b/docs/types/EnrollmentChallengeResponse.html index e89498b4..ec122232 100644 --- a/docs/types/EnrollmentChallengeResponse.html +++ b/docs/types/EnrollmentChallengeResponse.html @@ -1 +1,32 @@ -EnrollmentChallengeResponse | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                      @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                        Type Alias EnrollmentChallengeResponse

                                                                                                                                                                                                                                                                                                                                        EnrollmentChallengeResponse:
                                                                                                                                                                                                                                                                                                                                            | PasskeyEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                            | PhoneEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                            | EmailEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                            | TotpEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                            | PushNotificationEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                            | RecoveryCodeEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                            | PasswordEnrollmentChallengeResponse

                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                        +EnrollmentChallengeResponse | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        @auth0/auth0-react + +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                          Type Alias EnrollmentChallengeResponse

                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          EnrollmentChallengeResponse:
                                                                                                                                                                                                                                                                                                                                              | PasskeyEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                              | PhoneEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                              | EmailEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                              | TotpEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                              | PushNotificationEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                              | RecoveryCodeEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                              | PasswordEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          Member Visibility +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/EnrollmentResponse.html b/docs/types/EnrollmentResponse.html index 6192d892..d75ef080 100644 --- a/docs/types/EnrollmentResponse.html +++ b/docs/types/EnrollmentResponse.html @@ -1,2 +1,34 @@ -EnrollmentResponse | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                          @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                            Type Alias EnrollmentResponse

                                                                                                                                                                                                                                                                                                                                            EnrollmentResponse: OtpEnrollmentResponse | OobEnrollmentResponse

                                                                                                                                                                                                                                                                                                                                            Union type for all enrollment response types

                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                            +EnrollmentResponse | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            @auth0/auth0-react + +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                              Type Alias EnrollmentResponse

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              EnrollmentResponse: OtpEnrollmentResponse | OobEnrollmentResponse
                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                              Union type for all enrollment response types

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Member Visibility +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/EnrollmentVerifyOptions.html b/docs/types/EnrollmentVerifyOptions.html index daebb4f5..1f836d2b 100644 --- a/docs/types/EnrollmentVerifyOptions.html +++ b/docs/types/EnrollmentVerifyOptions.html @@ -1 +1,32 @@ -EnrollmentVerifyOptions | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                              @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                Type Alias EnrollmentVerifyOptions

                                                                                                                                                                                                                                                                                                                                                EnrollmentVerifyOptions:
                                                                                                                                                                                                                                                                                                                                                    | PasskeyEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                    | PhoneEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                    | EmailEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                    | TotpEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                    | PushNotificationEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                    | RecoveryCodeEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                    | PasswordEnrollmentVerifyOptions

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                +EnrollmentVerifyOptions | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                @auth0/auth0-react + +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                  Type Alias EnrollmentVerifyOptions

                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  EnrollmentVerifyOptions:
                                                                                                                                                                                                                                                                                                                                                      | PasskeyEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                      | PhoneEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                      | EmailEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                      | TotpEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                      | PushNotificationEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                      | RecoveryCodeEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                      | PasswordEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  Member Visibility +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/FetcherConfig.html b/docs/types/FetcherConfig.html index adbfa646..ad1365bc 100644 --- a/docs/types/FetcherConfig.html +++ b/docs/types/FetcherConfig.html @@ -1,5 +1,76 @@ -FetcherConfig | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                                  @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                    Type Alias FetcherConfig<TOutput>

                                                                                                                                                                                                                                                                                                                                                    type FetcherConfig<TOutput extends CustomFetchMinimalOutput> = {
                                                                                                                                                                                                                                                                                                                                                        baseUrl?: string;
                                                                                                                                                                                                                                                                                                                                                        dpopNonceId?: string;
                                                                                                                                                                                                                                                                                                                                                        fetch?: CustomFetchImpl<TOutput>;
                                                                                                                                                                                                                                                                                                                                                        getAccessToken?: AccessTokenFactory;
                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                    • TOutput extends CustomFetchMinimalOutput
                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                    baseUrl? +FetcherConfig | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    @auth0/auth0-react + +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                      Type Alias FetcherConfig<TOutput>

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      type FetcherConfig<TOutput extends CustomFetchMinimalOutput> = {
                                                                                                                                                                                                                                                                                                                                                          baseUrl?: string;
                                                                                                                                                                                                                                                                                                                                                          dpopNonceId?: string;
                                                                                                                                                                                                                                                                                                                                                          fetch?: CustomFetchImpl<TOutput>;
                                                                                                                                                                                                                                                                                                                                                          getAccessToken?: AccessTokenFactory;
                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                      • TOutput extends CustomFetchMinimalOutput
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      Index
                                                                                                                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                      baseUrl? dpopNonceId? fetch? getAccessToken? -

                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                      baseUrl?: string
                                                                                                                                                                                                                                                                                                                                                      dpopNonceId?: string
                                                                                                                                                                                                                                                                                                                                                      fetch?: CustomFetchImpl<TOutput>
                                                                                                                                                                                                                                                                                                                                                      getAccessToken?: AccessTokenFactory

                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                      baseUrl?: string
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                      dpopNonceId?: string
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                      fetch?: CustomFetchImpl<TOutput>
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                      getAccessToken?: AccessTokenFactory
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      Member Visibility +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      Properties +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/InteractiveErrorHandler.html b/docs/types/InteractiveErrorHandler.html index cfaa14c7..d0b0c0de 100644 --- a/docs/types/InteractiveErrorHandler.html +++ b/docs/types/InteractiveErrorHandler.html @@ -1,5 +1,37 @@ -InteractiveErrorHandler | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                                      @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                        Type Alias InteractiveErrorHandler

                                                                                                                                                                                                                                                                                                                                                        InteractiveErrorHandler: "popup"

                                                                                                                                                                                                                                                                                                                                                        Configuration option for automatic interactive error handling.

                                                                                                                                                                                                                                                                                                                                                        +InteractiveErrorHandler | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        @auth0/auth0-react + +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                          Type Alias InteractiveErrorHandler

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          InteractiveErrorHandler: "popup"
                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          Configuration option for automatic interactive error handling.

                                                                                                                                                                                                                                                                                                                                                          • 'popup': SDK automatically opens Universal Login popup on MFA error
                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Member Visibility +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/MfaFactorType.html b/docs/types/MfaFactorType.html index 0b5f0488..5128af63 100644 --- a/docs/types/MfaFactorType.html +++ b/docs/types/MfaFactorType.html @@ -1,2 +1,34 @@ -MfaFactorType | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                                          @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                            Type Alias MfaFactorType

                                                                                                                                                                                                                                                                                                                                                            MfaFactorType: "otp" | "sms" | "email" | "push" | "voice"

                                                                                                                                                                                                                                                                                                                                                            Supported MFA factors for enrollment

                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                            +MfaFactorType | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            @auth0/auth0-react + +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                              Type Alias MfaFactorType

                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              MfaFactorType: "otp" | "sms" | "email" | "push" | "voice"
                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Supported MFA factors for enrollment

                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              Member Visibility +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/PasskeyLoginOptions.html b/docs/types/PasskeyLoginOptions.html index 576ae922..d9e967f9 100644 --- a/docs/types/PasskeyLoginOptions.html +++ b/docs/types/PasskeyLoginOptions.html @@ -1,2 +1,34 @@ -PasskeyLoginOptions | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                                              @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                Type Alias PasskeyLoginOptions

                                                                                                                                                                                                                                                                                                                                                                PasskeyLoginOptions: PasskeyLoginChallengeOptions & {
                                                                                                                                                                                                                                                                                                                                                                    audience?: string;
                                                                                                                                                                                                                                                                                                                                                                    scope?: string;
                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                Options for passkey login (authenticating with an existing passkey).

                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                +PasskeyLoginOptions | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                @auth0/auth0-react + +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                                  Type Alias PasskeyLoginOptions

                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  PasskeyLoginOptions: PasskeyLoginChallengeOptions & {
                                                                                                                                                                                                                                                                                                                                                                      audience?: string;
                                                                                                                                                                                                                                                                                                                                                                      scope?: string;
                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                  Options for passkey login (authenticating with an existing passkey).

                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  Member Visibility +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/PasskeySignupOptions.html b/docs/types/PasskeySignupOptions.html index 7f7c55fe..1803cb07 100644 --- a/docs/types/PasskeySignupOptions.html +++ b/docs/types/PasskeySignupOptions.html @@ -1,2 +1,34 @@ -PasskeySignupOptions | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                                                  @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                    Type Alias PasskeySignupOptions

                                                                                                                                                                                                                                                                                                                                                                    PasskeySignupOptions: PasskeySignupChallengeOptions & {
                                                                                                                                                                                                                                                                                                                                                                        audience?: string;
                                                                                                                                                                                                                                                                                                                                                                        scope?: string;
                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                    Options for passkey signup (registering a new user with a passkey).

                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                    +PasskeySignupOptions | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    @auth0/auth0-react + +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                      Type Alias PasskeySignupOptions

                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      PasskeySignupOptions: PasskeySignupChallengeOptions & {
                                                                                                                                                                                                                                                                                                                                                                          audience?: string;
                                                                                                                                                                                                                                                                                                                                                                          scope?: string;
                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                      Options for passkey signup (registering a new user with a passkey).

                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      Member Visibility +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/RefreshTokenMode.html b/docs/types/RefreshTokenMode.html index 294ca151..f8daa87a 100644 --- a/docs/types/RefreshTokenMode.html +++ b/docs/types/RefreshTokenMode.html @@ -1,6 +1,39 @@ -RefreshTokenMode | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                                                      @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                        Type Alias RefreshTokenMode

                                                                                                                                                                                                                                                                                                                                                                        RefreshTokenMode: typeof RefreshTokenMode[keyof typeof RefreshTokenMode]

                                                                                                                                                                                                                                                                                                                                                                        The refresh-token variant used when useRefreshTokens: true.

                                                                                                                                                                                                                                                                                                                                                                        +RefreshTokenMode | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        @auth0/auth0-react + +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                          Type Alias RefreshTokenMode

                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          RefreshTokenMode: typeof RefreshTokenMode[keyof typeof RefreshTokenMode]
                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                          The refresh-token variant used when useRefreshTokens: true.

                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          Member Visibility +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/TokenEndpointResponse.html b/docs/types/TokenEndpointResponse.html index 6ca2fb01..ca305740 100644 --- a/docs/types/TokenEndpointResponse.html +++ b/docs/types/TokenEndpointResponse.html @@ -1,7 +1,84 @@ -TokenEndpointResponse | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                                                          @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                            Type Alias TokenEndpointResponse

                                                                                                                                                                                                                                                                                                                                                                            type TokenEndpointResponse = {
                                                                                                                                                                                                                                                                                                                                                                                access_token: string;
                                                                                                                                                                                                                                                                                                                                                                                expires_in: number;
                                                                                                                                                                                                                                                                                                                                                                                id_token: string;
                                                                                                                                                                                                                                                                                                                                                                                refresh_token?: string;
                                                                                                                                                                                                                                                                                                                                                                                scope?: string;
                                                                                                                                                                                                                                                                                                                                                                                token_type: string;
                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                            access_token +TokenEndpointResponse | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            @auth0/auth0-react + +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                                              Type Alias TokenEndpointResponse

                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              type TokenEndpointResponse = {
                                                                                                                                                                                                                                                                                                                                                                                  access_token: string;
                                                                                                                                                                                                                                                                                                                                                                                  expires_in: number;
                                                                                                                                                                                                                                                                                                                                                                                  id_token: string;
                                                                                                                                                                                                                                                                                                                                                                                  refresh_token?: string;
                                                                                                                                                                                                                                                                                                                                                                                  scope?: string;
                                                                                                                                                                                                                                                                                                                                                                                  token_type: string;
                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              Index
                                                                                                                                                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                              access_token expires_in id_token refresh_token? scope? token_type -

                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                              access_token: string
                                                                                                                                                                                                                                                                                                                                                                              expires_in: number
                                                                                                                                                                                                                                                                                                                                                                              id_token: string
                                                                                                                                                                                                                                                                                                                                                                              refresh_token?: string
                                                                                                                                                                                                                                                                                                                                                                              scope?: string
                                                                                                                                                                                                                                                                                                                                                                              token_type: string

                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                              access_token: string
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                              expires_in: number
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                              id_token: string
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                              refresh_token?: string
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                              scope?: string
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                              token_type: string
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              Member Visibility +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              Properties +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/variables/Auth0Context.html b/docs/variables/Auth0Context.html index 1d2d631a..f00dd40c 100644 --- a/docs/variables/Auth0Context.html +++ b/docs/variables/Auth0Context.html @@ -1,2 +1,34 @@ -Auth0Context | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                                                              @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                Variable Auth0ContextConst

                                                                                                                                                                                                                                                                                                                                                                                Auth0Context: Context<Auth0ContextInterface<User>> = ...

                                                                                                                                                                                                                                                                                                                                                                                The Auth0 Context

                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                +Auth0Context | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                @auth0/auth0-react + +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                                                  Variable Auth0ContextConst

                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  Auth0Context: Context<Auth0ContextInterface<User>> = ...
                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                  The Auth0 Context

                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/variables/RefreshTokenMode.html b/docs/variables/RefreshTokenMode.html index 053cb62a..ff8fae9a 100644 --- a/docs/variables/RefreshTokenMode.html +++ b/docs/variables/RefreshTokenMode.html @@ -1,6 +1,46 @@ -RefreshTokenMode | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                                                                  @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                    Variable RefreshTokenModeConst

                                                                                                                                                                                                                                                                                                                                                                                    RefreshTokenMode: { Offline: "offline"; Online: "online" }

                                                                                                                                                                                                                                                                                                                                                                                    The refresh-token variant used when useRefreshTokens: true.

                                                                                                                                                                                                                                                                                                                                                                                    +RefreshTokenMode | @auth0/auth0-react
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    @auth0/auth0-react + +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                                      Variable RefreshTokenModeConst

                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      RefreshTokenMode: { Offline: "offline"; Online: "online" }
                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      The refresh-token variant used when useRefreshTokens: true.

                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                      Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                      • ReadonlyOffline: "offline"
                                                                                                                                                                                                                                                                                                                                                                                      • ReadonlyOnline: "online"

                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                        ReadonlyOffline: "offline"
                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                        ReadonlyOnline: "online"
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/package-lock.json b/package-lock.json index 14a9abe2..3ec6b8cc 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@auth0/auth0-react", - "version": "2.22.0", + "version": "2.22.1", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@auth0/auth0-react", - "version": "2.22.0", + "version": "2.22.1", "license": "MIT", "dependencies": { "@auth0/auth0-spa-js": "^2.24.1" diff --git a/package.json b/package.json index ca726c8f..c86a3064 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "author": "Auth0", "name": "@auth0/auth0-react", - "version": "2.22.0", + "version": "2.22.1", "description": "Auth0 SDK for React Single Page Applications (SPA)", "keywords": [ "auth0",